Retrieve a checkout session

{
  "id": "cs_5pW1nR7kTe",
  "object": "string",
  "customer": "string",
  "mode": "top_up",
  "status": "open",
  "url": "string",
  "expires_at": "2024-01-15T09:30:00Z",
  "payment_provider": "stripe",
  "livemode": true,
  "created_at": "2024-01-15T09:30:00Z",
  "success_url": "string",
  "cancel_url": "string",
  "credits": "string",
  "plan": "string",
  "amount_total": {
    "amount": 1500,
    "currency": "usd"
  },
  "result": {
    "credit_grant": "string",
    "subscription": "string",
    "payment_method_saved": true
  },
  "provider_reference": "string",
  "payment": "string",
  "metadata": {},
  "completed_at": "2024-01-15T09:30:00Z"
}

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Path parameters

checkout_session_idstringRequired

The checkout session ID (cs_...).

Response

The checkout session.

idstring

object"checkout_session"

customerstring

modeenum

top_up buys credits, subscription starts a plan, payment_method saves a card for postpaid invoices.

Allowed values:

statusenum

Allowed values:

urlstringformat: "uri"

The hosted page to send the customer to.

expires_atdatetime

payment_providerstring

The name of the provider hosting the page, chosen by routing unless the request named one.

livemodeboolean

created_atdatetime

success_urlstringOptionalformat: "uri"

cancel_urlstringOptionalformat: "uri"

creditsstringOptional

planstringOptional

amount_totalobjectOptional

An amount of money in the currency's minor unit.

resultobjectOptional

What completion produced.

provider_referencestringOptional

The provider's ID for the payment, for reconciliation.

paymentstringOptional

The provider-neutral payment record (pay_...), once the customer has paid.

metadatamap from strings to stringsOptional

Up to 50 keys of your own, with keys up to 40 characters and values up to 500 characters.

completed_atdatetimeOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error