commitments

Update commitment

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.

patch/v3/commitments/{commitmentId}

Request

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

Path parameters

commitmentIdstring required

Commitment ID

Request body

commitmentValuenumber double

The commitment amount value

commitmentStartDatestring

Commitment start date (YYYY-MM-DD)

commitmentEndDatestring

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

isFullDurationboolean

Whether commitment lasts the full duration

commitmentInterval'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'YEARLY'

Commitment period interval

billingTermsToAddstring[]

Billing term IDs to add to the commitment

pricePriority'LOW' | 'HIGH'

Price priority when multiple products are selected

trueUpBehavior'DEFAULT' | 'NEVER'

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

Response

Commitment updated

payloadIntegratorsApiResponsePayload required

Response payload, will be empty when success is false

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.