Skip to main content

API Reference

Metrics Summary

Returns key subscription metrics for your account. Uses the secret key or a personal access token for authentication. Requires the Metrics module to be enabled.

Get Metrics Summary

GET /api/v1/metrics_summary Secret Key / PAT 30 req/min

Returns MRR, ARR, active subscriber count, customer churn rate, and a 12-month MRR trend.

Success Response (200)

{
  "mrr_cents": 125000,
  "arr_cents": 1500000,
  "active_subscribers": 42,
  "customer_churn_rate": 3.2,
  "mrr_trend": {
    "2025-04": 110000,
    "2025-05": 112000,
    "2025-06": 114000,
    "2025-07": 116000,
    "2025-08": 117500,
    "2025-09": 118000,
    "2025-10": 119000,
    "2025-11": 120000,
    "2025-12": 121000,
    "2026-01": 122500,
    "2026-02": 124000,
    "2026-03": 125000
  }
}

Response Fields

Field Type Description
mrr_cents integer Current monthly recurring revenue in cents
arr_cents integer Annual recurring revenue (MRR × 12) in cents
active_subscribers integer Number of distinct companies with active subscriptions
customer_churn_rate float or null Customer churn rate (%) over the last 90 days
mrr_trend object MRR by month for the last 12 months, keyed by YYYY-MM

Error Response (403)

{
  "error": "Metrics not enabled"
}