Sign in

v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB
Contracts

Update contract obligation

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

Path parameters

idstring required
Example:123e4567-e89b-12d3-a456-426614174000

Contract Id

obligationIdstring required
Example:123e4567-e89b-12d3-a456-426614174000

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

invoiceDateStrategystring

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).

netPaymentTermsnumber

Net Payment Terms

includeInArrboolean

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

billingStartDatestring

Billing Start Date

billingFrequencynumber

Billing Frequency

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

Billing Frequency Unit

totalNumberOfInvoicesnumber

Total Number of Invoices

revenueStartDatestring

Revenue Start Date

revenueEndDatestring

Revenue End Date

regenerateInvoicesboolean

Regenerate Invoices

Example request

{
  "name": "Name",
  "description": "Description",
  "itemId": "123e4567-e89b-12d3-a456-426614174000",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "classId": "123e4567-e89b-12d3-a456-426614174000",
  "categoryId": "123e4567-e89b-12d3-a456-426614174000",
  "eventTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "price": "100.00",
  "invoiceDateStrategy": "FIRST_OF_PERIOD",
  "netPaymentTerms": 1,
  "includeInArr": true,
  "billingStartDate": "2024-01-01",
  "billingFrequency": 1,
  "billingFrequencyUnit": "MONTH",
  "totalNumberOfInvoices": 1,
  "revenueStartDate": "2024-01-01",
  "revenueEndDate": "2024-01-01",
  "discount": {
    "type": "PERCENTAGE",
    "amount": "10",
    "note": "Early payment discount"
  },
  "regenerateInvoices": true
}

Response

Obligation updated successfully