Skip to content
Create account
or
Sign in
The Stripe Docs logo
/
Ask AI
Create account
Sign in
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
Developer tools
Get started
Payments
Finance automation
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
Overview
Versioning
Changelog
    Overview
    Basil
    Acacia
    Previous versions
Upgrade your API version
Upgrade your SDK version
Developer tools
SDKs
API
Testing
Workbench
Event Destinations
Workflows
Stripe CLI
Stripe Shell
Developers Dashboard
Agent toolkit
Stripe health alertsBuild with LLMsStripe for Visual Studio CodeFile uploads
Security
Security
Extend Stripe
Stripe Apps
Stripe Connectors
Partners
Partner ecosystem
Partner certification
HomeDeveloper toolsChangelogAcacia2024-09-30.acacia

Adds contextual filters to billing alertsBreaking 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_configenum value

Use usage_threshold_config if you intend for an alert to fire when a usage threshold on a meter is crossed.

New
usage_thresholdenum 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

ParametersChangeResources or endpoints
usage_thresholdAdded
Billing.Alert#createBilling.Alert
filterusage_threshold_configRemoved
Billing.Alert#createBilling.Alert

Upgrade

  1. View your current API version in Workbench.
  2. 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
  3. Upgrade the API version used for webhook endpoints.
  4. Test your integration against the new version.
  5. If you use Connect, test your Connect integration.
  6. In Workbench, perform the upgrade. You can roll back the version for 72 hours.

Learn more about Stripe API upgrades.

Related changes

  • Adds an Alerts API for usage-based billing
  • Adds an event for triggered billing alerts
  • Adds support for listening to triggered billing alerts
  • Adds billing alert resources and endpoints
  • Adds support for subscriptions and subscription items to billing alerts
  • Adds Meter Event v2 API endpoints
Was this page helpful?
YesNo
Need help? Contact Support.
Join our early access program.
Check out our changelog.
Questions? Contact Sales.
LLM? Read llms.txt.
Powered by Markdoc