Breaking changes
Adds contextual filters to billing alerts Breaking changes
What’s new
Moves the filter field inside of the alert type configuration as a list of filters. Also renames the alert type configuration fields to drop the _config suffix.
Current API version
usage_threshold_config enum value
Use usage_threshold_config if you intend for an alert to fire when a usage threshold on a meter is crossed.
New
usage_threshold enum value
Use usage_threshold if you intend for an alert to fire when a usage threshold on a meter is crossed.
Why is this a breaking change?
Because this change moves the filter parameter into the alert configuration, you can no longer apply the filter at the top level of alerts.
Additionally, you can no longer specify usage threshold configurations with usage_threshold_config and instead must use usage_threshold.
Impact
With this change, you can create filters that are unique to each alert type. You can see the filters as part of the alert type configuration.
Changes
| Parameters | Change | Resources or endpoints |
|---|---|---|
| filter | Removed | Billing. Alert Billing. Alert#create |
| usage_threshold | Added | Billing. Alert |
| usage_threshold_config | Removed | Billing. Alert |
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: 2024-09-30. acacia
- Upgrade the API version used for webhook endpoints .
- Test your integration against the new version.
- If you use Connect, test your Connect integration .
- In Workbench, perform the upgrade . You can roll back the version for 72 hours.
Learn more about Stripe API upgrades.