Calculate Billing

Calculate billing charges for a given period. Evaluates all active billing packages matching the specified type and returns transaction payloads ready for Midaz. All-or-nothing — if any package fails, no results are returned.

POST /v1/billing/calculate

cURL

volumeMonthly

curl --request POST \
  --url https://fees.sandbox.lerian.net/v1/billing/calculate \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "ledgerId": "ldg_01HZ...",
  "period": "2026-03",
  "type": "volume"
}
'

200

Example

{
  "results": [
    {
      "billingPackageId": "<string>",
      "billingPackageLabel": "<string>",
      "period": "<string>",
      "totalAccounts": 123,
      "totalCharged": 123,
      "totalSkipped": 123,
      "totalNetAmount": "<string>",
      "transactionPayload": {}
    }
  ],
  "summary": {
    "totalResults": 123,
    "totalVolume": 123,
    "totalMaintenance": 123,
    "totalNetAmount": "<string>"
  }
}

Headers

X-Organization-Id · string · required

The unique identifier of the Organization associated with the request.

Example:

"019c96a0-0a98-7287-9a31-786e0809c769"

Authorization · string

The authorization token in the 'Bearer ' format.

Important: This header is required if your environment has Access Manager enabled. For more information, refer to the Access Manager documentation.

Content-Type · string · required

The type of media of the resource. Must be application/json.

Example:

"application/json"

Body

application/json

ledgerId · string · required

Unique identifier of the Ledger to calculate billing for.

period · string · required

Billing period. Supported formats: YYYY-MM (monthly), YYYY-Www (weekly, e.g. 2026-W13), or YYYY-MM-DD (daily).

type · enum<string>

Filter by billing type. When omitted, both volume and maintenance packages are calculated.

Available options: volume, maintenance

Response

200

application/json

Billing calculation results with transaction payloads.

results · object[]

One result per active billing package processed.

Show child attributes

summary · object

Consolidated totals across all results.

Show child attributes