Getting Started
Welcome to the Order Surcharge documentation.
Whether you are a new or an advanced user, you can find some useful information here.
First of all, we recommend to check the following link:
Second of all, proceed then with Quick Start, which will guide you through creating your own Order Surcharge.
How to install the extension
- Backup your store's database and web directory.
- Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
- Copy the installation instructions from the page My Downloadable Products to the SSH console and press ENTER.
- Run command
php -f bin/magento module:enable Mirasvit_Core Mirasvit_Surcharge Mirasvit_ShippingArea to enable the extensions.
- Run command
php -f bin/magento setup:upgrade to install the extension.
- Run command
php -f bin/magento cache:clean to clean the cache.
-
Deploy static view files
rm -rf pub/static/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy
Quick Start
The Order Surcharge for Magento 2 extension is designed to help you make your prices more attractive while maintaining your profits.
This section is not finished yet.
How to upgrade extension
To upgrade the extension follow these steps:
- Backup your store's database and web directory.
- Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
- Run command
composer require mirasvit/module-surcharge:* --update-with-dependencies to update current extension with all dependencies.
Note
In some cases the command above is not applicable, it's not possible to update just current module, or you just need to upgrade all Mirasvit modules in a bundle. In this case command above will have no effect.
Run instead composer update mirasvit/* command. It will update all Mirasvit modules, installed on your store.
- Run command
php -f bin/magento setup:upgrade to install updates.
- Run command
php -f bin/magento cache:clean to clean the cache.
-
Deploy static view files
rm -rf pub/static/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy
Disabling the Extension
Temporarily Disable
To temporarily disable the extension please follow these steps:
- Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
- Run command
php -f bin/magento module:disable Mirasvit_Surcharge Mirasvit_ShippingArea to disable the extension.
- Log in to the Magento backend and refresh the store cache (if enabled).
Removing the Extension
To uninstall the extension, please follow these steps:
- Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
- Run the command
composer remove mirasvit/module-surcharge to remove the extension.
- Log in to the Magento backend and refresh the store cache (if enabled).
1.0.34
(2026-02-03)
Improvement
- Passing tax to Kustom checkout for taxable surcharges with the catalog settings "included tax"
1.0.33
(2026-01-14)
Improvement
- Compatibility with Kustom(Klarna) Checkout
1.0.32
(2025-12-16)
Fixed
- Undefined variable $surcharges in Paypal/Review.php
1.0.31
(2025-10-14)
Improvement
- Added system configuration field for surcharge total sort order in "Checkout Totals Sort Order"
Fixed
- Multiple surcharge totals were not displayed in the checkout totals section in some checkout configurations
1.0.30
(2025-09-18)
Fixed
- Added separate surcharge rows in cart totals
1.0.29
(2025-06-04)
Fixed
- Region is not validated on first load in cart and one step checkout
1.0.28
(2025-06-02)
Improvement
- Collected translation phrases for the translation file
1.0.27
(2025-06-02)
Improvement
- Improve WCAG 2.2 AA compliance for Surcharge module form inputs
1.0.26
(2025-04-18)
Improvement
- Compatibility with php8.4
1.0.25
(2025-03-24)
Improvement
- Added surcharges to PDF totals
1.0.23
(2024-08-16)
Fixed
- Wrong tax calculation for multiple surcharges
1.0.22
(2024-07-26)
Improvement
1.0.21
(2024-03-01)
Improvement
- Changed Surcharge displaying in the email template and in customer account
1.0.20
(2024-02-28)
Fixed
- Surcharge Group Label displayed only one Surcharge label in order/invoice emails
1.0.19
(2024-02-01)
Fixed
- Custom attributes are not validated
1.0.18
(2024-01-02)
Improvement
- Added percent type calculation per order subtotal
1.0.17
(2023-12-05)
Improvement
- Added mst_surcharge attribute to the order object
1.0.16
(2023-11-03)
Fixed
- Undefined array key "surcharge" in credit memo grid in admin
1.0.15
(2023-11-02)
Fixed
- Class "Magento\Framework\Currency\Data\Currency" not found in Credit Memo
1.0.14
(2023-10-06)
Fixed
- Rates per item and product applied to the non-valid items
- Surcharges did not validate "Stop further rules processing"
- Surcharge did not save rule actions
1.0.13
(2023-08-23)
Fixed
- Compatibility with m2.4.6 (Class Zend_Currency not found in Surcharge/Block/Adminhtml/Sales/Creditmemo/Create/Surcharge.php)
- Update totals in checkout
1.0.12
(2023-08-02)
Fixed
- Collection::addStoreFilter(): Argument #1 ($storeId) must be of type array, int given
1.0.10
(2023-07-28)
Fixed
- Deprecated Functionality: stripos(): Passing null to parameter #1 ($haystack) of type string is deprecated in module-price-permissions
- Argument #1 ($storeId) must be of type int, array given in Surcharge\Collection::addStoreFilter
1.0.9
(2023-07-21)
Improvement
- Added new option in the rule to calculate extra fee based on the discounted prices
1.0.8
(2023-07-18)
Improvement
- Added surcharge total to the success page
1.0.7
(2023-07-11)
Improvement
- Added actions to surcharge rules
1.0.6
(2023-06-08)
Fixed
- Validation for rate "Rate per applicable Product"
- Compatibility with Amasty Shippng
1.0.5
(2023-05-04)
Improvement
- Added new rate "Rate per one item"
1.0.4
(2023-01-06)
Fixed
- Error during creditmemo saving
1.0.3
(2022-12-15)
Fixed
- Error during invoice saving
1.0.2
(2022-12-07)
Improvement
- Added rate "Rate per applicable Product"
1.0.1
(2022-12-06)
Fixed
- Duplicate rows in admin grid
1.0.0
(2022-08-23)
Features