- Installing Subscription and Recurring Payments
- Introducing Subscription and Recurring Payments
- Backend Configuration
- Extension Log
- Payment Gateway Configuration
Magento 2 Subscription and Recurring Payments allows assigning subscriptions to products. Configure a payment gateway, payment schedule, subscription duration, initial fees, and trial payments, for each subscription plan. Set subscription prices per product. Subscribers are charged automatically once a subscription period starts. They can track the status of the purchased subscription(s) from their accounts.
Compatibility: Magento Open Source 2.2.X, Magento Commerce 2.2.X
Thank you for choosing Aheadworks!
Installing Subscription and Recurring Payments
Command Line Installation
Introducing Subscription and Recurring Payments
The Subscription and Recurring Payments extension offers the following subscription functionality:
- Payments processed via the PayPal Express, Authorize.Net, Adyen, and Stripe external gateways;
- Multiple subscription products can be purchased within the same subscription plan;
- Trial payments and initial fees configured per subscription product;
- Editable billing and shipping subscription addresses;
- Multi-store and multi-currency subscriptions;
- Configurable and bundle product support.
The extension allows store owners to offer regular products as subscriptions. Once subscription plans have been created, an admin can enable them at the product level. The general subscription settings, including subscription duration, payment frequency, etc., are configured per plan. The more specific ones are set at the product level.
The module does not convert products into subscriptions. Instead, it adds a few new purchase options to the appropriate product: as a regular item or as a subscription. The admin can decide whether to offer products as subscription-only, one-off only (by default), or in both variants.
In essence, the extension is divided into the following menu pages:
- Subscriptions - the main subscription management page. It lists all customer subscriptions with an overview of the most important subscription attributes;
- Subscription plans - a grid with the list of all active subscription plans. You can create the new and edit the existing plans;
- Log - a grid with a record of all subscription-related actions by the admin and customers (subscription status change, customer profile creation, etc.).
In addition, the extension introduces the general configuration settings page.
Start with configuring the extension settings under Stores > Configuration > AHEADWORKS EXTENSIONS > Subscription and Recurring Payments.
The settings define the extension behavior when dealing with taxes, the logging period's duration, and introduces a couple of UI enhancements:
- Apply Tax on Trial Amount - defines if product taxes should be applied to trial period payments;
- Apply Tax on Shipping Amount - defines if product taxes should be applied to shipping amounts;
- Display "You Save X %" on Product Page - defines whether the %-difference between an original item price and a subscription price should be displayed in the 'Subscribe' button on product pages (for promotional purposes);
- Tooltip Near Subscription Button on Product Page - allows displaying a tooltip next to the 'Subscribe' button on product pages. The tooltip describes how the subscription option works;
- Keep Log for, days - defines the number of days during which the extension keeps a log.
Having configured the settings, you may start creating subscription plans. Go to Sales > Subscription and Recurring Payments by Aheadworks > Subscription plans.
Subscription Plans is a grid that contains the basic information about the existing subscriptions:
- ID - an ID of a plan;
- Name - the plan's title;
- Status - the plan's status;
- Initial Fee - the column shows whether an initial fee is required by the plan;
- Trial Period - the column shows whether a trial period is provided by the plan;
- Total Number Of Payments - the total number of payments required by the plan;
- Number Of Trial Payments - the total number of trial payments required by the plan.
To create a new plan, click on the 'Add Subscription Plan' button above the grid. Once created, the plan is shared among all the products with the subscription option enabled.
Creating a New Plan
The 'New Subscription Plan' page's settings are split into four blocks: 'General Information', 'Schedule', 'Additional Pricing Settings', and 'Storefront Description'.
As the title suggests, the block lists the common plan settings:
- Status - allows enabling/disabling a subscription plan;
- Website - defines a website the plan should be available at;
- Name - allows defining the plan's name for internal identification purposes.
- Subscription engine - allows selecting a payment method available for the plan.
Here you can define how many times and how often customers will be charged along with the subscription start date:
- Number of Payments - defines how many times customers will be charged (the number of orders will be created accordingly);
- Repeat Payments - defines how often customers will be charged;
- Subscription start date - defines if the subscription will start at the moment of purchase, the exact day of a month, the last day of the current month, or on the date defined by a customer.
Additional Pricing Settings
This section controls all the additional subscription plan's pricing parameters:
- Enable Initial Fee - defines if the initial fee is enabled for the subscription plan. The exact value is set at the product level;
- Enable Trial Period - defines if the trial period is enabled for the subscription plan. The price is set at the product level;
- Number of Trial Payments - defines the number of trial period payments in this period. Make sure to enter the value that doesn't contradict the 'Number of Payments' setting.
In this section you can set the subscription plan's name and description to be displayed on the storefront:
- Store View - defines a store view this plan's title and description will be displayed at;
- Title - the name of the subscription plan;
- Description - the plan's description (supports HTML).
Additional store view descriptions can be added by clicking on the 'Add' button.
Once the plan's settings have been configured, click on the 'Save' button.
Configuring Subscription Products
The extension doesn't add a new product type with a limited set of options to the store. Instead, it allows you to offer the existing products as subscriptions.
Subscription settings are added to the configurable, bundle, simple, virtual, and downloadable product types. It can be found in the 'Subscription Configuration' section on the product details page in Catalog > Products.
There is a total of four settings:
- Subscription - defines if the product should be offered as a single-time purchase, only as a subscription, or available in both variants: a subscription and a single purchase;
- Regular Payment Price - defines the price of a regular subscription payment;
- Trial Price - defines the price of the trial subscription period (if the trial is period is enabled);
- Initial Fee - defines the initial fee a customer will have to pay for placing a subscription order. This is a single payment that is processed separately.
Every time the customer purchases a subscription product, a new entry is created in the 'Subscriptions' grid under Sales > Subscription and Recurring Payments by Aheadworks > Subscriptions.
Here you are presented with an overview of all active, suspended, canceled, and expired subscriptions.
- ID - an ID of a subscription;
- Subscription Profile ID - an ID of a subscription profile;
- Customer - the name of a subscribed customer;
- Email - the subscriber's email;
- Group - the subscriber's group;
- Subscription Plan - the plan purchased by the subscriber;
- Status - the current subscription status (active, suspended, or canceled);
- Created At - the order creation date;
- Start Date - the subscription's start date;
- Last Order - the last order's ID;
- Last Order Grand Total - the last order's largest total;
- Last Order Date - the last order's date.
With the 'Actions' drop-down, you can cancel and suspend the selected subscription(s).
By clicking 'Subscription Profile ID', you can check all orders associated with the subscription (just like in the native Magento).
Starting with the version 1.3.0, the extension comes with the 'Log' grid that stores all the subscription-related action records.
In case the log needs to be cleared, click the 'Clear Log' button.
Depending on the subscription options selected, the subscription product will look something like this:
In the above picture, you can see the product with the 'Subscription' option set to 'Optional'. Thus, there are two buttons displayed at once: 'Add to Cart' and 'Subscribe'.
The native 'Price' attribute of this product was set to $15, while the subscription price was set to $12,5. That's why one can see that subscribing to this product supplies will save 16% total.
All subscription products are added to the dedicated subscription cart. It was introduced to avoid issues with payment gateways, as most of the payment processors can either process a single-time payment or create a recurring profile.
When a customer clicks on the 'Subscribe' button, he/she gets redirected to the 'Subscription Cart' page:
The 'Subscription Cart' page represents a four-step progress bar indicating the checkout process.
At the first step - 'Product' - the customer is suggested to select the appropriate subscription plan. The plans come in individual blocks. Each block contains the subscription plan's basic info.
To get a comprehensive overview of the subscription terms, the customer needs to click on the 'See more details' active link below the 'Select Plan' button.
Upon clicking the 'Select Plan' button, the customer proceeds to the second checkout step - 'Subscription Plan'. There, he/she can see the plan's overview.
When everything is considered, one should click on the 'Continue to Checkout' button to proceed to the next step.
- The third step - 'Secure Checkout' - is the step of the native Magento 2 checkout. There the customer is suggested to indicate his/her shipping and billing info and choose the proper shipping method.
- The fourth step - 'Confirmation' - is the payment confirmation stage.
Once the subscription order has been placed, the customer can navigate to his/her account to check all active subscriptions.
Customer Account Section
The extension introduces the 'My Subscriptions' section to a customer account dashboard. The section lists all the customer's subscriptions (both the active and expired ones).
By clicking on the 'View' active link next to the required subscription, the customer can have an in-depth look at all associated orders and adjust his/her billing and shipping information (if required).
The subscription details page also allows customers to suspend and cancel subscriptions anytime required.
Payment Gateway Configuration
Make sure to save the changes made.
Make sure to save the changes made.
PayPal Express Checkout
Adyen has an extensive documentation about how to install the payment method in a Magento 2 store that can be found here: https://docs.adyen.com/developers/plug-ins-and-partners/magento/magento-2
In short, the installation process requires the following set of actions:
Make sure to save the changes made.
Note: For the extension's purposes, Adyen processes only the credit card payments.
You can always find the latest version of the software, full documentation, demos, screenshots, and reviews on http://ecommerce.aheadworks.com
License agreement: https://ecommerce.aheadworks.com/end-user-license-agreement/
Contact Us: http://ecommerce.aheadworks.com/contacts/
Copyright © 2018 Aheadworks Co. http://www.aheadworks.com