Subscription methods: update

Subscription.update

Changes the given properties of a Subscription. Verb page.

TypeScript

interface SubscriptionVerbs {
  update(input: SubscriptionUpdateInput, options?: SB.CallOptions): SB.Call<Subscription>
}

Emits Subscription.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Subscription.
`renewsAt`	`datetime`		When it next renews.
`quantity`	`integer`		How many units of the Offer’s Price it holds, such as 12 members; 1 by default.
`trialEndsAt`	`datetime`		When a trial ends and the first paid period starts.
`termEndsAt`	`datetime`		When a committed term ends; the Renewal and the renewal notice read it.

Returns

Output	Type	Required	Description
`subscription`	Subscription	required	The Subscription.

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 subscription = await $.Subscription.update({ id: 'sub_whVFaHKWIV', renewsAt: '2026-10-22T12:00:00Z' })