---
title: "List product rate plans by external ID"
method: GET
path: "/v1/product-rate-plans/external-id/{id}"
tags: ["Product Rate Plans"]
---

# List product rate plans by external ID

`GET /v1/product-rate-plans/external-id/{id}`

Retrieves information about one or multiple product rate plans by external ID.

## Path parameters

- `id` string, required

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Response `200`

OK

- GETProductRatePlanWithExternalIdMultiResponse
  - `productRatePlans` object[] — A list of product rate plans associated with the product. Each rate plan defines a set of charges and billing conditions that determine how a product is priced and billed.
    - `id` string — The unique product rate plan ID.
    - `status` 'Active' | 'Expired' | 'NotStarted' — The status of the product rate plan.
    - `name` string — The name of the product rate plan.
    - `description` string — The short description of the product rate plan.
    - `effectiveStartDate` string, date — The start date of the product rate plan.
    - `effectiveEndDate` string, date — The end date of the product rate plan.
    - `externalIdSourceSystem` string — The combination of `externallyManagedPlanId` and `externalIdSourceSystem` is the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.
    - `externallyManagedPlanIds` string[] — The unique identifier for the product rate plan in a third-party store. This field is used to represent a rate plan created through third-party stores.
    - `productRatePlanNumber` string — A unique, human-readable identifier for the product rate plan. This value is typically auto-generated by Zuora but can also be set explicitly by the customer. This field is required and should never be null.
    - `grade` number — The grade of the product rate plan. **Note**: 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/).
    - `organizationLabels` object[] — The organization(s) that the object belongs to. Note: This field is available only when the Multi-Org feature is enabled.
      - `organizationId` string — The organization ID.
      - `organizationName` string — The organization name.
  - `success` boolean — Returns `true` if the request was processed successfully.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

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