get https://api.chartmogul.com/v1/metrics/mrr
Retrieves the Monthly Recurring Revenue (MRR), for the specified time period.
Examples
curl -X GET "https://api.chartmogul.com/v1/metrics/mrr" \
-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(
start_date: "2023-07-01",
end_date: "2023-08-31",
interval: "month",
geo: "US",
plans: "Silver Monthly",
)
ChartMogul.Metrics.mrr(config, {
"start-date": "2023-07-01",
"end-date": "2023-08-31",
interval: "month",
geo: "US",
plans: "Silver Monthly",
});
ChartMogul\Metrics::mrr([
"start-date" => "2023-07-01",
"end-date" => "2023-08-31",
"interval" => "month",
"geo" => "US",
"plans" => "Silver Monthly"
])
api.MetricsRetrieveMRR(&cm.MetricsFilter{
StartDate: "2023-07-01",
EndDate: "2023-08-31",
Interval: "month",
Geo: "US",
Plans: "Silver Monthly",
})
chartmogul.Metrics.mrr(
config,
start_date="2023-07-01",
end_date="2023-08-31",
interval="month",
geo="US",
plans="Silver Monthly",
)
Result Format
{
"entries": [
{
"date": "2023-07-31",
"mrr": 363819722,
"percentage-change": 0.0,
"mrr-new-business": 288938,
"mrr-expansion": 108684,
"mrr-contraction": -147909,
"mrr-churn": -600866,
"mrr-reactivation": 0
},
{
"date": "2023-08-31",
"mrr": 363540396,
"percentage-change": -0.08,
"mrr-new-business": 38547,
"mrr-expansion": 82274,
"mrr-contraction": -90523,
"mrr-churn": -302423,
"mrr-reactivation": 0
}
],
"summary": {
"current": 354026144,
"previous": 353715871,
"percentage-change": 0.09
}
}
#<ChartMogul::Metrics::MRRs:0x007fa4ed85e0f0
@entries=[
#<ChartMogul::Metrics::MRR:0x007fa4ed85cf48
@date=2023-07-31,
@mrr=363819722,
@percentage_change=0.0,
@mrr_new_business=288938,
@mrr_expansion=108684,
@mrr_contraction=-147909,
@mrr_churn=-600866,
@mrr_reactivation=0
>,
#<ChartMogul::Metrics::MRR:0x007fa4ed854a50
@date=2023-08-31,
@mrr=363540396,
@percentage_change=-0.08,
@mrr_new_business=38547,
@mrr_expansion=82274,
@mrr_contraction=-90523,
@mrr_churn=-302423,
@mrr_reactivation=0
>
],
@summary=
#<ChartMogul::Summary:0x007fa4ec07dda0
@current=354026144,
@previous=353715871,
@percentage_change=0.09
>
>
{
entries: [
{
date: "2023-07-31",
mrr: 363819722,
"percentage-change": 0.0,
"mrr-new-business": 288938,
"mrr-expansion": 108684,
"mrr-contraction": -147909,
"mrr-churn": -600866,
"mrr-reactivation": 0
},
{
date: "2023-08-31",
mrr: 363540396,
"percentage-change": -0.08,
"mrr-new-business": 38547,
"mrr-expansion": 82274,
"mrr-contraction": -90523,
"mrr-churn": -302423,
"mrr-reactivation": 0
}
],
summary: {
current: 354026144,
previous: 353715871,
"percentage-change": 0.09
}
}
ChartMogul\Metrics\MRRs::__set_state(array(
"entries" => Doctrine\Common\Collections\ArrayCollection::__set_state(array(
"elements" => array(
0 => ChartMogul\Metrics\MRR::__set_state(array(
"date" => "2023-07-31",
"mrr" => 363819722,
"percentage-change" => 0.0,
"mrr_new_business" => 288938,
"mrr_expansion" => 108684,
"mrr_contraction" => -147909,
"mrr_churn" => -600866,
"mrr_reactivation" => 0,
)),
1 => ChartMogul\Metrics\MRR::__set_state(array(
"date" => "2023-08-31",
"mrr" => 363540396,
"percentage-change" => -0.08,
"mrr_new_business" => 38547,
"mrr_expansion" => 82274,
"mrr_contraction" => -90523,
"mrr_churn" => -302423,
"mrr_reactivation" => 0,
))
)
)),
"summary" => ChartMogul\Summary::__set_state(array(
"current" => 354026144,
"previous" => 353715871,
"percentage_change" => 0.09,
)),
));
(*chartmogul.MRRResult)(0xc0420b2f00)({
Entries: ([]*chartmogul.MRRMetrics) (len=2) {
(*chartmogul.MRRMetrics)(0xc0420ca180)({
Date: (string) (len=10) "2023-07-31",
MRR: (float64) 363819722,
PercentageChange: (float64) 0.0,
MRRNewBusiness: (float64) 288938,
MRRExpansion: (float64) 108684,
MRRContraction: (float64) -147909,
MRRChurn: (float64) -6008660,
MRRReactivation: (float64) 0
}),
(*chartmogul.MRRMetrics)(0xc0420ca1c0)({
Date: (string) (len=10) "2023-08-31",
MRR: (float64) 363540396,
PercentageChange: (float64) -0.08,
MRRNewBusiness: (float64) 38547,
MRRExpansion: (float64) 82274,
MRRContraction: (float64) -905230,
MRRChurn: (float64) -3024230,
MRRReactivation: (float64) 0
})
},
Summary: (*chartmogul.Summary)(0xc0420c6160)({
Current: (float64) 354026144,
Previous: (float64) 353715871,
PercentageChange: (float64) 0.09
})
})
Metrics(
entries=[
<Metrics{
date=datetime.date(2023, 7, 1),
mrr=363819722,
percentage_change=0.0,
mrr_new_business=288938,
mrr_expansion=108684,
mrr_contraction=-147909,
mrr_churn=-600866,
mrr_reactivation=0.0
}>,
<Metrics{
date=datetime.date(2023, 8, 31),
mrr=363540396,
percentage_change=-0.08,
mrr_new_business=38547,
mrr_expansion=82274,
mrr_contraction=-90523,
mrr_churn=-302423,
mrr_reactivation=0.0
}>
],
summary=<Summary{
current=354026144,
previous=353715871,
percentage_change=0.9
}>
)
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.mrr- The Monthly Recurring Revenue as at the end of the interval.percentage-change- The percentage change between the current MRR and MRR from the previous time interval. Will be set to0.0if this is the first entry in the response.mrr-new-business- New MRR during the interval from new customers.mrr-expansion- New MRR during the interval from existing customers (e.g. plan upgrades).mrr-contraction- Decrease in MRR during the interval, excluding cancellations.mrr-churn- Total decrease in MRR from customers who cancelled a subscription.mrr-reactivation- Increase in MRR from customers who previously cancelled a subscription.
All amounts are given in the selected currency of your account and are an integer number of cents. Divide by 100 to obtain the actual value.
The summary key contains the current MRR value, the value 30 days ago, and the percentage change between these two measures.