Adds support for retrieving thin events
What’s new
You can now retrieve thin Event objects for each notification from the /the relevant part of the product endpoint.
Thin events are lightweight events you can access through the API v2 API. Thin events have a more granular permissions model and their payloads contain no API-versioned data. This makes it easier to update integrations that receive events and are built with a well-typed Stripe SDK. Thin Event objects include a data property that can include additional information about the event.
The Meters API is the first API to use thin events. Currently, you can only retrieve the following Events v2 related to usage-based billing:
- v1.billing.meter.error_report_triggered
- v1.billing.meter.no_meter_found
Here’s an example of an v1.billing.meter.error_report_triggered event. The related_object field includes the id of the object, but doesn’t include the object record itself.
Learn more about events.
Impact
Thin events have several benefits. They make it easier to maintain future webhook integrations because the payloads are unversioned. You can send thin events to event destinations. Thin events are fully typed in the SDKs for API v2. Finally, if your application needs a corresponding API object related to an event (for example, the Meter), you must call the Stripe API for the object’s latest state. This helps prevent application errors caused by outdated object data (for example, race conditions). The SDKs for API v2 contain helper methods that allow you to retrieve records associated with an event.
Changes
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.