Analytics

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

FieldTypeRequiredNotes
environmentlive | testNoDefaults to live.
from / toISO dateNoDefaults to the last 30 days.
planId / productIdstringNo—
currencystringNo—
granularityday | monthNo—

Reports

MethodPathPurposePermission
GET/merchants/:merchantId/analytics/overviewMRR, ARR, ARPU, lifetime value, active subscriptions, churn, collected and invoiced amounts.analytics:read
GET/merchants/:merchantId/analytics/revenueSucceeded payments with gross, refunded and net per bucket.analytics:read
GET/merchants/:merchantId/analytics/subscribersNew, cancelled and net subscriptions with a growth series.analytics:read
GET/merchants/:merchantId/analytics/churnChurn rate, lost MRR and a per-plan breakdown.analytics:read
GET/merchants/:merchantId/analytics/retentionMonthly cohort retention for up to twelve periods.analytics:read
GET/merchants/:merchantId/analytics/cohortsCohort revenue, retained subscribers and revenue per subscriber.analytics:read
GET/merchants/:merchantId/analytics/trialsTrials started, converted and active, with conversion rate and average length.analytics:read
GET/merchants/:merchantId/analytics/plansPer-plan subscribers, MRR and average revenue per subscriber.analytics:read
GET/merchants/:merchantId/analytics/paymentsPayment counts, success rate and breakdowns by status, provider, brand and currency.analytics:read
GET/merchants/:merchantId/analytics/payment-recoveryFailed payments, retries, dunning recovery rate and top failure reasons.analytics:read
GET/merchants/:merchantId/analytics/invoicesInvoice counts, tax, discounts, overdue count and average days to payment.analytics:read
GET/merchants/:merchantId/analytics/dunningDunning processes by status, recovery rate and attempt outcomes.analytics:read
GET/merchants/:merchantId/analytics/exportCSV 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.