# Commission routes: update

URL: /code/api/commission/records-update · Id: `page:code/api/commission/records-update`

> The Commission Verbs update as api.sb routes, with inputs, result, refusals and an example.

Reference for [Commission](/business/nouns/commission), one group of [Commission routes](/code/api/commission).

### Commission.update
Changes the given properties of a Commission. [Verb page](/business/nouns/commission/update?interface=api).

```text
PATCH /{namespace}/commissions/{id}
```

Path: `id`. Body, as JSON: the other inputs. Emits `Commission.updated`.

**Inputs**

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

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `commission` | [Commission](/business/nouns/commission) | Yes | The Commission. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
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"
  }
}
```