List billing term seat amendments

GET

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

GET

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

curl https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/billing-terms/123e4567-e89b-12d3-a456-426614174000/seat-amendments \
     -H "Authorization: <apiKey>"

{
  "payload": {
    "data": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "obligationId": "456e7890-e89b-12d3-a456-426614174001",
        "effectiveDate": "2026-01-01",
        "newQuantity": 150,
        "prorationPolicy": "DAY",
        "trueUpTiming": "IMMEDIATE",
        "lastUpdatedAt": "2025-09-19T00:00:00.000Z"
      }
    ],
    "limit": 1.1,
    "totalItems": 1.1,
    "currentPage": 1.1
  },
  "success": true,
  "message": "string",
  "error": {
    "code": 1.1,
    "message": "string",
    "details": {}
  }
}

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Contract id

billingTermIdstringRequired

Billing term id

Query parameters

seatAmendmentIdstringOptional

Search for a specific seat amendment by seat amendment id (optional)

pagedoubleOptional

limitdoubleOptional

Response

Get all seat amendments for a billing term

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