A tier defines the different types of ticket that can be purchased.
Changing the coupon, variant, option and date parameters may affect the response values for each tier.
Field | Description |
|---|---|
id | The unique id for the tier |
serial | An auto-incrementing integer that will uniquely identify this tier within the product. |
weight | Defines the order in which variants should be displayed. |
name | The title or name of the tier. |
description | A short paragraph explaining who this tier is intended for or what it includes. |
size | The number of people this tier covers. Typically this will be 1 but could be more for Family Tickets for example. |
weight | Defines the order in which the tiers should be displayed. |
currency | The product currency, which is brought through for convenience. |
price | The price of this tier for an individual ticket given the supplied parameters. |
available | Whether this tier is available to purchase by default or not. |
minimum | The minimum number of tickets of this type that can be purchased in a single booking. |
limit | What is the maximum number of tickets that can be purchased with this tier for an individual booking. |
size | The maximum number of people permitted for a given option with this tier. Basically, this means: |
threshold | An integer value indicating how many spaces for an option need to be sold before this tier becomes available. |
count | The maximum number of times this ticket is allowed to be scanned. A |
notice | An ISO8601 time period indicating how long before an option is due to start before this tier becomes unavailable for purchase. |
period | An ISO8601 time period indicating how long before an option is due to start before this tier becomes available for purchase. |
interval | An ISO8601 time period indicating how long must be left between scanning this type of ticket. |
duration | How long this ticket would be valid for from the start of the option it is purchased for. |