Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Body

application/json
email
string | null
customer
string | null

Customer ID

discount_code
string | null
line_items
object[]

Response

Checkout session created

id
string
required
object
string
required
status
enum<string>
required
Available options:
open,
complete,
abandoned,
expired
created_at
string<date-time>
required
updated_at
string<date-time>
required
mode
string
required
currency
string | null
required
total
number
required
purchase_url
string
required
checkout_items
object[]
required
customer

ID by default, full object when expanded