Sign in
Billing

Charge the saved card to top up prepaid balance

Charges the org's default saved card off-session. The balance credit is applied by the payment_intent.succeeded webhook (the authoritative money signal), not this response: poll the balance after success.

post/v1/orgs/{orgId}/billing/deposit

Path parameters

orgIdstring required

Request body

amountCentsinteger required

Amount to charge the saved card, in cents (bounds $10-$500).

idempotencyKeystring

Client-generated id for this logical deposit; reused verbatim on retry so a network/client retry can't double-charge. Optional: the server generates one if absent (then retries won't dedupe).

Response

Charge outcome (status drives the dashboard's next step)

clientSecretstring

Set only when status is requires_action (on-session SCA).

paymentIntentIdstring required
statusstring required

Stripe PaymentIntent status. "succeeded" → credit lands via webhook; "requires_action" → complete SCA on-session with clientSecret; "requires_payment_method" → the card was declined.

Changes

Changed in 1 of the 20 revisions of this API.1