Skip to content

Start a credit top-up Checkout flow

POST
/api/v1/billing/topup

Create a Stripe Checkout Session for the per-plan credit top-up price ($40/1K Starter, $30/1K Professional, $20/1K Business). Enterprise tenants receive 403 — Enterprise top-ups are custom-negotiated.

Authorizations

Request Body required

Request body for POST /api/v1/billing/topup (FIN-04).

Attributes: credit_pack_size: Total credits to purchase. Must be a positive multiple of 1000 — the Stripe Product is priced per-1000 and quantity is derived as credit_pack_size // 1000.

object
credit_pack_size
required

Total credits to purchase (must be a positive multiple of 1000)

integer
> 0

Responses

200

Successful Response

Response for POST /api/v1/billing/topup.

Attributes: checkout_url: The hosted Stripe Checkout URL — frontend redirects the tenant here to complete payment. session_id: The Stripe Checkout Session ID. Primary idempotency key for the checkout.session.completed webhook handler.

object
checkout_url
required
string
session_id
required
string

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string