contracts

Create contract billing term

post/v3/contracts/{id}/billing-terms

Request

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

Path parameters

idstring required

Contract 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 required

Billing start date

isRecurringboolean required

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' required

Interval unit.

intervalFrequencynumber double required

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' required

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 required

Days between invoice issue and due date

quantitynumber double required

Quantity; set to 0 for UNIT billingType

billingType'UNIT' | 'FLAT' required

Billing type

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

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.

eventTypeIdstring

Usage event type ID

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

isPercentboolean

Charge a percentage of each usage event's value instead of a per-unit price. Valid with usage-based billing terms only, and not with seat-based terms. When true, each pricing[].amount is entered as a percent (10 = 10%). GET returns the stored rate as a decimal (0.1 = 10%).

billingTermGroupIdstring

Billing term group ID. If provided, the BT joins an existing group. If omitted, a new group is created.

Response

Billing term created

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.