renewals

Update a renewal

Updates the renewal's terms. Omit a field to leave it unchanged, or send null to clear it. Only DRAFT renewals can be updated. If the renewal has a draft renewal contract, it is regenerated from the updated terms, so draftContractId changes — read the draft's billing terms after your last update if you plan to exclude any on execute.

patch/v3/renewals/{id}

Request

  • Base URL: https://integrators.prod.api.tabsplatform.com
  • URL: https://integrators.prod.api.tabsplatform.com/v3/renewals/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

Renewal Id

Request body

type'MUTUAL' | 'AUTOMATIC' | 'UNILATERAL'
noticePeriodnumber double nullable
noticePeriodUnits'DAY' | 'MONTH' | 'YEAR'
renewalLengthnumber double nullable
renewalLengthUnits'DAY' | 'MONTH' | 'YEAR'
maxNumberOfRenewalsnumber double nullable

Use -1 for unlimited renewals

sameConditionsboolean nullable
priceIncreasenumber double nullable
priceIncreaseUnits'PERCENT' | 'DOLLAR'
recurringPeriodnumber double nullable
recurringPeriodUnits'DAY' | 'MONTH' | 'YEAR'
escalatorConditionsstring nullable
renewalCriteriastring nullable
renewalCriteriaDetailsstring nullable
termEndDatestring nullable

Response

The updated renewal

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Changes

No recorded changes to this operation across all 1 revision of this API.