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.

Request
header Parameters
Idempotency-Key
string <= 255 characters

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-Encoding
string

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-Encoding
string

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 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-Entity-Ids
string

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 do not need to set this header.

Request Body schema: application/json
required
productRatePlanChargeId
string

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

productRatePlanChargeNumber
string

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

productRatePlanId
string

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

productRatePlanNumber
string

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

Responses
200
500

Internal Server Error

4XX

Request Errors

post/v1/product-rateplan-definitions
Request samples
application/json
{
  • "productRatePlanChargeId": "2c9890e489f227bd0189f22f3482001f",
  • "productRatePlanChargeNumber": "PRPC-00000001",
  • "productRatePlanId": "2c9890678b1ca909018b1caea5c30000",
  • "productRatePlanNumber": "PRP-00000008"
}
Response samples
application/json
{
  • "id": "2c9890f78aba5c16018ababa00120019",
  • "success": true
}