Skip to main content
GET
checkout_sid_json_get

Headers

Viewer-Country
string<iso3166-alpha2>

The country of the viewer, used to determine the correct currency and payment methods.

Path Parameters

session_id
string<checkout-id>
required

The session ID

Response

checkout session

If the session is locked, and metadata about the lock.

url
object
required
order
object
required
configuration
object
required
id
string

An ID that uniquely identifies the resource

created_at
string<date-time>

The date-time when the resource was created

customer
object
expires_at
string<date-time>
checkboxes
object[]

Configuration for checkboxes that should be part of the checkout

Maximum array length: 2
express
object

Present only for Express Checkout sessions.

An Express Checkout session is a session where the end user will submit a shipping address and then select a shipping option before the before a payment method is selected and the payment is initiated.

Endpoints used in the Express Checkout flow.

  1. Set shipping address
  2. Set shipping option
metadata
object

metadata about the session

operations
object[]

Set of operation available, which operation available will depend on the current state of the session.

Example:
pay_lock
object
version
string

String that represents the state of the session.

Example:

"22596363b3de40b06f981fb85d82312e8c0ed511"

data_visibility
enum<string>
Available options:
full,
masked
Last modified on July 31, 2026