Skip to navigation

CRUD: Retrieve a product rate plan charge tier

View as Markdown
Retrieves a specific product rate plan charge tier.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

idstringRequired
Object id

Headers

Accept-EncodingstringOptional

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

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

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

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. 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-IdstringOptional<=64 characters

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

The minor API version.

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

Query parameters

fieldsstringOptional
Object fields to return

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-LimitstringOptional

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

RateLimit-Remainingdouble

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

RateLimit-Resetdouble

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

Zuora-Request-IdstringOptional
The Zuora internal identifier of the API call. You cannot control the value of this header.
Zuora-Track-IdstringOptional
A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

OK
CreatedByIdstringOptional<=32 characters
The ID of the Zuora user who created the ProductRatePlanChargeTier object.
CreatedDatedatetimeOptional
The date when the ProductRatePlanChargeTier object was created.
CurrencystringOptional<=3 characters
The valid code corresponding to the currency for the tier's price.
EndingUnitdoubleOptional

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

Character limit: 16

Values: any positive decimal value

IdstringOptional
Object identifier.
PricedoubleOptional

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

PriceFormatstringOptional<=8 characters

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.

StartingUnitdoubleOptional

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

Character limit: 16

Values: any positive decimal value

TierintegerOptional

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

Character limit: 20

Values: automatically generated

UpdatedByIdstringOptional<=32 characters
The ID of the user who last updated the product rate plan charge tier.
UpdatedDatedatetimeOptional
The date when the product rate plan charge tier was last updated.

Errors

401
Unauthorized Error
404
Not Found Error