Skip to main content

​
Pagination and Filtering

​
In a nutshell

List endpoints use page-based pagination.

​
Query parameters

ParameterDescription
pagePage number. Defaults to 1.
limitPage size. Defaults to 10.
searchAccepted by common pagination shape; availability depends on endpoint.

​
Paginated response

{
  "status": "success",
  "message": "Customers retrieved successfully",
  "data": {
    "data": [],
    "totalCount": 0,
    "page": 1,
    "limit": 10,
    "totalPages": 0,
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}

​
Endpoint filters

Plans support:
  • status
  • interval
  • amount
Subscriptions support:
  • customer
  • plan