Docs

Filter subscriptions by collection mode

List only automatically-collected or manually-collected subscriptions.

Product area

  • Subscriptions

Tooling

  • API

Released

October 3, 2023

Status

Released

API version

Version 1

What's new?

We added a new collection_mode query parameter that you can use when working with the list subscriptions operation to return entities that match the specified collection mode.

GET /subscriptions?collection_mode=automatic,manual
collection_mode string

Return entities that match the specified collection mode

How it works

The new collection_mode query parameter lets you filter subscriptions by collection mode. For example, you can use it to return subscriptions that are billed by invoice (manually-collected).

It works in the same way as the collection_mode query parameter when listing transactions.

Next steps

This change is available in version 1 of the Paddle API.

It's a non-breaking change, meaning it doesn't impact existing integrations.

You can list subscriptions using the API to start using the new query parameters.

Summary of changes

Entity Field Change Type
List subscriptions collection_mode + Added Field
Filter by automatic or manual collection mode.

Was this page helpful?