API

Pagination

1min

All top-level API resources have support for bulk fetches via "list" API methods. For instance, you can list payment﻿ and list invoices﻿.
The response of a list API method represents a single page in a reverse chronological stream of objects. If you do not specify the page, you will receive the first page of this stream, containing the newest objects. 
The stream of objects will return 40 objects for the requested resource by default and an object containing meta-information about the list. here is an example of the meta object:
﻿
JSON
{
  "invoices":[...],
  "meta": {
      "current_page": 1,
      "next_page": null,
      "prev_page": null,
      "total_pages": 1,
      "total_count": 5
  }  
}      
{
  "invoices":[...],
  "meta": {
      "current_page": 1,
      "next_page": null,
      "prev_page": null,
      "total_pages": 1,
      "total_count": 5
  }  
}      
﻿
Key
Description
current_page
The current page of the resource list.
next_page
The next page number if any, otherwise null
prev_page
The previous page number if any, otherwise null
total_pages
The total number of pages for the list of resources
total_count
The total number of invoices in the list 
﻿

Key	Description
current_page	The current page of the resource list.
next_page	The next page number if any, otherwise null
prev_page	The previous page number if any, otherwise null
total_pages	The total number of pages for the list of resources
total_count	The total number of invoices in the list

Updated 23 Nov 2023

Did this page help you?

Authentication

Metadata