Meter · StartupBuilder

Properties

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

Object

JSON

{
  "$id": "https://api.sb/ledgerlark.com/meters/meter_1",
  "$type": "Meter",
  "unit": "call",
  "of": "Reminder.sent",
  "aggregation": "sum",
  "window": "month"
}

Relationships

A Meter counts many Events: the Events the Meter counts toward usage billing. counts, inverse meteredBy.

Verbs

createCreates a Meter.
POST /{namespace}/metersdoMeter.created
getReturns one Meter by id.
GET /{namespace}/meters/{id}readNo Event
listReturns Meters, newest first, one page at a time.
GET /{namespace}/metersreadNo Event
updateChanges the given properties of a Meter.
PATCH /{namespace}/meters/{id}doMeter.updated
deleteDeletes a Meter; its history is kept.
DELETE /{namespace}/meters/{id}doMeter.deleted

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operation	`owner`	`admin`	`member`	`viewer`
`Meter.create`	Yes	Yes	Yes	No
`Meter.get`	Yes	Yes	Yes	Yes
`Meter.list`	Yes	Yes	Yes	Yes
`Meter.update`	Yes	Yes	Yes	No
`Meter.delete`	Yes	Yes	Yes	No

Call it

Text

Add a meter to PatentPad.

Example

The reminder Meter of a clinic-reminder SaaS counts each Reminder.sent Event once and posts one Entry per reminder at $0.03.

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

RelationshipsCopy Anchor Link

VerbsCopy Anchor Link

PermissionsCopy Anchor Link

Call itCopy Anchor Link

ExampleCopy Anchor Link