Sign in
Product Rate Plan Charge Tiers

CRUD: Retrieve a product rate plan charge tier

Retrieves a specific product rate plan charge tier.

get/v1/object/product-rate-plan-charge-tier/{id}

Path parameters

idstring required

Object id

Query parameters

fieldsstring

Object fields to return

Headers

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-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-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-Versionstring

The minor API version.

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

Response

OK

CreatedByIdstring

The ID of the Zuora user who created the ProductRatePlanChargeTier object.

CreatedDatestring date-time

The date when the ProductRatePlanChargeTier object was created.

Currencystring

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

EndingUnitnumber double

The end number of a range of units for the tier.

Character limit: 16

Values: any positive decimal value

Idstring

Object identifier.

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.

Character limit: 16

Values: a valid currency value

PriceFormatstring

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

Values: FlatFee, PerUnit

Note: The values Flat Fee and Per Unit (with spaces) is valid for create or update calls.

StartingUnitnumber double

The starting number of a range of units for the tier.

Character limit: 16

Values: any positive decimal value

Tierinteger

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

Character limit: 20

Values: automatically generated

UpdatedByIdstring

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

UpdatedDatestring date-time

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

Changes

No recorded changes to this endpoint across all 4 revisions of this API.