Developer Docs

Retrieve a checkout session

Returns the checkout session, including its status, associated paymentId (present once the buyer has submitted a payment method) and custom metadata.

Prefer subscribing to checkout_session.* merchant webhooks to be notified when the session completes and the paymentId is available. This endpoint is also available for on-demand retrieval.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the checkout session

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json