Skip to content

Retrieve tier details

Request

Retrieve full details of the requested tier

Security
SessionKey(Required scopes: customeradministrator)
Path
hostintegerrequired

Unique identifier of the requested host

tierintegerrequired

Unique identifier of the requested tier

curl -i -X GET \
  'https://docs.ticketingevents.com/_mock/openapi/hosts/{host}/tiers/{tier}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Full details of the requested tier were successfully retrieved.

Bodyapplication/json
selfstring

URI of the event resource

namestring

Name of the tier

descriptionstring

Informative or promotional text containing details of the tier.

pricenumber

Cost of purchasing tickets in this tier.

capacityinteger

Total number of tickets available for purchase in this tier.

available_fromstring, (date-time)

The date and time after which tickets in this tier can be purchased.

available_tostring, (date-time)

The date and time until which tickets in this tier can be purchased.

eventsArray of objects, non-empty

The group of events this tier applies to. When this tier is purchased tickets are issued to each event listed.

artworkstring, (uri)

URI of the tier's associated artwork or image

unit_sizeinteger

The number of tickets that will be issued to the user upon purchase of this tier.

purchase_limitinteger

The maximum number of tickets that can be purchased from this tier in a single order

purchase_notestring

A note sent to customers upon issuance of tickets wihin this tier, providing addiional event details, disclaimers or privileged content.

complimentaryboolean

Whether or not tickets issued under this tier are for complimentary distrbution by the host (true) or available for purchase (false)

transferableboolean

Whether or not tickets issued under this tier can be transferred after issuance (true) or must be user by the customer they were issued to (false)

upgradesArray of objects(response-14)

List of 'promotion tiers' to which tickets issued under this tier can be upgraded.

gross_salesnumber

Total gross from confirmed sales of tickets within this tier

units_soldnumber

Total number of units of this tier sold

Response
{
  "self": "/tiers/19381758318131",
  "name": "Backstage Pass",
  "description": "Gain exclusive access to meet the Supes and hang out after the show.",
  "price": 299.9,
  "capacity": 20,
  "available_from": "2025-05-02T21:00:00Z",
  "available_to": "2025-07-01T00:00:00Z",
  "events": [
    { … },
    { … }
  ],
  "artwork": "http://localhost/tier/artwork/19381758318131.jpeg",
  "unit_size": 1,
  "purchase_limit": 2,
  "purchase_note": "Your all set. Remember to give the codeword HOMELANDER when coming backstage.",
  "complimentary": false,
  "transferable": false,
  "upgrades": [
    { … }
  ],
  "gross_sales": 100000,
  "tickets_sold": 200
}