contracts

Update contract obligation

patch/v3.1/contracts/{id}/obligation/{obligationId}

Request

  • Base URL: https://integrators.prod.api.tabsplatform.com
  • URL: https://integrators.prod.api.tabsplatform.com/v3.1/contracts/{id}/obligation/{obligationId}
  • Auth: API key in header Authorization

Path parameters

idstring required

Contract Id

obligationIdstring required

Obligation Id

Request body

namestring

Billing term name

descriptionstring

Billing term description

itemIdstring

Item Id

productIdstring nullable

Product ID from /v3/products that links this billing term to an entry in the merchant's product catalog. Omit to leave unchanged, provide a UUID to link, or null to unlink. To ensure revenue reporting accuracy, associate the billing term with a product whenever applicable.

classIdstring

Class Id

categoryIdstring

Category Id

eventTypeIdstring

Event Type Id

pricestring

Price

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

Strategy for determining when to send invoices. FIRST_OF_PERIOD (invoice at start of billing period), LAST_OF_PERIOD (invoice at end of billing period), ARREARS (invoice after service delivery), ADVANCED_DUE_START (invoice date at start of billing period minus netPaymentTerms days, due start of service), OFFSET_FROM_PERIOD_START / OFFSET_FROM_PERIOD_END (invoice date at period start/end plus 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

Net Payment Terms

includeInArrboolean

Whether this billing term contributes to ARR (Annual Recurring Revenue)

billingStartDatestring

Billing Start Date

billingFrequencynumber double

Billing Frequency

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

Billing Frequency Unit.

totalNumberOfInvoicesnumber double

Total Number of Invoices

revenueStartDatestring

Revenue Start Date

revenueEndDatestring

Revenue End Date

regenerateInvoicesboolean

Regenerate Invoices

Response

Obligation updated successfully

ContractsIntegratorsApiContractsV31ControllerUpdateObligationResponse200 required

Empty response body

Changes

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