Renewal methods: create, get, list

Reference for Renewal, one group of Renewal methods.

Renewal.create

Creates a Renewal. Verb page.

TypeScript

interface RenewalVerbs {
  create(input: RenewalCreateInput, options?: SB.CallOptions): SB.Call<Renewal>
}

Emits Renewal.created.

Inputs

Input	Type	Required	Description
`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`	required	When the current term ends, read from the Subscription.
`openedAt`	`datetime`	required	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.
`subscription`	Subscription		Each Renewal decides one term of one Subscription; a Subscription has one Renewal per term.

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

TypeScript

import { $ } from 'startup-builder'

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

Returns one Renewal by id. Verb page.

TypeScript

interface RenewalVerbs {
  get(input: RenewalGetInput, options?: SB.CallOptions): SB.Call<Renewal>
}

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Renewal.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

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

TypeScript

import { $ } from 'startup-builder'

const renewal = await $.Renewal.get({ id: 'renewal_NrJC9bDcII' })

Returns Renewals, newest first, one page at a time. Verb page.

TypeScript

interface RenewalVerbs {
  list(input?: RenewalListInput, options?: SB.CallOptions): SB.ListCall<Renewal>
}

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`renewals`	list of Renewal	required	One page of Renewals.

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

TypeScript

import { $ } from 'startup-builder'

const renewals = await $.Renewal.list({ limit: 20 })