Magenest Subscriptions and Recurring Payments User Guide
Extension Version: | Extension Release Date: | Document Release Date:
Documentation Updates
To check for recent updates, or to verify that you are using the most recent edition of a document, go to: http://confluence.izysync.com/display/DOC/Documentation.
Support
Visit Magenest Support Website at http://magenest.com/.
This website provides contact information, details about the products and support that Magenest offers. As a valued support customer, you can benefit by using the support website to:
- Search for knowledge documents of interest
- Practice on product demo
- Submit support requests
In order to speed up the process of solving your problem, you should prepare before reporting a problem to Magenest. Make sure your system environment requirements are met. You can either submit a ticket at Magenest portal or email Magenest Support Team at [email protected].
About Magento Subscriptions and Recurring Payments User Guide
This guide describes how to use Magento Subscriptions and Recurring Payments extension designed by Magenest. It provides step-by-step instructions to help you manage your subscription products.
This guide is intended for Magento users at all levels. Readers should already have some understanding of Magento platform.
Introduction
Welcome to Magento Subscriptions and Recurring Payments developed by Magenest. This extension provides merchants options to configure subscription products such as magazines or newspapers. It will save customers’ time to buy products from repeating order process.
With this extension, you as a merchant will be able to manage subscription options for your products as desire.
Features
Magenest’s Subscriptions and Recurring Payments enables you to fully control subscription options and manage subscription profiles.
Customer Can Define Start Date provides merchants options to set whether customer can define the start subscription date or not.
Maximum Payment Failures enables merchants to set number of scheduled payments that can fail before subscription profile is automatically suspended.
Auto Bill on Next Cycle helps merchants to automatically bill the outstanding balance amount in the next billing cycle.
Multiple billing options allows merchants to create different billing periods.
Enable Trial (Trial Billing Amount, Trial Billing Period Unit, Trial Billing Frequency, Trial Billing Cycles, Enable Initial Fee)
Initial Fee Amount
Payment Profiles Manager allows merchants to manage subscription profiles, monitor which profiles are active or suspended or delete a profile.
Payment Methods
Magenest Subscriptions and Recurring Payments supports PayPal Express Checkout.
Subscription Product Types
Supported product types for Magenest Subscriptions and Recurring Payments extension include:
- Simple Product
- Virtual Product
- Downloadable Product
System Requirements
Your store should be running on Magento Community Edition version 2.0.0 or later versions.
Installation
Here we will walk you through the installation process of our extension. First off, open FileZilla, log in to your host as follows:
In the above example we switched the local site to the extension directory, and the remote site to the code directory. On the remote site window, inside app/code directory, create a folder named Magenest and go inside it. Now on your local site window, right click on Wrapper extension and click Upload. The extension will be uploaded onto your host in a few minutes.
The second method will require you to compress the extension into .zip or .tar.gz format, then execute the following command in your Command Line/Terminal:
scp <path to your extension> <ssh server>:<path to Magenest directory>
Then log into your ssh server, go to Magenest directory and execute the following command to decompress the module:
unzip <.zip compressed extension>
Or
tar -xzvf <.tar.gz compressed extension>
Now go to your Magento root directory, say it's named magento2, and execute the following commands:
sudo chmod -R 755 .
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy
sudo chmod -R 777 var pub
After running all these, your Command line/Terminal window might look like this:
Finally, flush the cache by either type this into the Command Line/Terminal:
php bin/magento cache:flush
Or go to System > Cache Management and click Flush Magento Cache
Now you can go to your store and check if the extension is working as expected.
Configuration
You can configure subscription setting for a new or an existing product.
- Log in your Magento backend system, click Products -> Catalog.
For new product, click Add Product or select a product type to start creating a new product on your store (our extension supports simple, virtual and downloadable products)
For existing product, click Edit
This will lead you to Basic Settings section where you can define your product characteristics.
- Click Subscription Options
Enable Subscription = Yes/ No
Customer Can Define Start Date = Yes/ No
Maximum Payment Failures: Allows you to set the maximum number of times that customer can fail to pay. When the number is reached, an IPN (Instant Payment Notification) message is sent to you and customer’s account will be suspended automatically.
Auto Bill on Next Cycle = Yes/ No. Indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle. The outstanding balance is the total amount of any previously failed scheduled payments that have yet to be successfully paid. It is one of the following values:
- Yes - PayPal does not automatically bill the outstanding balance
- No - PayPal does not automatically bill the outstanding balance
Billing Options. Enables you to define billing frequency or cycles.
Period Unit: is one of following values: Day, Week, SemiMonth, Month and Year.
Billing frequency: is number of billing period that make up a billing cycle.
Maximum Billing Cycles: is number of billing cycles for payment period.
Select period unit, enter the number you want to set on Billing Frequency and Maximum Billing Cycles.
For example, with this below configuration, product will be delivered to customer every 6 days. System will auto take payment from customer’s payment account after three delivery times.
Click here to see how this configuration will appear on your frontend store.
To add other billing options, click Add Option
To remove a billing option, click Remove
Enable Trial = Yes/ No
.....
Payment Profiles Management
You can manage the payment recurring profiles though Magenest Subscription -> Recurring Profiles. This Recurring Profiles Manager provides a table of recurring profiles with information on Profile ID, Status, Method Code, Subscriber Name and Start Date. Customers who subscribe to your products will be listed here.
Customize Recurring Profiles Manager View
You can choose which columns to be shown on the table.
By Default View, all columns (Profile ID, Status, Method Code, Subscriber Name and Start Date) are visible in the table.
To hide any column in the table, click Columns, uncheck the box of column you want to hide. To save this view setting for future usage, click the eye icon and name the view.
To set the table back to Default View, click Columns -> Reset. Or hit the eye icon, then click Default View.
Search Profile
To search for profiles, enter keyword in the Search by keyword box.
Or click Filter to search via criteria, enter information in any of the fields: Profile ID, Status, Method Code or Subscriber Name. Then click Apply Filters.
Click Clear All or hit the x icon to refresh your search result.
Note: you can filter recurring profiles via Status or Method Code.
Manage Profile Details
To check the profile details, click View.
To delete a profile, check the box in front of the row that has profiles you want to delete, click Actions -> Delete.
Export Profile
You can choose to export a list of recurring profiles in the format of CSV or Excel XML. At the top right corner, click Export, select format type and hit Export.