---
title: "CRUD: Retrieve a product rate plan"
method: GET
path: "/v1/object/product-rate-plan/{id}"
tags: ["Product Rate Plans"]
---

# CRUD: Retrieve a product rate plan

`GET /v1/object/product-rate-plan/{id}`

Retrieves a product rate plan.

## Path parameters

- `id` string, required

## Query parameters

- `fields` string

## Headers

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

## Response `200`

OK

- ProxyGetProductRatePlan — 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. This field cannot be queried in conjunction with any other fields except `id` at the same time.
  - `CreatedById` string — The automatically generated ID of the Zuora user who created the `ProductRatePlan` object.
  - `CreatedDate` string, date-time — The date when the `ProductRatePlan` object was created.
  - `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.
  - `Grade` number — The grade that is assigned for the product rate plan. **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/).
  - `Id` string — Object identifier.
  - `Name` string — 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 — The ID of the product that contains the product rate plan.
  - `UpdatedById` string — The automatically generated ID of the last user to update the object.
  - `UpdatedDate` string, date-time — The date when the object was last updated.
  - `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).

## Other responses

- `401` — Unauthorized
- `404`

---

[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)