renewals

Create a renewal for a contract

Creates a DRAFT renewal for a processed contract. All terms are optional. A contract can have at most one renewal.

post/v3/contracts/{contractId}/renewal

Request

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

Path parameters

contractIdstring required

Contract 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 created 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.