Installation, Uninstallation, License Keys, Upgrading, and Downgrading Guide

• Installing M2 Advanced Subscription Products
• Set up cron
• Integrate License Keys
• Important! Manage Keys During Deployments
• Upgrade to Version 3
• Downgrade to Version 2
• Uninstalling M2 Advanced Subscription Products

Installing M2 Advanced Subscription Products

Composer Installation

1. If you are installing an extension from Aheadworks for the first time, you need to add our composer repository to your Magento store:

Login to your ssh console and navigate to your store folder:

cd path_to_the_store_root_folder

Run the following command:

composer config repositories.aheadworks composer https://dist.aheadworks.com/

On successful execution of the command you will be able to use the composer to install the extensions.

To install the extension:

2. Login to your ssh console and navigate to your store folder:

cd path_to_the_store_root_folder

3. Run the following command to install the latest version of the extension:

composer require aheadworks/module-sarp3

if you need to install a specific version, run this command:

composer require aheadworks/module-sarp3:<version>

When prompted, enter Public Key (Username) and Private Key (Password):

Both Public Key (Username) and Private Key (Password) can be found in My Projects and Licenses in your personal account on our site:

If you need to install a specific version, run this command (specify the version of the extension in <version>):

composer require aheadworks/module-sarp3:<version>

Need to integrate M2 Advanced Subscription Products with a payment method or GraphQL?

Note: It is recommended to install only the payment method modules and compatibility modules that you’re going to use in your store.

General modules

Payment method modules

Note: Ensure the official module of the payment gateway you are using is installed.

4. Enable the extension:

bin/magento module:enable Aheadworks_Sarp2

How to enable a specific payment method or GraphQL?

Note: Enable only the payment method modules for which you have installed the official payment gateway module and a compatibility add-on.

Proceed with a corresponding command (associated with the specific module you intend to use):

Next, register the extension:

bin/magento setup:upgrade

Recompile the Magento store if you are in the Production mode:

bin/magento setup:di:compile

To verify that the extension is enabled, run this command:

bin/magento module:status

Clean store cache, by running the following command:

bin/magento cache:clean

Log out and Log in the backend again.

To upgrade the extension:

• Update per module name:

composer update aheadworks/module-sarp3

• If needed, you can specify an exact version:

composer require aheadworks/module-sarp3:<version>

Run the following commands to upgrade store, deploy it, and clean the cache.

bin/magento setup:upgrade --keep-generated
bin/magento setup:static-content:deploy
bin/magento cache:clean

Set up cron

If you have already configured cron jobs for your Magento installation, then you can skip this step. Read the following instructions on setting cron job for your Magento store: Magento user guide.

In most cases, it is enough to run the following command in the SSH console of your server: 

crontab -e

And insert the following lines:  

*/3 * * * * php -c <ini-file-path> <your Magento install dir>/bin/magento cron:run
*/3 * * * * php -c <ini-file-path> <your Magento install dir>/update/cron.php
*/3 * * * * php -c <ini-file-path> <your Magento install dir>/bin/magento setup:cron:run

Remember to confirm the Save request on exit.

Integrate License Keys

When the license for Advanced Subscription Products for Magento 2 is purchased and integrated into your project, four License Keys will be generated. One key is designated for production, while three are for testing environments. Each key allows you to connect one store with Advanced Subscription Products.

You can find these keys from My Account > My Projects and Licenses in the relevant project.

After installing Advanced Subscription Products, navigate to Stores > Configuration > Aheadworks Extensions > Advanced Subscription Products in your Magento Admin. In the Integration Details section, you'll find:

• License Key - insert the key from My Projects and Licenses.

• Magento Access Token - grants access to your Magento stores.
• Bypass HTTP Authorization - set Yes for test keys. This bypasses HTTP Authorization commonly used in development mode/staging.

If set to Yes, two additional fields appear:

• HTTP Authorization Username - enter the HTTP Authorization username associated with the website.
• HTTP Authorization Password - enter the corresponding password.

Make sure to configure the settings correctly to avoid any issues. If HTTP Authorization is enabled on the store and Bypass HTTP Authorization isn't configured, the extension won't function correctly.

Please click the "Connect" button to connect your website with Advanced Subscription Products. 

Remember to Disconnect your website each time during deployments.

Manage Keys During Deployments

If the key is already active on another store, inserting it on a new domain will trigger an error. When deploying from a stage server using test keys to production without clicking the disconnect button, an error will occur during setup:upgrade, resulting in a loss of connection and deletion of the public key stored in the database. A note will appear on all Magento pages, indicating the need to configure Subscription and Recurring Payments module. 

What to do: 

Change the key to another test or production key based on the data migration during deployment. 

If you click Disconnect before deployment, then after deployment, click the Connect button to activate everything on the new server.

In short:

1. When data has been duplicated after deployment, it's essential to insert a new key.
2. During data migration, click Disconnect, and after deployment, click Connect.

Upgrade to M2 Advanced Subscription Products Version 3

Before initiating the upgrade process, ensure that your current Advanced Subscription Products Version 2 is at least 2.24.0 to avoid potential issues. 

To install the extension:

1. Login to your ssh console and navigate to your store folder:

cd path_to_the_store_root_folder

2. Run the following command to install the latest version of the extension:

composer require aheadworks/module-sarp3

if you need to install a specific version, run this command:

composer require aheadworks/module-sarp3:<version>

Next, register the extension:

bin/magento setup:upgrade

Recompile the Magento store if you are in the Production mode:

bin/magento setup:di:compile

Clean store cache, by running the following command:

bin/magento cache:clean

Downgrade to Advanced Subscription Products Version 2

Note: Before downgrading, make sure to disconnect your License Keys to avoid any loss of data.

1. Login to your ssh console and navigate to your store folder:

cd path_to_the_store_root_folder

2. Run the following command:

composer remove --no-update aheadworks/module-sarp3

composer update aheadworks/module-sarp3

Next, upgrade setup:

bin/magento setup:upgrade

Recompile the Magento store if you are in the Production mode:

bin/magento setup:di:compile

Clean store cache, by running the following command:

bin/magento cache:clean

Uninstalling M2 Advanced Subscription Products

Please be very careful when uninstalling/disabling this module. This module uses a declarative DB scheme. Once the module is uninstalled the DB tables will be lost.

1. Disable the extension and the integration patches by executing the following commands:

bin/magento module:uninstall Aheadworks_Sarp2
bin/magento module:uninstall Aheadworks_Sarp2Adyen
bin/magento module:uninstall Aheadworks_Sarp2Stripe
bin/magento module:uninstall Aheadworks_Sarp2FreePayment
bin/magento module:uninstall Aheadworks_GraphQL
bin/magento module:uninstall Aheadworks_Sarp2AuthNetCim
bin/magento module:uninstall Aheadworks_Sarp2QuickView
bin/magento module:uninstall Aheadworks_Sarp2Reports
bin/magento module:uninstall Aheadworks_Sarp2Braintree
bin/magento module:uninstall Aheadworks_Sarp2BraintreeByPaypal
bin/magento module:uninstall Aheadworks_Sarp2Aps
bin/magento module:uninstall Aheadworks_Sarp2Paypal
bin/magento module:uninstall Aheadworks_Sarp2CustomerGroup
bin/magento module:uninstall Aheadworks_Sarp2Psigate

Next Guide >>>

Want to learn more about Advanced Subscription Products? Read the following articles:

• Introduction to Advanced Subscription Products
• General Settings
• Subscriptions Management
• Subscriptions on Storefront