Skip to content
Revenue API
/
/
List revenue contracts

List revenue contracts

Request

Purpose

Returns a paginated list of revenue contract header records for the book.

When to use

  • Build a contract inventory or reconcile Zuora Revenue contracts with an external system.
  • Look up contract IDs (rcId) before you call the line, hold, or Manual Action APIs.
  • Check indicators and amounts across many contracts in one pass.

Behavior notes

The only filterable and sortable field is id.

Filtering

Every query parameter other than page, size, and sort is treated as a filter.

  • field=value matches records where the field equals the value.
  • field[op]=value applies an operator. URL-encode the brackets as %5B and %5D, for example id%5Bgt%5D=1000. Operators: eq, ne, gt, gte, lt, lte, like (supply % wildcards yourself).
  • All filters are combined with AND. At most 5 filters are allowed per request.
  • Blank filter values are ignored.
  • An unknown field or operator returns HTTP 400.
Security
bearerAuth
Query
pageinteger, (int32), >= 0

Page number, starting at 1. 0 and an omitted value both return the first page.

Default:1
Example:page=1
sizeinteger, (int32), [ 1 .. 100 ]

Records per page. Default 20, maximum 100.

Default:20
Example:size=20
sortstring

Sort order as field,direction. Separate several sort fields with ; (for example id,desc;rcId,asc). Direction is asc or desc; any other value sorts ascending. Sortable fields: id. When sort is omitted the order is not guaranteed, so always sort when paging through results.

Example:sort=id,asc
idinteger, (int64)

Filter by revenue contract ID. Supports id[op] forms such as id[gte]=100000.

Example:id=111442
Headers
X-REV-BOOK-IDinteger, (int64)

Revenue book to work in. Defaults to 1 (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books.

Default:1
Example:1
Zuora-Request-Idstring, <= 64 characters

Optional correlation ID, echoed in the traceId response header.

Example:b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11
cURL
curl -i -X GET \
  'https://one.zuora.com/revenue/services/v1/contracts/list?page=1&size=20&sort=id%2Casc&id=111442' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-REV-BOOK-ID: 1' \
  -H 'Zuora-Request-Id: b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11'

Responses

A page of records. An empty data array means no record matched.

Headers
traceIdstring

Correlation ID of the request. Quote it when you contact Zuora Global Support.

Bodyapplication/json
dataArray of objects(RevenueContractHead)required
pageobject(PageMetadata)required

Pagination details for a list response.

Response
{
  "data": [
    { … }
  ],
  "page": {
    "number": 1,
    "size": 20,
    "totalElements": 57,
    "totalPages": 3,
    "first": true,
    "last": false
  }
}