Create Variable-Amount Checkout Session

Creates a new checkout session in Stripe.

POST

Body

Arguments

stringrequired

Checkout mode: payment, setup, or subscription.

array of object

Line items for this checkout session.

number

Quantity for the line item.

string

URL to redirect customers after successful checkout in hosted mode.

string

URL to redirect customers if they cancel checkout.

string

Existing customer ID to prefill checkout.

stringrequired

Three-letter lowercase currency code for the inline Stripe Price, for example usd.

numberrequired

Positive integer amount in the currency's smallest unit (cents for USD).

stringrequired

Customer-visible product or payment-request name.

Uncommon arguments

string

URL to return customers to your site for embedded/custom UI modes.

string

Email used to prefill customer data when no customer ID is provided.

array of string

Allowed payment method types for this session.

string

Checkout UI mode: hosted, embedded, or custom.

string

Reference ID to reconcile session with your internal systems.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.