List contract billing term groups

GET

https://integrators.prod.api.tabsplatform.com/v3/contracts/:id/billing-term-groups

GET

/v3/contracts/:id/billing-term-groups

$ curl -G https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/billing-term-groups \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d page=1 \
>      -d limit=50

1 {
2   "payload": {
3     "data": [
4       {
5         "id": "a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f9a1c23",
6         "name": "Enterprise Billing Group",
7         "billingTermIds": [
8           "b7d9e8f1-2c3a-4d5e-8f7b-9a0c1d2e3f45"
9         ],
10         "performanceObligationIds": [
11           "c8e7f6a5-b4d3-2c1e-9f8a-7b6d5e4c3a21"
12         ],
13         "createdAt": "2023-11-15T09:30:00.000Z",
14         "updatedAt": "2024-04-10T16:45:00.000Z"
15       }
16     ],
17     "limit": 50,
18     "totalItems": 1,
19     "currentPage": 1
20   },
21   "success": true,
22   "message": "Billing term groups retrieved successfully",
23   "error": {
24     "code": 0,
25     "message": "",
26     "details": {}
27   }
28 }

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Contract Id

Query parameters

pagedoubleRequiredDefaults to 1

Page Number

limitdoubleRequiredDefaults to 50

Number of items to return

filterstringOptional

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

Fields: createdAt (datetime): eq, neq, gt, gte, lt, lte updatedAt (datetime): eq, neq, gt, gte, lt, lte

Date-only values (YYYY-MM-DD) match the full UTC day.

Example: filter=createdAt:gte:2026-01-01

Response

Billing term groups for the contract

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

400

Bad Request Error

404

Not Found Error

500

Internal Server Error