List commitments

GET

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

GET

/v3/commitments

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

1 {
2   "payload": {
3     "data": [
4       {
5         "id": "550e8400-e29b-41d4-a716-446655440000",
6         "contractId": "550e8400-e29b-41d4-a716-446655440000",
7         "customerId": "550e8400-e29b-41d4-a716-446655440000",
8         "prepaidEnabled": false,
9         "prepaidValue": "5000.00",
10         "commitmentValue": "10000.00",
11         "commitmentUnitType": "DOLLARS",
12         "commitmentStartDate": "2024-01-01T00:00:00.000Z",
13         "commitmentEndDate": "2024-12-31T00:00:00.000Z",
14         "commitmentPeriodInterval": "MONTHLY",
15         "commitmentCustomInterval": "3_MONTHS",
16         "nextSequentialCommitmentId": "550e8400-e29b-41d4-a716-446655440000",
17         "pricePriority": "LOW",
18         "prepaymentScheduleType": "FULL_UPFRONT",
19         "eventTypesIncluded": [
20           "string",
21           "string"
22         ],
23         "currentCumulative": {
24           "amount": "150.50",
25           "units": "1000"
26         },
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                 "eventTypeName": "API Calls",
44                 "cumulative": {
45                   "amount": "150.50",
46                   "units": "1000"
47                 },
48                 "overages": {
49                   "amount": "150.50",
50                   "units": "1000"
51                 }
52               }
53             ],
54             "finalizedAt": null,
55             "lastCalculatedAt": "2024-01-15T10:30:00.000Z",
56             "createdAt": "2024-01-01T00:00:00.000Z",
57             "updatedAt": "2024-01-15T10:30:00.000Z"
58           }
59         ],
60         "createdAt": "2024-01-01T00:00:00.000Z",
61         "updatedAt": "2024-01-15T10:30:00.000Z",
62         "deletedAt": "string",
63         "trueUpBehavior": "DEFAULT",
64         "schedules": [
65           {
66             "id": "550e8400-e29b-41d4-a716-446655440000",
67             "sequence": 0,
68             "startDate": "2024-01-01T00:00:00.000Z",
69             "endDate": "2024-12-31T00:00:00.000Z",
70             "commitmentInterval": "DAILY",
71             "prepaymentScheduleType": "FULL_UPFRONT",
72             "steps": [
73               {
74                 "id": "550e8400-e29b-41d4-a716-446655440000",
75                 "sequence": 0,
76                 "effectiveCommitmentValue": "10000.00",
77                 "effectivePrepaidValue": "5000.00",
78                 "prepaidEnabled": false,
79                 "commitmentUnitType": "DOLLARS",
80                 "pricePriority": "LOW",
81                 "billingTermIds": [
82                   "string"
83                 ],
84                 "enteredAt": "2025-04-01T00:00:00.000Z"
85               }
86             ]
87           }
88         ]
89       }
90     ],
91     "limit": 1.1,
92     "totalItems": 1.1,
93     "currentPage": 1.1
94   },
95   "success": true,
96   "message": "string",
97   "error": {
98     "code": 1.1,
99     "message": "string",
100     "details": {}
101   }
102 }

Authentication

Authorizationstring

API Key authentication via header

Query parameters

pagedoubleOptionalDefaults to 1

Page Number

limitdoubleOptionalDefaults to 50

Number of items to return

filterstringOptional

Format: field:rule:value — comma-separated for multiple filters.

Fields: customerId (uuid): eq, neq, in, nin, isnull, isnotnull contractId (uuid): eq, neq, in, nin, isnull, isnotnull

Example: filter=customerId:eq:00000000-0000-0000-0000-000000000001

Response

Get all commitments with optional customer and contract filtering

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobject

json element with any error messages or warnings

Errors

500

Internal Server Error