{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/checkoutpage-com/json-schema/checkoutpage-com-create-event-page-input-schema.json", "title": "CreateEventPageInput", "x-generated": "2026-11-03", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/checkoutpage-com-openapi.yml#/components/schemas/CreateEventPageInput", "properties": { "afterPaymentAction": { "description": "Behavior after checkout. `confirmation` shows the confirmation page. `checkout` redirects to `redirectPageId`. `redirect` sends the customer to `redirectUrl`. Defaults to `confirmation`.", "enum": [ "confirmation", "checkout", "redirect", null ], "type": [ "string", "null" ] }, "allowDynamicDescription": { "description": "Allow page description to be overridden via URL query parameters.", "type": [ "boolean", "null" ] }, "allowDynamicDiscountedFromPrice": { "description": "Allow the compare-at (discounted-from) price to be overridden via URL query parameters.", "type": [ "boolean", "null" ] }, "allowDynamicLabel": { "description": "Allow a price's label to be overridden via URL query parameters.", "type": [ "boolean", "null" ] }, "allowDynamicPreselectedPrice": { "description": "Allow a price to be preselected (and revealed if hidden) via URL query parameters.", "type": [ "boolean", "null" ] }, "allowDynamicPrice": { "description": "Allow price to be overridden via URL query parameters.", "type": [ "boolean", "null" ] }, "allowDynamicRedirectUrl": { "description": "Allow redirect URL to be overridden via URL query parameters.", "type": [ "boolean", "null" ] }, "allowDynamicTitle": { "description": "Allow page title to be overridden via URL query parameters.", "type": [ "boolean", "null" ] }, "checkoutAbandonment": { "$ref": "#/$defs/PageCheckoutAbandonmentSettingsInput" }, "closePopupOnClickOutside": { "description": "Whether a popup embed closes when clicking outside the container. Defaults to `false`.", "type": [ "boolean", "null" ] }, "confirmationCheckoutMessage": { "description": "Confirmation message. Accepts HTML or plaintext.", "type": [ "string", "null" ] }, "confirmationCheckoutTitle": { "description": "Confirmation title.", "type": [ "string", "null" ] }, "confirmationEmailMessage": { "description": "Custom confirmation email message. Accepts HTML or plain text.", "type": [ "string", "null" ] }, "confirmationEmailShowLogo": { "description": "Show store logo in confirmation email.", "type": [ "boolean", "null" ] }, "confirmationEmailShowStoreName": { "description": "Show store name in confirmation email.", "type": [ "boolean", "null" ] }, "confirmationEmailSubject": { "description": "Custom confirmation email subject.", "type": [ "string", "null" ] }, "customizeCheckoutConfirmation": { "description": "If set to true `confirmationCheckoutMessage` and `confirmationCheckoutTitle` will be displayed on the confirmation page. Defaults to `false`.", "type": [ "boolean", "null" ] }, "customizeEmailConfirmation": { "description": "Use a custom email confirmation template. If enabled, provide `confirmationEmailSubject` and `confirmationEmailMessage`.", "type": [ "boolean", "null" ] }, "description": { "description": "Page description shown to customers. Accepts HTML or plain text.", "type": [ "string", "null" ] }, "eventDetails": { "description": "Event-specific details like type, dates, location.", "properties": { "capacity": { "description": "Total event capacity. Omit for unlimited. `0` marks the event as sold out.", "minimum": 0, "type": [ "number", "null" ] }, "currency": { "description": "Currency code (lowercase). Defaults to `usd`.", "maxLength": 3, "minLength": 3, "type": [ "string", "null" ] }, "discounts": { "description": "Bulk discounts applied when a customer purchases a minimum number of tickets. To apply a discount to specific ticket types, assign a `key` to each relevant ticket type in `ticketGroups[].ticketTypes[].key` and reference those keys in `discounts[].ticketTypeIds[].key` within the same request.", "items": { "properties": { "amountOff": { "description": "Fixed discount in smallest currency unit (e.g. cents). Cannot be combined with `percentOff`.", "minimum": 0, "type": [ "number", "null" ] }, "maxQuantity": { "description": "Maximum quantity for this discount tier. Omit for no upper limit.", "minimum": 1, "type": [ "number", "null" ] }, "minQuantity": { "description": "Minimum quantity required for this discount to apply.", "minimum": 1, "type": "number" }, "percentOff": { "description": "Percentage discount. Cannot be combined with `amountOff`.", "maximum": 100, "minimum": 0, "type": [ "number", "null" ] }, "quantityCondition": { "description": "Whether the discount applies to the total order quantity or to specific ticket types. `total_quantity` fires based on the total number of tickets in the order. `ticket_type_quantity` fires only when specific ticket types reach the threshold — assign a `key` to each relevant ticket type in `ticketGroups[].ticketTypes[].key` and reference those keys in `ticketTypeIds[].key` within the same request. Keys are resolved to MongoDB ObjectIds at save time and do not appear in the response.", "enum": [ "total_quantity", "ticket_type_quantity" ], "type": "string" }, "ticketTypeIds": { "description": "Ticket types this discount applies to. Only used when `quantityCondition` is `ticket_type_quantity`. Use `{ key }` to reference a ticket type being created in the same request (the `key` must match `ticketGroups[].ticketTypes[].key`). Use `{ id }` to reference an existing ticket type by its ObjectId (useful when updating an event).", "items": { "anyOf": [ { "properties": { "key": { "type": "string" } }, "required": [ "key" ], "type": "object" }, { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" } ] }, "type": [ "array", "null" ] } }, "required": [ "quantityCondition", "minQuantity" ], "type": "object" }, "type": [ "array", "null" ] }, "endDate": { "description": "Event end date in ISO 8601 format. Must be on or after `startDate`.", "format": "date-time", "type": [ "string", "null" ] }, "fixedTaxRateIds": { "description": "List of Tax Rate IDs applied to this event. When tax.mode is \"fixed\" and this is omitted on create, the seller default rate is applied.", "items": { "allOf": [ { "$ref": "#/$defs/UniqueIdentifier" }, { "description": "Unique identifier. Must be in BSON ObjectId format." } ] }, "maxItems": 1, "type": [ "array", "null" ] }, "limitRegistrations": { "description": "Duplicate-registration prevention settings for this event.", "properties": { "enabled": { "description": "Prevent a guest who has already registered for or bought tickets to this event from registering again. Defaults to `false`.", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ] }, "location": { "description": "Event location address. Required for `in_person` and `hybrid` events.", "type": [ "string", "null" ] }, "mapsLink": { "description": "Google Maps or other map URL for the event location.", "type": [ "string", "null" ] }, "meetingLink": { "description": "Virtual meeting link (e.g., Zoom, Teams). Required for `virtual` and `hybrid` events.", "pattern": "^https?:\\/\\/.+", "type": [ "string", "null" ] }, "pdfTicketsEnabled": { "description": "Whether PDF tickets are generated and sent to attendees after purchase.", "type": [ "boolean", "null" ] }, "platform": { "description": "Virtual meeting platform. Applies to `virtual` and `hybrid` events.", "enum": [ "zoom", "google_meet", "microsoft_teams", "youtube", "hopin", "vimeo", "discord", "other", null ], "type": [ "string", "null" ] }, "startDate": { "description": "Event start date in ISO 8601 format.", "format": "date-time", "type": [ "string", "null" ] }, "taxBehavior": { "description": "Tax behaviour for this event. Defaults to the store setting when omitted.", "enum": [ "inclusive", "exclusive", "automatic", "", null ], "type": [ "string", "null" ] }, "taxCode": { "description": "Stripe tax code for this event.", "type": [ "string", "null" ] }, "timezone": { "description": "Event timezone.", "type": [ "string", "null" ] }, "type": { "description": "Type of event. Defaults to `in_person`.", "enum": [ "in_person", "virtual", "hybrid", null ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "fees": { "description": "Add extra fees at checkout, like processing or handling. [Learn more](https://checkoutpage.com/docs/articles/fees-and-surcharges)", "items": { "$ref": "#/$defs/PageFeeInput" }, "type": [ "array", "null" ] }, "fields": { "description": "Custom checkout fields to create. When provided, at least one field must be an `email` element with `type` `email` and `required` `true`. When omitted, the page gets Name and Email address fields, plus a required billing Address on checkout and event pages. Forms get Name and Email address only.", "items": { "$ref": "#/$defs/FieldInput" }, "type": [ "array", "null" ] }, "formLayout": { "description": "How to arrange the page's form, top to bottom. Reference a field by `fieldKey`: the `key` you gave it in `fields` in this request. Each item is one of: `field` (`fieldKey`), `heading` (`id`, `text`, `level` `heading` or `subheading`), `divider` (`id`), `discount-code` (no other properties) and `group` (`id`, optional `name`, `columns` 1 to 4, and `items` holding fields, headings, dividers or the discount code; groups never nest). You choose the `id` of each heading, divider and group: 1 to 64 characters, unique in the layout. Fields the layout leaves out are added after it, in their current order. `formLayout` on the page decides the form's order. Each field's `order` is its position among the page's fields and follows the layout: saving a layout (in the dashboard or through the API) rewrites every field's `order`. On a page that has never saved a layout, setting `order` moves the field; once a layout is saved, move fields with `formLayout` instead. A `discount-code` item only places the discount code box: the box shows while `showCouponCodeField` is on, and the item does not switch it on. Forms have no discount code, so a form layout must leave it out. More item types may be added later. When reading a layout, skip any item type you do not recognise. When updating, send every item back as you received it, including those.", "items": { "$ref": "#/$defs/FormLayoutItemInput" }, "maxItems": 500, "type": "array" }, "funnelSteps": { "description": "Ordered funnel configuration for this page. Supports intermediate checkout steps, one-click upsells, and confirmation behavior.", "items": { "$ref": "#/$defs/CreateFunnelStepInput" }, "type": [ "array", "null" ] }, "googleIndex": { "description": "Allow Google to index this page for search results. Defaults to `true`.", "type": [ "boolean", "null" ] }, "hostedLayoutType": { "description": "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 page into two halves, the content on one and the checkout form on the other. `null` resets it to the default, `double`.", "enum": [ "center", "double", "split", null ], "type": [ "string", "null" ] }, "imageIds": { "description": "Array of images for the page gallery. All referenced file IDs must exist and belong to your account.", "items": { "allOf": [ { "$ref": "#/$defs/UniqueIdentifier" }, { "description": "Unique identifier. Must be in BSON ObjectId format." } ] }, "type": [ "array", "null" ] }, "invoiceSettings": { "$ref": "#/$defs/PageInvoiceSettingsInput" }, "locale": { "description": "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`.", "enum": [ "ar-SA", "bn-BD", "bn-IN", "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AU", "en-CA", "en-GB", "en-IE", "en-IN", "en-NZ", "en-US", "en-ZA", "es-AR", "es-CL", "es-CO", "es-ES", "es-MX", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "he-IL", "hi-IN", "hu-HU", "id-ID", "it-CH", "it-IT", "jp-JP", "ko-KR", "nl-BE", "nl-NL", "no-NO", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "ru-RU", "sk-SK", "sv-SE", "ta-IN", "ta-LK", "th-TH", "tr-TR", "zh-CN", "zh-HK", "zh-TW", null ], "type": [ "string", "null" ] }, "name": { "description": "Internal page name used in your dashboard and API responses.", "maxLength": 500, "minLength": 1, "type": "string" }, "notifyEmail": { "description": "Email addresses to send notifications to. Supports comma separated emails.", "type": [ "string", "null" ] }, "paymentMethods": { "$ref": "#/$defs/PagePaymentMethodsInput" }, "paymentOptions": { "description": "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_on_delivery`. Combine `full` (pay now), `manual` (invoice or cash on delivery), and `partial` (deposit) types to offer flexible payment flows. At least one option should have `enabled: true`. [Learn more](https://checkoutpage.com/docs/articles/manual-payments-pay-in-full-by-invoice-pay-deposit-or-cash-on-delivery)", "items": { "$ref": "#/$defs/PagePaymentOptionInput" }, "type": [ "array", "null" ] }, "redirect": { "description": "If enabled, redirects the customer to the specified URL before the page loads.", "properties": { "enabled": { "type": [ "boolean", "null" ] }, "url": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "redirectPageId": { "description": "ID of the page (checkout, event or form) to redirect to after payment. Applies when `afterPaymentAction` is `checkout`.", "pattern": "^[0-9a-fA-F]{24}$", "type": [ "string", "null" ] }, "redirectUrl": { "description": "URL to redirect to after payment. Applies if `afterPaymentAction` is `redirect`.", "type": [ "string", "null" ] }, "redirectUrlInsideEmbed": { "description": "If the page is embedded, redirect the customer within the embed instead of redirecting the main browser window. Defaults to `false`.", "type": [ "boolean", "null" ] }, "redirectUrlPath": { "description": "Additional path parameters appended to the `redirectUrl`. Applies if `afterPaymentAction` is `redirect` and `redirectUrl` is set. [Learn more](https://checkoutpage.com/docs/articles/add-field-and-variant-data-to-redirect-url)", "items": { "properties": { "fieldKey": { "type": [ "string", "null" ] }, "identifier": { "type": [ "string", "null" ] }, "key": { "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "redirectUrlQuery": { "description": "Query parameters for the `redirectUrl`. Applies if `afterPaymentAction` is `redirect` and `redirectUrl` is set. [Learn more](https://checkoutpage.com/docs/articles/add-field-and-variant-data-to-redirect-url)", "items": { "properties": { "fieldKey": { "type": [ "string", "null" ] }, "identifier": { "type": [ "string", "null" ] }, "key": { "type": [ "string", "null" ] }, "parameter": { "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "savePaymentMethod": { "description": "Whether to save the customer's payment method after payment. Defaults to false when omitted. Subscription payment methods are always saved.", "type": [ "boolean", "null" ] }, "sendEmailConfirmation": { "description": "Send an email confirmation to the customer. Defaults to `true`.", "type": [ "boolean", "null" ] }, "sendPaymentNotification": { "description": "Send payment/submission notification emails to the store owner.", "type": [ "boolean", "null" ] }, "showConfirmationAddToCalendar": { "description": "Show the add to calendar button on payment confirmation page. Defaults to `true`.", "type": [ "boolean", "null" ] }, "showConfirmationEventAddOns": { "description": "Show the purchased add-ons on payment confirmation page. Defaults to `true`.", "type": [ "boolean", "null" ] }, "showConfirmationEventDateTime": { "description": "Show the event date on payment confirmation page. Defaults to `true`.", "type": [ "boolean", "null" ] }, "showConfirmationEventLocation": { "description": "Show the event location on payment confirmation page. Defaults to `true`.", "type": [ "boolean", "null" ] }, "showConfirmationEventMeetingLink": { "description": "Show the event virtual meeting link on payment confirmation page. Defaults to `true`.", "type": [ "boolean", "null" ] }, "showConfirmationEventName": { "description": "Show the event name on payment confirmation page. Defaults to `true`.", "type": [ "boolean", "null" ] }, "showConfirmationEventTickets": { "description": "Show the purchased tickets on payment confirmation page. Defaults to `true`.", "type": [ "boolean", "null" ] }, "showCouponCodeField": { "description": "Whether to show the coupon code input.", "type": [ "boolean", "null" ] }, "showCouponCodeFieldType": { "description": "Display type for coupon code field.", "enum": [ "link", "field" ], "type": "string" }, "slug": { "description": "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`.", "maxLength": 200, "minLength": 1, "type": [ "string", "null" ] }, "status": { "description": "Publication status of the page.", "enum": [ "published", "draft", "archived", null ], "type": [ "string", "null" ] }, "tax": { "description": "Tax configuration for this page.", "properties": { "enabled": { "description": "If enabled mode must be one of `fixed` or `stripe`. If disabled mode must be `none`.", "type": "boolean" }, "mode": { "description": "Use mode `none` to not collect any tax. Use mode `fixed` for a fixed tax rate at checkout (configure the rate ID on `product.fixedTaxRateIds` for checkout pages or `eventDetails.fixedTaxRateIds` for event pages). Use mode `stripe` to enable Stripe tax, make sure Stripe tax is enabled globally in your Checkout Page account and configured in Stripe. You must also configure address fields in your page for the Stripe Tax calculation to be completed successfully. If omitted when `enabled` is `true`, defaults to `stripe`.", "enum": [ "none", "fixed", "stripe" ], "type": "string" } }, "required": [ "enabled" ], "type": [ "object", "null" ] }, "testmode": { "description": "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 `livemode: false`. Turn it off to take real payments again.", "type": "boolean" }, "themeId": { "allOf": [ { "$ref": "#/$defs/UniqueIdentifier" }, { "description": "The theme the page uses: one of your themes or a built-in one (see List themes). `themeOverrides` apply on top. Leave it out to use your store's default theme." } ] }, "themeOverrides": { "$ref": "#/$defs/ThemeOverridesInput" }, "ticketGroups": { "description": "Ticket groups with their ticket types. If not provided, a default ticket group with a free ticket will be created.", "items": { "$ref": "#/$defs/TicketGroupInput" }, "type": [ "array", "null" ] }, "title": { "description": "Public title shown to customers on the page. Defaults to `name` when omitted.", "maxLength": 500, "type": "string" }, "trackingCodes": { "description": "Custom tracking scripts to include on the page. Supports HTML `