contracts

Append commitment step

post/v3/contracts/{id}/commitments/{commitmentId}/steps

Request

Base URL: https://integrators.prod.api.tabsplatform.com
URL: https://integrators.prod.api.tabsplatform.com/v3/contracts/{id}/commitments/{commitmentId}/steps
Auth: API key in header Authorization

idstring required

Contract Id

commitmentIdstring required

Commitment Id

scheduleIdstring required

Schedule on the parent commitment that the new step is being appended to

commitmentValuenumber double required

Commitment amount value for the new step

commitmentUnitType'DOLLARS' | 'UNITS' required

Unit type for the commitment value

pricePriority'LOW' | 'HIGH' required

Price priority for the step

prepaidEnabledboolean required

Whether prepaid is enabled for the new step

prepaidValuenumber double

Prepaid amount for the new step (when prepaid is enabled)

billingTermIdsstring[] required

Base usage billing term IDs to link to the new step

Step appended

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

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