Adds a metadata field to the Vault and Forward API
What’s new
This change adds a metadata field to the Vault and Forward API. You can add additional information when you create a forwarding request.
Impact
The new metadata field lets you perform reconciliation on forwarding requests. Previously, you had to rely on the idempotency key to attribute forwarding requests to specific customers or invoices.
Changes
| Parameter | Change | Resources or endpoints |
|---|---|---|
| metadata | Added | Forwarding. Request#create Forwarding. Request |
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-10-28. 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.