Execute a renewal

Starts executing the renewal asynchronously: the excluded billing terms are removed from the draft renewal contract, the draft is marked processed, and the renewal becomes APPROVED. Poll GET /v3/renewals/:id until the status is APPROVED. The renewal must be DRAFT and have a draft renewal contract (approve the contract to generate one). Repeat calls start only one workflow; deduped is true when an execution was already in flight, and this call's payload was not delivered to that execution.

post/v3/renewals/{id}/execute

Request

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

Path parameters

idstring required

Renewal Id

Request body

excludedBillingTermIdsstring[]

Billing term ids on the draft renewal contract to leave out of the renewal. Ids not on the current draft are ignored.

Response

The execute workflow was started

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.