Skip to content

by Startups.Studio

Share.issue

POST /{namespace}/shares/issue

Issue records new Shares of one class to a Holder under a board-approved Agreement, with the certificate or book entry.

Noun: Share
Mode: do
Event: Share.issued

You, to your agent

Issue the latest share with a holder and an agreement.

curl -X POST https://api.sb/kilnbakery.com/shares/issue \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"holder":"holder_1","class":"Example class","quantity":1,"price":{"amount":9,"currency":"USD"},"agreement":"agreement_1"}'

import { $ } from 'startup-builder'

const share = await $.Share.issue({ holder: 'holder_1', class: 'Example class', quantity: 1, price: { amount: 9, currency: 'USD' }, agreement: 'agreement_1' })

npx startup-builder do Share.issue --json '{"holder":"holder_1","class":"Example class","quantity":1,"price":{"amount":9,"currency":"USD"},"agreement":"agreement_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Share.issue({ holder: 'holder_1', class: 'Example class', quantity: 1, price: { amount: 9, currency: 'USD' }, agreement: 'agreement_1' })"
  }
}

Inputs

Input	Type	Required	Description
`holder`	Holder	required	The Holder who receives the Shares.
`class`	`string`	required	The share class.
`quantity`	`integer`	required	How many Shares.
`price`	`money`	required	The price paid per Share.
`agreement`	Agreement	required	The board-approved Agreement that authorizes the issue.

Outputs

Output	Type	Required	Description
`share`	Share	required	The issued Share record.

Effects

Emits Share.issued.
Performed by the Legal Lead.
One-way (money): it waits out its delay window, and runs in the send and do modes.
The cap table reads the new record from its issue date.

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.	Share.issue

When it waits

Gate	Default
Decision class	High: one-way, broad (money)
Delay window	1 business day, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The spend Limit of the Permission or Mandate 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`.

Share.get

Previous Page

Share.list

Next Page