Meters

Unarchive a meter

Changed on

Restore an archived meter: it returns to the default listing and resumes accruing usage from the next matching event. Idempotent — unarchiving an active meter returns it unchanged. No gate applies and none is needed: archiving never released the meter's name, because per-store name uniqueness counts archived meters (which is why creating a meter with an archived meter's name returns 409 meter_name_taken with details.archived_holder), and it never altered the definition. Usage ingested while the meter was archived is retained as raw events and IS folded back in for any period still inside the late-event window, since a period is recomputed in full rather than incrementally — so units for an open period can increase by more than the usage seen since the unarchive. Finalized periods are not moved.

post/v1/meters/{id}/unarchive

Request

Path parameters

idstring required

Response

Meter unarchived (or already active)

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