Adds filtering by creation date to Invoice Payment lists
What’s new
You can now filter Invoice Payments by their creation date using the new created parameter when you list invoice payments.
The parameter supports date range queries using the following operators to specify a date interval: gt (greater than), gte (greater than or equal to), lt (less than) and lte (less than or equal to).
Impact
You can now filter invoice payments by their creation date when calling the list endpoint. This provides more granular control over which payments you retrieve, allowing you to:
- Retrieve invoice payments created on a specific date by passing a timestamp to the created parameter. For example, specifying ?created=1609459200 filters for payments created at that exact timestamp.
- Retrieve invoice payments created before or after a certain date using comparison operators. For example, specifying created[gte]=1609459200 filters for invoice payments created after 1 January 2021.
- Retrieve invoice payments within a date range by combining operators. For example, specifying created[gte]=1609459200&created[lt]=1612137600 filters for invoice payments created in January 2021.
These new filter operators reduce the need to retrieve all invoice payments and then filter them client-side, improving performance and reducing data transfer volume for date-specific queries.
Changes
| Parameter | Change | Resources or endpoints |
|---|---|---|
| created | Added | InvoicePayment#list |
Upgrade
- View your current API version in Workbench.
- If you use an SDK, upgrade to the corresponding SDK version for this API version.
- If you don’t use an SDK, update your API requests to include Stripe-Version: 2025-11-17. clover
- Upgrade the API version used for webhook endpoints .
- Test your integration against the new version.
- If you use Connect, test your Connect integration .
Learn more about Stripe API upgrades.