Skip to main content
POST
Preview a credit top-up

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Body

application/json
organizationId
string
required
Minimum string length: 1
credits
integer
required
Required range: 400 <= x <= 9007199254740991
successUrl
string
Minimum string length: 1
idempotencyKey
string
Minimum string length: 1

Response

Price projection for the top-up.

Read-only price projection. Nothing is charged or changed.

total
number | null
required

Total amount due now; null when the provider does not return one.

currency
string | null
required

ISO currency code, e.g. usd.

lineItems
object[]
required

Itemized charges that make up the total.