List billing terms

GET

https://integrators.prod.api.tabsplatform.com/v3/billing-terms

GET

/v3/billing-terms

$ curl -G https://integrators.prod.api.tabsplatform.com/v3/billing-terms \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d page=1 \
>      -d limit=50

200Retrieved

1 {
2   "payload": {
3     "data": [
4       {
5         "billingTermId": "a3f1c9e2-4b7d-4f9a-9c3e-2d5f7a8b9c01",
6         "contractId": "d2e4f6a8-9b7c-4d3e-8f1a-0b2c3d4e5f67",
7         "name": "Standard Monthly Subscription",
8         "description": "Monthly subscription billing term for SaaS product",
9         "itemId": "e7f8a9b0-c1d2-3e4f-5a6b-7c8d9e0f1a2b",
10         "productId": "f1a2b3c4-d5e6-7f89-0a1b-2c3d4e5f6789",
11         "billingStartDate": "2023-01-01T00:00:00Z",
12         "billingEndDate": "2023-12-31T23:59:59Z",
13         "terminatedAt": null,
14         "quantity": 1,
15         "currentSeatCount": 25,
16         "duration": 12,
17         "intervalFrequency": 1,
18         "interval": "MONTH",
19         "invoiceDateStrategy": "FIRST_OF_PERIOD",
20         "netPaymentTerms": 30,
21         "billingType": "FLAT",
22         "pricingType": "SIMPLE",
23         "isRecurring": true,
24         "includeInArr": true,
25         "isArrears": true,
26         "eventTypeId": "b4c3d2e1-f0a9-8765-4321-0fedcba98765",
27         "eventTypeName": "API Calls",
28         "classId": "c1d2e3f4-a5b6-7890-cdef-1234567890ab",
29         "departmentId": "d4e5f6a7-b8c9-0123-4567-89abcdef0123",
30         "projectId": "e8f9a0b1-c2d3-4567-89ab-cdef01234567",
31         "pricing": [
32           {
33             "tier": 1,
34             "amount": 120000,
35             "amountType": "TOTAL_INVOICE",
36             "tierMinimum": 0
37           }
38         ],
39         "billingTermGroupId": "f0e1d2c3-b4a5-6789-0abc-def123456789",
40         "commitmentId": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
41         "commitmentBillingTermType": "Standard Commitment",
42         "discounts": [
43           {
44             "type": "PERCENTAGE",
45             "amount": "0.10",
46             "note": "Partner discount"
47           },
48           {
49             "type": "FIXED",
50             "amount": "100",
51             "note": "Early payment discount"
52           }
53         ]
54       }
55     ],
56     "limit": 50,
57     "totalItems": 125,
58     "currentPage": 1
59   },
60   "success": true,
61   "message": "Billing terms retrieved successfully",
62   "error": {
63     "code": 0,
64     "message": "",
65     "details": {}
66   }
67 }

Authentication

Authorizationstring

API Key authentication via header

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: contractId (uuid): eq, neq, in, nin, isnull, isnotnull customerId (uuid): eq, neq, in, nin, isnull, isnotnull startDate (datetime): eq, neq, gt, gte, lt, lte endDate (datetime): eq, neq, gt, gte, lt, lte billingTermGroupId (uuid): eq, neq, in, nin, isnull, isnotnull productId (uuid): eq, neq, in, nin, isnull, isnotnull

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

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

Format: field:rule:value — comma-separated for multiple filters. Fields: contractId (uuid): eq, neq, in, nin, isnull, isnotnull customerId (uuid): eq, neq, in, nin, isnull, isnotnull startDate (datetime): eq, neq, gt, gte, lt, lte endDate (datetime): eq, neq, gt, gte, lt, lte billingTermGroupId (uuid): eq, neq, in, nin, isnull, isnotnull productId (uuid): eq, neq, in, nin, isnull, isnotnull Date-only values (YYYY-MM-DD) match the full UTC day. Example: filter=contractId:eq:00000000-0000-0000-0000-000000000001

Response

Get all Billing Terms by filter

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