Commission programs: update

Reference for Commission, one group of Commission programs.

Commission.update

Changes the given properties of a Commission. Verb page.

Text

do: return await $.Commission.update(input)

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Commission.update({ id: 'commission_oYhMioUeCH', rate: 1 })"
  }
}