Docs

Create Checkout Page

Creates a checkout page in Checkout Page.

POST

Body

Arguments
stringrequired

Internal page name used in your dashboard and API responses.

string

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.

string

Initial publication status. Defaults to "published" if not provided.

object

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.

array of object

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.

string

Locale code.

boolean

If set to true confirmationCheckoutMessage and confirmationCheckoutTitle will be displayed on the confirmation page. Defaults to false.

boolean

Allow page title to be overridden via URL query parameters.

boolean

Allow page description to be overridden via URL query parameters.

boolean

Whether a popup embed closes when clicking outside the container. Defaults to false.

object

If enabled, redirects the customer to the specified URL before the page loads.

string

Behavior after checkout. confirmation shows the confirmation page. checkout redirects to redirectPageId. redirect sends the customer to redirectUrl. Defaults to confirmation.

Field selectionChoose which fields should be included in the response. Learn more
string

Comma-separated response fields to include.

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is
One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.
Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.
Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.