Append commitment schedule

POST

https://integrators.prod.api.tabsplatform.com/v3/contracts/:id/commitments/:commitmentId/schedules

POST

/v3/contracts/:id/commitments/:commitmentId/schedules

$ curl -X POST https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/commitments/commitmentId/schedules \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "startDate": "2026-01-01",
>   "endDate": "2026-12-31",
>   "steps": [
>     {
>       "sequence": 0,
>       "commitmentValue": 1000,
>       "commitmentUnitType": "DOLLARS",
>       "pricePriority": "LOW",
>       "prepaidEnabled": false,
>       "billingTermIds": [
>         "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
>       ]
>     }
>   ]
> }'

1 {
2   "payload": {
3     "scheduleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
4     "sequence": 1,
5     "stepIds": [
6       "string"
7     ]
8   },
9   "success": true,
10   "message": "string",
11   "error": {
12     "code": 1.1,
13     "message": "string",
14     "details": {}
15   }
16 }

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Contract Id

commitmentIdstringRequired

Commitment Id

Request

This endpoint expects an object.

startDatestringRequired

Schedule start date (YYYY-MM-DD, inclusive). Must be the day after the previous schedule’s endDate on the commitment.

endDatestringRequired

Schedule end date (YYYY-MM-DD, inclusive). The last day the schedule covers.

stepslist of objectsRequired

commitmentIntervalenumOptional

Commitment period interval for the schedule

prepaymentScheduleTypeenumOptional

Prepayment schedule type

Response

Schedule appended

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

403

Forbidden Error

404

Not Found Error