Skip to main content
GET
/
checkout_configurations
/
{id}
Retrieve a checkout configuration
curl --request GET \
  --url https://{defaultHost}/checkout_configurations/{id}
{
  "id": "<string>",
  "created_at": 123,
  "updated_at": 123,
  "company_id": "<string>",
  "currency": "<string>",
  "plan": {},
  "affiliate_code": "<string>",
  "metadata": {},
  "redirect_url": "<string>",
  "purchase_url": "<string>",
  "three_ds_level": "<string>",
  "payment_method_configuration": {}
}

Headers

​
Api-Version-Date
string<date>

Pins the request to a dated API version. When omitted, the request uses the original (2025-01-01) request/response shapes, so existing unversioned callers are never broken. Generated SDKs always send the latest version they were built against. An unrecognized value is rejected with a 400. The schemas documented here always describe the latest version.

Example:

"2026-06-09"

Path Parameters

​
id
string
required

The ID of the checkout configuration.

Response

checkout configuration found (unauthenticated)

​
id
string
required

The unique identifier of the checkout configuration.

​
created_at
integer
required

Unix timestamp when the checkout configuration was created.

​
updated_at
integer
required

Unix timestamp when the checkout configuration was last updated.

​
company_id
string
required

The ID of the company that owns this checkout configuration.

​
mode
enum<string>
required

The checkout mode.

Available options:
payment,
setup
​
currency
string | null

The currency for this checkout configuration.

​
plan
object

The plan associated with this checkout configuration.

​
affiliate_code
string | null

The affiliate code applied at checkout.

​
metadata
object

Arbitrary key-value metadata. Only returned when caller has checkout_configuration:basic:read scope.

​
redirect_url
string | null

The URL to redirect after checkout.

​
purchase_url
string | null

The URL for the checkout page.

​
three_ds_level
string | null

The 3D Secure enforcement level.

​
payment_method_configuration
object

Payment method configuration.