# Agreement methods: update

URL: /code/sdk/agreement/records-update · Id: `page:code/sdk/agreement/records-update`

> The Agreement Verbs update as typed SDK methods, with inputs, result, refusals and an example.

Reference for [Agreement](/business/nouns/agreement), one group of [Agreement methods](/code/sdk/agreement).

### Agreement.update
Changes the given properties of an Agreement. [Verb page](/business/nouns/agreement/update?interface=sdk).

```ts
interface AgreementVerbs {
  update(input: AgreementUpdateInput, options?: SB.CallOptions): SB.Call<Agreement>
}
```

Emits `Agreement.updated`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Agreement. |
| `term` | `text` | No | How long it runs and how it ends. |
| `signedAt` | `datetime` | No | When the last Party signed. |
| `terminatedAt` | `datetime` | No | When it ended under its term; it stays on record. |
| `payoutSchedule` | `string` | No | For a Supplier’s Agreement: how often the released earned balance pays out. |
| `clearanceDays` | `integer` | No | For a Supplier’s Agreement: days an Order’s earnings wait after confirmation before they can pay out. |

**Returns**

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

**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**

```ts
import { $ } from 'startup-builder'

const agreement = await $.Agreement.update({ id: 'agreement_zHIUnX8LwY', signedAt: '2026-10-22T12:00:00Z' })
```