What's new?
We added new query parameters that you can use when working with the list notifications operation to filter returned entities.
/notifications Return entities from a specific time. Pass an RFC 3339 datetime string
Return entities up to a specific time. Pass an RFC 3339 datetime string
Return entities that contain the Paddle ID specified. Pass a transaction, customer, or subscription ID
How it works
The new from and to query parameters let you filter notifications by date. For example, you can use them to return notifications that happened in the last day, week, or another period.
The new filter query parameter lets you filter notifications that relate to transactions, subscriptions, or customers using their relevant Paddle IDs. For example, you can find all notifications that relate to a particular customer. This isn't just limited to notifications for customer events, it includes notifications for any events that relate to that customer — including subscriptions or transactions for them.
Examples
This example returns notifications that occurred during May 2023.
/notifications?from=2023-05-01T00:00:00Z&to=2023-06-01T00:00:00Z Return entities from a specific time. Pass an RFC 3339 datetime string
Return entities up to a specific time.
This examples returns notifications for a customer. It includes all notifications that relate to the customer, including subscriptions and transactions for them.
/notifications?filter=ctm_01h2asct98zxebssbkt1q6tfyr Return entities up to a specific time. Pass an RFC 3339 datetime string
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 notifications using the API to start using the new query parameters.
Summary of changes
| Entity | Field | Change | Type |
|---|---|---|---|
| List notifications | from | + Added | Field |
| Filter notifications by start date. | |||
| List notifications | to | + Added | Field |
| Filter notifications by end date. | |||
| List notifications | filter | + Added | Field |
| Filter by customer, subscription, or transaction ID. | |||