Commission methods: update
The Commission Verbs update as typed SDK methods, with inputs, result, refusals and an example.
Reference for Commission, one group of Commission methods.
Commission.update
Changes the given properties of a Commission. Verb page.
interface CommissionVerbs {
update(input: CommissionUpdateInput, options?: SB.CallOptions): SB.Call<Commission>
}Emits Commission.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Commission. |
rate | number | The share of collected revenue earned, as a percent, such as 20. Never randomized. | |
term | integer | Months after the first payment over which revenue earns the rate, such as 12. Never randomized. | |
clawbackDays | integer | Days a payment waits before it earns, so a refund inside the window earns nothing. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
commission | Commission | required | The Commission. |
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. | None. |
Example
import { $ } from 'startup-builder'
const commission = await $.Commission.update({ id: 'commission_oYhMioUeCH', rate: 1 })