Transcription

1 Product Name: Recurring & Subscription Payments Document Type: Help doc Author: Milople Inc.

2 Table of Content 1) Installation and uninstallation guide 1.1) How to install the extension 1.1.1) What are the system requirements? 1.1.2) Steps to follow while installing the extension ) Installation through Magentoconnect OR Manual Installation ) Theme Integration 1.2) Uninstallation and urgent deactivation 1.2.1) How to uninstall/deactivate the extension 1.2.2) How to deactivate the extension in case of emergency 2) General Configuration 2.1) License and Status 2.1.1) Configuration fields in detail 2.2) General Settings 2.2.1) How to show terms created for the plan on frontend in product page 2.2.2) How to activate subscriptions based on various events performed 2.2.3) How to enable extension for specific customer or customer groups 2.2.4) General Settings fields in detail 3) Discount Settings 3.1) How to apply discounts on subscription 3.2) Is it possible to enable discount based on selected customer groups 3.3) What are the options to apply discount 3.4) What are the ways to apply discount 3.5) Discount Settings fields in detail 4) Terms and conditions Settings 4.1. How it works 5) PayPal Pay flow Settings 5.1. Why we need this setting 6) Order Confirmation Settings 6.1) How to configure extension to send s once the order is confirmed 6.2) Order Confirmation settings in detail 7) Upcoming Payment Reminder Settings 7.1) How to send reminder s to customers for their upcoming rent payment 7.2) Upcoming Payment Reminder settings in detail 8) Payment Confirmation Settings 8.1) How to send s for received and confirmed subscription payment 8.2) Payment Confirmation settings in detail 9) Subscription Status Notifications Settings 9.1) How to send s to customers when status of the subscriptions get changed 9.2) Subscription Status Notifications Settings in detail 10) Subscription Expiry Reminder Settings 10.1) How to send reminder s to customers before due dates of subscription expiry 10.2) Subscription Expiry Reminder Settings in detail 11) How to setup first recurring product 11.1) How to name a plan 11.2) Can the products be offered as normal purchase 11.3) How to define start date of subscription 11.4) How to enable or disable a plan 2

3 11.5) How to create various terms for each plan 11.6) How to assign products to a plan 11.7) Where I can see the list of all saved plans 11.8) Can i assign unique first term price for specific product 12) Frontend View 12.1) Recurring & Subscription Payments on product view page 12.2) Recurring & Subscription Payments on cart page 12.3) Recurring & Subscription Payments on checkout page 12.4) Recurring & Subscription Payments in My Account page 12.5) Editing Subscriptions from My Subscription page 12.6) Subscription Payments in My Subscription page 13) Manage Subscriptions 14) Payment Method Dependency 15) Troubleshooting 16) Support and feedback 17) FAQ (Frequently asked questions) 3

4 1) Installation and Uninstallation guide: Installation and Uninstallation procedure of Magento Recurring & Subscription Payments extension is simple, fast and quick. Below are the guidelines that need to be followed while installing and uninstalling the Recurring & Subscription Payments extension. 1.1) How to install the extension? Installation of the extension is easy and neither requires a hardcore coding nor rocket science knowledge. Just follow the below mentioned rules for installing the Recurring & Subscription Payments extension by Milople ) what are the system requirements? An E-commerce store created using Magento Compatible With - Community: 1.5.x to 1.9.x, Enterprise: 1.10.x to 1.14.x 1.1.2) Steps to follow while installing the extension ) Installation through Magentoconnect Get Recurring & Subscription Payments extension from Milople Magento extension store Extract the module package and you will see Milople_Recurringandsubscriptionpayments-x.x.x.tgz file inside. Go to System > Magento Connect > Magento Connect Manager. Log in with your admin credentials and go to Direct Package File Upload tab. Browse Milople_Recurringandsubscriptionpayments-x.x.x.tgz file and upload it. Check the screen and the module will be seen installed once you click Refresh from bottom of the page. Click on Return to Admin link from top right corner of the page. Go to System > Configuration. Look for Recurring & Subscription Payments option under the Milople Extensions tab on the left hand side of configuration. If you find it, then the extension is installed successfully. OR ) Manual Installation Get Recurring & Rental Payments extension from Milople Magento extension store Unzip the extension and copy the folder structure in your store. Your Magento store installation should contain a folder structure like this: root/magento/app root/magento/js root/magento/skin Recurring & Rental Payments extension contains a similar folder structure so you just have to copy the module s folders and upload them on your server in your Magento store installation. Go to the administration area of your store. Log in and go to System > Configuration. Look for Recurring & Rental Payments option under the Milople Extensions tab on the left hand side of configuration. If you find it, then the extension is installed successfully. Read FAQ or Troubleshooting for further information or any problems during installation. 4

