Update contract obligation

patch

https://integrators.prod.api.tabsplatform.com/v3/contracts/{id}/obligation/{obligationId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Contract Id

obligationId

string

required

Obligation Id

Body Params

name

string

Billing term name

description

string

Billing term description

itemId

string

Item Id

productId

string | null

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.

classId

string

Class Id

categoryId

string

Category Id

eventTypeId

string

Event Type Id

price

string

Price

invoiceDateStrategy

string

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) or ADVANCED_DUE_START (invoice date at start of
billing period minus netPaymentTerms days, due start of service).

netPaymentTerms

number

Net Payment Terms

billingStartDate

string

Billing Start Date

billingFrequency

number

Billing Frequency

billingFrequencyUnit

string

enum

Billing Frequency Unit

totalNumberOfInvoices

number

Total Number of Invoices

revenueStartDate

string

Revenue Start Date

revenueEndDate

string

Revenue End Date

discount

object

Discount configuration. Pass empty object {} to remove existing discount, omit field to leave discount untouched, or provide values to update discount. Examples: { type: 'FIXED', amount: '5.00' } for a $5.00 fixed discount, { type: 'PERCENTAGE', amount: '0.10' } for a 10% percentage discount, or {} to remove discount

regenerateInvoices

boolean

Regenerate Invoices

Responses

200

Obligation updated successfully

404

Obligation not found

500

Internal server error