Skip to navigation
Commitments

Update commitment

Deprecated
View as Markdown

Partially updates an existing usage commitment. Only fields present in the request body are changed; omitted fields are left as-is.

Supports changing the commitment value’s start/end dates, whether it spans the full contract duration, its billing interval, price priority, and true-up behavior, and adding additional billing term IDs via billingTermsToAdd. Does not touch overage configuration — overage pricing is set at commitment creation time only.

Fails with a validation error if the commitment does not exist for this manufacturer or is locked (already invoiced) against the requested change.

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
Allowed values:
trueUpBehaviorenumOptional

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

Allowed values:

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

errorobjectOptional
json element with any error messages or warnings

Errors

400
Bad Request Error
404
Not Found Error