Checkout Sessions
Get checkout session
Gets details about a current Checkout Session.
GET
/
checkout
/
sessions
/
{checkout_session_id}
This endpoint requires the checkout-sessions.read
scope.
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
checkout_session_id
string
requiredThe unique ID for a Checkout Session.
Response
200 - application/json
type
enum<string>
checkout-session
.
Available options:
checkout-session
id
string
The ID of the Checkout Session.
expires_at
string
The date and time when the Checkout Session will expire. By default this will be set to 1 hour from the date of creation.
cart_items
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.
payment_method
object | null
Details about the payment method for card type only.
Was this page helpful?