Sign in
organizations

Changed on

Create a new top-up checkout session.

Validates the requested amount, ensures a billing account exists for the organization, creates a BillingTopUp row, and returns the Stripe Checkout URL for client-side redirect.

post/v1/organizations/billing/top-ups/checkout-session/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid
    • API key in header X-Session-Token

Headers

Vellum-Organization-Idstring uuid

Required if using Cookie-based or X-Session-Token authentication methods.

Request body

amountstring

Amount as a decimal string (e.g. '25.00'). Must have exactly two decimal places. Preferred over amount_usd.

amount_usdstring

Deprecated. Amount in USD as a decimal string (e.g. '25.00'). Must have exactly two decimal places. Use 'amount' instead.

return_pathstring

Client-side path to redirect to after checkout completes. Ignored when return_target is 'native'.

return_target'web' | 'native'
  • web - web
  • native - native

Response

billing_top_up_idstring uuid required
checkout_urlstring uri required
requested_amountstring required
requested_amount_usdstring required

Changes

  • 8b022ce74761Revision changes
    • ○

      added the new optional request property (media type: application/json)

    • ○

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • ○

      added the new optional request property (media type: multipart/form-data)