REST Pub API: Pricing

Pricing objects represent price indications for an event and are used by API resources that need to return fixed pricing information.

An individual price is composed of a descriptive label as well as the amount, currency and applicable tax.

This article outlines the technical specification of pricing (structure and fields).

Collection structure

Pricing information is returned as a structured array containing one or more price entries. The order of the array is not specific, and clients should always sort and display pricing in an order appropriate for their use.

[
   {
         "CurrencyCode":"AUD",
         "AmountTaxExclusive":296.65,
         "AmountTaxInclusive":326.32,
         "FormattedAmountTaxExclusive":"$296.65",
         "FormattedAmountTaxInclusive":"$326.32",
         "TaxRate":{
            "ShortName":"GST",
            "Name":"GST (10.0%)",
            "RatePercent":10
         }
   },
   {
         "CurrencyCode":"AUD",
         "AmountTaxExclusive":349,
         "AmountTaxInclusive":383.9,
         "FormattedAmountTaxExclusive":"$349.00",
         "FormattedAmountTaxInclusive":"$383.90",
         "TaxRate":{
            "ShortName":"GST",
            "Name":"GST (10.0%)",
            "RatePercent":10
         }
   },
   {
         "CurrencyCode":"AUD",
         "AmountTaxExclusive":303.55,
         "AmountTaxInclusive":333.9,
         "FormattedAmountTaxExclusive":"$303.55",
         "FormattedAmountTaxInclusive":"$333.90",
         "TaxRate":{
            "ShortName":"GST",
            "Name":"GST (10.0%)",
            "RatePercent":10
         }
   }
]

Fields

Field	Description
CurrencyCode	A string value indicating the currency of the price.
AmountTaxExclusive	Decimal value with the tax-exclusive amount of the price
AmountTaxInclusive	Decimal value with the tax-inclusive amount of the price. If tax is not applicable, or cannot be calculated, this value will be the same as the exclusive amount.
FormattedAmountTaxExclusive	String value with a display-formatted representation of the tax-exclusive amount.
FormattedAmountTaxInclusive	String value with a display-formatted representation of the tax-inclusive amount.
TaxRate	A structure representing associated tax information for the price. This field is relevant only if tax is applicable. If tax does not apply, this field is omitted.