Entitlement programs: check

Entitlement.check

Check says whether a Customer may call a Verb now, how much of its Limit remains, when that resets, and which Offer lifts it. Verb page.

Text

do: return await $.Entitlement.check(input)

Inputs

Input	Type	Required	Description
`customer`	Customer	required	The Customer making the call.
`verb`	Verb	required	The Verb it wants to call, as `Noun.verb`.
`amount`	`integer`		How many units the call would use. Defaults to 1.

Returns

Output	Type	Required	Description
`allowed`	`boolean`	required	True when an Entitlement grants the call and its Limit has room for `amount`.
`entitlement`	Entitlement		The Entitlement that grants the Verb, when one does.
`remaining`	`integer`		Units left in the current period; absent for a `feature` Entitlement.
`resetsAt`	`datetime`		When the period resets; absent when the Limit never resets.
`upgrade`	Offer		The Offer that lifts the bound, when its Offer’s `atBound` is `upgrade`.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Entitlement.check({ customer: 'cus_K1BROJhqzZ', verb: 'verb_hlkWBvrAyZ' })"
  }
}