v2

latestOpenAPI 3.1.02026-08-07139158192.4 KB

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).

promoCodestring

Optional first-deposit promo code. When valid on the org's first deposit, amountCents is the deposit the customer wants credited and the saved card is charged the DISCOUNTED amount; the discount is credited as free (usage-only) credit by the webhook. Invalid / already-used codes are rejected (400) before any charge.

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.