Commitments

Update commitment

View as Markdown

Authentication

Authorizationstring
API Key authentication via header

Path parameters

commitmentIdstringRequired
Commitment ID

Request

This endpoint expects an object.
commitmentValuedoubleOptional
The commitment amount value
commitmentStartDatestringOptional

Commitment start date (YYYY-MM-DD)

commitmentEndDatestringOptional

Commitment end date, inclusive (YYYY-MM-DD)

isFullDurationbooleanOptional
Whether commitment lasts the full duration
commitmentIntervalenumOptional
Commitment period interval
billingTermsToAddlist of stringsOptional
Billing term IDs to add to the commitment
pricePriorityenumOptional
Price priority when multiple products are selected
trueUpBehaviorenumOptional

True-up behavior for the commitment (commitments-v2). DEFAULT trues up unmet commitment; NEVER suppresses it.

Response

Commitment updated
payloadobject
Response payload, will be empty when success is false
successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobject
json element with any error messages or warnings

Errors

400
Bad Request Error
404
Not Found Error