Skip to main content
GET
Get Checkout Session

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Path Parameters

id
string
required
Example:

"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

Query Parameters

expand_customer
boolean | null

If true, expands the customer object in the response.

Example:

false

expand_payment_intent
boolean | null

If true, expands the payment intent object in the response.

Example:

false

expand_subscription
boolean | null

If true, expands the subscription object in the response.

Example:

false

expand
string
default:""

Comma-separated list of related objects to expand in the response.

Example:

""

Response

An envelope wrapping a single checkout session object.

An envelope wrapping a single checkout session object.

checkout_session
object
required

The checkout session payload.

Example: