Ticket Definition Object

A Ticket Definition is a reusable configuration for an event that specifies ticket settings such as pricing, service fee handling, availability limits, and sale period.

You can use Ticket Definitions to define and manage ticket types, control inventory and sale windows, and automate updates via the API.

Read more about Ticket Definitions.

Properties
actualLimitintegerRead-onlyformat int32

The maximum number of tickets that can be sold for the event after adding a seating map to the event. If no seating map is defined, this property is the same as initialLimit.

createdDatestringRead-onlyformat date-time

Date and time the ticket definition was created.

descriptionstringmaxLength 500

Ticket definition description.

eventDetailsEventDetailsRead-only

Information about the even the ticket is for.
Note: This field is only returned when EVENT_DETAILS is specified in field in the request.

eventIdstringformat GUIDimmutable

Event ID to which the ticket definition belongs.

extendedFieldsExtendedFields

Data extensions.

feeTypestring

Type of ticket service fee to collect.

hiddenboolean

Whether this ticket definition is hidden from site visitors and can't be purchased.

idstringRead-onlyformat GUID

Ticket definition ID.

initialLimitintegerformat int32

The maximum number of tickets that can be sold for the event when first defining the event. If a seating map is defined after you created a ticket definition, this property is ignored and actualLimit is used instead.

limitedbooleanRead-only

Whether the ticket has a limited maximum quantity.

limitPerCheckoutintegerRead-onlyminimum 0maximum 50format int32

Number of tickets that can be purchased per checkout.

Note: If the actualLimit or salesDetails.unsoldCount field value is smaller than limitPerCheckout, then it overrides this field.

namestringminLength 1maxLength 30

Ticket definition name.

policyTextstringmaxLength 1000

Ticket definition policy.

pricingMethodPricingMethod

Ticket pricing method.

revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing revision must be used when updating a ticket definition.

salePeriodSalePeriod

Ticket sale period.

salesDetailsSalesDetailsRead-only

Ticket sales information.

Note: This field is only returned when SALES_DETAILS is specified in field in the request.

saleStatusstringRead-only

Ticket sale status.

seatingDetailsSeatingDetailsRead-only

Seating information including available seats and areas for this ticket definition.
Note: This field is only returned when SEATING_DETAILS is specified in field in the request, and when the event has a seating plan.

updatedDatestringRead-onlyformat date-time

Date and time the ticket definition was updated.

Did this help?