OpenMeter Subscriptions

List subscriptions

Changed on
get/openmeter/subscriptions

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/subscriptions
  • Auth: none declared

Query parameters

sizeinteger

The number of items to include per page.

numberinteger

The page number.

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.

Changes

  • v3159bfd1e78cfRevision changes
    • info

      added to the /////////// response property allOf list for the response status

    • info

      removed from the /////////// response property allOf list for the response status

  • v3bd7fb1027684Revision changes
    • breaking

      added to the /////////////// response property oneOf list for the response status

    • info

      removed from the /////////////// response property anyOf list for the response status