5 ) Theme Integration If you are using custom theme in your store, you have to copy the layout and template files of our extension into your store theme manually in order to make your theme compatible with our extension. Copy following files and folders as shown below: copy app/design/frontend/default/default/layout/recurringandrentalpayments.xml file and paste it to app/design/frontend/your-package/your-theme/layout/ directory copy app/design/frontend/default/default/template/recurringandrentalpayments folder and paste it to app/design/frontend/your-package/your-theme/template/ directory Copy skin/frontend/default/default/recurringandrentalpayments folder and paste it to skin/frontend/your-package/your-theme/ directory 1.2) Uninstallation and urgent deactivation Make sure to follow similar type of method to uninstall by which you had installed earlier ) How to uninstall/deactivate the extension? Uninstallation through Magento Connect Go to System > Magento Connect > Magento Connect Manager. Log in with your admin credentials. Find Milople_Recurringandsubscriptionpayments extension from the Manage Existing Extensions tab, select Uninstall from the drop down and click on Commit Changes button, the extension will be uninstalled immediately. OR Manual Uninstallation app/code/local/indies/recurringandrentalpayments/ app/design/adminhtml/default/default/layout/recurringandrentalpayments.xml app/design/adminhtml/default/default/layout/subscribed.xml app/design/adminhtml/default/default/template/recurringandrentalpayments/ app/design/frontend/default/default/layout/recurringandrentalpayments.xml app/design/frontend/default/default/template/recurringandrentalpayments/ app/etc/modules/indies_recurringandrentalpayments.xml app/locale/en_us/template/ /recurringandrentalpayments/ js/jquery/jquery.min.js skin/adminhtml/default/default/recurringandrentalpayments/images/ skin/frontend/default/default/recurringandrentalpayments/css/ skin/frontend/default/default/recurringandrentalpayments/images/ Note: If you have integrated extension in your custom theme, you need to delete respective files and folders from theme ) How to deactivate the extension in case of emergency Open following files: app/etc/modules/indies_recurringandrentalpayments.xml app/etc/modules/milople_support.xml Replace <active>true</active> with <active>false</active> in above mentioned files. Refresh the cache from admin panel and if something goes wrong, please submit a Support Ticket to 5

6 If you find something wrong and unable to access the Admin Panel, then delete the following folders from your magento store. var/cache var/session var/locks 2) General Configuration After successful installation of Recurring & Subscription Payments extension, follow these steps to configure it in your store. Open Magento Recurring & Subscription Payments extension settings page from, System> Configuration> Milople Extensions> Recurring & Subscription Payments It contains general settings of the Recurring & Subscription Payments extension such as the serial key, module activation information, settings that affect frontend and auto reply mail settings. 2.1) License and Status Contains the serial key provided by Milople Magento Store admin can enable/disable the Recurring & Subscription Payments extension ) Configuration fields in detail License and status Field Name Description Input value Serial Key Enter the serial key provided by Milople Alpha numeric value Status Enable/Disable extension Drop down List. Possible options: - Enable - Disable 2.2) General Settings Contains all the general settings that can be made by store admin in Recurring & Subscription Payments to make it function as per his requirements ) How to show terms created for the plan on frontend in product page? To show created terms, go to System > Configuration, click on General Settings. You will find Recurring & Subscription Terms in option. Select the option from dropdown to show terms. 6

7 2.2.2) How to activate subscriptions based on various events performed? The extension provides facility to activate subscriptions on events as selected by admin. Go to System > Configuration, click on General Settings. You will find Activate Subscription On option from which you can select an event to activate subscriptions of customers ) How to enable extension for specific customer or customer groups? Go to System > Configuration, click on General Settings and find option Enable Recurring & Subscription Payments for, Select customer groups for which you need to enable Recurring & Subscription Payments ) General Settings fields in detail General Settings Field Name Description Input value Show Recurring & Subscription Terms in Terms to show on frontend Drop down List. Possible options: - Drop down - Radio Buttons Activate Subscriptions on Enable Recurring & Subscription Payments for Select an event to activate subscription on Select customers or customer groups to which you want to avail this payment facility Drop down List. Possible options: - Order Placement - Invoice generation - Order Completion - Manually by Admin Drop down List. Possible options: - All customers including guests - Registered customers only - Specific customer groups only 3) Discount Settings 3.1) How to apply discounts on subscription? Extension provides an option to apply discount on subscriptions. Go to System > Configuration, click on Discount Settings and find option Apply Discount, select yes. 7

