Sign in
Product Rate Plans

CRUD: Create a product rate plan

Retrieves a product rate plan.

post/v1/object/product-rate-plan

Query parameters

rejectUnknownFieldsboolean

Specifies whether the call fails if the request body contains unknown fields. With rejectUnknownFields set to true, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is:

{
    "message": "Error - unrecognised fields"
}

By default, Zuora ignores unknown fields in the request body.

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-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 (').

X-Zuora-WSDL-Versionstring

Zuora WSDL version number.

Zuora-Versionstring

The minor API version.

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

Request body

ActiveCurrenciesstring[]

A list of 3-letter currency codes representing active currencies for the product rate plan. Use a comma to separate each currency code.

When creating a product rate plan, you can use this field to specify default currency and at most four other active currencies.

Descriptionstring

A description of the product rate plan.

EffectiveEndDatestring date

The date when the product rate plan expires and can't be subscribed to, in yyyy-mm-dd format.

EffectiveStartDatestring date

The date when the product rate plan becomes available and can be subscribed to, in yyyy-mm-dd format.

ExternalIdSourceSystemstring

The ID of the external source system.

Note: To use this field, you must set the X-Zuora-WSDL-Version request header to 130 or later. Otherwise, an error occurs.

ExternalRatePlanIdsstring

An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. If you want to update to multiple values, use a comma separated string.

Note: To use this field, you must set the X-Zuora-WSDL-Version request header to 130 or later. Otherwise, an error occurs.

Gradenumber

The grade that is assigned for the product rate plan. The value of this field must be a positive integer. The greater the value, the higher the grade.

A product rate plan to be added to a Grading catalog group must have one grade. You can specify a grade for a product rate plan in this request or update the product rate plan individually.

Notes:

  • To use this field, you must set the X-Zuora-WSDL-Version request header to 116 or later. Otherwise, an error occurs.
  • This field is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.
Namestring required

The name of the product rate plan. The name doesn't have to be unique in a Product Catalog, but the name has to be unique within a product.

ProductIdstring required

The ID of the product that contains the product rate plan.

ProductRatePlanNumberstring

The natural key of the product rate plan.

Possible values:

  • leave null for automatically generated string
  • an alphanumeric string of 100 characters or fewer

Note: This field is only available if you set the X-Zuora-WSDL-Version request header to 133 or later.

BillingPeriod__NS'Monthly' | 'Quarterly' | 'Annual' | 'Semi-Annual'

Billing period associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Class__NSstring

Class associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Department__NSstring

Department associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

IncludeChildren__NS'Yes' | 'No'

Specifies whether the corresponding item in NetSuite is visible under child subsidiaries. Only available if you have installed the Zuora Connector for NetSuite.

IntegrationId__NSstring

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

IntegrationStatus__NSstring

Status of the product rate plan's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

ItemType__NS'Inventory' | 'Non Inventory' | 'Service'

Type of item that is created in NetSuite for the product rate plan. Only available if you have installed the Zuora Connector for NetSuite.

Location__NSstring

Location associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

MultiCurrencyPrice__NSstring

Multi-currency price associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Price__NSstring

Price associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Subsidiary__NSstring

Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

SyncDate__NSstring

Date when the product rate plan was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Example request

{
  "Name": "Basic Plan",
  "Description": "monthly plan",
  "ProductId": "8ad081dd90c4bdwafe0190desada8f9b15",
  "ActiveCurrencies": "USD",
  "EffectiveStartDate": "2020-10-20",
  "EffectiveEndDate": "2030-10-20",
  "ExternalIdSourceSystem": "extsys",
  "ExternalRatePlanIds": "ext01,ext02"
}

Response

OK

Idstring
Successboolean

Changes

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