Lexicon Garden

space.highport.manage.getConsumption

The caller's bandwidth allowance for a period: granted, used, remaining, which entitlements contributed, and which domains may draw on it. One allowance covers both the caller's own sites and its visits to sender-pays sites.

Repository @lexicons.highport.space did:plc:ciygg5hma4q7ah2kxaszkyob namespace authority
Details · query
Kindquery
Authoritymanage.highport.space
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

period

string

A UTC month as YYYY-MM. Defaults to the current month.

Output

application/json

approvals

array

Domains the caller agreed to let spend its allowance, with the cap it chose for each.

itemsobject

Standing consent to spend the allowance on one domain.

consumption

requiredobject

One identity's allowance for one period.

Errors

InvalidRequest

period is not a UTC month formatted as YYYY-MM.