Skip to content

Create a checkout session for a price. Returns a cs_ id + a one-time public URL carrying the raw token. Idempotency-Key required on retries.

POST
/v1/checkout/sessions
Idempotency-Key
string

Required on every mutating /v1/* endpoint (Phase 1 fixture relaxes to optional)

object
priceId
required
string
>= 1 characters
successUrl
required
string format: uri
cancelUrl
required
string format: uri
linkId
string
>= 1 characters
metadata
object
key
additional properties
object
success
required
boolean
data
required
object
id
required
string
status
required
string
environment
required
string
Allowed values: sandbox live
priceId
required
string
linkId
required
string
nullable
successUrl
required
string
cancelUrl
required
string
expiresAt
required
string format: date-time
publicUrl
required
string
publicToken
required
string
createdAt
required
string format: date-time
meta
required
object
requestId
required
string