Sign in
Object Queries

Retrieve a product rate plan charge tier

Retrieve the details of a specific Product Rate Plan Charge Tier object.

get/object-query/product-rate-plan-charge-tiers/{key}

Path parameters

keystring required

ID of a product rate plan charge tier.

Query parameters

pageSizeinteger

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

cursorstring

A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with next_page=W3sib3JkZXJ=, your subsequent call can include cursor=W3sib3JkZXJ= in order to fetch the next page of the list.

sort[]string[]

A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. accountnumber.ASC) or descending (e.g. accountnumber.DESC). You cannot sort on properties in arrays. If the array-type properties are specified for the sort[] parameter, they are ignored.

expand[]string[]

Allows you to expand responses by including related object information in a single call.

filter[]string[]

A case-insensitive filter on the list.

fields[]string[]

A case-insensitive query parameter that allows you to specify which fields are returned in the response.

includeNullFieldsboolean

Specifies whether to include fields with the null value in the response.

  • If set to true, all fields will be returned in the response, including those with the null value.
  • If set to false, only fields with non-null values will be returned.

Headers

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.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora 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 ("), and quote (').

Zuora-Entity-Idsstring

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

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

idstring

The unique identifier of the product rate plan charge tier.

createdByIdstring

The unique identifier of the user who created the product rate plan charge tier.

createdDatestring date-time

The time that the product rate plan charge tier gets created in the system, in the YYYY-MM-DD HH:MM:SS format.

updatedByIdstring

The unique identifier of the user who last updated the product rate plan charge tier.

updatedDatestring date-time

The date and time when the product rate plan charge tier was last updated.

activeboolean

Indicates whether the product rate plan charge tier is active.

currencystring

The valid code corresponding to the currency for the tier's price.

discountAmountnumber double

The specific amount for a fixed discount. This field is applicable for charges based on the Discount-Fixed Amount charge model.

discountPercentagenumber double

The percentage of discount for a percentage discount. This field is applicable for charges based on the Discount-Percentage charge model.

endingUnitnumber

The end number of a range of units for the tier. This field is applicable for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model.

includedUnitsnumber

Specifies the number of units in the base set of units.

overagePricenumber double

Indicates whether the price is an overage price, which is the price when usage surpasses the last defined tier.

pricenumber double

The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.

priceFormat'Flat Fee' | 'Per Unit'

Indicates if pricing is a flat fee or is per unit. This field is for tiered and volume pricing models only.

startingUnitnumber

The starting number of a range of units for the tier. This field is applicable for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model.

tierinteger

A unique number that identifies the tier that the price applies to.

isDefaultboolean

Indicates whether the tier is the default tier. The default tier is the tier that is used when the usage does not fall into any of the defined tiers.

productRatePlanChargeIdstring

The unique identifier of the product rate plan charge that the tier belongs to.

productChargeDefinitionIdstring

The unique identifier of the product rate plan charge definition that the tier belongs to.

Changes