Create contract billing term
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
Contract Id
Request body
Line item name. Required unless productId is provided, in which case it is populated from the product's display name.
Line item description
Billing start date
Is recurring billing
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 unit.
Interval frequency
Number of billing periods
Invoice date strategy. OFFSET_FROM_PERIOD_START / OFFSET_FROM_PERIOD_END require invoiceDateOffsetDays.
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.
Days between invoice issue and due date
Quantity; set to 0 for UNIT billingType
Billing type
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.
Usage event type ID
ERP item ID for the line item
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.
ERP class ID
Department ID
Project ID
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%).
Billing term group ID. If provided, the BT joins an existing group. If omitted, a new group is created.
Response
Billing term created
Boolean with true=success, false=failure
Plain-text description of the result
Changes
No recorded changes to this operation across all 1 revision of this API.