Create Checkout Page
Creates a checkout page in Checkout Page.
Query
Comma-separated response fields to include.
Body
Internal page name used in your dashboard and API responses.
Page URL slug. For events and forms the slug defaults to the slugified version of your `title`. For checkouts the slug defaults to the slugified version of your `productData.title`.
Initial publication status. Defaults to "published" if not provided.
Product configuration for checkout pages. Use this object to define pricing mode, subscription/payment plan behavior, inventory, variants, and conditional variant visibility. Common setup patterns: - Standard one-time checkout: set `price.amount`, `price.currency`, and keep `price.pricingType` as `single`. - Variant-driven pricing: set `price.pricingType` to `multiple`, then define `variants` and per-option `additionalChargeAmount`. - Subscriptions (recurring): configure `price.recurring`. - Payment plans (fixed installments): configure `price.paymentPlan` with `planIterations`. Important rules: - You cannot set both `price.recurring` and `price.paymentPlan`. - `price.payWhatYouWant` cannot be used with subscriptions or payment plans. - `trialPeriodDays` and `startDate` are mutually exclusive within `recurring` and `paymentPlan`. - For conditional variant logic (`showHideLogic`) or `preselect`, set a `key` on variants/options to enable cross-references. Keys are not persisted.
Custom checkout fields to create. If one of your fields must be an `email` element and `required` must be true. Defaults to a name and email field if none are set.
Locale code.
If set to true `confirmationCheckoutMessage` and `confirmationCheckoutTitle` will be displayed on the confirmation page. Defaults to `false`.
Allow page title to be overridden via URL query parameters.
Allow page description to be overridden via URL query parameters.
Whether a popup embed closes when clicking outside the container. Defaults to `false`.
If enabled, redirects the customer to the specified URL before the page loads.
Behavior after checkout. `confirmation` shows the confirmation page. `checkout` redirects to `redirectPageId`. `redirect` sends the customer to `redirectUrl`. Defaults to `confirmation`.