Paid Subscriber Churn Rate

GET https://api.chartmogul.com/v2/metrics/paid_subscriber_churn

Retrieves the churn rate of paid subscribers for the specified time period.

curl -X GET "https://api.chartmogul.com/v2/metrics/paid_subscriber_churn" \
     -u YOUR_API_KEY: \
     -G \
     -d start=2026-08-01 \
     -d end=2026-10-31 \
     -d interval=month \
     -d include_summary=true
{
  "entries": [
    {
      "date": "2026-09-30",
      "value": 0.0,
      "change": null,
      "starting_customers": 18,
      "net_churn_customer_count": 0,
      "net_new_to_churn_customer_count": 0,
      "net_churn_to_reactivation_customer_count": 0,
      "YoY_value": 13.33,
      "YoY_percentage_change": -0.07,
      "YoY_interval_start": "2025-10-01",
      "YoY_interval_end": "2026-09-30",
      "percentage-change": null
    },
    {
      "date": "2026-10-31",
      "value": 0.0,
      "change": null,
      "starting_customers": 18,
      "net_churn_customer_count": 0,
      "net_new_to_churn_customer_count": 0,
      "net_churn_to_reactivation_customer_count": 0,
      "YoY_value": 12.5,
      "YoY_percentage_change": -0.06,
      "YoY_interval_start": "2025-11-01",
      "YoY_interval_end": "2026-10-31",
      "percentage-change": null
    }
  ],
  "summary": {
    "current": 0.0,
    "previous": 0.0,
    "percentage-change": null
  }
}

Query parameters

start date required
The start date of the required period of data. An ISO-8601 formatted date, e.g. 2026-08-01. Must not be later than end.
end date required
The end date of the required period of data. An ISO-8601 formatted date, e.g. 2026-10-31.
interval string required
One of day, week, month, quarter, or year.
filters string optional
A set of filters to limit the results, formatted as CFL. Copy URL-encoded CFL from the app (e.g., filters=currency~ANY~%27USD%27) or write the expression manually and enclose the key-value pair in double quotes (e.g., "filters=currency~ANY~'USD'"). To limit the results to certain countries or plans, use a filter; there are no separate geo and plans parameters.
include_summary boolean optional default: false
Set to true to add the summary key to the response.

Response

In the response, the entries key contains an object for each interval, with the following data:

date
The date of the end of the interval.
value
The Paid Subscriber Churn Rate for the interval, expressed as a percentage.
starting_customers
The number of subscribers at the start of the interval.
net_churn_customer_count
The number of subscribers that churned during the interval.
net_new_to_churn_customer_count
The number of customers that subscribed and churned within the same interval.
net_churn_to_reactivation_customer_count
The number of customers that churned and reactivated within the same interval.
change
The change from the previous entry, in percentage points.
YoY_value
The churn rate for the twelve months that end on date.
YoY_percentage_change
The change of YoY_value from the previous entry.
YoY_interval_start, YoY_interval_end
The start and end dates of those twelve months.
percentage-change
The percentage change from the previous entry. Not present in the first entry.

The summary key is present when include_summary is true. It contains the values for the last complete month and the month before that (current and previous) of the Paid Subscriber Churn Rate and the percentage change between the two (percentage-change).