Entitlement

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/patentpad.com/entitlements/entitlement_1",
  "$type": "Entitlement",
  "verb": "verb_1",
  "limit": "limit_1",
  "kind": "feature"
}

RelationshipsCopy Anchor Link

• An Entitlement is granted by one Offer: an accepted Offer grants Entitlements, each a Verb on a Noun, optionally bounded by a Limit. grantedBy, inverse grants.
• An Entitlement is held by one Customer: a Customer’s Entitlements are what it may do right now, granted by the Offers it accepted. heldBy, inverse holds.

VerbsCopy Anchor Link

1. createCreates an Entitlement.
   POST /{namespace}/entitlementsdoEntitlement.created
2. getReturns one Entitlement by id.
   GET /{namespace}/entitlements/{id}readNo Event
3. listReturns Entitlements, newest first, one page at a time.
   GET /{namespace}/entitlementsreadNo Event
4. updateChanges the given properties of an Entitlement.
   PATCH /{namespace}/entitlements/{id}doEntitlement.updated
5. deleteDeletes an Entitlement; its history is kept.
   DELETE /{namespace}/entitlements/{id}doEntitlement.deleted
6. checkCheck says whether a Customer may call a Verb now, how much of its Limit remains, when that resets, and which Offer lifts it.
   POST /{namespace}/entitlements/checkdoEntitlement.checked

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

Call itCopy Anchor Link

Check the latest entitlement with a customer and a verb.

ExampleCopy Anchor Link

A dental office on the $99 plan holds an Entitlement to send appointment reminders from its Tenant. A Limit bounds it at 1,000 reminders a month.