Sign in

v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB
Contracts

Update contract billing term

patch/v3/contracts/{id}/billing-terms/{billingTermId}

Path parameters

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

Contract Id

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

Billing Term Id

Request body

namestring

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

descriptionstring

Line item description

billingStartDatestring

Billing start date

isRecurringboolean

Is recurring billing

includeInArrboolean

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'NONE' | 'DAY' | 'MONTH' | 'HOUR' | 'YEAR' | 'QUARTER' | 'SEMI_MONTH' | 'WEEK'

Interval unit

intervalFrequencynumber

Interval frequency

durationnumber

Number of billing periods

invoiceDateStrategy'FIRST_OF_PERIOD' | 'LAST_OF_PERIOD' | 'ARREARS' | 'ADVANCED_DUE_START'

Invoice date strategy

netPaymentTermsnumber

Days between invoice issue and due date

quantitynumber

Quantity; set to 0 for UNIT billingType

billingType'UNIT' | 'FLAT'

Billing type

pricingType'SIMPLE' | 'TIERED' | 'VOLUME'

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.

itemIdstring

ERP item ID for the line item

productIdstring nullable

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.

classIdstring

ERP class ID

departmentIdstring

Department ID

projectIdstring

Project ID

Example request

{
  "name": "Annual Platform License",
  "description": "Enterprise platform license",
  "billingStartDate": "2025-01-01",
  "isRecurring": true,
  "includeInArr": true,
  "interval": "MONTH",
  "intervalFrequency": 1,
  "invoiceDateStrategy": "FIRST_OF_PERIOD",
  "netPaymentTerms": 30,
  "quantity": 1,
  "billingType": "FLAT",
  "pricingType": "SIMPLE",
  "itemId": "d4e5f6a7-8901-4abc-8def-555555555555",
  "productId": "c5f6a7b8-9012-4abc-8def-444444444444",
  "classId": "e5f6a7b8-9012-4abc-8def-666666666666",
  "departmentId": "e5f6a7b8-9012-4abc-8def-777777777777",
  "projectId": "f6a7b8c9-0123-4abc-8def-888888888888",
  "pricing": [
    {
      "tier": 1,
      "amount": 10000,
      "amountType": "TOTAL_INVOICE",
      "tierMinimum": 0
    }
  ],
  "discount": {
    "type": "PERCENTAGE",
    "amount": "10",
    "note": "Early payment discount"
  }
}

Response

Billing term updated; invoice regeneration enqueued