Skip to content

Renewal routes: open

The Renewal Verbs open as api.sb routes, with inputs, result, refusals and an example.

Reference for Renewal, one group of Renewal routes.

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.

Text
POST /{namespace}/renewals/open

Body, as JSON: the inputs. Emits Renewal.opened.

Inputs

InputTypeRequiredDescription
subscriptionSubscriptionrequiredThe Subscription whose term is ending.

Returns

OutputTypeRequiredDescription
renewalRenewalrequiredThe open Renewal.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/renewals/open \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subscription":"sub_whVFaHKWIV"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "renewal": {
    "$id": "https://api.sb/leaseline.app/renewals/renewal_NrJC9bDcII",
    "$type": "Renewal",
    "status": "Open",
    "termEndsAt": "2026-10-22T12:00:00Z",
    "openedAt": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Renewal.open",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}