Renewal commands: update, delete
The Renewal Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Renewal, one group of Renewal commands.
Renewal.update
Changes the given properties of a Renewal. Verb page.
npx startup-builder do Renewal.update --json '<input>' [--try | --send | --do]Emits Renewal.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Renewal. |
value | money | What the Deal is worth if won. | |
owner | Worker | The Worker who runs it. | |
closesOn | date | The date the buyer expects to decide. | |
nextStep | text | The next dated step agreed with the buyer. | |
termEndsAt | datetime | When the current term ends, read from the Subscription. | |
openedAt | datetime | When it opened: by default 90 days before the term ends. | |
usageReview | text | Usage against each Entitlement over the term, written before any Quote. | |
noticeSentAt | datetime | When the renewal notice the legal floor requires went out, with the date, Price and cancel link. | |
saveOffer | text | The one save offer shown on cancel; it never blocks the cancel. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
renewal | Renewal | required | The Renewal. |
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 Renewal.update --json '{"id": "renewal_NrJC9bDcII", "termEndsAt": "2026-10-22T12: 00: 00Z"}'Renewal.delete
Deletes a Renewal: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Renewal.delete --json '<input>' [--try | --send | --do]Emits Renewal.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Renewal. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
renewal | Renewal | required | The Renewal. |
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 Renewal.delete --json '{"id": "renewal_NrJC9bDcII"}'