Skip Main Navigation
Page Content

Cross Event Discounts

Cross Event Discount

Cross Event Discount is an object representing a discount that a ticket buyer can use. The term “Cross” refers to the fact that this kind of discount can be applied to many events at the same time.

There are four types of discounts:

  • Public Discounts, that any user can see on the listing or checkout pages. Only applied to single event discounts.
  • Coded Discounts, that requires the user to provide a secret code in order to enable them.
  • Access Codes, that allow the user to access hidden tickets, but cannot provide a discount.
  • Hold Discounts, that allow the user to unlock or apply discounts to seats defined as hold.

Fields

  • code string: The name of the discount (on public discounts) or the code that user should provide in order to activate it (on access codes or coded discounts).
  • type string: One of access, coded, public or hold, indicating the type of discount.
  • end_date local datetime: The code will be usable until this date.
  • end_date_relative integer: The code will be usable until this amount of seconds before the event start.
  • amount_off decimal: A fixed amount that is applied as a discount. It doesn’t have a currency, it depends on the event’s currency from 0.01 to 99999.99. Only two decimals are allowed. Will be null for an access code.
  • percent_off decimal: A percentage discount that will be applied on the ticket display price during the checkout, from 1.00 to 100.00. Only two decimals are allowed. Will be null for an access code.
  • quantity_available integer: The number of times this discount can be used, when 0 means “unlimited”.
  • quantity_sold integer: The number of times the discount was used. This is a display only field, it cannot be written.
  • start_date local datetime: The code will be usable since this date.
  • start_date_relative integer: The code will be usable since this amount of seconds before the event start.
  • ticket_class_ids list: On single event discounts, the list of IDs of tickets that are part of event_id for wich this discounts applies to. If empty, means “all the tickets of the event”.
  • event_id string: On single event discounts, the id of the Event this discount applies to. This is empty for cross event discounts.
  • ticket_group_id string: On cross event discounts, it is the id of the ticket group for which the discount applies to.
  • hold_ids list: List of IDs of holds this discount can unlock.

Expansions

  • event from event_id event: The Event for this discount (only for single event discounts).
  • ticket_group from ticket_group_id ticket_group: The Ticket Group for this discount (only for cross event discounts).