contracts

Create billing term seat amendment

post/v3/contracts/{id}/billing-terms/{billingTermId}/seat-amendment

Request

  • Base URL: https://integrators.prod.api.tabsplatform.com
  • URL: https://integrators.prod.api.tabsplatform.com/v3/contracts/{id}/billing-terms/{billingTermId}/seat-amendment
  • Auth: API key in header Authorization

Path parameters

idstring required

Contract id

billingTermIdstring required

Billing term id

Request body

effectiveDatestring date-time required

Effective date of the seat amendment

newQuantitynumber double required

New quantity of seats

prorationPolicy'NONE' | 'DAY' | 'MONTH' | 'YEAR'

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

trueUpTiming'IMMEDIATE' | 'CO_TERM'

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

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Changes

No recorded changes to this operation across all 1 revision of this API.