MRR Churn Rate
GET https://api.chartmogul.com/v1/metrics/mrr-churn-rate
Retrieves the Net MRR Churn Rate, for the specified time period.
curl -X GET "https://api.chartmogul.com/v1/metrics/mrr-churn-rate" \
-u YOUR_API_KEY: \
-d start-date=2023-07-01 \
-d end-date=2023-08-31 \
-d interval=month \
-d geo=US \
-d plans=Silver%20Monthly
ChartMogul::Metrics.mrr_churn_rate(
start_date: "2023-07-01",
end_date: "2023-08-31",
interval: "month",
geo: "US",
plans: "Silver Monthly",
)
ChartMogul.Metrics.mrrChurnRate(config, {
"start-date": "2023-07-01",
"end-date": "2023-08-31",
interval: "month",
geo: "US",
plans: "Silver Monthly",
});
ChartMogul\Metrics::mrrChurnRate([
"start-date" => "2023-07-01",
"end-date" => "2023-08-31",
"interval" => "month",
"geo" => "US",
"plans" => "Silver Monthly"
]);
api.MetricsRetrieveMRRChurnRate(&cm.MetricsFilter{
StartDate: "2023-07-01",
EndDate: "2023-08-31",
Interval: "month",
Geo: "US",
Plans: "Silver Monthly",
})
chartmogul.Metrics.mrr_churn_rate(
config,
start_date="2023-07-01",
end_date="2023-08-31",
interval="month",
geo="US",
plans="Silver Monthly",
)
{
"entries": [
{
"date": "2023-07-31",
"mrr-churn-rate": 11.9,
"percentage-change": 0.0
},
{
"date": "2023-08-31",
"mrr-churn-rate": 12.5,
"percentage-change": 5.0
}
],
"summary": {
"current": 12.5,
"previous": 11.9,
"percentage-change": 5.0
}
}
#<ChartMogul::Metrics::MrrChurnRates:0x007faf03caacd8
@entries=[
#<ChartMogul::Metrics::MrrChurnRate:0x007faf03caa990
@date=2023-07-31,
@mrr_churn_rate=11.9,
@percentage_change=0.0
>,
#<ChartMogul::Metrics::MrrChurnRate:0x007faf03caa3a0
@date=2023-08-31,
@mrr_churn_rate=-12.5,
@percentage_change=5.0
>
],
@summary=
#<ChartMogul::Summary:0x007faf03ca3dc0
@current=012.5,
@previous=11.9,
@percentage_change=5.0
>
>
{
entries: [
{
date: "2023-07-31",
"mrr-churn-rate": 11.9,
"percentage-change": 0.0
},
{
date: "2023-08-31",
"mrr-churn-rate": 12.5,
"percentage-change": 5.0
}
],
summary: {
current: 12.5,
previous: 11.9,
"percentage-change": 5.0
}
}
ChartMogul\Metrics\MRRChurnRates::__set_state(array(
"entries" => Doctrine\Common\Collections\ArrayCollection::__set_state(array(
"elements" => array(
0 => ChartMogul\Metrics\MRRChurnRate::__set_state(array(
"date" => "2023-07-31",
"mrr_churn_rate" => 11.9,
"percentage_change" => 0.0
)),
1 => ChartMogul\Metrics\MRRChurnRate::__set_state(array(
"date" => "2023-08-31",
"mrr_churn_rate" => 12.5,
"percentage_change" => 5.0
))
)
)),
"summary" => ChartMogul\Summary::__set_state(array(
"current" => 12.5,
"previous" => 11.9,
"percentage_change" => 5.0
)),
));
(*chartmogul.MRRChurnRateResult)(0xc0420b2f00)({
Entries: ([]*chartmogul.MRRChurnRateMetrics) (len=2) {
(*chartmogul.MRRChurnRateMetrics)(0xc04210e760)({
Date: (string) (len=10) "2023-07-31",
MRRChurnRate: (float64) 11.9,
PercentageChange: (float64) 0
}),
(*chartmogul.MRRChurnRateMetrics)(0xc04210e7c0)({
Date: (string) (len=10) "2023-08-31",
MRRChurnRate: (float64) 12.5,
PercentageChange: (float64) 5.0
})
},
Summary: (*chartmogul.Summary)(0xc04210e800)({
Current: (float64) 12.5,
Previous: (float64) 11.9,
PercentageChange: (float64) 5.0
})
})
Metrics(
entries=[
<Metrics{
date=datetime.date(2023, 7, 31),
mrr_churn_rate=11.9,
percentage_change=0.0
}>,
<Metrics{
date=datetime.date(2023, 8, 31),
mrr_churn_rate=12.5,
percentage_change=-5.0
}>
],
summary=<Summary{
current=12.5,
percentage_change=5.0,
previous=11.9
}>
)
Query parameters
start-date
datetime required- The start date of the required period of data. An ISO-8601 formatted date, e.g.
2015-05-12
end-date
datetime required- The end date of the required period of data. An ISO-8601 formatted date, e.g.
2015-05-12
interval
string default: "month"- One of
day
,week
,month
(default), orquarter
geo
string- A comma-separated list of ISO 3166-1 Alpha-2 formatted country codes to filter the results to, e.g.
US,UK,DE
. plans
string- A comma-separated list of plan names (as configured in your ChartMogul account), UUIDs and external IDs to filter the results. Spaces in plan names must be URL-encoded (e.g.,
Silver%20plan,Gold%20plan,Enterprise%20plan
). Plan UUIDs are accepted with or without thepl_
prefix (e.g.,pl_ca7565ce-1973-9351-11ee-9f34ab5816d8,b35fdb9e-1ca2-11ee-90be-6f197565b760
). Plan names and IDs are case-sensitive. You can mix plan names, UUIDs and external IDs in a single string, (e.g.,Silver%20plan,pl_ca7565ce-1973-9351-11ee-9f34ab5816d8,gold_plan
).
Response
In the response, the entries
key contains an object for each month, with the following data:
date
- The date of the end of the month
mrr-churn-rate
- The Net MRR churn rate at the end of that month, expressed as a percentage.
percentage-change
- The percentage change between the current mrr churn rate and mrr churn rate from the previous time interval. Will be set to 0.0 if this is the first entry in the response.
Note that MRR Churn Rate can be both negative, and larger than 100% - in this case, a negative churn rate of -300.0% means that the MRR actually quadrupled during that period. Normal values will typically be between -10% and +10%, though that depends, naturally, on what your customers are actually doing.
The summary
key contains the last month's MRR Churn Rate value, the value a month before that, and the percentage change between these two measures.