Checkout Page · Schema
UpdateEventPageInput
CompanyPaymentsCheckoutStripeNo-CodeE-CommerceSubscriptionEvent Ticketing
Properties
| Name | Type | Description |
|---|---|---|
| afterPaymentAction | stringnull | Behavior after checkout. `confirmation` shows the confirmation page. `checkout` redirects to `redirectPageId`. `redirect` sends the customer to `redirectUrl`. Defaults to `confirmation`. |
| allowDynamicDescription | booleannull | Allow page description to be overridden via URL query parameters. |
| allowDynamicDiscountedFromPrice | booleannull | Allow the compare-at (discounted-from) price to be overridden via URL query parameters. |
| allowDynamicLabel | booleannull | Allow a price's label to be overridden via URL query parameters. |
| allowDynamicPreselectedPrice | booleannull | Allow a price to be preselected (and revealed if hidden) via URL query parameters. |
| allowDynamicPrice | booleannull | Allow price to be overridden via URL query parameters. |
| allowDynamicRedirectUrl | booleannull | Allow redirect URL to be overridden via URL query parameters. |
| allowDynamicTitle | booleannull | Allow page title to be overridden via URL query parameters. |
| checkoutAbandonment | object | |
| closePopupOnClickOutside | booleannull | Whether a popup embed closes when clicking outside the container. Defaults to `false`. |
| confirmationCheckoutMessage | stringnull | Confirmation message. Accepts HTML or plaintext. |
| confirmationCheckoutTitle | stringnull | Confirmation title. |
| confirmationEmailMessage | stringnull | Custom confirmation email message. Accepts HTML or plain text. |
| confirmationEmailShowLogo | booleannull | Show store logo in confirmation email. |
| confirmationEmailShowStoreName | booleannull | Show store name in confirmation email. |
| confirmationEmailSubject | stringnull | Custom confirmation email subject. |
| customizeCheckoutConfirmation | booleannull | If set to true `confirmationCheckoutMessage` and `confirmationCheckoutTitle` will be displayed on the confirmation page. Defaults to `false`. |
| customizeEmailConfirmation | booleannull | Use a custom email confirmation template. If enabled, provide `confirmationEmailSubject` and `confirmationEmailMessage`. |
| description | stringnull | Page description shown to customers. Accepts HTML or plain text. |
| eventDetails | objectnull | Event-specific details like type, dates, location. Ticket-specific discounts (`discounts[].ticketTypeIds`) must reference existing ticket types by `{ id }` — update cannot create new ticket types to k |
| fees | arraynull | Add extra fees at checkout, like processing or handling. [Learn more](https://checkoutpage.com/docs/articles/fees-and-surcharges) |
| formLayout | array | Replaces how the page's form is arranged, top to bottom. Reference fields by `fieldId`, the ids in the page's `fields`; an id that is not on the page is rejected. Send the whole layout: read the curre |
| funnelSteps | arraynull | Ordered funnel configuration for this page. Supports intermediate checkout steps, one-click upsells, and confirmation behavior. Field references inside upsell/confirmation redirect steps resolve by `f |
| googleIndex | booleannull | Allow Google to index this page for search results. Defaults to `true`. |
| hostedLayoutType | stringnull | Layout of the hosted page. `center` shows the content and the checkout form in one centered card on a page background, `double` shows them side by side in two columns, and `split` divides the whole pa |
| imageIds | arraynull | Array of images for the page gallery. All referenced file IDs must exist and belong to your account. |
| invoiceSettings | object | |
| locale | stringnull | Locale used to format prices and numbers on the page, for example `en-US` shows $1,234.56 and `de-DE` shows 1.234,56 $. Defaults to `en-US`. |
| name | string | Internal page name used in your dashboard and API responses. |
| notifyEmail | stringnull | Email addresses to send notifications to. Supports comma separated emails. |
| paymentMethods | object | |
| paymentOptions | arraynull | Payment options presented to customers at checkout. Only these enabled combinations are supported: `full`, `invoice`, `partial`, `cash_on_delivery`, `full + invoice`, `full + partial`, or `full + cash |
| redirect | objectnull | If enabled, redirects the customer to the specified URL before the page loads. |
| redirectPageId | stringnull | ID of the page (checkout, event or form) to redirect to after payment. Applies when `afterPaymentAction` is `checkout`. |
| redirectUrl | stringnull | URL to redirect to after payment. Applies if `afterPaymentAction` is `redirect`. |
| redirectUrlInsideEmbed | booleannull | If the page is embedded, redirect the customer within the embed instead of redirecting the main browser window. Defaults to `false`. |
| redirectUrlPath | arraynull | Additional path parameters appended to the `redirectUrl`. Applies if `afterPaymentAction` is `redirect` and `redirectUrl` is set. To reference a field value, use `fieldId` (the persisted field ID, fro |
| redirectUrlQuery | arraynull | Query parameters for the `redirectUrl`. Applies if `afterPaymentAction` is `redirect` and `redirectUrl` is set. To reference a field value, use `fieldId` instead of the create-time `fieldKey`. [Learn |
| savePaymentMethod | booleannull | Whether to save the customer's payment method after payment. Defaults to false when omitted. Subscription payment methods are always saved. |
| sendEmailConfirmation | booleannull | Send an email confirmation to the customer. Defaults to `true`. |
| sendPaymentNotification | booleannull | Send payment/submission notification emails to the store owner. |
| showConfirmationAddToCalendar | booleannull | Show the add to calendar button on payment confirmation page. Defaults to `true`. |
| showConfirmationEventAddOns | booleannull | Show the purchased add-ons on payment confirmation page. Defaults to `true`. |
| showConfirmationEventDateTime | booleannull | Show the event date on payment confirmation page. Defaults to `true`. |
| showConfirmationEventLocation | booleannull | Show the event location on payment confirmation page. Defaults to `true`. |
| showConfirmationEventMeetingLink | booleannull | Show the event virtual meeting link on payment confirmation page. Defaults to `true`. |
| showConfirmationEventName | booleannull | Show the event name on payment confirmation page. Defaults to `true`. |
| showConfirmationEventTickets | booleannull | Show the purchased tickets on payment confirmation page. Defaults to `true`. |
| showCouponCodeField | booleannull | Whether to show the coupon code input. |
| showCouponCodeFieldType | string | Display type for coupon code field. |
| slug | stringnull | 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`. |
| status | stringnull | Publication status of the page. |
| tax | objectnull | Tax configuration for this page. |
| testmode | boolean | Puts the page in test mode. While it is on, every purchase on this page is a test purchase: no money is taken, the buyer still receives everything the page delivers, and the records are created with ` |
| themeId | object | |
| themeOverrides | object | |
| title | string | Public title shown to customers on the page. Defaults to `name` when omitted. |
| trackingCodes | stringnull | Custom tracking scripts to include on the page. Supports HTML `
Work with this as dataEvery JSON Schema here is available over the APIs.io API and to AI agents over MCP. MCP serverOne button, every client — Claude, Cursor, VS Code and the rest.
Tools for schemas4 MCP tools reach this
Call it yourselfcurl for this page
This JSON Schema
All schemas
Calls without Get an API keyFree tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms. A second provider on the same verified email joins the account you already have. |