v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB

Analytics

Get subscription analytics

Retrieve subscription metrics including active count, churn rate, new subscriptions, and status distribution.

get/api/analytics/subscriptions

Query parameters

dateFromstring

Example:2025-01-01

dateTostring

Example:2025-12-31

currencystring

groupBy'day' | 'week' | 'month'

Response

Subscription metrics and trends

totalnumber required

activenumber required

cancelednumber required

trialingnumber required

pausednumber required

newSubscriptionsnumber required

churnRatestring required

Churn rate percentage

retentionRatestring required

Retention rate percentage

Example response

{
  "total": 100,
  "active": 85,
  "canceled": 5,
  "trialing": 8,
  "paused": 2,
  "newSubscriptions": 12,
  "churnRate": "5.00",
  "retentionRate": "95.00"
}