Retrieve a price

Quickstart API Reference

Retrieve a price

Request

Retrieves the price with the given ID.

Security

bearerAuth

Path

price_idstringrequired

Price Id

Query

fields[]Array of strings

Allows you to specify which fields are returned in the response.

Accepted values

`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `tiers`, `charge_model`, `charge_type`, `name`, `description`, `revenue_recognition_rule`, `stacked_discount`, `recognized_revenue_accounting_code`, `deferred_revenue_accounting_code`, `accounting_code`, `recurring`, `start_event`, `tax_code`, `tax_inclusive`, `taxable`, `unit_of_measure`, `quantity`, `min_quantity`, `max_quantity`, `price_base_interval`, `discount_level`, `overage`, `plan_id`, `tiers_mode`, `apply_discount_to`, `prepayment`, `drawdown`, `discount_amounts`, `unit_amounts`, `discount_percent`, `amounts`, `price_change_percentage`, `price_change_option`, `price_increase_option`

Example:fields[]=id,created_time

price.fields[]Array of stringsdeprecated

Allows you to specify which fields are returned in the response.

Accepted values

Example:price.fields[]=id,created_time

expand[]Array of strings

Allows you to expand responses by including related object information in a single call. See the Expand responses section of the Quickstart API Tutorials for detailed instructions.

filter[]Array of strings

A case-sensitive filter on the list. See the Filter lists section of the Quickstart API Tutorial for detailed instructions.
Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the filter[] parameter on the related objects such as filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63

page_sizeinteger, [ 1 .. 99 ]

The maximum number of results to return in a single page. If the specified page_size is less than 1 or greater than 99, Zuora will return a 400 error.

zuora-track-idstring

A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), or quote (').

asyncboolean

Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.

Default:false

zuora-entity-idsstring

An entity ID. If you have Multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity or you do not have Multi-entity enabled, you do not need to set this header.

idempotency-keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see Idempotent Requests.

accept-encodingstring

Include a accept-encoding: gzip header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see Request and Response Compression.

content-encodingstring

Include a content-encoding: gzip header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see Request and Response Compression.

zuora-org-idsstring

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

cURL

curl -i -X GET \
  'https://rest.test.zuora.com/v2/prices/{price_id}?fields%5B%5D=id%2Ccreated_time&price.fields%5B%5D=id%2Ccreated_time&expand%5B%5D=string&filter%5B%5D=string&page_size=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'accept-encoding: string' \
  -H 'async: false' \
  -H 'content-encoding: string' \
  -H 'idempotency-key: string' \
  -H 'zuora-entity-ids: string' \
  -H 'zuora-org-ids: string' \
  -H 'zuora-track-id: string'

Responses

Default Response

Headers

ratelimit-limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

ratelimit-remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

ratelimit-resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

zuora-request-idstring

Zuora’s internal identifier for this request.

zuora-track-idstring

A user-supplied identifier for this request. If you supply a zuora-track-id as a request header, Zuora returns the zuora-track-id as a response header.

Bodyapplication/json

idstringread-only

Unique identifier for the object.

updated_by_idstringread-only

Unique identifier of the Zuora user who last updated the object

updated_timestring, (date-time)read-only

The date and time when the object was last updated in ISO 8601 UTC format.

created_by_idstringread-only

Unique identifier of the Zuora user who created the object

created_timestring, (date-time)read-only

The date and time when the object was created in ISO 8601 UTC format.

custom_fieldsobject(CustomFields)

Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format.

custom_objectsobjectread-only

The custom objects associated with a Zuora standard object.

namestring

The name of the price.

descriptionstring

An arbitrary string attached to the object. Often useful for displaying to users.

recognized_revenue_accounting_codestring, <= 100 characters

An active accounting code in your Zuora chart of accounts.

deferred_revenue_accounting_codestring, <= 100 characters

An active accounting code in your Zuora chart of accounts.

recurringobject(Recurring)

The recurring components of a price such as interval and usage.

start_eventstring

Specifies when to start billing your customer.

Enum:"contract_effective""service_activation""customer_acceptance""specific_date"

apply_discount_toArray of strings

Any combination of one_time, recurring and plan.

Items Enum:"one_time""recurring""usage"

tiersArray of objects(Tier)

Price information for different tiers. When creating or updating tiered prices, you must specify this field and the tiers_mode field.

tax_codestring

A tax code identifier. If a tax_code of a price is not provided when you create or update a price, Zuora will treat the charged amount as non-taxable. If this code is provide, Zuora considers that this price is taxable and the charged amount will be handled accordingly.

tax_inclusiveboolean

If this field is set to true, it indicates that amounts are inclusive of tax.

unit_of_measurestring

A configured unit of measure. This field is required for per-unit prices.

quantitynumber

Quantity of the product to which your customers subscribe.

min_quantitynumber

The minimum quantity for a price. Specify this field and the max_quantity field to create a range of quantities allowed in a price.

max_quantitynumber

The maximum quantity for a price. Specify this field and the min_quantity field to create a range of quantities allowed in a price.

discount_levelstring

Specifies at what level a discount should be applied: account, subscription, or plan.

Enum:"account""subscription""plan"

revenue_recognition_rulestring

Determines when to recognize the revenue for this charge. You can choose to recognize upon invoicing or daily over time.

stacked_discountboolean

This field is only applicable for the Percentage Discount price. This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:

true: This is a stacked discount, which should be calculated by stacking with other discounts.
false: This is not a stacked discount, which should be calculated in sequence with other discounts.

For more information, see Stacked discounts

amountsobject

Example:

{
  "USD": 10,
  "GBP": 15
}

unit_amountsobject

Example:

{
  "USD": 10,
  "GBP": 15
}

discount_amountsobject

Example:

{
  "USD": 10,
  "GBP": 15
}

discount_percentnumber

Discount percent. Specify this field if you offer a percentage-based discount.

price_base_intervalstring

Specifies the base interval of a price. If not provided, this field defaults to billing_period.

Enum:"month""billing_period""week"

revenueobject(Revenue)

Accounting configuration if you have Zuora Revenue enabled.

accounting_codestring

An active accounting code defined in Finance Settings > Configure Accounting Codes in your Zuora tenant.

prepaymentobject(Prepayment)

drawdownobject(Drawdown)

taxableboolean

price_change_percentagenumber

The percentage to increase or decrease the price of a termed subscription's renewal.

price_change_optionstring

Applies an automatic price change when a termed subscription is renewed.

Default:"none"

Enum:"latest_catalog_pricing""percentage""none"

price_increase_optionboolean

Indicates whether to apply an automatic price change when a termed subscription is renewed.

plan_idstring

Specify the ID of a plan to which this price is associated.

plan_numberstring

Specify the number of a plan to which this price is associated. This field is required if plan_id is not supplied

charge_typestring

The type of charge. Can be one_time,recurring, or usage.

charge_modelstring

The charge model of the price, which determines how users are charged. Common charge models include flat fee, per-unit, volume, and tiered prices.

tiers_modestringdeprecated

Specifies the mode for tiered prices.

Enum:"graduated""volume""high_watermark_volume""high_watermark_graduated""graduated_with_overage"

overageobject(Overage)deprecated

An object defining how overage charges are calculated.

activebooleandeprecated

Whether the price can be used for new purchases.

Response

{
  "id": "8ad08ccf8437067601843a7af4e64rq3",
  "updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
  "updated_time": "2022-08-02T05:56:54-07:00",
  "created_by_id": "2c92c0946a6dffc0016a7faab604299b",
  "created_time": "2022-08-02T05:56:54-07:00",
  "custom_fields": {
    "field__c": "custom field value"
  },
  "name": "Recurring Perunit",
  "description": "from Postman",
  "recurring": {
    "on": "subscription_item_start_day",
    "usage": false,
    "interval": "month",
    "interval_count": 1,
    "alignment_behavior": "none",
    "timing": "in_advance",
    "duration_interval": "subscription_term",
    "duration_interval_count": 1
  },
  "start_event": "contract_effective",
  "tiers_mode": "graduated",
  "tiers": [
    { … },
    { … }
  ],
  "tax_code": "Avalara",
  "tax_inclusive": false,
  "unit_of_measure": "Each",
  "quantity": 15,
  "price_base_interval": "billing_period",
  "plan_id": "8ad0877b813e5774018143f39e98059b",
  "charge_type": "recurring",
  "charge_model": "tiered"
}

Retrieve a price

Request

Path

Query

Headers

Responses

Was this helpful?