OpenMeter Customers
List customers
get/v3/openmeter/customers
Query parameters
Determines which page of the collection to retrieve.
sortstring
The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').
Example:created_at desc
Sort customers returned in the response. Supported sort attributes are:
- id
- name (default)
- created_at
The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order.
Filter customers returned in the response.
To filter customers by key add the following query param: filter[key]=my-db-id
{
"billing_profile_id": "01G65Z755AFWAKHE12NY0CQ9FH"
}Response
Page paginated response.
Example response
{
"data": [
{
"id": "01G65Z755AFWAKHE12NY0CQ9FH",
"labels": {
"env": "test"
},
"created_at": "2023-01-01T01:01:01.001Z",
"updated_at": "2023-01-01T01:01:01.001Z",
"deleted_at": "2023-01-01T01:01:01.001Z",
"key": "019ae40f-4258-7f15-9491-842f42a7d6ac",
"currency": "USD",
"billing_address": {
"country": "US"
}
}
],
"meta": {
"page": {
"number": 1,
"size": 10,
"total": 100
}
}
}