API REFERENCE
Analytics
Every analytics route is merchant-scoped, requires analytics:read and accepts the same filter set. Figures are computed from billing records, not a separate warehouse.
Shared filters
| Field | Type | Required | Notes |
|---|---|---|---|
| environment | live | test | No | Defaults to live. |
| from / to | ISO date | No | Defaults to the last 30 days. |
| planId / productId | string | No | — |
| currency | string | No | — |
| granularity | day | month | No | — |
Reports
| Method | Path | Purpose | Permission |
|---|---|---|---|
| GET | /merchants/:merchantId/analytics/overview | MRR, ARR, ARPU, lifetime value, active subscriptions, churn, collected and invoiced amounts. | analytics:read |
| GET | /merchants/:merchantId/analytics/revenue | Succeeded payments with gross, refunded and net per bucket. | analytics:read |
| GET | /merchants/:merchantId/analytics/subscribers | New, cancelled and net subscriptions with a growth series. | analytics:read |
| GET | /merchants/:merchantId/analytics/churn | Churn rate, lost MRR and a per-plan breakdown. | analytics:read |
| GET | /merchants/:merchantId/analytics/retention | Monthly cohort retention for up to twelve periods. | analytics:read |
| GET | /merchants/:merchantId/analytics/cohorts | Cohort revenue, retained subscribers and revenue per subscriber. | analytics:read |
| GET | /merchants/:merchantId/analytics/trials | Trials started, converted and active, with conversion rate and average length. | analytics:read |
| GET | /merchants/:merchantId/analytics/plans | Per-plan subscribers, MRR and average revenue per subscriber. | analytics:read |
| GET | /merchants/:merchantId/analytics/payments | Payment counts, success rate and breakdowns by status, provider, brand and currency. | analytics:read |
| GET | /merchants/:merchantId/analytics/payment-recovery | Failed payments, retries, dunning recovery rate and top failure reasons. | analytics:read |
| GET | /merchants/:merchantId/analytics/invoices | Invoice counts, tax, discounts, overdue count and average days to payment. | analytics:read |
| GET | /merchants/:merchantId/analytics/dunning | Dunning processes by status, recovery rate and attempt outcomes. | analytics:read |
| GET | /merchants/:merchantId/analytics/export | CSV attachment for revenue, subscriptions, payments, invoices, dunning or plans. | analytics:read |
How the headline numbers are calculated
MRR normalises each subscription's price snapshot to a monthly figure: daily is multiplied by 30.4375, weekly by 4.345, and yearly is divided by twelve. ARR is twelve times MRR.
Export
The export route returns text/csv with a filename of the form revenue-report-2026-11-15.csv. It accepts the analytics filters plus report: revenue, subscriptions, payments, invoices, dunning or plans.