v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Billing Calculation API

Calculate billing

post/v1/organizations/{organization_id}/billing/calculate

Path parameters

organization_idstring uuid required

The unique identifier of the Organization associated with the Ledger.

Headers

Content-Typestring

The type of media of the resource. Recommended value is application/json.

X-Request-Idstring uuid

A unique identifier used to trace and track each request.

Authorizationstring

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Response

Example response

{
  "results": [
    {
      "billingPackageId": "00000000-0000-0000-0000-000000000000",
      "billingPackageLabel": "Monthly Volume Billing",
      "billingType": "volume",
      "period": "2026-01",
      "totalAccounts": 500,
      "totalCharged": 480,
      "totalNetAmount": "123.45",
      "totalSkipped": 20
    }
  ],
  "summary": {
    "totalMaintenance": 3,
    "totalNetAmount": "456.78",
    "totalResults": 10,
    "totalVolume": 7
  }
}