Skip to content

by Startups.Studio

Finance Instrument

Instrument.cancel

POST /{namespace}/instruments/{instrument}/cancel

Cancel ends an unvested, expired or forfeited Instrument and returns any option Shares to the pool.

Noun: Instrument
Mode: do
Event: Instrument.canceled

You, to your agent

Cancel the latest instrument.

curl -X POST https://api.sb/patentpad.com/instruments/instrument_1/cancel \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"unvested"}'

import { $ } from 'startup-builder'

const instrument = await $.Instrument.cancel({ instrument: 'instrument_1', reason: 'unvested' })

npx startup-builder do Instrument.cancel --json '{"instrument":"instrument_1","reason":"unvested"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Instrument.cancel({ instrument: 'instrument_1', reason: 'unvested' })"
  }
}

Inputs

Input	Type	Required	Description
`instrument`	Instrument	required	The Instrument to end.
`reason`	`string`	required	Why it ends: `unvested`, `expired` or `forfeited`.

Outputs

Output	Type	Required	Description
`instrument`	Instrument	required	The canceled Instrument, kept with its history.

Effects

Emits Instrument.canceled.
Performed by the Legal Lead.
One-way: it waits out its delay window, and runs in the send and do modes.
Returns option Shares to the unallocated pool.

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

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

Previous Page

Instrument.convert

Next Page