Create event

Creates an event with ticket groups and ticket types.

POST/v1/events/

Authorization

api_key_auth

AuthorizationBearer <token>

API key authentication. Use "Bearer YOUR_API_KEY" format.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Internal page name used in your dashboard and API responses.

Length1 <= length <= 500

slug?|

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.

Length1 <= length <= 200

locale?|

Locale code.

Value in

"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"

customizeCheckoutConfirmation?|

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

status?|

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

Value in"published" | "draft" | "archived"

fields?array<>|

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.

allowDynamicTitle?|

Allow page title to be overridden via URL query parameters.

allowDynamicDescription?|

Allow page description to be overridden via URL query parameters.

closePopupOnClickOutside?|

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

redirect?|

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

afterPaymentAction?|

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

Value in"confirmation" | "checkout" | "redirect"

confirmationCheckoutTitle?|

Confirmation title.

confirmationCheckoutMessage?|

Confirmation message. Accepts HTML or plaintext.

redirectUrl?|

URL to redirect to after payment. Applies if afterPaymentAction is redirect.

redirectUrlPath?array<>|

Additional path parameters appended to the redirectUrl. Applies if afterPaymentAction is redirect and redirectUrl is set. Learn more

redirectUrlQuery?array<>|

Query parameters for the redirectUrl. Applies if afterPaymentAction is redirect and redirectUrl is set. Learn more

redirectUrlInsideEmbed?|

If the page is embedded, redirect the customer within the embed instead of redirecting the main browser window. Defaults to false.

redirectPageId?|

ID of the page (checkout, event or form) to redirect to after payment. Applies when afterPaymentAction is checkout.

sendPaymentNotification?|

Send payment/submission notification emails to the store owner.

notifyEmail?|

Email addresses to send notifications to. Supports comma separated emails.

sendEmailConfirmation?|

Send an email confirmation to the customer.

customizeEmailConfirmation?|

Use a custom email confirmation template. If enabled, provide confirmationEmailSubject and confirmationEmailMessage.

confirmationEmailSubject?|

Custom confirmation email subject.

confirmationEmailMessage?|

Custom confirmation email message. Accepts HTML or plain text.

confirmationEmailShowLogo?|

Show store logo in confirmation email.

confirmationEmailShowStoreName?|

Show store name in confirmation email.

googleIndex?|

Allow Google to index this page for search results. Defaults to true.

trackingCodes?|

Custom tracking scripts to include on the page. Supports HTML <script> tags.

invoiceSettings?|

Invoice configuration settings.

funnelSteps?array<||>|

Ordered funnel configuration for this page. Supports intermediate checkout steps, one-click upsells, and confirmation behavior.

savePaymentMethod?|

Whether to save the customer's payment method after payment. Defaults to false when omitted. Subscription payment methods are always saved.

paymentMethods?|

Payment method configuration for Stripe.

checkoutAbandonment?|

Cart abandonment configuration.

paymentOptions?array<>|

Payment options presented to customers at checkout. 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

fees?array<>|

Add extra fees at checkout, like processing or handling. Learn more

showCouponCodeField?|

Whether to show the coupon code input.

showCouponCodeFieldType?string

Display type for coupon code field.

Value in"link" | "field"

allowDynamicPrice?|

Allow price to be overridden via URL query parameters.

allowDynamicDiscountedFromPrice?|

Allow the compare-at (discounted-from) price to be overridden via URL query parameters.

allowDynamicRedirectUrl?|

Allow redirect URL to be overridden via URL query parameters.

title?string

Public title shown to customers on the page.

Lengthlength <= 500

description?|

Page description shown to customers. Accepts HTML or plain text.

tax?|

Enable automatic tax calculation via Stripe Tax. This requires your store to have Stripe Tax enabled.

eventDetails?|

Event-specific details like type, dates, location.

ticketGroups?array<>|

Ticket groups with their ticket types. If not provided, a default ticket group with a free ticket will be created.

showConfirmationEventName?|

Show the event name on payment confirmation page. Defaults to true.

showConfirmationEventDateTime?|

Show the event date on payment confirmation page. Defaults to true.

showConfirmationEventLocation?|

Show the event location on payment confirmation page. Defaults to true.

showConfirmationEventMeetingLink?|

Show the event virtual meeting link on payment confirmation page. Defaults to true.

showConfirmationEventTickets?|

Show the purchased tickets on payment confirmation page. Defaults to true.

imageIds?array<>|

Array of images for the page gallery. All referenced file IDs must exist and belong to your account.

Response Body

`application/json`

