{
  "coupons": [
    // ...
  ],
  "meta": {
    "current_page": 1,
    "next_page": 2,
    "prev_page": 1,
    "total_pages": 10,
    "total_count": 100
}
Many API endpoints that return lists of resources support pagination, enabling you to manage large result sets efficiently. You can control which results are returned by specifying the page and per_page query parameters. Paginated responses include a meta object that provides detailed pagination information, such as:
  • current_page: The current page number.
  • next_page: The next page number, if available.
  • prev_page: The previous page number, if available.
  • total_pages: The total number of pages.
  • total_count: The total number of records available.
{
  "coupons": [
    // ...
  ],
  "meta": {
    "current_page": 1,
    "next_page": 2,
    "prev_page": 1,
    "total_pages": 10,
    "total_count": 100
}

​
Parameters

​
page
integer
default:1
required
The page number to return.
​
per_page
integer
required
The number of results per page. In most cases, the default value is 100.

​
List response

​
meta.current_page
number
required
The current page number.
​
meta.next_page
number
The next page number.
​
meta.prev_page
number
The previous page number.
​
meta.total_pages
number
required
The total number of pages.
​
meta.total_count
number
required
The total number of records.