Skip to content

Commission commands: update

The Commission Verbs update as CLI commands, with inputs, result, refusals and an example.

Reference for Commission, one group of Commission commands.

Commission.update

Changes the given properties of a Commission. Verb page.

Text
npx startup-builder do Commission.update --json '<input>' [--try | --send | --do]

Emits Commission.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Commission.
ratenumberThe share of collected revenue earned, as a percent, such as 20. Never randomized.
termintegerMonths after the first payment over which revenue earns the rate, such as 12. Never randomized.
clawbackDaysintegerDays a payment waits before it earns, so a refund inside the window earns nothing.

Returns

OutputTypeRequiredDescription
commissionCommissionrequiredThe Commission.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Commission.update --json '{"id":"commission_oYhMioUeCH","rate":1}'