Skip to content

by Startups.Studio

Finance Entitlement

Entitlement.create

POST /{namespace}/entitlements

Creates an Entitlement.

Noun: Entitlement
Mode: do
Event: Entitlement.created

You, to your agent

Add an entitlement to ShiftNote with a verb.

curl -X POST https://api.sb/shiftnote.app/entitlements \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"verb":"verb_1"}'

import { $ } from 'startup-builder'

const entitlement = await $.Entitlement.create({ verb: 'verb_1' })

npx startup-builder do Entitlement.create --json '{"verb":"verb_1"}'

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

Create makes a new Entitlement from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`verb`	Verb	required	The Verb it grants.
`limit`	Limit		The Limit that bounds it.
`kind`	`string`		Computed, never set: `feature`, or `limit` when a Limit bounds it.
`offer`	Offer		An accepted Offer grants Entitlements, each a Verb on a Noun, optionally bounded by a Limit.
`customer`	Customer		A Customer’s Entitlements are what it may do right now, granted by the Offers it accepted.

Outputs

Output	Type	Required	Description
`entitlement`	Entitlement	required	The Entitlement.

Effects

Emits Entitlement.created.
Two-way: try, send, do.

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

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

Previous Page

Entitlement.delete

Next Page