---
title: "CRUD: Create a product rate plan"
method: POST
path: "/v1/object/product-rate-plan"
tags: ["Product Rate Plans"]
---

# CRUD: Create a product rate plan

`POST /v1/object/product-rate-plan`

Retrieves a product rate plan.

## Query parameters

- `rejectUnknownFields` boolean

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string
- `X-Zuora-WSDL-Version` string
- `Zuora-Version` string

## Request body

- ProxyCreateProductRatePlan — Container for custom fields of a Product Rate Plan object.
  - `ActiveCurrencies` string[] — 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.
  - `Description` string — A description of the product rate plan.
  - `EffectiveEndDate` string, date — The date when the product rate plan expires and can't be subscribed to, in `yyyy-mm-dd` format.
  - `EffectiveStartDate` string, date — The date when the product rate plan becomes available and can be subscribed to, in `yyyy-mm-dd` format.
  - `ExternalIdSourceSystem` string — 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.
  - `ExternalRatePlanIds` string — 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.
  - `Grade` number — 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](http://support.zuora.com/).
  - `Name` string, 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.
  - `ProductId` string, required — The ID of the product that contains the product rate plan.
  - `ProductRatePlanNumber` string — 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](https://www.zuora.com/connect/app/?appId=265).
  - `Class__NS` string — Class associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
  - `Department__NS` string — Department associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
  - `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](https://www.zuora.com/connect/app/?appId=265).
  - `IntegrationId__NS` string — ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
  - `IntegrationStatus__NS` string — Status of the product rate plan's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
  - `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](https://www.zuora.com/connect/app/?appId=265).
  - `Location__NS` string — Location associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
  - `MultiCurrencyPrice__NS` string — Multi-currency price associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
  - `Price__NS` string — Price associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
  - `Subsidiary__NS` string — Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
  - `SyncDate__NS` string — Date when the product rate plan was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

## Response `200`

OK

- ProxyCreateOrModifyResponse
  - `Id` string
  - `Success` boolean

## Other responses

- `400`
- `401` — Unauthorized

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)