Retrieve a rate plan

Retrieves the detailed information about a specific subscription rate plan.

  • If you have the Orders 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 Orders Harmonization feature enabled, this operation retrieves information about a subscription rate plan and the related order and amendment that have amended the rate plan.

  • 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 What is Orders Harmonization and join the Orders Harmonization community group for more information. If you want to enable Orders, submit a request at Zuora Global Support.

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

  • addProduct
  • updateProduct
  • removeProduct
  • changePlan
Request
path Parameters
ratePlanId
required
string <string>

The ID of the subscription rate plan to be retrieved.

header Parameters
Accept-Encoding
string

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-Encoding
string

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

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 (:), semicolon (;), double quote ("), and quote (').

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 do not need to 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.

Responses
200
get/v1/rateplans/{ratePlanId}
Request samples
Response samples
application/json
{
  • "amendment": {
    },
  • "id": "402880e47ccbaca1017ccbdd63aa18c8",
  • "lastChangeType": "Update",
  • "order": {
    },
  • "productId": "2c9890207c9649c0017c96a0588201a2",
  • "productName": "MMORPG game",
  • "productRatePlanId": "2c9890207c9649c0017c96a0f11001a4",
  • "productSku": "SKU-00000001",
  • "ratePlanName": "Rate Plan 1",
  • "subscriptionId": "402880e47ccbaca1017ccbdd644d18d0",
  • "subscriptionVersion": 5,
  • "success": true
}