OPopenmeter
Product Catalog

List plans

List all plans.

get/api/v1/plans

Request

  • Base URL
    https://openmeter.cloud (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or API key in cookie __session

Query parameters

includeDeletedboolean

Include deleted plans in response.

Usage: ?includeDeleted=true

idstring[]

Filter by plan.id attribute

[
  "01G65Z755AFWAKHE12NY0CQ9FH"
]
keystring[]

Filter by plan.key attribute

keyVersionobject

Filter by plan.key and plan.version attributes

statusPlanStatus[]

Only return plans with the given status.

Usage:

  • ?status=active: return only the currently active plan
  • ?status=draft: return only the draft plan
  • ?status=archived: return only the archived plans
currencyCurrencyCode[]

Filter by plan.currency attribute

[
  "USD"
]
pageinteger

Page index.

Default is 1.

pageSizeinteger

The maximum number of items per page.

Default is 100.

order'ASC' | 'DESC'

The order direction.

orderBy'id' | 'key' | 'version' | 'created_at' | 'updated_at'

Order by options for plans.

The order by field.

Response

The request has succeeded.

pageinteger required

The page index.

pageSizeinteger required

The maximum number of items per page.

totalCountinteger required

The total number of items.

Changes

No recorded changes to this operation across all 2 revisions of this API.