Skip to main content
GET
/
v1
/
meters
List Meters
curl --request GET \
  --url https://api.example.com/v1/meters
{
  "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.
​
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
}