Skip to content

by Startups.Studio

Finance Entitlement

Entitlement.check

POST /{namespace}/entitlements/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.

Noun: Entitlement
Mode: do
Event: Entitlement.checked

You, to your agent

Check the latest entitlement with a customer and a verb.

curl -X POST https://api.sb/ledgerlark.com/entitlements/check \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customer":"customer_1","verb":"verb_1"}'

import { $ } from 'startup-builder'

const { allowed, entitlement, remaining, resetsAt, upgrade } = await $.Entitlement.check({ customer: 'customer_1', verb: 'verb_1' })

npx startup-builder do Entitlement.check --json '{"customer":"customer_1","verb":"verb_1"}'

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

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.

Outputs

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`.

Effects

Emits Entitlement.checked.
Two-way: it runs at once, in the try, send and do modes.
Changes nothing and never refuses: past the bound it answers allowed: false, and the Verb it guards then replies 402 payment-required, unless atBound is overage.

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.	Entitlement.check

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Entitlement

Previous Page

Entitlement.create

Next Page