v1
latestOpenAPI 3.0.02026-07-24102143224.1 KBCommitments
Create commitments
post/v3/commitments
Request body
Example request
{
"contractId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"commitments": [
{
"commitmentValue": 1000,
"commitmentUnitType": "DOLLARS",
"prepaidEnabled": true,
"prepaidValue": 500,
"prepaymentInvoiceLineName": "Prepayment",
"prepaymentIntegrationItem": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"revenueRecognitionPattern": "straight-line",
"trueUpName": "True up",
"trueUpIntegrationItem": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"billingTermIds": [
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
],
"commitmentStartDate": "2025-01-01",
"commitmentEndDate": "2025-12-31",
"isFullDuration": true,
"commitmentInterval": "MONTHLY",
"previousCommitmentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"prePaidWholeCommitment": true,
"prepaymentScheduleType": "FULL_UPFRONT",
"pricePriority": "LOW",
"overageConfigs": [
{
"billingTermId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"overagePrice": 1.5,
"overageInvoiceLineName": "Overage",
"overageIntegrationItemId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"overagePricings": [
{
"name": "Overage tier 1",
"mantissa": "0",
"exponent": "0",
"currency": "USD"
}
]
}
],
"schedules": [
{
"startDate": "2025-01-01",
"endDate": "2025-06-30",
"commitmentInterval": "MONTHLY",
"steps": [
{
"commitmentValue": 1000,
"commitmentUnitType": "DOLLARS",
"prepaidValue": 500,
"pricePriority": "LOW",
"billingTermIds": [
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
],
"enteredAt": "2025-04-01"
}
]
}
]
}
]
}Response
Usage commitments created successfully