Skip to main content
POST
New checkout session
This endpoint requires the checkout-sessions.write scope.

Authorizations

Authorization
string
header
required

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

Body

application/json

A request to create a checkout session.

expires_in
integer
default:3600

Defines when the checkout session will expire (in seconds). Defaults to an hour (3600 seconds).

Required range: 3600 <= x <= 86400
Example:

7200

cart_items
Cart Item · object[] | null

An array of cart items that represents the line items of a transaction.

metadata
object | null

Any additional information about the transaction that you would like to store as key-value pairs. This data is passed to payment service providers that support it.

Example:
airline
Airline Addendum · object | null

The airline addendum data which describes the airline booking associated with this transaction.

buyer
Buyer · object | null

Provide buyer details for the transaction. No buyer resource will be created on Gr4vy when used.

Response

Returns the new Checkout Session.

A short-lived checkout session.

type
enum<string>

checkout-session.

Available options:
checkout-session
Example:

"checkout-session"

id
string<uuid>

The ID of the Checkout Session.

Example:

"8d3fe99b-1422-42e6-bbb3-932d95ae5f79"

expires_at
string<date-time>

The date and time when the Checkout Session will expire. By default this will be set to 1 hour from the date of creation.

Example:

"2022-01-01T00:00:00+00:00"

cart_items
Cart Item · object[] | null

An array of cart items that represents the line items of a transaction.

metadata
object | null

Any additional information about the transaction that you would like to store as key-value pairs. This data is passed to payment service providers that support it.

Example:
airline
Airline Addendum · object | null

Contains information about an airline travel, if applicable.

payment_method
object | null

Details about the payment method for card type only.