v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Contracts

List contract billing terms

get/v3/contracts/{id}/billing-terms

Path parameters

idstring required

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

Contract Id

Query parameters

billingTermGroupIdstring

Optional billing term group (BTG) ID to filter by

pagenumber required

Page Number

limitnumber required

Number of items to return

Response

Billing terms for the contract

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "data": [
      {
        "quantity": 1,
        "duration": 12,
        "interval": "MONTH",
        "invoiceDateStrategy": "FIRST_OF_PERIOD",
        "netPaymentTerms": 30,
        "billingType": "FLAT",
        "pricingType": "SIMPLE",
        "pricing": [
          {
            "tier": 1,
            "amount": 120000,
            "amountType": "TOTAL_INVOICE",
            "tierMinimum": 0
          }
        ],
        "discounts": [
          {
            "type": "PERCENTAGE",
            "amount": "0.10",
            "note": "Partner discount"
          },
          {
            "type": "FIXED",
            "amount": "100",
            "note": "Early payment discount"
          }
        ]
      }
    ]
  }
}