Commitments

Update commitment

patch/v3/commitments/{commitmentId}

Request

Base URL
https://integrators.prod.api.tabsplatform.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/tabsplatform/apis/tabs-external-api/docs/v3/commitments/:commitmentId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

commitmentIdstring required

Commitment ID

Request body

commitmentValuenumber

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' | '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.

Example request

{
  "commitmentValue": 1000,
  "commitmentStartDate": "2025-01-01",
  "commitmentEndDate": "2025-12-31",
  "isFullDuration": true,
  "commitmentInterval": "MONTHLY",
  "pricePriority": "LOW"
}

Response

Commitment updated

payloadobject 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.