Meter routes: update, delete

Reference for Meter, one group of Meter routes.

Meter.update

Changes the given properties of a Meter. Verb page.

Text

PATCH /{namespace}/meters/{id}

Path: id. Body, as JSON: the other inputs. Emits Meter.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Meter.
`unit`	`string`		What it counts, such as calls or tokens.
`of`	`string`		The declared Event the Meter counts.
`aggregation`	`string`		How counted Events combine over the window: a sum of a value, a count, or the last value.
`window`	`string`		The period usage accrues over before it bills, such as a month.

Returns

Output	Type	Required	Description
`meter`	Meter	required	The Meter.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

curl -X PATCH https://api.sb/ratebook.dev/meters/mtr_z08Ufi8LwY \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"unit":"call"}'

JSON

{
  "api": "https://api.sb/ratebook.dev",
  "meter": {
    "$id": "https://api.sb/ratebook.dev/meters/mtr_z08Ufi8LwY",
    "$type": "Meter",
    "unit": "call",
    "of": "Reminder.sent",
    "aggregation": "sum",
    "window": "month"
  },
  "action": {
    "$id": "https://api.sb/ratebook.dev/actions/act_M5LgINdysq",
    "operation": "Meter.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/actions/act_M5LgINdysq"
  }
}

Meter.delete

Deletes a Meter: a soft delete that keeps its history, undone by Thing.restore. Verb page.