Skip to content

by Startups.Studio

Meter.update

PATCH /{namespace}/meters/{id}

Changes the given properties of a Meter.

Noun: Meter
Mode: do
Event: Meter.updated

You, to your agent

Change the latest meter.

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

import { $ } from 'startup-builder'

const meter = await $.Meter.update({ id: 'meter_1', unit: 'call' })

npx startup-builder do Meter.update --json '{"id":"meter_1","unit":"call"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Meter.update({ id: 'meter_1', unit: 'call' })"
  }
}

Update changes the given properties of a Meter. It is inherited: every Noun has get, list, create, update and delete.

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.

Outputs

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

Effects

Emits Meter.updated.
Two-way: try, send, do.

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.	Meter.update

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Meter.list

Previous Page

Order

Next Page