Lexicon Garden

space.highport.manage.setDomainBilling

Set whose allowance a domain's traffic uses. Changing payerPolicy revokes every visitor approval on the domain, since visitors agreed to the old arrangement. The owner always pays whatever nobody else covers.

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

Procedure

procedure · POST

Input

application/json

domain

requiredstring

The registered hostname. Must belong to the caller.

  • maxLength: 253

fallbackToOwner

boolean

Under the visitor policy: whether a visitor who has run out falls back to the owner instead of being refused. True keeps the site up when one visitor overspends.

  • default: true

ownerBudgetBytes

integer

How many bytes of the owner's allowance this site may spend per period on readers who are not signed in. 0 requires sign-in for everything. When set, it determines payerPolicy and fallbackToOwner; when omitted, those two apply as set.

  • minimum: 0

payerPolicy

requiredstring

owner: all traffic uses the owner's allowance. visitor: signed-in visitors use their own, and the owner pays for anonymous traffic and for visitors who have run out.

  • knownValues: owner | visitor

visitorCapBytes

integer

The most any one visitor can spend here per period. Absent means only the visitor's own cap applies.

  • minimum: 0

Output

application/json

approvalsRevoked

integer

How many visitor approvals the policy change revoked.

billing

requiredobject

Whose allowance a domain's traffic uses.

Errors

InvalidDomain

Not a valid, non-reserved, public-suffix-safe domain. Unlike DomainNotFound, the input is not a hostname at all.

DomainNotFound

No such domain, or it does not belong to the caller.

InvalidRequest

payerPolicy must be 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.