BillKit/Docs Console
Metrics

Get home metrics

Four headline numbers for your account, in one call.

GET/v1/metrics/home
Operation get_home_metrics · Scope metrics:read · Spec snapshot 2026-09-13

Parameters

This endpoint takes no parameters.

Returns

Returns a HomeMetricsResponse object.

Errors

Status Cause
401 Missing or invalid API key.
403 Key is missing the metrics:read scope.
429 Rate limited. Back off and retry.
Request · curl 
curl -X GET https://api.billkit.eu/v1/metrics/home \
  -H "Authorization: Bearer $BILLKIT_SECRET_KEY"
Response · 200 OK 
{
  "active_subscriptions": {
    "delta": 0,
    "sparkline": [
      0
    ],
    "value": 0
  },
  "as_of": 0,
  "failed_payments_24h": {
    "delta": 0,
    "sparkline": [
      0
    ],
    "value": 0
  },
  "mode": "string",
  "mrr": {
    "delta": 0,
    "sparkline": [
      0
    ],
    "value": 0
  },
  "object": "metrics.home",
  "today_revenue": {
    "delta": 0,
    "sparkline": [
      0
    ],
    "value": 0
  }
}