CRcreem
Meters

Archive a meter

Changed on

Archive a meter: it leaves the default listing and stops accruing new usage, but is never deleted, so the usage it already recorded stays meaningful. Idempotent — archiving an archived meter returns it unchanged.

post/v1/meters/{id}/archive

Request

Path parameters

idstring required

Response

Meter archived

idstring required

Meter ID

store_idstring required

Store ID

namestring required

Meter name

event_namestring required

Usage event name the meter consumes

aggregation'count' | 'sum' | 'average' | 'min' | 'max' | 'unique' required

Aggregation applied to matching events

aggregation_propertystring nullable required

Property the aggregation reduces; null for "count"

unit_labelstring required

Display unit

status'active' | 'archived' required

Whether the meter is active or archived

created_atstring required

Creation timestamp (ISO 8601)

updated_atstring required

Last update timestamp (ISO 8601)

Example response

{
  "id": "mtr_abc123",
  "store_id": "sto_abc123",
  "name": "Image generations",
  "event_name": "image.generated",
  "aggregation": "sum",
  "aggregation_property": "tokens",
  "filter": {
    "conjunction": "and",
    "clauses": [
      {
        "property": "tier",
        "operator": "equals"
      }
    ]
  },
  "unit_label": "images",
  "status": "active"
}

Changes