Create Checkout

Creates a new custom checkout as a published clone of the account's default checkout: payment methods — including icon/name overrides and required-field condition sets — are copied from the default; general settings and styling inherit the account baseline until the checkout's first publish. The new checkout is born with status PUBLISHED and is never the account's default. The identifier is exposed as the top-level id.

post/checkouts

Headers

X-Idempotency-Keystring

Optional client key, up to 64 characters. Best-effort — re-sending the same key is not guaranteed to be de-duplicated.

Request body

namestring required

Checkout name. Required, non-blank, and unique per account (a duplicate name is rejected with 409).

descriptionstring

Optional free-text description.

Response

The created checkout. Born PUBLISHED as a clone of the account's default; is_default is always false on creation. Use id as the checkout_code in the other Checkout Builder endpoints.

idstring

Checkout identifier (UUID).

namestring

Checkout name.

descriptionstring

Checkout description.

is_defaultboolean

Whether this checkout is the account's default.

is_activeboolean

Whether the checkout is active (serving traffic).

created_atstring date-time

Creation timestamp (ISO-8601).

Changes

No recorded changes to this endpoint across all 1 revision of this API.