Skip to content
StartupBuilderby Startups.Studio
Business
Changelog
Events

Entitlement.checked

Emitted each time an Entitlement is checked.

Entitlement.check emits Entitlement.checked when it completes on an Entitlement.

PropertyValue
Emitted byEntitlement.check
NounEntitlement
WakesNone.

Payload

Each delivery is an Event record. data holds what Entitlement.check returns.

FieldTypeRequiredDescription
namestringrequiredEntitlement.checked.
atdatetimerequiredWhen it happened.
seqintegerIts position in the namespace, one more than the Event before; any seq is a cursor into the history.
datajsonrequiredThe Thing as the Action left it.
data.allowedbooleanrequiredTrue when an Entitlement grants the call and its Limit has room for amount.
data.entitlementEntitlementThe Entitlement that grants the Verb, when one does.
data.entitlement.verbVerbrequiredThe Verb it grants.
data.entitlement.limitLimitThe Limit that bounds it.
data.entitlement.kindstringComputed, never set: feature, or limit when a Limit bounds it.
data.remainingintegerUnits left in the current period; absent for a feature Entitlement.
data.resetsAtdatetimeWhen the period resets; absent when the Limit never resets.
data.upgradeOfferThe Offer that lifts the bound, when its Offer’s atBound is upgrade.

Example

JSON
{
  "$id": "https://api.sb/patentpad.com/events/event_1",
  "$type": "Event",
  "name": "Entitlement.checked",
  "at": "2026-10-22T12:00:00Z",
  "data": {
    "allowed": true,
    "entitlement": {
      "$id": "https://api.sb/patentpad.com/entitlements/entitlement_1",
      "$type": "Entitlement",
      "verb": "verb_1",
      "limit": "limit_1",
      "kind": "feature"
    },
    "remaining": 1,
    "resetsAt": "2026-10-22T12:00:00Z",
    "upgrade": {
      "$id": "https://api.sb/patentpad.com/offers/offer_1",
      "$type": "Offer",
      "price": {
        "amount": 499,
        "currency": "USD"
      }
    }
  },
  "seq": 1
}