Skip to content

by Startups.Studio

Finance Subscription

Subscription.resume

POST /{namespace}/subscriptions/{subscription}/resume

Resume restarts billing and Entitlements on a paused Subscription before its pause ends.

Noun: Subscription
Mode: do
Event: Subscription.resumed

You, to your agent

Resume the latest subscription.

curl -X POST https://api.sb/kilnbakery.com/subscriptions/subscription_1/resume \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const subscription = await $.Subscription.resume({ subscription: 'subscription_1' })

npx startup-builder do Subscription.resume --json '{"subscription":"subscription_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Subscription.resume({ subscription: 'subscription_1' })"
  }
}

Inputs

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

Outputs

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

Effects

Emits Subscription.resumed.
Performed by the Billing Specialist.
Two-way: it runs at once, in the try, send and do modes.

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

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

Previous Page

Subscription.switch

Next Page