API reference
Tickets
Create ticketed events and retrieve the tiers available for sale.
Ticket endpoints let a business create an event with one or more pricing tiers, then use each tier as an invoice item during checkout.
Create a ticketed event
POST /Ticket/createBusinessTicket creates the event and its ticket tiers in one authenticated request.
Event fields
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Event name. |
tiers | array | Yes | One or more ticket tier objects. |
description | string | No | Customer-facing event description. |
event_date | string | No | Event date and time. |
venue | string | No | Event location. |
cover_image | string | No | File name or URL for the event cover image. |
slug | string | No | Unique event slug. |
Tier fields
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Tier name, such as General or VIP. |
price | number | Yes | Non-negative price for one ticket in this tier. |
quantity | number | Yes | Non-negative number of tickets available. |
description | string | No | What the tier includes. |
picture | string | No | Image for the tier. |
daily_booking_limit | number | No | Maximum tickets that may be booked per day. |
slug | string | No | Unique tier slug. Xara generates one when omitted. |
Each created tier has its own catalog item identifier. Use that identifier as product_id when requesting an invoice.
The older
Ticket/requestInvoice endpoint is deprecated. Sell a ticket tier through Payment/requestInvoice instead.Retrieve ticket tiers
GET /Ticket/getTiers?event_slug=EVENT_SLUG returns the tiers for an event slug.
Use the returned tier data to show availability and pricing before creating the customer's invoice.