get
https://www.pelcro.com/api/v1/core/analytics/subscriptions/health
Get subscription retention and churn metrics over a date range.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Returns subscription retention and churn metrics over a date range, broken down by month or year.
Metrics explained
| Metric | Meaning |
|---|---|
| OA | Opening Active — subscriptions active at the start of the period |
| NS | New Starts — subscriptions that started during the period |
| CO | Churned from Opening — OA subscriptions that expired during the period |
| CI | Churned In-Period — new starts that expired within the same period |
| CA | Closing Active — subscriptions active at the end of the period |
| CAO | Closing Active from Opening — OA minus CO |
| sub_ret_pct | Subscriber retention: (OA - CO) / OA × 100 |
| total_ret_pct | Total retention: CA / (OA + NS) × 100 |
| sub_churn_pct | Subscriber churn: CO / OA × 100 |
| in_per_churn_pct | In-period churn: CI / NS × 100 |
| total_churn_pct | Total churn: (CO + CI) / (OA + NS) × 100 |
Limits
- Maximum 20 periods per request. Exceeding this returns a
422withTOO_MANY_PERIODS. - Results are cached for 1 hour.
- Gift donor subscriptions are excluded from all metrics.
Validation
The is_valid field confirms the formula: CA = OA + NS - CO - CI. If false, there may be a data inconsistency.