Skip to content

by Startups.Studio

Finance Commission

Commission.create

POST /{namespace}/commissions

Creates a Commission.

Noun: Commission
Mode: do
Event: Commission.created

You, to your agent

Add a commission to ShiftNote.

curl -X POST https://api.sb/shiftnote.app/commissions \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rate":1,"term":1,"clawbackDays":1}'

import { $ } from 'startup-builder'

const commission = await $.Commission.create({ rate: 1, term: 1, clawbackDays: 1 })

npx startup-builder do Commission.create --json '{"rate":1,"term":1,"clawbackDays":1}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Commission.create({ rate: 1, term: 1, clawbackDays: 1 })"
  }
}

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

Inputs

Input	Type	Required	Description
`rate`	`number`	required	The share of collected revenue earned, as a percent, such as 20. Never randomized.
`term`	`integer`	required	Months after the first payment over which revenue earns the rate, such as 12. Never randomized.
`clawbackDays`	`integer`	required	Days a payment waits before it earns, so a refund inside the window earns nothing.

Outputs

Output	Type	Required	Description
`commission`	Commission	required	The Commission.

Effects

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

Commission

Previous Page

Commission.get

Next Page