Sign in
Rate Plans

Retrieve a rate plan

Retrieves the detailed information about a specific subscription rate plan.

  • If you have the <a href="https://docs.zuora.com?resourceId=billing-overview-orders" target="_blank">Orders</a> feature enabled, this operation retrieves information about a subscription rate plan and the related order that has amended the rate plan.

  • If you have the <a href="https://docs.zuora.com?resourceId=billing-overview-orders-harmonization" target="_blank">Orders Harmonization</a> feature enabled, this operation retrieves information about a subscription rate plan and the related order and amendment that have amended the rate plan. The returned objects may be different since amendment, order, and order action are generated asynchronously.

    • If all are generated, the related amendment and order, including the order action, are returned.
    • If not, only the related amendment may be returned before generating the order and order action.

  • If you are an existing Zuora Subscribe and Amend customer, this operation retrieves information about a subscription rate plan and the related amendment that has amended the rate plan.

Note: Orders is now generally available as of Zuora Billing Release 284 (August 2020). If you are an existing Zuora Subscribe and Amend customer and want to adopt Orders, see <a href="https://docs.zuora.com?resourceId=billing-overview-orders-harmonization" target="_blank">What is Orders Harmonization</a> and join the <a href="https://community.zuora.com/t5/Orders-Harmonization/gp-p/Orders-Harmonization" target="_blank">Orders Harmonization community group</a> for more information. If you want to enable Orders, submit a request at <a href="https://support.zuora.com/" target="_blank">Zuora Global Support</a>.

Note: You can only retrieve information about the following order actions:

  • addProduct
  • updateProduct
  • removeProduct
  • changePlan
get/v1/rateplans/{ratePlanId}

Path parameters

ratePlanIdstring string required

The ID of the subscription rate plan to be retrieved.

Headers

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

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

The minor API version.

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

Response

OK

processIdstring

The ID of the process that handles the operation.

requestIdstring uuid

Unique identifier of the request.

successboolean

Indicates whether the call succeeded.

externallyManagedPlanIdstring

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.

idstring

Unique subscription rate-plan ID.

lastChangeTypestring

Latest change type. Possible values are:

  • New
  • Update
  • Remove
productIdstring

Product ID

productNamestring

The name of the product.

productRatePlanIdstring

Product rate plan ID

productSkustring

The unique SKU for the product.

ratePlanNamestring

The name of the rate plan.

subscriptionIdstring

Subscription ID.

{"stackTrail":"components:schemas:GetOrderActionRatePlanResponse:allOf:properties:subscriptionVersion","oasType":"schema","type":"unknown","description":"The version of the subscription.\n"}

Changes

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