Skip to content

by Startups.Studio

Finance Subscription

Subscription.update

PATCH /{namespace}/subscriptions/{id}

Changes the given properties of a Subscription.

Noun: Subscription
Mode: do
Event: Subscription.updated

You, to your agent

Change the latest subscription.

curl -X PATCH https://api.sb/quietcopy.com/subscriptions/subscription_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"renewsAt":"2026-10-22T12:00:00Z"}'

import { $ } from 'startup-builder'

const subscription = await $.Subscription.update({ id: 'subscription_1', renewsAt: '2026-10-22T12:00:00Z' })

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

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

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

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.

Outputs

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

Effects

Emits Subscription.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.	Subscription.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`.

Subscription.unsubscribe

Previous Page

Transaction

Next Page