Get checkout session
Gets details about a current Checkout Session.
This endpoint requires the checkout-sessions.read
scope.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The unique ID for a Checkout Session.
"8724fd24-5489-4a5d-90fd-0604df7d3b83"
Response
A short-lived checkout session.
checkout-session
.
checkout-session
"checkout-session"
The ID of the Checkout Session.
"8d3fe99b-1422-42e6-bbb3-932d95ae5f79"
The date and time when the Checkout Session will expire. By default this will be set to 1 hour from the date of creation.
"2022-01-01T00:00:00+00:00"
An array of cart items that represents the line items of a transaction.
A cart item that represents a single cart line item for a transaction. Note that some optional properties are required for certain payment service providers. If no value is set for these properties, we will use their default value.
If the total due to be paid for the item is required by the payment service provider, generally referred to as the "total amount", the formula below will usually be used to calculate this amount:
(unit_amount * quantity) - discount_amount + tax_amount
It's highly recommended that the total amount to pay for all items should match the transaction's amount to reduce the risk of the transaction being declined by the payment service provider.
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.
{ "key": "value" }
Details about the payment method for card type only.
Was this page helpful?