Purchase credits

Purchase a one-time amount of credits against the saved payment method. Requires a user credential with billing:manage and a stable idempotency key.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

organizationId?string

Organization to operate on. Auto-filled from CLI and SDK context when omitted. User tokens must supply it unless the credential's fixed scope resolves it; secret keys may omit it (the key's organization applies).

Length1 <= length

amount*string

Amount to charge in the account currency; grants an equal credit balance.

Match^\d+(?:\.\d{1,6})?$

idempotencyKey*string

Client-generated key. Repeating a request with the same key returns the original purchase instead of charging again.

Length1 <= length <= 128

Response Body

`application/json`

curl -X POST "https://example.com/billing/credits/purchase" \  -H "Content-Type: application/json" \  -d '{    "amount": "string",    "idempotencyKey": "string"  }'

{  "status": "paid",  "billingInvoiceId": "string",  "topUpAmount": "string",  "creditsToGrant": "string",  "currency": "string"}

Request Body

Response Body

200application/json

`application/json`