Ticket Definition Object


Properties
idstringRead-onlyformat GUID

Ticket definition ID.


eventIdstringformat GUID

Event ID to which the ticket definition belongs.


revisionintegerRead-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.


createdDatestringRead-onlyformat date-time

Date and time when the ticket definition was created.


updatedDatestringRead-onlyformat date-time

Date and time when the ticket definition was updated.


namestringminLength 1maxLength 30

Ticket definition name.


descriptionstringmaxLength 500

Ticket definition description.


policyTextstringmaxLength 1000

Ticket definition policy.


hiddenboolean

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


limitedbooleanRead-only

Whether the ticket has a limited maximum quantity.


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.


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.


pricingMethodPricingMethod

Ticket pricing method.


feeTypestring

Whether fee is included in the ticket price or customer pays it additionally at checkout. Possible values:

  • FEE_INCLUDED: The fee is deducted from the ticket price for a seller. For example, if you're selling tickets for $10, then a service fee of $0.25 will be deducted from the price and you'll get $9.75.
  • FEE_ADDED_AT_CHECKOUT: The fee is shown in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer will see a service fee of $0.25 and will pay $10.25 in total.

salePeriodSalePeriod

Ticket sale period.


saleStatusstringRead-only

Ticket sale status. Possible values:

  • SALE_SCHEDULED: Tickets are not on sale yet.
  • SALE_STARTED: Tickets are on sale.
  • SALE_ENDED: Tickets are not on sale.

salesDetailsSalesDetails

Ticket sales information.
Note: This field is only returned when SALES_DETAILS fieldset is included in the request.


limitPerCheckoutintegerRead-onlyminimum 0maximum 50format int32

Number of tickets that can be purchased per checkout.
Note: If the actuaLimit or salesDetails.unsoldCount field value is smaller than limitPerCheckout, then it overrides this field.


extendedFieldsExtendedFields

Data extensions.

Did this help?