Skip to content

Subscription commands: update

The Subscription Verbs update as CLI commands, with inputs, result, refusals and an example.

Reference for Subscription, one group of Subscription commands.

Subscription.update

Changes the given properties of a Subscription. Verb page.

Text
npx startup-builder do Subscription.update --json '<input>' [--try | --send | --do]

Emits Subscription.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Subscription.
renewsAtdatetimeWhen it next renews.
quantityintegerHow many units of the Offer’s Price it holds, such as 12 members; 1 by default.
trialEndsAtdatetimeWhen a trial ends and the first paid period starts.
termEndsAtdatetimeWhen a committed term ends; the Renewal and the renewal notice read it.

Returns

OutputTypeRequiredDescription
subscriptionSubscriptionrequiredThe Subscription.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Subscription.update --json '{"id":"sub_whVFaHKWIV","renewsAt":"2026-10-22T12:00:00Z"}'