Object Structures

Below is the explanation of all of the data fields shown on each type of content related to the order api. Please note that currency amounts are not floating point results ($5.00 USD = 500). This is to prevent any potential for floating point error occuring with billing information.

Order Summary

The fields of a user’s order summary:

• currencyApplied (boolean): if currency is applied.
• feesApplied (boolean): if fees are applied
• discountsApplied (boolean): if discounts are applied.
• creditsApplied (boolean): if credits have been applied.
• taxApplied (boolean): if taxes have been levied.
• subTotalApplied (boolean): if a subtotal has been applied.
• totalApplied (boolean): if a total has been applied.
• currencyCode (string): the currency code of the transaction
• fee (integer): An additional fee applied to the transaction.
• subTotalsByItemType (list): A collection of items within purchasable content.
  • [LIST]
    • track (object): The property of tracks on the cart.
      • price (integer): The total price of tracks on the cart.
      • count (integer): The number of tracks on the cart.
• itemSubTotal (integer): The subtotal for all items.
• subTotal (integer): The subtotal for items and fees.
• discount (integer): The discount amount applied.
• discountError (object): The error response if a discount was not successfully applied.
  • name (string): The error code related to the discountError.
  • message (string): An english textual description of the specific error.
• creditBalance (integer): The credits currently held by the authenticated user.
• creditAmountApplied (integer): The amount of credits applied to this order.
• taxes (object): A collection of various taxes levied against this transaction.
  • vat (integer): The value-added-tax applied to this transaction.
  • state (integer): The state sales tax applied to this transaction.
  • city (integer): The city sales tax applied to this transaction.
• taxTotal (integer): The sum total of all taxes applied to the transaction.
• total (integer): The total amount billed to the users billing info upon completion of the order.