Pagination

All top-level Quickstart 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: a cursor for use in pagination. The 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.
Note that the Quickstart API does not support pagination for expanded objects in the same call. You must use the cursor parameter to retrieve remaining results for the expanded objects in separate calls.For example, when you query accounts while expanding on subscriptions, if the subscription size is 30 for an account, only 10 would be returned in the response with a next_page value. You should pass in this value to the cursor parameter in the "List subscriptions" call to get the remaining results.
Bear in mind that do not include quotes (" or ') in the cursor query.

List Response Format

data(array): an array containing the actual response elements, paginated by any request parameters.The default page_size value for all "List" endpoints is 30.next_page(string): a cursor you can use to fetch the next page of the list.