Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthDealRenewal

Renewal routes: create, get, list

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

Reference for Renewal, one group of Renewal routes.

Renewal.create

Creates a Renewal. Verb page.

Text
POST /{namespace}/renewals

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

Inputs

InputTypeRequiredDescription
valuemoneyWhat the Deal is worth if won.
ownerWorkerThe Worker who runs it.
closesOndateThe date the buyer expects to decide.
nextSteptextThe next dated step agreed with the buyer.
termEndsAtdatetimerequiredWhen the current term ends, read from the Subscription.
openedAtdatetimerequiredWhen it opened: by default 90 days before the term ends.
usageReviewtextUsage against each Entitlement over the term, written before any Quote.
noticeSentAtdatetimeWhen the renewal notice the legal floor requires went out, with the date, Price and cancel link.
saveOffertextThe one save offer shown on cancel; it never blocks the cancel.
subscriptionSubscriptionEach Renewal decides one term of one Subscription; a Subscription has one Renewal per term.

Returns

OutputTypeRequiredDescription
renewalRenewalrequiredThe 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 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"termEndsAt":"2026-10-22T12:00:00Z","openedAt":"2026-10-22T12:00:00Z"}'
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.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Renewal.get

Returns one Renewal by id. Verb page.

Text
GET /{namespace}/renewals/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Renewal.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
renewalRenewalrequiredThe 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 https://api.sb/leaseline.app/renewals/renewal_NrJC9bDcII \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Renewal",
  "$id": "https://api.sb/leaseline.app/renewals/renewal_NrJC9bDcII",
  "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"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/renewals/renewal_NrJC9bDcII",
    "up": "https://api.sb/leaseline.app/renewals"
  }
}

Renewal.list

Returns Renewals, newest first, one page at a time. Verb page.

Text
GET /{namespace}/renewals

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
renewalslist of RenewalrequiredOne page of Renewals.

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 "https://api.sb/leaseline.app/renewals?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Renewal",
  "renewals": [
    {
      "$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"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "renewal_NrJC9bDcII"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/renewals?limit=20",
    "next": "https://api.sb/leaseline.app/renewals?after=renewal_NrJC9bDcII"
  }
}

Renewal

Previous

update, delete

Next