Pagination

List endpoints return paginated results to improve performance. You control pagination using query parameters:

Parameter
Default
Maximum
Description

page

1

-

Page number (1-based)

per_page

50

100

Items per page

Example request:

GET /v2/customers?page=2&per_page=25

Response format:

{
  "data": [
    { "id": "cus_123", "email": "[email protected]", ... },
    { "id": "cus_124", "email": "[email protected]", ... }
  ],
  "pagination": {
    "page": 2,
    "limit": 25,
    "total": 150,
    "pages": 6
  }
}

The pagination object provides:

  • page: Current page number

  • limit: Items per page (same as per_page parameter)

  • total: Total number of items across all pages

  • pages: Total number of pages

Last updated