List Meters

Retrieve a paginated list of all meters in your environment.

GET /v1/meters

List Meters

cURL

curl --request GET \
  --url https://api.example.com/v1/meters

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "tenant_id": "<string>",
      "event_name": "<string>",
      "aggregation": {},
      "filters": [
        {}
      ],
      "reset_usage": "<string>",
      "status": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123,
  "has_more": true
}

Query Parameters

limit · integer · default: "10"

Maximum number of meters to return.

Example: 20

offset · integer · default: "0"

Number of meters to skip before starting to return results.

Example: 10

cursor · string

Cursor for pagination (alternative to offset).

Response

data · array

Array of meter objects.

Show meter properties

id · string

Unique identifier for the meter.

name · string

Human-readable name for the meter.

tenant_id · string

Tenant ID that owns this meter.

event_name · string

Name of the event being tracked.

aggregation · object

Aggregation configuration.

filters · array

Array of filters applied to events.

reset_usage · string

Usage reset configuration.

status · string

Status of the meter.

created_at · string

ISO 8601 timestamp when the meter was created.

updated_at · string

ISO 8601 timestamp when the meter was last updated.

total · integer

Total number of meters matching the query.

limit · integer

Maximum number of results returned.

offset · integer

Number of results skipped.

has_more · boolean

Whether there are more results available.

Example Request

cURL

curl --request GET \
  --url 'https://api.flexprice.io/v1/meters?limit=20&offset=0' \
  --header 'Authorization: Bearer <token>'

Example Response

{
  "data": [
    {
      "id": "meter_550e8400e29b41d4a716446655440000",
      "name": "API Usage Meter",
      "tenant_id": "tenant_123",
      "event_name": "api_request",
      "aggregation": {
        "type": "COUNT"
      },
      "filters": [],
      "reset_usage": "BILLING_PERIOD",
      "status": "published",
      "created_at": "2024-03-20T15:04:05Z",
      "updated_at": "2024-03-20T15:04:05Z"
    },
    {
      "id": "meter_6a1f94c1a3eb42e5b827557766551111",
      "name": "Compute Hours Meter",
      "tenant_id": "tenant_123",
      "event_name": "compute_usage",
      "aggregation": {
        "type": "SUM",
        "field": "hours"
      },
      "filters": [],
      "reset_usage": "BILLING_PERIOD",
      "status": "published",
      "created_at": "2024-03-21T10:15:30Z",
      "updated_at": "2024-03-21T10:15:30Z"
    }
  ],
  "total": 2,
  "limit": 20,
  "offset": 0,
  "has_more": false
}