RevKeenDocs
StatusSupport
API Reference
📊 Usage BillingMeters

Update a meter

Update a meter's configuration. Note: event_name and aggregation are immutable after creation.

PATCH/meters/{id}

Update a meter's configuration. Note: event_name and aggregation are immutable after creation.

Related endpoints

  • GET /meters — List meters
  • POST /meters — Create a meter
  • GET /meters/{id}/quantities — Get meter quantities
  • GET /meters/{id} — Get a meter

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.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

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 UUID.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Parameters for updating an existing meter. Only display name and metadata can be changed.

Response Body

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X PATCH "https://api.revkeen.com/v2/meters/11111111-1111-4111-8111-111111111111" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "example",
    "slug": "example",
    "description": "Example request from API docs",
    "status": "active"
  }'

Synthetic documentation data, validated against the response schema; not a live API result.

{  "data": {    "id": "7c8d9e0f-1a2b-4630-8d4e-5f6a7b8c9d01",    "name": "API calls",    "slug": "api-calls",    "description": "Counts requests to the merchant's public API.",    "event_name": "api_call",    "aggregation": "count",    "value_key": null,    "value_expression": null,    "meter_definition_version": 1,    "unit_name": "calls",    "unit_of_measure_code": "C62",    "status": "active",    "filter_conditions": null,    "unique_count_key": null,    "carry_forward": false,    "metadata": {},    "created_at": "2026-04-02T10:00:00.000Z",    "updated_at": "2026-04-02T10:05:00.000Z"  }}

Put this endpoint to work

Configure usage billing