Subscription methods: keep, pause, renew, resize
The Subscription Verbs keep, pause, renew, resize as typed SDK methods, with inputs, result, refusals and an example.
Reference for Subscription, one group of Subscription methods.
Subscription.keep
Keep takes back a cancel before the period closes, so the Subscription renews on its date at the same terms. Verb page.
interface SubscriptionVerbs {
keep(input: SubscriptionKeepInput, options?: SB.CallOptions): SB.Call<Subscription>
}Emits Subscription.kept.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
subscription | Subscription | required | The ending Subscription. |
offer | Offer | The Offer to renew on, when the Customer took the save offer. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
subscription | Subscription | required | The Subscription, active again. |
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. | None. |
| Once the period has closed; a canceled Subscription starts again as a new one | refused | Clear what the check names, then call it again. | None. |
Example
import { $ } from 'startup-builder'
const subscription = await $.Subscription.keep({ subscription: 'sub_whVFaHKWIV' })Subscription.pause
Pause stops billing and Entitlements on a Subscription until a date, without ending it. Verb page.
interface SubscriptionVerbs {
pause(input: SubscriptionPauseInput, options?: SB.CallOptions): SB.Call<Subscription>
}Emits Subscription.paused.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
subscription | Subscription | required | The active Subscription. |
until | date | required | When billing resumes on its own. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
subscription | Subscription | required | The paused Subscription. |
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. | None. |
Example
import { $ } from 'startup-builder'
const subscription = await $.Subscription.pause({ subscription: 'sub_whVFaHKWIV', until: '2026-10-22' })Subscription.renew
Renew starts a Subscription’s next period and bills it at the Offer Version the Customer accepted. Verb page.
interface SubscriptionVerbs {
renew(input: SubscriptionRenewInput, options?: SB.CallOptions): SB.Call<SubscriptionRenewOutput>
}Emits Subscription.renewed.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
subscription | Subscription | required | The Subscription to renew. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
invoice | Invoice | required | The Invoice for the new period. |
subscription | Subscription | required | The Subscription in its new period. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The operation is part of an Offer the caller has not accepted or paid for. | payment-required | Accept the Offer named in the response, then retry the call. | Offer.accept |
| 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. | None. |
Example
import { $ } from 'startup-builder'
const { invoice, subscription } = await $.Subscription.renew({ subscription: 'sub_zgJUx08kwY' })Subscription.resize
Resize changes how many units a Subscription holds and prorates the current period. Verb page.
interface SubscriptionVerbs {
resize(input: SubscriptionResizeInput, options?: SB.CallOptions): SB.Call<Subscription>
}Emits Subscription.resized.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
subscription | Subscription | required | The Subscription to change. |
quantity | integer | required | The new unit count. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
subscription | Subscription | required | The Subscription at its new quantity. |
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. | None. |
Example
import { $ } from 'startup-builder'
const subscription = await $.Subscription.resize({ subscription: 'sub_whVFaHKWIV', quantity: 1 })