Price List Object

The Price List object contains the price configuration for the various ticket types (often referred to as "person type".)


Note: The Price List Object is used in a variety of endpoints. As the fields may vary across various endpoints, be sure to check the endpoint examples for specifics.



FieldExample
id or priceListId
The ID of the price list.

Note: The field name varies based on the endpoint. Make sure to check the endpoint examples when working with this field.		Example:
54248a84e4b01cd228b007a2
name
The name of the price list
Example:
General Admission Pricing
description
The description of the price list
Example:
Standard admission prices
startTime (ISO8601 format)
The effective start date of the price list
Example:
2023-01-01T00:00:00-05:00
prices[ ]
A list of prices, with their corresponding person/ticket type, configured for a price list.
prices[x].displayOrder
The order that you want the person type to be displayed.
Example:
2
prices[x].price
The price for this person/ticket type.
Note: If a discount is applied, this price will account for the discount.
Example:
12.00
prices[x].discount
The value of the discount.
Example:
3.00
prices[x].discountedPrice
The discounted price for this person/ticket type, if applicable.
Note: This is the price after the applicable discount is applied.		Example:
12.00
prices[x].personType
The details of the person type (aka ticket type)
prices[x].personType.id
ID of the person type		Example:
58c1f29c79e71d020be4abd5
prices[x].personType.name
Name of the person type		Example:
Adult
prices[x].personType.description
Description of the person type.

Note: If updated at the event level, the update will only be for that specific event, not the original person type description.		Example:
Ages 18-64
prices[x].personType.type
The type of ticket		Example:
  • Individual
  • Combo
  • Membership
prices[x].personType.active
Boolean value representing whether or not this person type is active or deactivated.		Example:
  • true
  • false
prices[x].salesChannels[ ]
List of the sales channels and whether or not they are enabled for this person/ticket type.
prices[x].salesChannels[y].name
The display name of the sales channel.
Example:
  • Web
  • Point of Sale
  • Reseller
  • Kiosk

prices[x].salesChannels[y].channel
The sales channel value.
Example:
  • online
  • pointOfSale
  • reseller
  • kiosk
prices[x].salesChannels[y].enabled
Boolean representing if the sales channel is enabled for this person/ticket type
Example:
  • true
  • false