Sign in

v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-03101355448.4 KB
OpenMeter Governance

Query governance access

Query feature access for a list of customers.

The endpoint resolves each provided identifier to a customer and returns the access status for the requested features, plus optional credit balance availability.

Designed to be called on a fixed refresh interval and the query response is intended to be cached.

post/openmeter/governance/query

Query parameters

sizeinteger

The number of items to include per page.

afterstring

Request the next page of data, starting with the item after this parameter.

beforestring

Request the previous page of data, starting with the item before this parameter.

Request body

include_creditsboolean

Whether to include credit balance availability for each resolved customer. When true, each feature evaluation includes credit balance checks.

Defaults to false.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "customer": {
        "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"
        }
      },
      "updated_at": "2023-01-01T01:01:01.001Z"
    }
  ],
  "meta": {
    "page": {
      "size": 10
    }
  }
}