Pricing information

ON THIS PAGE          HideON THIS PAGE          Show Item price, use code and pricing message Example: Pricing for an item included in your plan Example: Pricing for an item available for an extra charge

Item price, use code and pricing message

If pricing=true is specified in the request, the API returns the following in the meta property adjacent to the item to which the pricing applies:

• The content item price:

  • pricing.amount. The charge for the content item.

  • pricing.currency. The currency of the charge; in one of the following:

    • Actual currency; for example, US dollars.

    • Meter ticks, which is a form of virtual currency for content items included in your plan. For example, if your plan allows for a certain number of downloads per billing cycle, the charge for the content item in meter ticks indicates how many download units are deducted from your meter once the content item is downloaded.

    • Credits, which is a form of virtual currency for content items included in your credit-style plan with a credit limit (metered credits plan). The charge per content item in credits indicates how many credits are deducted from your meter once the content item is downloaded.

  • pricing.formatted. The formatted price that may be used for display; for example, on a website.

  • pricing.tier. (For plans such as Choice) The name of the Choice tier used by your plan's meter to calculate the payment amount.

• Use code and pricing message. A use code in the pricing.apusecode property and a pricing message in the pricing.message property:

 

Pricing Scenario	Use Code	Plan Type	API Pricing Message
Included in Your Plan	810	Choice	Included in your Choice plan at the Tier indicated.
	801	Other plans	Included in your plan.
Not Included in Your Plan (Extra Charge)	851	All plans	Not included in your plan. Available for an extra charge.
Not Included in Your Plan (Contact Licensing)	860	All plans	Not included in your plan. To learn more about license rights, please contact your licensing representative.

 

Example: Pricing for an item included in your plan

"pricing": {
   "amount": 1,
   "currency": "Meter Ticks",
   "formatted": "1 Meter Tick",
   "apusecode": 801,
   "message": "Included in your plan."}

Example: Pricing for an item available for an extra charge

"pricing": {
   "amount": 42,
   "currency": "USD",
   "formatted": "$42.00",
   "apusecode": 851,
   "tier": "Tier 1 - PhotoChoice",
   "message": "Not included in your plan. Available for an extra charge."}