v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB

Billing

List customers

Returns a paginated list of customers in the workspace.

get/customers/

Query parameters

pageinteger

Page number to retrieve (1-indexed).

page_sizeinteger

Number of items per page.

orderingstring

Field to sort results by. Prefix with - for descending order (e.g. -created).

countrystring

Filter by country ID.

emailstring

namestring

tax_idstring

createdstring date-time

Use lookups: created__gte, created__lte.

subscriptionsstring

Filter by linked subscription ID.

sourcesstring

Filter by linked source ID.

Headers

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

Whether to operate against test-mode data. Defaults to false.

Response

Paginated customer list.

countinteger required

Total number of items matching the filter.

nextstring uri nullable

URL of the next page, or null if last page.

previousstring uri nullable

URL of the previous page, or null if first page.

Example response

{
  "count": 142,
  "results": [
    {
      "id": "cus_01H8XYZ123ABC",
      "country": {
        "id": "CL",
        "name": "Chile",
        "code": "+56",
        "currencies": [
          "CLP"
        ]
      },
      "state": {
        "country": "CL"
      },
      "currency": "CLP",
      "contacts": [
        {
          "id": "con_01H8XYZ123ABC"
        }
      ]
    }
  ]
}