v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Fetch Checkout Configuration

Returns the full custom checkout for the given code — configuration and styling composed in a single response. The checkout identifier is exposed as the top-level id.

get/checkouts/{checkout_code}

Path parameters

checkout_codestring required

The unique identifier of the checkout to retrieve (UUID, 36 chars). Non-UUID values are rejected with 400 before processing.

Response

The custom checkout, with configuration and styling composed.

idstring

Checkout UUID (the checkout_code).

namestring

Checkout name.

descriptionstring

Checkout description.

statusstring

Checkout status.

is_defaultboolean

Whether this is the account's default checkout.

created_atstring

Creation timestamp (ISO 8601).

updated_atstring

Last updated timestamp (ISO 8601).

stylingobject

Checkout styling and SDK settings: styles, settings, flags, external_fonts, payment_link_styles.

Example response

{
  "id": "8005ca91-dcfb-4428-b9f6-49c6e3446474",
  "name": "Main Checkout",
  "status": "PUBLISHED",
  "is_default": true
}