8 3.2) Is it possible to enable discount based on selected customer groups? Yes, go to System > Configuration, click on Discount Settings and find option Discount Available to and select customer groups for which you want to enable discount. 3.3) What are the options to apply discount? You can apply discount on subscription terms in 3 ways. Go to System > Configuration, click on Discount Settings and find option Apply Discount On and select a term option to apply discount. 3.4) What are the ways to apply discount? You can apply discount in two ways: either in percentage or in fixed amount. Go to System > Configuration, click on Discount Settings and find option Calculate Discount in and input an appropriate value of discount in the option Discount Value. 3.5) Discount Settings fields in detail Discount Settings Field Name Description Input value Apply Discount Option to apply discount Drop down List. Possible options: - Yes - No Discount Available to Apply Discount On Calculate Discount in Select customers or customer groups to which you want to avail discount Various options to enable discount on Select option to Calculation discount in Drop down List. Possible options: - All customers including guests - Registered customers only - Specific customer groups only Drop down List. Possible options: - All Terms - First Term - All Except First Term Drop down List. Possible options: - Fixed Amount - Percentage Discount Value Enter discount value Numeric discount value 8

9 4) Terms and Conditions Settings 4.1) How it works Admin can set terms and conditions for subscription products from System> Configuration> Milople Extensions> Recurring & Subscription Payments. This clause will be display on the cart page and customer cannot proceed for checkout without accepting terms and conditions clause. From this your customer can see this Checkbox in front end 5) PayPal Pay Flow Settings: 5.1) Why we need this setting PayPal pay flow allow reference transaction based on first transaction for 12 months only. So you need to update token before day(s) value otherwise it will expire. 9

10 6) Order Confirmation Settings Send confirmation to customers who have subscribed for product(s). 6.1) How to configure extension to send s once the order is confirmed? Magento Store Admin can configure to send mails automatically to customers once they submit orders by completing checkout. Go to System > Configuration, click on Order Confirmation Settings tab and make necessary settings. 6.2) Order Confirmation settings in detail Order Confirmation Settings Field Name Description Input value Send Order Confirmation Select Yes to enable auto Drop down List. Possible options: - Yes - No Sender Sender of the mail Select from Dropdown Template Choose a template for sending mail Select from Dropdown CC to ID to send carbon copy of the mails Enter valid ID 7) Upcoming Payment Reminder Settings Send reminder to customers for their upcoming rent payment of the subscription. 7.1) How to send reminder s to customers for their upcoming payment? Admin can configure extension to send auto reminder s for the upcoming payments of customers before the days specified. Go to System > Configuration, click on Upcoming Payment Reminder Settings tab and make necessary settings. 10

11 7.2) Upcoming Payment Reminder settings in detail Upcoming Payment Reminder Settings Field Name Description Input value Send Upcoming Sending mail for upcoming payment reminder Drop down List. Possible options: Payment Reminder - Yes - No Send Before Days Days to send mails before due date of the Enter days in numeric payments Sender Sender of the mail Select from Dropdown Template Choose a template for sending mail Select from Dropdown CC to ID to send carbon copy of the mails Enter valid ID 8) Payment Confirmation Settings Send confirmation to customers for their successful rent payment. 8.1) How to send s for received and confirmed subscription payment? Admin can configure extension to send s for payment confirmation once the invoice is generated. Go to System>Configuration, click on Payment Confirmation Settings tab and make necessary settings. 8.2) Payment Confirmation settings in detail Payment Confirmation settings Field Name Description Input value Send Payment Confirmation Confirmation once the payment is received Drop down List. Possible options: - Yes - No Sender Sender of the mail Select from Dropdown Template Choose a template for sending mail Select from Dropdown CC To ID to send carbon copy of the mails Enter valid ID 9) Subscription Status Notifications Settings Send notifications to customers for the change in their subscription status. These changes of status may have many reasons behind. Admin can prepare templates to send notifications with the possible reasons and to overcome them. 11

12 9.1) How to send s to customers when status of the subscriptions gets changed? Admin can configure extension to send s to customers when the status of their subscription gets changed. Go to System > Configuration, click on Subscription Status Notification Settings tab and make necessary settings. 9.2) Subscription Status Notifications Settings in detail Subscription Status Notifications Settings Field Name Description Input value Send Notifications for Status Select statuses to send Drop down List. Possible options: notifications for - Active - Suspended - Cancelled - Expired Active Status Template Choose a template for sending Select from Dropdown Suspended Status Template Canceled Status Template notifications for active status Choose a template for sending notifications for suspended status Choose a template for sending notifications for canceled status Select from Dropdown Select from Dropdown Expired Status Template Choose a template for sending Select from Dropdown notifications for expired status Sender Sender of the mail Select from Dropdown CC to ID to send carbon copy of the mails Enter valid ID 12

