Renewals API
9 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.
| Method | Path | Description |
|---|---|---|
GET |
/api/renewals/ |
List Renewals Query: account_id, outcome, limit, offset. |
POST |
/api/renewals/ |
Create Renewal Accepts a JSON body. |
GET |
/api/renewals/at-risk |
At Risk Renewals Query: threshold. |
GET |
/api/renewals/calendar |
Renewal Calendar Query: start, end. |
GET |
/api/renewals/dashboard |
Renewal Dashboard Query: period_months. |
POST |
/api/renewals/sync |
Sync Renewals |
GET |
/api/renewals/{renewal_id} |
Get Renewal |
PATCH |
/api/renewals/{renewal_id} |
Update Renewal Accepts a JSON body. |
DELETE |
/api/renewals/{renewal_id} |
Delete Renewal |
Try it
The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.