Create billing term seat amendment

POST

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

POST

/v3/contracts/:id/billing-terms/:billingTermId/seat-amendment

$ curl -X POST https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/billing-terms/123e4567-e89b-12d3-a456-426614174000/seat-amendment \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "effectiveDate": "2026-01-01",
>   "newQuantity": 150
> }'

1 {
2   "payload": {
3     "id": "123e4567-e89b-12d3-a456-426614174000",
4     "obligationId": "456e7890-e89b-12d3-a456-426614174001",
5     "effectiveDate": "2026-01-01",
6     "newQuantity": 150,
7     "lastUpdatedAt": "2025-09-19T00:00:00.000Z",
8     "prorationPolicy": "DAY",
9     "trueUpTiming": "IMMEDIATE"
10   },
11   "success": true,
12   "message": "string",
13   "error": {
14     "code": 1.1,
15     "message": "string",
16     "details": {}
17   }
18 }

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Contract id

billingTermIdstringRequired

Billing term id

Request

This endpoint expects an object.

effectiveDatedatetimeRequired

Effective date of the seat amendment

newQuantitydoubleRequired

New quantity of seats

prorationPolicyenumOptional

Proration policy for the amendment: • NONE: No proration applied - full period charges regardless of timing • DAY: Proration calculated on a daily basis • MONTH: Proration calculated on a monthly basis • YEAR: Proration calculated on a yearly basis

trueUpTimingenumOptional

True-up timing for the amendment: • IMMEDIATE: True-up amounts are applied immediately on the effective date • CO_TERM: True-up amounts are applied at the next invoice date after the effective date

Response

The seat amendment

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

400

Bad Request Error

404

Not Found Error