Skip to main content
POST
Create billing checkout session

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
checkout_type
enum<string>
required
Available options:
subscription
return_path
string
required
Maximum string length: 500
Pattern: ^/(?:(?:\.{3,}[!-"$&-.0->A-\[\]-~]*|\.{0,2}[!-"$&--0->A-\[\]-~][!-"$&-.0->A-\[\]-~]*)/)*(?:\.{3,}[!-"$&-.0->A-\[\]-~]*|\.{0,2}[!-"$&--0->A-\[\]-~][!-"$&-.0->A-\[\]-~]*)?$
tier
enum<string>
required
Available options:
starter,
pro,
max

Response

Created

checkout_session_id
string<uuid>
required
checkout_session_token
string
required
Pattern: ^pcs_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
checkout_type
enum<string>
required
Available options:
subscription
status
enum<string>
required
Available options:
created,
completed,
expired,
failed
subscription_status
enum<string>
required
Available options:
active,
failed,
pending,
pending_webhook
target_tier
enum<string>
required
Available options:
starter,
pro,
max
url
string