curl -X POST "https://api.checkoutpage.com/v1/events/" \  -H "Content-Type: application/json" \  -d '{    "name": "Premium Course Checkout"  }'

{
  "data": {
    "id": "65f4a1c2e4a9f3d2b1c0a9e8",
    "sellerId": "65f4a1c2e4a9f3d2b1c0a9e8",
    "name": "string",
    "slug": "string",
    "status": "published",
    "images": [
      {
        "fileId": "string",
        "url": "https://bucket-name.s3.amazonaws.com/image.jpg",
        "name": "product-image.jpg",
        "size": 245678,
        "width": 1920,
        "height": 1080
      }
    ],
    "locale": "string",
    "fields": [
      {
        "id": "507f1f77bcf86cd799439011",
        "label": "Company Name",
        "placeholder": "Enter your company name",
        "element": "text",
        "type": "company-name",
        "options": [
          {
            "id": "65f4a1c2e4a9f3d2b1c0a9e8",
            "label": "Label",
            "value": "value"
          }
        ],
        "required": true,
        "order": 0,
        "reference": "custom_field_1",
        "hidden": false,
        "defaultValue": {
          "enabled": true,
          "value": "string"
        },
        "showHideLogic": {
          "enabled": true,
          "comparison": "is",
          "value": "string",
          "element": {
            "elementTitle": "string",
            "elementType": "field",
            "elementId": "string"
          }
        },
        "minValue": {
          "enabled": true,
          "value": "string"
        },
        "maxValue": {
          "enabled": true,
          "value": "string"
        },
        "limitAllowedCountries": {
          "enabled": true,
          "countries": [
            "string"
          ]
        },
        "showSelectedDialCode": true,
        "createdAt": "2024-01-15T10:30:00.000Z",
        "updatedAt": "2024-01-15T10:30:00.000Z"
      }
    ],
    "url": "string",
    "customizeCheckoutConfirmation": true,
    "closePopupOnClickOutside": true,
    "funnelSteps": [
      {
        "type": "upsell",
        "order": 1,
        "enabled": true,
        "config": {
          "action": "checkout",
          "pageId": "507f1f77bcf86cd799439012"
        }
      },
      {
        "type": "confirmation",
        "order": 2,
        "enabled": true,
        "config": {
          "action": "confirmation",
          "customizeCheckoutConfirmation": true,
          "confirmationCheckoutTitle": "Order confirmed",
          "confirmationCheckoutMessage": "<p>Thanks for your purchase.</p>"
        }
      }
    ],
    "visitCount": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "redirect": {
      "enabled": true,
      "url": "string"
    },
    "afterPaymentAction": "confirmation",
    "redirectPageId": "65f4a1c2e4a9f3d2b1c0a9e8",
    "redirectUrl": "string",
    "redirectUrlPath": [
      {
        "key": "string",
        "identifier": "string"
      }
    ],
    "redirectUrlQuery": [
      {
        "parameter": "string",
        "key": "string",
        "identifier": "string"
      }
    ],
    "redirectUrlInsideEmbed": true,
    "confirmationCheckoutTitle": "string",
    "confirmationCheckoutMessage": "string",
    "sendPaymentNotification": true,
    "notifyEmail": "string",
    "sendEmailConfirmation": true,
    "customizeEmailConfirmation": true,
    "confirmationEmailSubject": "string",
    "confirmationEmailMessage": "string",
    "confirmationEmailShowLogo": true,
    "confirmationEmailShowStoreName": true,
    "googleIndex": true,
    "trackingCodes": "string",
    "type": "event",
    "title": "string",
    "description": "string",
    "descriptionHtml": "string",
    "eventDetails": {
      "status": "active",
      "currency": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "type": "in_person",
      "timezone": "string",
      "location": "string",
      "mapsLink": "string",
      "meetingLink": "string",
      "platform": "zoom",
      "capacity": 0,
      "taxBehavior": "inclusive",
      "taxCode": "string",
      "pdfTicketsEnabled": true,
      "discounts": [
        {
          "quantityCondition": "total_quantity",
          "ticketTypeIds": [
            "65f4a1c2e4a9f3d2b1c0a9e8"
          ],
          "minQuantity": 0,
          "maxQuantity": 0,
          "percentOff": 0,
          "amountOff": 0
        }
      ]
    },
    "showConfirmationEventName": true,
    "showConfirmationEventDateTime": true,
    "showConfirmationEventLocation": true,
    "showConfirmationEventMeetingLink": true,
    "showConfirmationEventTickets": true,
    "ticketGroups": [
      {
        "id": "string",
        "name": "string",
        "description": "string",
        "status": "enabled",
        "availabilityStatus": "available",
        "reference": "string",
        "layout": {
          "type": "list",
          "columns": 0,
          "collapse": true,
          "alignment": "default",
          "spacing": "comfortable",
          "imageSize": "small",
          "showTicketGroupName": true,
          "showTicketTypeName": true,
          "showTicketPrice": true,
          "showTicketTotalPrice": true,
          "showTicketSaleDateTimezone": true
        },
        "ticketSelectionType": "single",
        "preselect": {
          "enabled": true,
          "ticketTypeId": "65f4a1c2e4a9f3d2b1c0a9e8",
          "quantity": 0
        },
        "capacity": 0,
        "hidden": true,
        "hideWhenSoldOut": true,
        "hideWhenNotOnSale": true,
        "hideWhenScheduled": true,
        "hideWhenUnavailable": true,
        "bulkDiscounts": [
          {
            "minQuantity": 0,
            "maxQuantity": 0,
            "percentOff": 0
          }
        ],
        "availabilityBehavior": "always_available",
        "saleStartOn": "string",
        "saleEndOn": "string",
        "triggerTicketGroupId": "65f4a1c2e4a9f3d2b1c0a9e8",
        "ticketTypes": [
          {
            "id": "string",
            "ticketGroupId": "65f4a1c2e4a9f3d2b1c0a9e8",
            "name": "string",
            "description": "string",
            "reference": "string",
            "hidden": true,
            "hideWhenSoldOut": true,
            "hideWhenNotOnSale": true,
            "hideWhenScheduled": true,
            "hideWhenUnavailable": true,
            "pricing": "paid",
            "price": 0,
            "discountedFromPrice": 0,
            "capacity": 0,
            "quantitySold": 0,
            "minQuantity": 0,
            "maxQuantity": 0,
            "showAvailableQuantity": true,
            "showTicketSaleDates": true,
            "image": {
              "fileId": "string",
              "url": "https://bucket-name.s3.amazonaws.com/image.jpg",
              "name": "product-image.jpg",
              "size": 245678,
              "width": 1920,
              "height": 1080
            },
            "availabilityBehavior": "always_available",
            "availabilityStatus": "available",
            "saleStartOn": "string",
            "saleEndOn": "string",
            "triggerTicketTypeId": "65f4a1c2e4a9f3d2b1c0a9e8",
            "status": "enabled"
          }
        ]
      }
    ],
    "tax": {
      "enabled": true
    },
    "savePaymentMethod": true,
    "paymentMethods": {
      "stripe": {
        "card": {
          "enabled": true
        },
        "agpay": {
          "enabled": true,
          "mode": "default"
        },
        "multiple": {
          "enabled": false
        }
      }
    },
    "paymentOptions": [
      {
        "type": "manual",
        "enabled": true,
        "name": "Pay in full",
        "description": "string",
        "instructions": "Bank details will be sent via email after checkout.",
        "partialAmount": 0,
        "showPaymentButton": true,
        "manualType": "invoice"
      }
    ],
    "fees": [
      {
        "name": "Processing fee",
        "amount": 50,
        "percentage": 0,
        "multiplyByQuantity": true,
        "multiplyByTickets": true,
        "applyToSpecificPaymentMethods": false,
        "paymentMethods": [
          "acss_debit"
        ]
      }
    ],
    "allowDynamicPrice": true,
    "allowDynamicDiscountedFromPrice": true,
    "allowDynamicTitle": true,
    "allowDynamicDescription": true,
    "allowDynamicRedirectUrl": true,
    "showCouponCodeField": true,
    "showCouponCodeFieldType": "link",
    "invoiceSettings": {
      "bankDetails": "Account: 12345678, Sort code: 00-00-00",
      "additionalInformation": {
        "enabled": true,
        "title": "Payment terms",
        "message": "Payment is due within 30 days of invoice date."
      },
      "dueDays": {
        "enabled": true,
        "days": 30
      }
    },
    "checkoutAbandonment": {
      "disableEmails": true,
      "showStoreLogo": true,
      "showStoreName": true,
      "emailReminders": {
        "property1": {
          "customizeEmail": true,
          "subject": "Complete your purchase",
          "body": "<p>You left something behind!</p>",
          "buttonText": "Complete order"
        },
        "property2": {
          "customizeEmail": true,
          "subject": "Complete your purchase",
          "body": "<p>You left something behind!</p>",
          "buttonText": "Complete order"
        }
      }
    }
  }
}

{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}

{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}

{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}

{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}

{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`