Api referenceRenewals

Get upcoming renewals

List policies with renewals coming up within the specified number of days.

Query Parameters

days?integer

Number of days to look ahead (default: 30)

Default30

Response Body

`application/json`

curl -X GET "https://example.com/api/renewal/upcoming"

[
  {
    "id": "string",
    "organizationId": "string",
    "contractId": "string",
    "policyReference": "string",
    "name": "string",
    "ratePerNight": 0,
    "currency": "string",
    "termStart": "2019-08-24",
    "termEnd": "2019-08-24",
    "autoRenew": true,
    "status": "PENDING",
    "currentRenewalId": "string",
    "renewalCount": 0
  }
]

Get renewal history GET

Retrieve the full renewal history for a specific policy.

Trigger renewal processing POST

Manually trigger the renewal processing job. Processes all policies due for renewal.