Filter subscriptions reports by scheduled change

What's new?

You can now filter subscriptions reports by subscription_scheduled_change_action, whether you generate the report using the API or from the Paddle dashboard.

Every subscriptions report already carries subscription_scheduled_change_action as a column. It's now a filter too, so you can export the subscriptions scheduled to cancel without sifting through the whole report to find them.

How it works

Reports in Paddle let you export information from your account to import into accounting software, ERPs, and other business intelligence tools. Each filter you pass has a name and a value, so subscription_scheduled_change_action is a value you pass as a filter name.

Pass one or more of these values:

• cancel returns the subscriptions scheduled to cancel.
• pause returns the subscriptions scheduled to pause.
• resume returns the paused subscriptions scheduled to resume.
• none returns the subscriptions that don't have a scheduled change.

Leave out operator, or pass null. subscription_created_at is the only subscriptions report filter that takes an operator.

A scheduled change isn't a status. A subscription scheduled to cancel or pause is still active until the change takes effect, so it appears in the report as subscription_status: active with a subscription_scheduled_change_action of cancel or pause. A subscription scheduled to resume is paused, because the pause has already taken effect.

Combine the two filters to scope a report to a single case.

Example

This example creates a report of the active subscriptions that are scheduled to cancel:

{
  "type": "subscriptions",
  "filters": [
    {
      "name": "subscription_status",
      "value": ["active"]
    },
    {
      "name": "subscription_scheduled_change_action",
      "value": ["cancel"]
    }
  ]
}

Next steps

This filter works in version 1 of the Paddle API and in the Paddle dashboard. It's a non-breaking change, meaning it doesn't impact existing integrations.

Check out the subscriptions report guide for the full list of filters and columns, and create a report for the request format.