Cancel a renewal

POST

https://integrators.prod.api.tabsplatform.com/v3/renewals/:id/cancel

POST

/v3/renewals/:id/cancel

curl -X POST https://integrators.prod.api.tabsplatform.com/v3/renewals/123e4567-e89b-12d3-a456-426614174000/cancel \
     -H "Authorization: <apiKey>"

{
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "contractId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "DRAFT",
    "draftContractId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "AUTOMATIC",
    "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",
    "quotes": "string"
  },
  "success": true,
  "message": "string",
  "error": {
    "code": 1.1,
    "message": "string",
    "details": {}
  }
}

Deletes the draft renewal contract, if any, and sets the renewal to DECLINED.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Renewal Id

Response

The cancelled renewal

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobjectOptional

json element with any error messages or warnings

Errors

400

Bad Request Error

404

Not Found Error