Pre-1.0 · one maintainer · Stripe and cards only · no SDKs (client libraries) yet · no production users yet. Docs describe v0.9.1 (29 Oct 2026) · What’s new →

Get meter

GET

/v1/meters/{id}

const url = 'http://localhost:8080/v1/meters/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/v1/meters/example \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

required

string

Responses

200

The meter

application/json

object

required

string

tenant_id

string

event_name

required

The event_name usage events send for this meter.

string

name

required

string

unit

required

string

aggregation

required

How the meter rolls its events into one quantity per billing period. Every price of the meter bills under it. last is the latest event by timestamp, then by id. Fixed once the meter has a usage event (see has_usage).

string

Allowed values: sum count max last

has_usage

Whether the meter has usage events. Once it has, its aggregation cannot change. Held usage for its event_name does not count until it is released. Returned when you create, get or update one meter; the meter list leaves it out. A create or update that succeeded leaves it out if it could not be read.

boolean

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "aggregation": "sum"
}

404

not_found: no meter with this id in this tenant and mode.

application/json

object

error

object

type

One of invalid_request_error, authentication_error, rate_limit_error or api_error. Every error the API answers has this shape, including an unknown path (404, code route_not_found) and a method the path does not take (405, code method_not_allowed, with an Allow header). The few exceptions are listed in docs/api-surface.md.

string

code

string

message

string

request_id

string

param

The request field the error is about. Sent only when the error names one. A request body may hold only the fields its operation lists, spelled and cased as listed: any other field, or one the server sets (such as id), is refused with 422 and param naming it. An operation with no request body lists no fields: send no body, {} or null. The Stripe and Postmark webhooks and the LiteLLM callback take their sender’s body as it comes.

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}