Skip to main content
POST
Create top-up checkout

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Body

application/json

Request model for top-up credit purchase.

message_credits
integer
default:0

Message credits to buy: a multiple of 50, up to 400. Defaults to 0.

Example:

100

integration_credits
integer
default:0

Integration credits to buy: a multiple of 1,000, up to 8,000. Defaults to 0.

Example:

1000

Response

The checkout page to send the card owner to.

session_id
string
required

ID of the Stripe Checkout session.

Example:

"cs_live_a1B2c3D4e5F6g7H8i9J0"

url
string
required

Stripe Checkout page for this purchase. Open it in a browser so the card owner can review and pay.

Example:

"https://checkout.stripe.com/c/pay/cs_live_a1B2c3D4e5F6g7H8i9J0"