Skip to content
Legacy API Reference
/
/
List revenue schedules by...

List revenue schedules by subscription charge key

Request

Retrieves the revenue schedule details by specifying subscription charge ID. Request and response field descriptions and sample code are provided

Path
charge-keystringrequired

ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012.

Query
pageinteger, >= 1

The index number of the page that you want to retrieve. This parameter is dependent on pageSize. You must set pageSize before specifying page. For example, if you set pageSize to 20 and page to 2, the 21st to 40th records are returned in the response.

Default:1
pageSizeinteger, <= 300

The number of records returned per page in the response.

Default:8
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.

Authorizationstring

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

Zuora-Track-Idstring, <= 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-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 do not need to set this header.

cURL
curl -i -X GET \
  'https://rest.zuora.com/v1/revenue-schedules/subscription-charges/{charge-key}?page=1&pageSize=8' \
  -H 'Accept-Encoding: string' \
  -H 'Authorization: string' \
  -H 'Content-Encoding: string' \
  -H 'Zuora-Entity-Ids: string' \
  -H 'Zuora-Track-Id: string'

Responses

Headers
Content-Encodingstring

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-Idstring, = 36 characters

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-Idstring, <= 64 characters

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Bodyapplication/json
nextPagestring, (URL)

URL to retrieve the next page of the response if it exists; otherwise absent.

revenueSchedulesArray of objects(revenueSchedules)

Represents how revenue will be recognized over time.

This contains the details of a revenue schedule. If you do not specify the pageSize variable, the default number of revenue schedules returned per invocation is 8, and if there are more than 8 revenue schedules to be returned, the nextPage field will provide a hyperlink to view the next page(s) of revenue events. The order of revenue schedules is descending by the updatedOn field.

successboolean

Returns true if the request was processed successfully.

Response
{
  "revenueSchedules": [
    { … },
    { … }
  ],
  "nextPage": "https://rest.zuora.com/v1/revenue-schedules/subscription-charges/2c92c0f943977b4f0143b23487ed432e?page=2&pageSize=8",
  "success": true
}