Skip to main content
POST
Create Checkout Session

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

test_mode
boolean
default:true

Use test mode credentials

Body

application/json

Request to create a Stripe checkout session.

price_id
string
required
Minimum string length: 1
success_url
string
required
Minimum string length: 1
cancel_url
string
required
Minimum string length: 1
mode
string
default:subscription
Pattern: ^(subscription|payment)$
quantity
integer
default:1
Required range: x >= 1
metadata
Metadata · object | null
allow_existing_subscription
boolean
default:false

If true, allows checkout even if user has active subscription

Response

Successful Response

Stripe checkout session response.

session_id
string
required
checkout_url
string
required