Sign in
Product Rate Plan Definitions

Create a product rate plan definition

Creates a product rate plan definition to use a charge in a product rate plan.

In the request, you must specify either the unique ID or number of both the charge and the product rate plan to add the specified charge to a specific rate plan.

Note: This operation requires the Attribute-based Pricing feature to be enabled, which is in the Early Adopter phase.

post/v1/product-rateplan-definitions

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

The minor API version.

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

Request body

productRatePlanChargeIdstring

The unique ID of the product rate plan charge to be used in the product rate plan.

productRatePlanChargeNumberstring

The unique number (natural key) of the product rate plan charge to be used in the product rate plan.

productRatePlanIdstring

The unique ID of the product rate plan that uses this rate plan definition.

productRatePlanNumberstring

The unique number (natural key) of the product rate plan that uses this rate plan definition.

Example request

{
  "productRatePlanChargeId": "2c9890e489f227bd0189f22f3482001f",
  "productRatePlanChargeNumber": "PRPC-00000001",
  "productRatePlanId": "2c9890678b1ca909018b1caea5c30000",
  "productRatePlanNumber": "PRP-00000008"
}

Response

OK

idstring

The unique ID of the product charge definition.

successboolean

Indicates whether the request succeeded.

Changes

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