Skip to content

by Startups.Studio

Finance Subscription

Subscription.resize

POST /{namespace}/subscriptions/{subscription}/resize

Resize changes how many units a Subscription holds and prorates the current period.

Noun: Subscription
Mode: do
Event: Subscription.resized

You, to your agent

Resize the latest subscription.

curl -X POST https://api.sb/ledgerlark.com/subscriptions/subscription_1/resize \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"quantity":1}'

import { $ } from 'startup-builder'

const subscription = await $.Subscription.resize({ subscription: 'subscription_1', quantity: 1 })

npx startup-builder do Subscription.resize --json '{"subscription":"subscription_1","quantity":1}'

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

Inputs

Input	Type	Required	Description
`subscription`	Subscription	required	The Subscription to change.
`quantity`	`integer`	required	The new unit count.

Outputs

Output	Type	Required	Description
`subscription`	Subscription	required	The Subscription at its new quantity.

Effects

Emits Subscription.resized.
Performed by the Billing Specialist.
Two-way: it runs at once, in the try, send and do modes.
Bills or credits the prorated difference at once.
A lower quantity takes effect at the next period.

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

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

Previous Page

Subscription.resume

Next Page