Create contract billing term

post

https://integrators.prod.api.tabsplatform.com/v3/contracts/{id}/billing-terms

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Contract Id

Body Params

name

string

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

description

string

Line item description

billingStartDate

string

required

Billing start date

isRecurring

boolean

required

Is recurring billing

interval

string

enum

required

Interval unit

intervalFrequency

number

required

Interval frequency

duration

number

Defaults to 0

Number of billing periods

invoiceDateStrategy

string

enum

required

Invoice date strategy

Allowed:

netPaymentTerms

number

required

Days between invoice issue and due date

quantity

number

required

Quantity; set to 0 for UNIT billingType

billingType

string

enum

required

Billing type

Allowed:

pricingType

string

enum

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.

Allowed:

eventTypeId

string

Usage event type ID

itemId

string

ERP item ID for the line item

productId

string | null

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.

classId

string

ERP class ID

departmentId

string

Department ID

projectId

string

Project ID

pricing

array of objects

required

Pricing tiers

pricing*

discount

object

Discount configuration

billingTermGroupId

string

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

seatConfig

object

Seat-based billing configuration. When provided, the billing term is created as seat-based and seat changes are managed via the seat-amendment endpoints.

Responses

400

Bad Request - validation failed

404

Contract not found

500

Internal Server Error

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Billing term created