Skip to content

by Startups.Studio

Finance Instrument

Instrument.grant

POST /{namespace}/instruments/grant

Grant gives a Holder an option from the pool, with its strike price, vesting schedule and cliff.

Noun: Instrument
Mode: do
Event: Instrument.granted

You, to your agent

Grant the latest instrument with a holder.

curl -X POST https://api.sb/patentpad.com/instruments/grant \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"holder":"holder_1","quantity":1,"strike":{"amount":499,"currency":"USD"},"vesting":{}}'

import { $ } from 'startup-builder'

const instrument = await $.Instrument.grant({ holder: 'holder_1', quantity: 1, strike: { amount: 499, currency: 'USD' }, vesting: {} })

npx startup-builder do Instrument.grant --json '{"holder":"holder_1","quantity":1,"strike":{"amount":499,"currency":"USD"},"vesting":{}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Instrument.grant({ holder: 'holder_1', quantity: 1, strike: { amount: 499, currency: 'USD' }, vesting: {} })"
  }
}

Inputs

Input	Type	Required	Description
`holder`	Holder	required	The Holder who receives the option, usually a Worker.
`quantity`	`integer`	required	The Shares the option covers.
`strike`	`money`	required	The exercise price, at or above the latest fair market value.
`vesting`	`json`	required	The schedule and cliff.

Outputs

Output	Type	Required	Description
`instrument`	Instrument	required	The granted option.

Effects

Emits Instrument.granted.
Performed by the Legal Lead.
One-way: it waits out its delay window, and runs in the send and do modes.
Refuses a strike below the latest 409A fair market value.

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.	Instrument.grant
A strike below the latest 409A fair market value	`refused`	Clear what the check names, then call it again.	Instrument.grant

When it waits

Gate	Default
Decision class	Medium: one-way, bounded
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
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`.

Instrument.get

Previous Page

Instrument.list

Next Page