List contract billing terms

GET

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

GET

/v3/contracts/:id/billing-terms

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

1 {
2   "payload": {
3     "data": [
4       {
5         "billingTermId": "a3f1c9d2-4b7e-4f9a-9c3d-2e5f7a8b9c01",
6         "contractId": "123e4567-e89b-12d3-a456-426614174000",
7         "name": "Standard Monthly Subscription",
8         "description": "Monthly subscription fee for standard service package",
9         "itemId": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70",
10         "productId": "f1e2d3c4-b5a6-7890-1234-56789abcdef0",
11         "billingStartDate": "2023-01-01",
12         "billingEndDate": "2023-12-31",
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": "b2c3d4e5-f6a7-8901-2345-6789abcdef01",
27         "eventTypeName": "API Calls",
28         "classId": "c1d2e3f4-a5b6-7890-1234-56789abcdef2",
29         "departmentId": "d3e4f5a6-b7c8-9012-3456-789abcdef345",
30         "projectId": "e4f5a6b7-c8d9-0123-4567-89abcdef4567",
31         "pricing": [
32           {
33             "tier": 1,
34             "amount": 120000,
35             "amountType": "TOTAL_INVOICE",
36             "tierMinimum": 0
37           }
38         ],
39         "billingTermGroupId": "f5a6b7c8-d9e0-1234-5678-9abcdef56789",
40         "commitmentId": "a6b7c8d9-e012-3456-789a-bcdef6789abc",
41         "commitmentBillingTermType": "Annual 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": 1,
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

Path parameters

idstringRequired

Contract Id

Query parameters

billingTermGroupIdstringOptional

Optional billing term group (BTG) ID to filter by

pagedoubleRequiredDefaults to 1

Page Number

limitdoubleRequiredDefaults to 50

Number of items to return

Response

Billing terms 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

404

Not Found Error

500

Internal Server Error