Skip to content

by Startups.Studio

Finance Subscription

Subscription.pause

POST /{namespace}/subscriptions/{subscription}/pause

Pause stops billing and Entitlements on a Subscription until a date, without ending it.

Noun: Subscription
Mode: do
Event: Subscription.paused

You, to your agent

Pause the latest subscription.

curl -X POST https://api.sb/patentpad.com/subscriptions/subscription_1/pause \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"until":"2026-10-22"}'

import { $ } from 'startup-builder'

const subscription = await $.Subscription.pause({ subscription: 'subscription_1', until: '2026-10-22' })

npx startup-builder do Subscription.pause --json '{"subscription":"subscription_1","until":"2026-10-22"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Subscription.pause({ subscription: 'subscription_1', until: '2026-10-22' })"
  }
}

Inputs

Input	Type	Required	Description
`subscription`	Subscription	required	The active Subscription.
`until`	`date`	required	When billing resumes on its own.

Outputs

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

Effects

Emits Subscription.paused.
Performed by the Billing Specialist.
Two-way: it runs at once, in the try, send and do modes.
Moves the next renewal and the term end by the paused days.

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.pause

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.list

Previous Page

Subscription.renew

Next Page