Renewal methods: open
The Renewal Verbs open as typed SDK methods, with inputs, result, refusals and an example.
Reference for Renewal, one group of Renewal methods.
Renewal.open
Open starts the Renewal for a term Subscription before its term ends, with a usage review and any notice the legal floor requires. Verb page.
interface RenewalVerbs {
open(input: RenewalOpenInput, options?: SB.CallOptions): SB.Call<Renewal>
}Emits Renewal.opened.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
subscription | Subscription | required | The Subscription whose term is ending. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
renewal | Renewal | required | The open Renewal. |
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 renewal = await $.Renewal.open({ subscription: 'sub_whVFaHKWIV' })