Commission routes: update · StartupBuilder

Reference for Commission, one group of Commission routes.

Commission.update

Changes the given properties of a Commission. Verb page.

Text

PATCH /{namespace}/commissions/{id}

Path: id. Body, as JSON: the other inputs. 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

Terminal

curl -X PATCH https://api.sb/leaseline.app/commissions/commission_oYhMioUeCH \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rate":1}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "commission": {
    "$id": "https://api.sb/leaseline.app/commissions/commission_oYhMioUeCH",
    "$type": "Commission",
    "rate": 1,
    "term": 1,
    "clawbackDays": 1
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Commission.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Commission.updateCopy Anchor Link

Commission.update