contracts

Update contract billing term

patch/v3/contracts/{id}/billing-terms/{billingTermId}

Request

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

Path parameters

idstring required

Contract Id

billingTermIdstring required

Billing Term Id

Request body

namestring

Line item name. Required unless productId is provided, in which case it is populated from the product's display name.

descriptionstring

Line item description

billingStartDatestring

Billing start date

isRecurringboolean

Is recurring billing

includeInArrboolean

Whether this billing term contributes to ARR (Annual Recurring Revenue). Defaults based on billing type and interval when omitted (usage and one-time terms default to false).

interval'NONE' | 'DAY' | 'WEEK' | 'MONTH' | 'SEMI_MONTH' | 'YEAR' | 'HOUR'

Interval unit.

intervalFrequencynumber double

Interval frequency

durationnumber double

Number of billing periods

invoiceDateStrategy'FIRST_OF_PERIOD' | 'LAST_OF_PERIOD' | 'ARREARS' | 'ADVANCED_DUE_START' | 'OFFSET_FROM_PERIOD_START' | 'OFFSET_FROM_PERIOD_END'

Invoice date strategy. OFFSET_FROM_PERIOD_START / OFFSET_FROM_PERIOD_END require invoiceDateOffsetDays.

invoiceDateOffsetDaysnumber double

Days to offset the invoice date from the period start (OFFSET_FROM_PERIOD_START) or period end (OFFSET_FROM_PERIOD_END). Required for those strategies and not allowed for FIRST_OF_PERIOD, LAST_OF_PERIOD, ARREARS, or ADVANCED_DUE_START. Integer from -365 to 365.

netPaymentTermsnumber double

Days between invoice issue and due date

quantitynumber double

Quantity; set to 0 for UNIT billingType

billingType'UNIT' | 'FLAT'

Billing type

pricingType'SIMPLE' | 'TIERED' | 'VOLUME'

Pricing type. For TIERED and VOLUME, supply 2+ pricing entries with tier indices that are 0-indexed and contiguous (0, 1, 2, …) and tierMinimum values starting at 0 and strictly increasing.

itemIdstring

ERP item ID for the line item

productIdstring nullable

Product ID from /v3/products. When set, name/description/itemId/classId are populated from the product for any not provided on the billing term. To ensure revenue reporting accuracy, associate the billing term with a product whenever applicable.

classIdstring

ERP class ID

departmentIdstring

Department ID

projectIdstring

Project ID

Response

Billing term updated; invoice regeneration enqueued

ContractsIntegratorsApiContractsv3ControllerPatchBillingTermResponse200 required

Empty response body

Changes

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