RevKeenDocs
StatusSupport
API Reference

Get meter quantities

Get bucketed quantities for a meter over a time period. Timestamps are UTC. Polar-compatible query names (`start_timestamp`, `end_timestamp`, `interval`) are required. --- **Related endpoints** - `GET /meters` — List meters - `POST /meters` — Create a meter - `GET /meters/{id}` — Get a meter - `PATCH /meters/{id}` — Update a meter - `POST /meters/{meterId}/prices` — Create a meter price - `GET /meters/{meterId}/prices` — List meter prices - `PATCH /meters/{meterId}/prices/{priceId}` — Update a meter price - `POST /meters/{meterId}/prices/{priceId}/deactivate` — Deactivate a meter price **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.

GET
/meters/{id}/quantities

Get bucketed quantities for a meter over a time period. Timestamps are UTC. Polar-compatible query names (start_timestamp, end_timestamp, interval) are required.

Related endpoints

  • GET /meters — List meters
  • POST /meters — Create a meter
  • GET /meters/{id} — Get a meter
  • PATCH /meters/{id} — Update a meter
  • POST /meters/{meterId}/prices — Create a meter price
  • GET /meters/{meterId}/prices — List meter prices
  • PATCH /meters/{meterId}/prices/{priceId} — Update a meter price
  • POST /meters/{meterId}/prices/{priceId}/deactivate — Deactivate a meter price

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 401 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.

Authorization

apiKey
x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Path Parameters

id*string

Meter ID

Query Parameters

start_timestamp*string

Start timestamp (ISO 8601, UTC)

Formatdate-time
end_timestamp*string

End timestamp (ISO 8601, UTC)

Formatdate-time
interval*string

Bucket width. UTC date_trunc semantics; week is ISO (Monday).

Value in

  • "hour"
  • "day"
  • "week"
  • "month"
  • "year"
customer_id?string

Filter by customer ID

external_customer_id?string

Filter by the merchant's external customer ID

subscription_id?string

Filter by subscription ID

timezone?string

Only UTC is supported. Omit or pass UTC.

Response Body

application/json

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/meters/mtr_abc123/quantities?start_timestamp=2026-03-01T00%3A00%3A00Z&end_timestamp=2026-03-08T00%3A00%3A00Z&interval=day" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "object": "meter_quantities",  "meter_id": "string",  "start_timestamp": "2019-08-24T14:15:22Z",  "end_timestamp": "2019-08-24T14:15:22Z",  "interval": "hour",  "quantities": [    {      "timestamp": "2019-08-24T14:15:22Z",      "quantity": 0    }  ]}

List meters GET

List all usage meters with optional filtering and pagination. --- **Related endpoints** - `POST /meters` — Create a meter - `GET /meters/{id}/quantities` — Get meter quantities - `GET /meters/{id}` — Get a meter - `PATCH /meters/{id}` — Update a meter - `POST /meters/{meterId}/prices` — Create a meter price - `GET /meters/{meterId}/prices` — List meter prices - `PATCH /meters/{meterId}/prices/{priceId}` — Update a meter price - `POST /meters/{meterId}/prices/{priceId}/deactivate` — Deactivate a meter price **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.

Update a meter price PATCH

Update an existing usage price configuration. The pricing_model is immutable. --- **Related endpoints** - `GET /meters` — List meters - `POST /meters` — Create a meter - `GET /meters/{id}/quantities` — Get meter quantities - `GET /meters/{id}` — Get a meter - `PATCH /meters/{id}` — Update a meter - `POST /meters/{meterId}/prices` — Create a meter price - `GET /meters/{meterId}/prices` — List meter prices - `POST /meters/{meterId}/prices/{priceId}/deactivate` — Deactivate a meter price **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).