Agreement commands: update
The Agreement Verbs update as CLI commands, with inputs, result, refusals and an example.
Reference for Agreement, one group of Agreement commands.
Agreement.update
Changes the given properties of an Agreement. Verb page.
npx startup-builder do Agreement.update --json '<input>' [--try | --send | --do]Emits Agreement.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Agreement. |
term | text | How long it runs and how it ends. | |
signedAt | datetime | When the last Party signed. | |
terminatedAt | datetime | When it ended under its term; it stays on record. | |
payoutSchedule | string | For a Supplier’s Agreement: how often the released earned balance pays out. | |
clearanceDays | integer | 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 | required | The Agreement. |
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
npx startup-builder do Agreement.update --json '{"id":