Breaking changes
Updates consent modeling for saving cards with Terminal Breaking changes
What’s new
Removes the customer_consent_collected parameter and replaces it with allow_redisplay.
Requires allow_redisplay when using setup_future_usage.
Removed
customer_consent_collected boolean
Indicates whether customer consent has been collected to redisplay the payment method.
Added
allow_redisplay enum
This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to unspecified.
Why is this a breaking change?
This is a breaking change because it requires allow_redisplay when saving card details with Terminal. For SetupIntents, customer_consent_collected has been removed and replaced with allow_redisplay. For PaymentIntents that specify setup_future_usage, then allow_redisplay must also be passed before collecting card details. With the new version, you must use allow_redisplay to control whether a payment can be shown to a customer again.
Impact
Lets you save cards in more regions using Terminal, expanding your service coverage. Additionally, the improved alignment with industry requirements for customer consent collection ensures regulatory compliance.
You must add the new parameter to your integration before March 31, 2025 and ensure that it’s set to always or limited on all Setup Intents transactions and Payment Intents that specify setup_future_usage.
Changes
| Parameters | Change | Resources or endpoints |
|---|---|---|
| allow_redisplay | Added | Terminal. Reader#process_payment_intent. process_config Terminal. Reader#process_setup_intent |
| customer_consent_collected | Removed | Terminal. Reader#process_setup_intent |
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.