Get commitment by ID

GET

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

GET

/v3/commitments/:commitmentId

$ curl https://integrators.prod.api.tabsplatform.com/v3/commitments/commitmentId \
>      -H "Authorization: <apiKey>"

1 {
2   "payload": {
3     "id": "550e8400-e29b-41d4-a716-446655440000",
4     "contractId": "550e8400-e29b-41d4-a716-446655440000",
5     "customerId": "550e8400-e29b-41d4-a716-446655440000",
6     "prepaidEnabled": false,
7     "commitmentValue": "10000.00",
8     "commitmentUnitType": "DOLLARS",
9     "eventTypesIncluded": [
10       "string",
11       "string"
12     ],
13     "currentCumulative": {
14       "amount": "150.50",
15       "units": "1000"
16     },
17     "createdAt": "2024-01-01T00:00:00.000Z",
18     "updatedAt": "2024-01-15T10:30:00.000Z",
19     "prepaidValue": "5000.00",
20     "commitmentStartDate": "2024-01-01T00:00:00.000Z",
21     "commitmentEndDate": "2024-12-31T00:00:00.000Z",
22     "commitmentPeriodInterval": "MONTHLY",
23     "commitmentCustomInterval": "3_MONTHS",
24     "nextSequentialCommitmentId": "550e8400-e29b-41d4-a716-446655440000",
25     "pricePriority": "LOW",
26     "prepaymentScheduleType": "FULL_UPFRONT",
27     "totals": {
28       "overages": "250.50",
29       "trueUps": "0.00"
30     },
31     "periods": [
32       {
33         "periodId": "550e8400-e29b-41d4-a716-446655440000",
34         "periodDate": "2024-01-01T00:00:00.000Z",
35         "amounts": {
36           "cumulative": "5000.00",
37           "remaining": "5000.00",
38           "trueUp": "0.00"
39         },
40         "eventTypes": [
41           {
42             "eventTypeId": "550e8400-e29b-41d4-a716-446655440000",
43             "cumulative": {
44               "amount": "150.50",
45               "units": "1000"
46             },
47             "overages": {
48               "amount": "150.50",
49               "units": "1000"
50             },
51             "eventTypeName": "API Calls"
52           }
53         ],
54         "createdAt": "2024-01-01T00:00:00.000Z",
55         "updatedAt": "2024-01-15T10:30:00.000Z",
56         "finalizedAt": null,
57         "lastCalculatedAt": "2024-01-15T10:30:00.000Z"
58       }
59     ],
60     "deletedAt": "string",
61     "trueUpBehavior": "DEFAULT",
62     "schedules": [
63       {
64         "id": "550e8400-e29b-41d4-a716-446655440000",
65         "sequence": 0,
66         "startDate": "2024-01-01T00:00:00.000Z",
67         "endDate": "2024-12-31T00:00:00.000Z",
68         "steps": [
69           {
70             "id": "550e8400-e29b-41d4-a716-446655440000",
71             "sequence": 0,
72             "effectiveCommitmentValue": "10000.00",
73             "effectivePrepaidValue": "5000.00",
74             "prepaidEnabled": false,
75             "commitmentUnitType": "DOLLARS",
76             "pricePriority": "LOW",
77             "billingTermIds": [
78               "string"
79             ],
80             "enteredAt": "2025-04-01T00:00:00.000Z"
81           }
82         ],
83         "commitmentInterval": "DAILY",
84         "prepaymentScheduleType": "FULL_UPFRONT"
85       }
86     ]
87   },
88   "success": true,
89   "message": "string",
90   "error": {
91     "code": 1.1,
92     "message": "string",
93     "details": {}
94   }
95 }

Authentication

Authorizationstring

API Key authentication via header

Path parameters

commitmentIdstringRequired

Commitment ID

Response

Get commitment by ID with breakdown by commitment period and overage details

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

404

Not Found Error

500

Internal Server Error