OpenMeter Subscriptions
List subscriptions
get/openmeter/subscriptions
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 subscriptions returned in the response. Supported sort attributes are:
- id
- active_from (default)
- active_to
The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order.
Filter subscriptions.
{
"id": "01G65Z755AFWAKHE12NY0CQ9FH",
"customer_id": "01G65Z755AFWAKHE12NY0CQ9FH",
"plan_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",
"customer_id": "01G65Z755AFWAKHE12NY0CQ9FH",
"plan_id": "01G65Z755AFWAKHE12NY0CQ9FH",
"billing_anchor": "2023-01-01T01:01:01.001Z"
}
],
"meta": {
"page": {
"number": 1,
"size": 10,
"total": 100
}
}
}