Retrieves a product rate plan.
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 If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a |
Content-Encoding | string Include the |
Authorization | string The value is in the |
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 should not set this header. |
Zuora-Org-Ids | string 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. If the header is not set, the operation is performed in scope of the user's accessible orgs. |
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 ( |
X-Zuora-WSDL-Version | string Default: 79 Zuora WSDL version number. |
ActiveCurrencies | Array of strings 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 <= 500 characters A description of the product rate plan. |
EffectiveEndDate | string <date> <= 29 characters The date when the product rate plan expires and can't be subscribed to, in |
EffectiveStartDate | string <date> <= 29 characters The date when the product rate plan becomes available and can be subscribed to, in |
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:
|
Name required | string <= 255 characters 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 required | string <= 32 characters The ID of the product that contains the product rate plan. |
ProductRatePlanNumber | string <= 100 characters The natural key of the product rate plan. Possible values:
Note: This field is only available if you set the |
BillingPeriod__NS | string Billing period associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
Class__NS | string <= 255 characters Class associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
Department__NS | string <= 255 characters Department associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
IncludeChildren__NS | string Specifies whether the corresponding item in NetSuite is visible under child subsidiaries. Only available if you have installed the Zuora Connector for NetSuite. |
IntegrationId__NS | string <= 255 characters ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
IntegrationStatus__NS | string <= 255 characters Status of the product rate plan's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
ItemType__NS | string 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__NS | string <= 255 characters Location associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
MultiCurrencyPrice__NS | string <= 255 characters Multi-currency price associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
Price__NS | string <= 255 characters Price associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
Subsidiary__NS | string <= 255 characters Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
SyncDate__NS | string <= 255 characters Date when the product rate plan was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
property name* additional property | any Custom fields of the Product Rate Plan object. The name of each custom field has the form |
{- "Name": "Basic Plan",
- "ProductId": "8ad081dd90c4bafe0190deda8f9b154b",
- "EffectiveStartDate": "2020-10-20",
- "EffectiveEndDate": "2030-10-20"
}
{- "Id": "2c93808457d787030157e0324735512b",
- "Success": true
}