BizKitHub
DocsAPI ReferenceBilling/bff/billing/usage-report
getBillingAdmin BFF

/bff/billing/usage-report

Returns the per-metric spend against the assigned tariff for the current calendar month. Includes the tariff snapshot, the billing-period window, per-metric usage vs included limit, overage packages, CZK charge, and a 30-day daily series (oldest → newest) for sparklines.

BillinggetBffBillingUsage-report

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success
organisationIdnumberRequired

Organisation the report belongs to.

tariffobject | nullRequired

Assigned tariff snapshot. NULL when the org has no cas__organisation_tariff row.

One of 2:
Variant 1
idnumberRequired

Tariff ID in cas__tariff.

codestringRequired

Tariff code (free, startup, business, enterprise).

monthlyPriceCzknumberRequired

Catalogue monthly price in WHOLE CZK. For Enterprise this is the lower bound.

priceFrombooleanRequired

True when monthlyPriceCzk is "od" and the real price is negotiated per org.

Variant 2
null
billingPeriodobjectRequired
startstringRequired

First day of the current calendar month (UTC, ISO date).

endstringRequired

First day of the next calendar month (UTC, ISO date, exclusive).

totalChargeCzknumberRequired

Sum of per-metric overage charges in whole CZK for the current billing period.

metricsobject[]Required
Each array item:
codestringRequired

Stable machine code (e.g. storage_bytes, api_requests).

labelCsstringRequired

Czech display label.

labelEnstringRequired

English display label.

unitCodestringRequired

Raw base unit (B, requests, tokens, emails, orders).

aggregation"sum" | "snapshot"Required

How usage was aggregated: sum of deltas or latest snapshot.

positionnumberRequired

Display order in the report.

includedUnitsnumberRequired

Units included in the tariff at no extra cost.

packageSizenumberRequired

Overage batch size in the metric's base unit.

packagePriceCzknumberRequired

Price per overage package in whole CZK.

isUnlimitedbooleanRequired

True = no cap, no charge (Enterprise).

isEnabledbooleanRequired

False = metric is not sold on this tariff (hidden from report).

usagenumberRequired

Current-period usage in the metric's base unit.

overageUnitsnumberRequired

Units billed above the included allowance. 0 when within tariff.

chargePackagesnumberRequired

Number of overage packages the org will be billed for.

chargeCzknumberRequired

Total overage charge for this metric in whole CZK.

dailyPointsobject[]Required

Last 30 days ordered oldest → newest. Missing days are filled with 0.

Each array item:
daystringRequired

ISO date (YYYY-MM-DD, UTC).

amountnumberRequired

Value recorded for that day in the metric's base unit.

Response example

application/json
{
  "organisationId": 0,
  "billingPeriod": {
    "start": "example_start",
    "end": "example_end"
  },
  "totalChargeCzk": 0,
  "metrics": [
    {
      "code": "example_code",
      "labelCs": "example_labelCs",
      "labelEn": "example_labelEn",
      "unitCode": "example_unitCode",
      "position": 0,
      "includedUnits": 0,
      "packageSize": 0,
      "packagePriceCzk": 0,
      "isUnlimited": false,
      "isEnabled": false,
      "usage": 0,
      "overageUnits": 0,
      "chargePackages": 0,
      "chargeCzk": 0,
      "dailyPoints": [
        {
          "day": "example_day",
          "amount": 0
        }
      ]
    }
  ]
}

Request example

GET /bff/billing/usage-report

get
curl -X GET "https://api.bizkithub.com/bff/billing/usage-report" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key