Skip to main content
POST
Purchase credits by card (top-up alias)

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Body

application/json
amount
integer
required

Top-up amount in cents (minimum $0.50, up to the wallet ceiling; e.g. 5000 = $50.00).

successUrl
string<uri>
required

URL redirected to on a completed payment (e.g. https://orbit.devotel.io/billing?topup=success). Must use a trusted Orbit origin (orbit.devotel.io).

cancelUrl
string<uri>
required

URL redirected to when the customer abandons checkout (e.g. https://orbit.devotel.io/billing?topup=cancelled). Must use a trusted Orbit origin (orbit.devotel.io).

currency
enum<string>
default:usd

Top-up currency (usd or eur).

Available options:
usd,
eur

Response

The hosted checkout session — checkoutUrl (the provider URL to redirect the browser to; on settle, pass its session id to POST /billing/credits/confirm when the success page returns) — in the standard { data, meta } envelope.

The hosted checkout session — checkoutUrl (the provider URL to redirect the browser to; on settle, pass its session id to POST /billing/credits/confirm when the success page returns) — in the standard { data, meta } envelope.