CMRR summary


The /reports/cmrr-summary endpoint returns Committed Monthly Recurring Revenue (CMRR) values at different historical points. CMRR includes scheduled future subscription changes, giving a forward-looking view of expected recurring revenue.

💡 Use case: Forecast revenue with scheduled changes. Track CMRR trends over time to understand future revenue commitments and compare to actual MRR.

GET /reports/cmrr-summary

Returns CMRR snapshots at current and historical points (30, 60, 180, 365 days ago).

Authentication

Required

Include your API key in the Authorization header:

curl https://api.growpanel.io/reports/cmrr-summary \
-H "Authorization: Bearer YOUR_API_KEY"

Query parameters

ParameterTypeDescription
baseCurrencyoptionalstringTarget currency for conversion. Defaults to account base currency (e.g., usd).
regionoptionalstringFilter by region or country codes (space-separated). Example: us ca or eu
currencyoptionalstringFilter by currency codes (space-separated). Example: usd eur gbp
planoptionalstringFilter by plan group IDs (space-separated).
industryoptionalstringFilter by industry (space-separated).
channeloptionalstringFilter by channel (space-separated).
sizeoptionalstringFilter by customer size (space-separated).
data_sourceoptionalstringFilter by data source ID (space-separated).

Response

200 OK

Returns a summary object with CMRR values at different time points.

{
"currency": "usd",
"summary": {
"cmrr_current": 135000,
"cmrr_30": 130000,
"cmrr_60": 125000,
"cmrr_180": 110000,
"cmrr_365": 90000
}
}

Response fields

FieldTypeDescription
currencystringReporting currency (ISO 4217 code)
cmrr_currentnumberCurrent committed MRR including scheduled changes (cents)
cmrr_30numberCMRR from 30 days ago (cents)
cmrr_60numberCMRR from 60 days ago (cents)
cmrr_180numberCMRR from 180 days ago (cents)
cmrr_365numberCMRR from 365 days ago (cents)

Example requests

Get overall CMRR summary

curl https://api.growpanel.io/reports/cmrr-summary \
-H "Authorization: Bearer YOUR_API_KEY"

Filter by region

curl "https://api.growpanel.io/reports/cmrr-summary?region=eu" \
-H "Authorization: Bearer YOUR_API_KEY"

Filter by plan

curl "https://api.growpanel.io/reports/cmrr-summary?plan=plan_123" \
-H "Authorization: Bearer YOUR_API_KEY"

Convert to EUR

curl "https://api.growpanel.io/reports/cmrr-summary?baseCurrency=eur" \
-H "Authorization: Bearer YOUR_API_KEY"

Notes

⚠️ Currency values: All monetary values are returned in cents/smallest currency unit. Divide by 100 for display in most currencies.

  • CMRR calculation: Includes current MRR plus scheduled subscription changes (upgrades, downgrades, cancellations)
  • Historical snapshots: Each value represents what CMRR was at that point in time
  • Trend analysis: Compare CMRR over time to understand how future revenue expectations evolved
  • Accuracy: CMRR accuracy depends on subscription schedule data from your billing system