Scheduled churn movements

The /reports/churn-scheduled-movements endpoint returns individual customer-level detail for scheduled churn in a given period. This complements the scheduled churn summary by showing which specific customers are scheduled to churn and by how much.

💡 Use case: Identify at-risk customers, reach out to prevent churn, export scheduled cancellations for retention campaigns.

GET /reports/churn-scheduled-movements

Returns a list of scheduled churn movements with customer details.

Authentication

Required

Include your API key in the Authorization header:

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

Query parameters

Parameter	Type	Description
`selected-date`optional	string	Period start date to show movements for (format: `YYYY-MM-DD`).
`selected-type`optional	string	Churn type: `month_churn`, `year_churn`, `quarter_churn`, `week_churn`, `day_churn`
`baseCurrency`optional	string	Target currency for conversion. Defaults to account base currency.
`interval`optional	string	Aggregation interval. Defaults to `month`.
`breakdown`optional	string	Group by dimension (e.g., `plan`, `country`).
`breakdown-value`optional	string	Filter to a specific breakdown value.
`fix_fx`optional	boolean	Use fixed exchange rates.
`customer`optional	string	Filter by customer ID.
`sort`optional	string	Sort field (e.g., `mrr_change`, `date`).
`order`optional	string	Sort direction: `asc` or `desc`.

Response

200 OK

Returns a list of scheduled churn movements.

{
  "result": {
    "list": [
      {
        "date": "2025-03-01",
        "currency": "usd",
        "customer_id": "cus_456",
        "customer_name": "Beta LLC",
        "customer_email": "[email protected]",
        "type": "churn",
        "mrr_change": -4900,
        "mrr_change_base_currency": -4900,
        "description": "Pro Plan cancellation"
      },
      {
        "date": "2025-03-15",
        "currency": "eur",
        "customer_id": "cus_789",
        "customer_name": "Gamma GmbH",
        "customer_email": "[email protected]",
        "type": "churn",
        "mrr_change": -9900,
        "mrr_change_base_currency": -10692,
        "description": "Enterprise Plan cancellation"
      }
    ]
  }
}

Response fields

Field	Type	Description
`date`	string	Scheduled churn date (ISO format: YYYY-MM-DD)
`currency`	string	Original currency of the subscription
`customer_id`	string	Customer external ID from billing system
`customer_name`	string	Customer name
`customer_email`	string	Customer email address
`type`	string	Movement type (always `churn`)
`mrr_change`	number	MRR change in original currency (cents, negative)
`mrr_change_base_currency`	number	MRR change in base currency (cents, negative)
`description`	string	Description of the scheduled change

Example requests

Get all scheduled churn

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

Get churn scheduled for March 2025

curl "https://api.growpanel.io/reports/churn-scheduled-movements?selected-date=2025-03-01" \
  -H "Authorization: Bearer YOUR_API_KEY"

Get monthly churn only

curl "https://api.growpanel.io/reports/churn-scheduled-movements?selected-type=month_churn" \
  -H "Authorization: Bearer YOUR_API_KEY"

Sort by largest churn amounts

curl "https://api.growpanel.io/reports/churn-scheduled-movements?sort=mrr_change&order=asc" \
  -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.

Scheduled churn: Based on subscription end dates and cancellation schedules from your billing system
Proactive retention: Use this data to identify and reach out to at-risk customers before they churn
Accuracy: Depends on accurate subscription schedule data synced from Stripe, Chargebee, or Recurly
Churn types: Filter by billing frequency to focus on monthly vs annual churn
Customer detail: Includes contact information for retention outreach

Churn Scheduled - Aggregated scheduled churn timeline
Scheduled Churn Summary - Historical churn snapshots
Movement Table - Actual (past) churn movements