All .list methods, such as invoice.list, client.list etc, may not return the entire list of objects in a single request. If the list contains more than 25 items (by default, see 'Page Size' below), it will be paginated (i.e. split across multiple pages of data, each requiring a separate request to fetch).
The pagination details are included in the response to any .list method request. The response will indicate:
Here’s an example response from the recurring.list method:
The above indicates that there are 4 pages of about 25 items (the last page will be the remainder, so it may not be a full page), and a total of 99 items.
Requesting specific pages
Specific pages are requested by including a
You can adjust the size of pages to meet your needs. The default page size is 25, but the system will allow pages of up to 100 items. (Specifying more than 100 will behave the same as if you’ve requested exactly 100). You set the page size by sending the
If there are fewer items than the page size in the system, then the entire list is returned.
Things to remember
This applies to all .list methods.