Skip to content

by Startups.Studio

Product What you sell Offer

Offer.grant

POST /{namespace}/offers/{offer}/grant

Grant adds an Entitlement to an Offer: a Verb its Customers may call, optionally bounded by a Limit.

Noun: Offer
Mode: do
Event: Offer.granted

You, to your agent

Grant the offer “Saturday sourdough” with a verb.

curl -X POST https://api.sb/kilnbakery.com/offers/offer_1/grant \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"verb":"verb_1"}'

import { $ } from 'startup-builder'

const { entitlement, offer } = await $.Offer.grant({ offer: 'offer_1', verb: 'verb_1' })

npx startup-builder do Offer.grant --json '{"offer":"offer_1","verb":"verb_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Offer.grant({ offer: 'offer_1', verb: 'verb_1' })"
  }
}

Inputs

Input	Type	Required	Description
`offer`	Offer	required	The Offer that grants it.
`verb`	Verb	required	The Verb its Customers may call, as `Noun.verb`.
`limit`	Limit		The Limit that bounds it. Unset: a feature, called as often as the Customer likes.

Outputs

Output	Type	Required	Description
`entitlement`	Entitlement	required	The new Entitlement, granted by the Offer.
`offer`	Offer	required	The Offer, with the Entitlement added.

Effects

Emits Offer.granted.
Performed by the Product Lead.
Two-way: it runs at once, in the try, send and do modes.
Every Customer holding the Offer holds the Entitlement on their next call; no Subscription changes.
Adds the Verb to the Offer’s row in the pricing table and the Portal’s plan comparison.

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.	Offer.grant

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

Offer.get

Previous Page

Offer.list

Next Page