POST
/
checkout-sessions

Authorizations

Authorization
string
headerrequired

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

Body

application/json
successUrl
string

The URL to redirect the user to upon successful payment.

cancelUrl
string

The URL to redirect the user to upon cancellation of payment.

customerEmail
string

The email of the customer.

customerPhoneNumber
string | null

The phone number of the customer.

customerFirstName
string

The first name of the customer.

customerLastName
string

The last name of the customer.

customerId
string

The unique ID of the customer.

expiresAt
string

The expiration date of the checkout session.

lineItems
array
required

List of items in the checkout session.

metadata
object

Additional metadata for the checkout session.

amountTotal
number
required

The total amount of the checkout session.

locale
enum<string>
default: fr_FR

The locale of the checkout session. default: fr_FR

Available options:
en_US,
fr_FR
clientReferenceId
string

Unique string of your choice to reconcile with your internal system

paymentClientReferenceId
string

Unique string of your choice to reconcile a payment with your internal system

paymentGroupShareId
string | null

The shared identifier of the payment group.

Response

201 - application/json
successUrl
string

The URL to redirect the user to upon successful payment.

cancelUrl
string

The URL to redirect the user to upon cancellation of payment.

customerEmail
string

The email of the customer.

customerPhoneNumber
string | null

The phone number of the customer.

customerFirstName
string

The first name of the customer.

customerLastName
string

The last name of the customer.

customerId
string

The unique ID of the customer.

expiresAt
string

The expiration date of the checkout session.

lineItems
array
required

List of items in the checkout session.

metadata
object

Additional metadata for the checkout session.

amountTotal
number
required

The total amount of the checkout session.

locale
enum<string>
default: fr_FR

The locale of the checkout session. default: fr_FR

Available options:
en_US,
fr_FR
clientReferenceId
string

Unique string of your choice to reconcile with your internal system

paymentClientReferenceId
string

Unique string of your choice to reconcile a payment with your internal system

paymentGroupShareId
string | null

The shared identifier of the payment group.