Skip to content

by Startups.Studio

Growth Deal Renewal

Renewal.update

PATCH /{namespace}/renewals/{id}

Changes the given properties of a Renewal.

Noun: Renewal
Mode: do
Event: Renewal.updated

You, to your agent

Change the latest renewal.

curl -X PATCH https://api.sb/shiftnote.app/renewals/renewal_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"termEndsAt":"2026-10-22T12:00:00Z"}'

import { $ } from 'startup-builder'

const renewal = await $.Renewal.update({ id: 'renewal_1', termEndsAt: '2026-10-22T12:00:00Z' })

npx startup-builder do Renewal.update --json '{"id":"renewal_1","termEndsAt":"2026-10-22T12:00:00Z"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Renewal.update({ id: 'renewal_1', termEndsAt: '2026-10-22T12:00:00Z' })"
  }
}

Update changes the given properties of a Renewal. It is inherited: every Noun has get, list, create, update and delete.

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.

Outputs

Output	Type	Required	Description
`renewal`	Renewal	required	The Renewal.

Effects

Emits Renewal.updated.
Two-way: try, send, do.

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.	Renewal.update

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Renewal.open

Previous Page

Demand Budget

Next Page