Docs

Filter subscriptions by ID when listing

Pass a list of subscription IDs when listing subscriptions to return subscriptions that match.

Product area

  • Subscriptions

Tooling

  • API

Released

October 6, 2023

Status

Released

API version

Version 1

What's new?

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

GET /subscriptions
id array[string]

Return only the IDs specified. Use a comma-separated list to get multiple entities

How it works

The new id query parameter lets you filter subscriptions by ID. You can pass a comma-separated list, and Paddle returns any entities that match.

id is already supported by other list endpoints, so this release makes the /subscriptions endpoint consistent with the rest of the Paddle API.

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 id + Added Field
Filter by one or more subscription IDs.

Was this page helpful?