Lexicon Garden

blue.hearth.tier

A subscription tier offered by a creator. Lives in the creator's repository, so the creator is the repo owner and is not repeated as a field. Tiers are tied to the creator's DID rather than to any publication or app.

Repository @hearth.blue did:web:hearth.blue namespace authority
Details · record, key tid
Kindrecord
Record keytid
Authorityhearth.blue
Indexed
Compare Edit in builder → Fork →

Record

record · key tid

Properties

amount

requiredinteger

Price per billing period, in the smallest unit of the currency (e.g. cents). Matches network.attested.payment.recurring's amount so no conversion is needed when the payment record is written.

  • minimum: 1

closedAt

string · datetime

When this tier stopped accepting NEW subscriptions. Closing is not deleting: existing entitlements keep referencing this record and must keep resolving, so a tier is never removed once anyone has subscribed to it.

createdAt

requiredstring · datetime

currency

requiredstring

ISO 4217 currency code, e.g. USD.

  • minLength: 3
  • maxLength: 3

description

string

What a subscriber gets. Prose, not machine-read.

  • maxLength: 10000
  • maxGraphemes: 1000

frequency

integer

Multiplier on unit, so unit=monthly with frequency=3 bills every three months. Defaults to 1. Mirrors network.attested.payment.recurring.

  • minimum: 1
  • default: 1

name

requiredstring

Display name of the tier.

  • maxLength: 640
  • maxGraphemes: 64

unit

requiredstring

Billing period. Closed set, matching network.attested.payment.recurring exactly. Closed rather than knownValues because an unrecognised unit is not forward-compatible, it is uncomputable: a verifier cannot derive a billing period from a value it does not know, so accepting one would mean writing a tier nothing can price.

  • enum: monthly | quarterly | semiannual | yearly

Similar lexicons

semantic match

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

  • am.noz.mecenas.tier

    record

    A public description of a creator membership tier; it is not canonical billing state.

  • network.attested.payment.recurring

    record

    A recurring payment commitment. Immutable once created — supporters cancel and create new subscriptions to change terms. Bills on anniversary dates with automatic retry on failure.

  • at.mecenas.tier

    record

    A public description of a creator membership tier; it is not canonical billing state.

  • blue.hearth.entitlement

    record

    Proof that a subscriber currently holds a tier. This is the record attested.network deliberately leaves undefined: its payment records prove a payment happened but carry no expiry, revocation or status, so they cannot answer 'is this subscription active right now'. Lives in the SUBSCRIBER's repository, alongside the payment record that granted it. Entitlements are short-lived and RENEWED, never long-lived and revoked: each successful billing cycle writes a fresh record, so cancellation is the ob

  • fund.at.funding.plan

    record

    A funding plan or tier with a suggested amount. Each plan is an individual record keyed by its slug ID. Plans reference channels by AT URI, allowing cross-account references (e.g. multiple maintainers pointing plans at a shared org channel).