All top-level API resources have support for bulk fetches via the "list" API methods. For instance, you can list accounts, list subscriptions and list billing documents. These list API methods share a common structure - taking an optional cursor
parameter.
Zuora uses cursor-based pagination via the cursor
query parameter. The cursor parameter takes the next_page
value returned in the response returned from a previous request. Objects are returned, by default, in reverse chronological order.
Parameters
cursor
(string): a cursor for use in pagination. cursor defines your place in the list. For instance, if you make a "List" request and receive 10 objects, with next_page=76683efa-4b25-4716-a5c1-852b2162fcdb
, your subsequent call can include cursor=76683efa-4b25-4716-a5c1-852b2162fcdb
to fetch the next page of the list.
List Response Format
data
(array): an array containing the actual response elements, paginated by any request parameters.
next_page
(string): a cursor you can use to fetch the next page of the list.