Skip to main content
POST
Create Stripe Checkout Session

Authorizations

Authorization
string
header
required

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

Path Parameters

environment
enum<string>
required

Payment provider environment.

Available options:
test,
live

Body

application/json

Metadata keys starting with insforge_ are reserved and rejected.

mode
enum<string>
required
Available options:
payment,
subscription
lineItems
object[]
required
Required array length: 1 - 100 elements
successUrl
string<uri>
required
cancelUrl
string<uri>
required
subject
object
customerEmail
string<email> | null
metadata
object
idempotencyKey
string
Required string length: 1 - 200

Response

Checkout Session created

checkoutSession
object
required