Use the Stripe app for Adobe Commerce (Magento 2)

Learn how to install, upgrade, and uninstall the Stripe app for Adobe Commerce (Magento 2).

Caution

We recommend that you test the module before installing it in your production environment. If you have an installation issue, see Troubleshooting.

Install the module

1. Place an order for the module through the Adobe Marketplace.
2. Open a terminal and run the following command in your Adobe Commerce directory: Command Line composer require stripe/stripe-payments

At this stage, you might have to submit your username and password. Provide your Adobe Commerce authentication keys. You can accept to save your credentials when prompted by Composer. If you’ve saved your keys and see the error Invalid Credentials, update your keys in ~/the relevant part of the product or delete this file and run the command again.

1. Set up the module by running the following commands: Command Line php bin/magento setup:upgrade php bin/magento cache:flush php bin/magento cache:clean
2. If you run Adobe Commerce in production mode, you must also compile and deploy the module’s static files.

Command Line

php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

Upgrade the module

Before you upgrade:

• Back up your files and database.
• Start with your sandbox environment.
• Keep a copy of any customization you made to the module’s original code.
• Check out the the related setting .

Patch releases (x.x.Y) are backward compatible and require no extra development on your side after you upgrade. Minor and major releases might add new features or change code in a backwards incompatible way. If you customized the module’s code, you’ll need to port these customizations after upgrading and resolve any potential conflict.

Run the following commands:

Command Line

composer remove stripe/stripe-payments
composer require stripe/stripe-payments
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento cache:clean

Uninstall the module

Before you uninstall:

• Back up your files and database.
• Keep a copy of any customization you made to the module’s original code in case you need to reinstall it later.

Run the following commands:

Command Line

composer remove stripe/stripe-payments
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento cache:clean

Lifecycle policy

The latest version of the module supports the following versions of Adobe Commerce:

For stripe/stripe-payments:4.5.x and later, we provide bug fixes and security patches. Stripe recommends that you upgrade to the latest published version of the module. All releases are available in the Adobe Marketplace and in the stripe-magento2-releases GitHub repository.

Version history

Learn about backward compatibility changes in Adobe Commerce app versions (Magento 2).

Version 4.1

Version 4.1.0 introduces changes to handle scenarios where orders could be placed and invoiced without collecting payment. These scenarios include:

• Purchases of trial subscriptions.
• Subscriptions with future start dates.
• Upgrades or downgrades of existing subscription plans.

Previously, the module automatically refunded and closed these orders with an offline credit memo. Now, to improve tax reporting:

• Automatic refunds are deprecated.
• Order items in these scenarios have a custom price of 0.
• These items are excluded from shipping amount calculations.

This results in orders with zero subtotal, shipping, and tax amounts. When regular products are purchased with subscriptions, the subtotal, shipping, and tax amounts only reflect the regular order items. These changes ensure the order grand total matches the collected payment amount on the order date.

Additionally, version 4.1 changes how partial captures and refunds are handled:

• Previously, partial captures or refunds from the Stripe dashboard automatically created invoices or credit memos in Magento.
• These documents didn’t include order items, using manual totals or adjustment fees or refunds instead.
• This approach caused issues with tax reporting.

In version 4.1:

• Only full captures and full refunds result in automatic invoices or credit memos.
• For partial captures or refunds, merchants should use the Magento admin panel.
• This ensures correct tax breakdown on documents and accurate reporting to the Stripe API.

See also

• Configuring the Stripe app for Adobe Commerce
• Using the Adobe Commerce admin panel
• Troubleshooting