Scheduled churn summary

The /reports/churn-scheduled-summary endpoint returns scheduled churn values at different historical points (current, 30, 60, 180, 365 days ago), similar to the summary metrics endpoint but focused on scheduled churn.

💡 Use case: Track how scheduled churn has evolved over time. Monitor trends in cancellation patterns and retention effectiveness.

GET /reports/churn-scheduled-summary

Returns scheduled churn snapshots at current and historical points.

Authentication

Required

Include your API key in the Authorization header:

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

Query parameters

Parameter	Type	Description
`baseCurrency`optional	string	Target currency for conversion. Defaults to account base currency (e.g., `usd`).
`region`optional	string	Filter by region or country codes (space-separated). Example: `us ca` or `eu`
`currency`optional	string	Filter by currency codes (space-separated). Example: `usd eur gbp`
`plan`optional	string	Filter by plan group IDs (space-separated).
`industry`optional	string	Filter by industry (space-separated).
`channel`optional	string	Filter by channel (space-separated).
`size`optional	string	Filter by customer size (space-separated).
`data_source`optional	string	Filter by data source ID (space-separated).

Response

200 OK

Returns a summary object with scheduled churn values at different time points.

{
  "currency": "usd",
  "summary": {
    "churn_current": -4200,
    "churn_30": -3800,
    "churn_60": -5100,
    "churn_180": -2900,
    "churn_365": -6500
  }
}

Response fields

Field	Type	Description
`currency`	string	Reporting currency (ISO 4217 code)
`churn_current`	number	Current scheduled churn MRR (cents, negative)
`churn_30`	number	Scheduled churn from 30 days ago (cents, negative)
`churn_60`	number	Scheduled churn from 60 days ago (cents, negative)
`churn_180`	number	Scheduled churn from 180 days ago (cents, negative)
`churn_365`	number	Scheduled churn from 365 days ago (cents, negative)

Example requests

Get overall scheduled churn summary

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

Filter by region

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

Filter by plan

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

Convert to EUR

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

Notes

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

Historical comparison: Track how your scheduled churn has changed over time
Trend analysis: Increasing scheduled churn may indicate retention issues
Negative values: All churn amounts are negative to represent revenue loss
Snapshot data: Each value represents what scheduled churn was at that specific point in time
Retention effectiveness: Compare trends to measure retention campaign impact

Summary Metrics - MRR and ARR snapshots
Churn Scheduled - Detailed scheduled churn timeline
Scheduled Churn Movements - Individual customer detail