v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Renewals

List renewals

get/v3/renewals

Query parameters

pagenumber required

Page Number

limitnumber required

Number of items to return

filterstring

Format: field:rule:value — comma-separated for multiple filters.

Fields: contractId (uuid): eq, neq, in, nin, isnull, isnotnull type (string): eq, neq, like, nlike, in, nin, isnull, isnotnull status (string): eq, neq, like, nlike, in, nin, isnull, isnotnull contractEndDate (datetime): eq, neq, gt, gte, lt, lte

Date-only values (YYYY-MM-DD) match the full UTC day.

Example: filter=contractId:eq:00000000-0000-0000-0000-000000000001

Response

Get all Renewals by filter

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "data": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "contractId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "AUTOMATIC",
        "status": "DRAFT",
        "noticePeriod": 30,
        "noticePeriodUnits": "DAY",
        "renewalLength": 12,
        "renewalLengthUnits": "MONTH",
        "maxNumberOfRenewals": 3,
        "sameConditions": true,
        "priceIncrease": 5.5,
        "priceIncreaseUnits": "PERCENT",
        "recurringPeriod": 12,
        "recurringPeriodUnits": "MONTH",
        "escalatorConditions": "Based on CPI",
        "renewalCriteria": "Performance metrics",
        "renewalCriteriaDetails": "Must meet 95% SLA",
        "termEndDate": "2024-12-31",
        "escalatorClauseSummary": "Annual increase",
        "summary": "Automatic renewal with 30 day notice"
      }
    ]
  }
}