> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.tabs.com/api-reference/contracts/integrators-api-contractsv-3-controller-append-commitment-step/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.tabs.com/_mcp/server. # Append commitment step POST https://integrators.prod.api.tabsplatform.com/v3/contracts/{id}/commitments/{commitmentId}/steps Content-Type: application/json Reference: https://docs.tabs.com/api-reference/contracts/integrators-api-contractsv-3-controller-append-commitment-step ## Authentication - `Authorization` header (required) — API Key authentication via header ## Request ### Path parameters - `id` (string, required) — Contract Id - `commitmentId` (string, required) — Commitment Id ### Body (application/json) This endpoint expects an AppendUsageCommitmentStepV3RequestDto. - `scheduleId` (string, required) — Schedule on the parent commitment that the new step is being appended to - `commitmentValue` (double, required) — Commitment amount value for the new step - `commitmentUnitType` (enum, required) — Unit type for the commitment value - Allowed values: `DOLLARS`, `UNITS` - `pricePriority` (enum, required) — Price priority for the step - Allowed values: `LOW`, `HIGH` - `prepaidEnabled` (boolean, required) — Whether prepaid is enabled for the new step - `billingTermIds` (list of string, required) — Base usage billing term IDs to link to the new step - `prepaidValue` (double, optional) — Prepaid amount for the new step (when prepaid is enabled) - `overageBillingTerms` (list of AppendUsageCommitmentStepOverageBTV3Dto, optional) — Per-base-BT overage config; omit if the new step has no overage - `containerConfig` (AppendUsageCommitmentStepContainerConfigV3Dto, optional) — Optional naming + ERP item ID overrides for prepaid and true-up container BTs ## Response ### 201 Step appended - `payload` (AppendUsageCommitmentStepV3ResponseDto, required) — Response payload, will be empty when success is false - `success` (boolean, required) — Boolean with true=success, false=failure - `message` (string, required) — Plain-text description of the result - `error` (IntegratorsApiError, optional) — json element with any error messages or warnings ## Errors ### 400 Bad Request Error Schedule does not belong to commitment, or event-type set mismatch - `any` ### 403 Forbidden Error Commitments v2 is not enabled for this manufacturer - `any` ### 404 Not Found Error Commitment not found - `any` ## Types ### AppendUsageCommitmentStepOverageBTV3Dto - `usageBillingTermId` (string, required) — Existing base usage BT whose overflow this overage covers - `overageName` (string, optional) — Display name for the overage BT line item - `overageItemId` (string, optional) — ERP item ID for the overage BT line item - `overagePricings` (list of AppendUsageCommitmentStepOveragePricingItemV3Dto, optional) — Overage pricing tiers applied when usage exceeds the step's commitment. Send a single-entry array for flat overage; multiple entries describe tiered overage. - `tierPricingType` (enum, optional) — How tiered overage pricing is applied. USE_ALL_TIER_PRICES (graduated) charges each tier's rate for the portion of usage within it; USE_TOP_TIER_PRICE_ONLY (volume) charges the single rate of the tier the total usage falls into. Defaults to graduated for backwards compatibility. Ignored for flat (single-pricing) overage. - Allowed values: `USE_TOP_TIER_PRICE_ONLY`, `USE_ALL_TIER_PRICES` ### AppendUsageCommitmentStepContainerConfigV3Dto - `prepaidName` (string, optional) — Display name for the prepaid container BT - `trueUpName` (string, optional) — Display name for the true-up container BT - `prepaidItemId` (string, optional) — ERP item ID for the prepaid container BT - `trueUpItemId` (string, optional) — ERP item ID for the true-up container BT ### AppendUsageCommitmentStepV3ResponseDto - `stepId` (string, required) — ID of the newly created step - `sequence` (double, required) — Server-assigned sequence number for the new step ### IntegratorsApiError - `code` (double, required) — API response code - `message` (string, required) — API response message - `details` (IntegratorsApiErrorDetails, optional) — Additional details about the error ### AppendUsageCommitmentStepOveragePricingItemV3Dto - `name` (string, optional) — Pricing name shown on invoice line items - `mantissa` (string, optional) — Mantissa for the overage price - `exponent` (string, optional) — Exponent for the overage price - `currency` (enum, optional) — ISO 4217 currency code - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BOV`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHE`, `CHF`, `CHW`, `CLF`, `CLP`, `CNY`, `COP`, `COU`, `CRC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MXV`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLE`, `SOS`, `SRD`, `SSP`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `USN`, `UYI`, `UYU`, `UYW`, `UZS`, `VED`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XBA`, `XBB`, `XBC`, `XBD`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `XSU`, `XTS`, `XUA`, `XXX`, `YER`, `ZAR`, `ZMW`, `ZWG`, `ZWL` - `tier` (double, optional) — Tier number (defaults to 0; relevant for tiered overage) - `conditionValue` (double, optional) — Numeric tier threshold; the price applies when usage crosses this value. Defaults to 0. Distinct from conditionOperator. ### IntegratorsApiErrorDetails Additional details about the error ## Examples **Request** ```json { "scheduleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "commitmentValue": 1000, "commitmentUnitType": "DOLLARS", "pricePriority": "LOW", "prepaidEnabled": false, "billingTermIds": [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ] } ``` **Response** ```json { "payload": { "stepId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "sequence": 2 }, "success": true, "message": "string", "error": { "code": 1.1, "message": "string", "details": {} } } ``` **SDK Code** ```python import requests url = "https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/commitments/commitmentId/steps" payload = { "scheduleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "commitmentValue": 1000, "commitmentUnitType": "DOLLARS", "pricePriority": "LOW", "prepaidEnabled": False, "billingTermIds": ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"] } headers = { "Authorization": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/commitments/commitmentId/steps'; const options = { method: 'POST', headers: {Authorization: '', 'Content-Type': 'application/json'}, body: '{"scheduleId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","commitmentValue":1000,"commitmentUnitType":"DOLLARS","pricePriority":"LOW","prepaidEnabled":false,"billingTermIds":["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/commitments/commitmentId/steps" payload := strings.NewReader("{\n \"scheduleId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"commitmentValue\": 1000,\n \"commitmentUnitType\": \"DOLLARS\",\n \"pricePriority\": \"LOW\",\n \"prepaidEnabled\": false,\n \"billingTermIds\": [\n \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n ]\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/commitments/commitmentId/steps") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"scheduleId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"commitmentValue\": 1000,\n \"commitmentUnitType\": \"DOLLARS\",\n \"pricePriority\": \"LOW\",\n \"prepaidEnabled\": false,\n \"billingTermIds\": [\n \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/commitments/commitmentId/steps") .header("Authorization", "") .header("Content-Type", "application/json") .body("{\n \"scheduleId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"commitmentValue\": 1000,\n \"commitmentUnitType\": \"DOLLARS\",\n \"pricePriority\": \"LOW\",\n \"prepaidEnabled\": false,\n \"billingTermIds\": [\n \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n ]\n}") .asString(); ``` ```php request('POST', 'https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/commitments/commitmentId/steps', [ 'body' => '{ "scheduleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "commitmentValue": 1000, "commitmentUnitType": "DOLLARS", "pricePriority": "LOW", "prepaidEnabled": false, "billingTermIds": [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ] }', 'headers' => [ 'Authorization' => '', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/commitments/commitmentId/steps"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"scheduleId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"commitmentValue\": 1000,\n \"commitmentUnitType\": \"DOLLARS\",\n \"pricePriority\": \"LOW\",\n \"prepaidEnabled\": false,\n \"billingTermIds\": [\n \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "", "Content-Type": "application/json" ] let parameters = [ "scheduleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "commitmentValue": 1000, "commitmentUnitType": "DOLLARS", "pricePriority": "LOW", "prepaidEnabled": false, "billingTermIds": ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/commitments/commitmentId/steps")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```