Lexicon Garden

space.highport.manage.setDomainBilling

Set whose allowance a domain's traffic draws on. Changing payerPolicy revokes every visitor approval the domain holds: consent was given to a different arrangement. The owner always remains the residual payer.

Repository @lexicons.highport.space did:plc:ciygg5hma4q7ah2kxaszkyob namespace authority
Details · procedure
Kindprocedure
Authoritymanage.highport.space
Indexed

Showing version bafyreied6p5tt7fbczv7ofkrqiplgunxeeims7xz5ta2fwc3wshmi7tnsi. Show the latest

Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

domain

requiredstring

The registered hostname. Must be registered to the calling identity.

  • maxLength: 253

fallbackToOwner

boolean

Under the visitor policy, whether a visitor with nothing left falls back to the owner rather than being refused. True is what stops a site going dark because one visitor overspent.

  • default: true

ownerBudgetBytes

integer

Bytes of the owner's own allowance this site may spend on readers who have not signed in, per period. 0 requires a sign-in before anything is served; omitted leaves payerPolicy and fallbackToOwner in charge. When present it derives both.

  • minimum: 0

payerPolicy

requiredstring

owner: every byte draws on the domain owner's allowance. visitor: authenticated visitors spend their own, and the owner pays for anonymous traffic and for visitors with nothing left.

  • knownValues: owner | visitor

visitorCapBytes

integer

A ceiling on what any single visitor may spend here per period. Absent means no ceiling beyond the one the visitor themselves set.

  • minimum: 0

Output

application/json

approvalsRevoked

integer

How many visitor approvals the policy change invalidated.

billing

requiredobject

Whose allowance a domain's traffic draws on.

Errors

InvalidDomain

Not a syntactically valid, non-reserved, public-suffix-safe domain. Distinct from DomainNotFound: the string is not a hostname at all.

DomainNotFound

No such domain, or it is not registered to the calling identity.

InvalidRequest

payerPolicy is not one of owner or visitor.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.