13 10) Subscription Expiry Reminder Settings Send reminder s to customers before few days of the subscription expiry. The days can be set from backend as per the choice of admin. 10.1) How to send reminder s to customers before due dates of subscription expiry? Admin can send reminder s to customers to make them aware about subscription expiry before few days of expiry. Go to System > Configuration, click on Subscription Expiry Reminder Settings tab and make necessary settings. 10.2) Subscription Expiry Reminder Settings in detail Subscription Expiry Reminder Settings in detail Field Name Description Input value Subscription Expiry Reminder Sending mail for Subscription Drop down List. Possible options: Expiry reminder - Yes - No Send Before Days Days to send mails before due date Enter days in numeric of the subscription expiry Sender Sender of the mail Select from Dropdown Template Choose a template for sending Select from Dropdown mail CC To ID to send carbon copy of the mails Enter valid ID 11) How to setup first recurring product? Admin can create recurring product by creating and managing various plans and assign it to various products to enable subscription payments. Go to Recurring & Subscription Payment > Manage Plans and click on Add New Plan to create a new plan. Click on the tab Plan Information and provide various details and set them as per the need of your products. 13

14 11.1) How to name the plan? Find Plan Name option from the tab Plan Information and provide an appropriate name for customers to recognize the basic characteristics of the plan. 11.2) Can the products be offered as normal purchase? Admin can allow customers to purchase the subscription based products as a normal purchase too. Find Allow Purchase as Normal Product option from the tab Plan Information and set it to Yes. 11.3) How to define start date of subscription? Admin can set the start date of subscription with various options. Go to Subscription Start Date and select any option as per the requirement to define the start date if subscription. 11.4) How to enable or disable a plan? Go to Status and enable or disable the plan status from there. 11.5) How to create various terms for each plan? Admin can create multiple terms under a single plan and allow customer to select relevant as per their convenience. Go to Recurring & Subscription Payment > Manage Plans and click on Add New Plan to create a new plan. Click on the tab Terms and click on add term. Add necessary settings and save terms for the plan. 11.6) How to assign products to a plan? Go to Recurring & Subscription Payment > Manage Plans and click on Add New Plan to create a new plan. Click on the tab Products and select all the products you need to offer with this plan. 14

15 11.7) Where I can see the list of all saved plans? All the created and saved plans can be seen enlisted at Recurring & Subscription Payments > Manage Plans. Admin can edit and delete all the plans from here. 11.8) Can i assign unique first term price for specific product? Yes, the extension provides you the facility to add product specific first term value. Go to Catalog > Manage Products and select a product for which you want to add first term value. Select Price tab from left side in which you find option to add first term value. Note: If you have kept the blank, the global settings for the term price will be applied. 15

16 12) Frontend view The look and feel of the frontend lies in the hands of store admin. Store Admin can make all the necessary changes as per his requirements. 12.1) Recurring & Subscription Payments on product view page 12.2) Recurring & Subscription Payments on cart page 16

17 12.3) Recurring & Subscription Payments on checkout page 12.4) Recurring & Subscription Payments in My Account page 17

18 12.5) Editing Subscriptions from My Subscription page Customers can check their subscription details and edit them clicking on Edit link on My Subscription page. 12.6) Subscription Payments in My Subscription page Customers can track their payment history clicking on Payments link from My Subscription page. 18

19 13) Manage Subscriptions Admin can manage all subscription details once customer subscribe. Go to Recurring & Subscription Payments > Manage Subscriptions. - Clicking on Edit for a particular order ID will let admin check and edit Subscription Information of that particular subscription order. From here, admin can change the status of the subscription. - If a subscription failed to capture payment by any means, admin can pay this subscription payment from backend clicking on Pay Now link. 14) Payment Method Dependency With regards to Recurring and Subscription payments each payment gateway may have certain limitations and/or dependencies as explained bellow. 19

20 1 Paypal Payflow: Set "Allow Reference Transaction" to Yes in merchant Pay Flow Account > Account Administration > Transaction Settings Every token is valid for a year so we are updating that token before it expired. 2 Paypal Express: Please set Billing Agreement Signup as auto at admin payment methods > PayPal express checkout. Billing agreement id is valid for 2 years only So subscription beyond 2 years will not capture any amount after this. 3 Braintree Credit Card: If customer saved a credit card while placing subscription order, then only we can capture next payment of that subscription 15) Troubleshooting If the extension does not show up at System > Configuration > Milople Extensions Try the following: Clear your cache Log out of your administration area and log in again - For more details or queries, check our Knowledge Base 16) Support and Feedback Store admin can come in direct contact with the Milople Technologies from his/her own E-commerce store itself. System Configuration Milople Extensions Support and Feedback Store Admin can have the complete detail of the Recurring & Subscription Payments extension that is being installed in his/her store, give feedback to Milople, and connect with Milople through social media. 17) FAQ (Frequently asked questions) For which type of products, Recurring & Subscription Payments is generally used? Recurring & Subscription extension is generally used for subscription based products and services to collect timely subscriptions and rental. We have a wide pool of customers using this extension in their Magento stores with multiple types of subscription products. Some of those are: Software as a service Monthly rent or electricity bills Magazines, newspapers, or other publications Services like web hosting, ride sharing, gym memberships etc. 20