Magento 2 eWay Recurring & Subscriptions extension allows to sell subscriptions and automatically capture secure payments on a regular interval via the eWay payment gateway.
Table of Content
- Extension Installation Guide
- Configure Payment Method
- Configuration
- Subscription Types
- Product Specific eWay Recurring & Subscriptions Settings
- eWay Recurring & Subscriptions in Frontend
- Subscription Details in Backend
- Manage Subscription Schedules
- Manage Subscribers
- Email Notifications to Customers
- Extract the zip folder and upload our extension to the root of your Magento 2 directory via FTP.
- Login to your SSH and run below commands step by step:
- php bin/magento setup:upgrade
- For Magento version 2.0.x to 2.1.x - php bin/magento setup:static-content:deploy
- For Magento version 2.2.x & above - php bin/magento setup:static-content:deploy -f
- php bin/magento cache:flush
- That’s it.
- Configure Payment Method
Go to Sales > Payment Method > eWay Recurring Payment to configure the eWay payment method to capture subscription payments from your Magento 2 stores.- Enabled: Enable payment method from here.
- Title: Enter the title of the payment method to show in the frontend.
- New Order Status: Select order status to assign whenever a new order is placed through eWay recurring payment method.
- Customer ID: Enter customer ID provided by eWay payment gateway.
- eWay Recurring Username: Enter user name provided by eWay payment gateway.
- eWay Recurring Password: Enter password provided by eWay payment gateway.
- Credit Card Types: Select credit card types to allow accepting payments from.
- Sandbox Mode: Enable sandbox mode to enable testing mode for the payment gateway.
- Debug Mode: Enable debug mode to get error logs.
- Payment from Applicable Countries: Select countries to enable payment method for.
- Payment from Specific Countries: Select countries to enable payment method for specific countries.
- Sort Order: Add sort order of the payment method.
- Configuration
To configure the extension, log in to Magento 2 backend, move to Stores > Configuration > eWay Recurring & Subscriptions where you can find various Email settings to send notifications on various subscription events.
- Subscription Cancellation Notification Settings:
- Email Template: Select template for subscription cancellation Email to be sent to the customers.
- Admin Email: Enter Email ID of the admin to get the same mail.
- Email Sender Name: Select Email sender.
- Payment Failure Notification Settings:
- Email Sender: Select Email sender.
- Email Template: Select template for subscription payment failure Email to be sent to the customers.
- Send Email Copy to: Enter Email ID to send a copy of the same mail.
- Credit Card Expiry Notification Settings:
- Email Sender: Select Email sender.
- Email Template: Select template for credit card expiry notification Email to be sent to the customers.
- Send Email Copy to: Enter Email ID to send a copy of the same mail.
- Next Subscription Reminder Notification Settings:
- Email Sender: Select Email sender.
- Email Template: Select template for next subscription reminder Email to be sent to the customers.
- Send Email Copy to: Enter Email ID to send a copy of the same mail.
- Subscription Types
All the already created and saved subscription types enlisted here. You can add new subscription type from here and assign to as many products as you want.
- Add New Option
- Title: Set the title of the new subscription type.
- Period Unit: Select period unit for the subscription type.
- Maximum Billing Cycles: Set maximum billing cycle which is sub orders per subscription. For example, you have subscribed for a magazine and set 8 maximum billing cycles, customers can maximumly subscribe to 8 magazine editions.
- Assigned Products
Select products to assign this subscription type to. Based on the settings here, customers will get the options in the frontend to select the subscription options.
- Product Specific eWay Recurring & Subscriptions Settings
Apart from global settings, the extension facilitates to configure a particular product for eWay recurring. To set, go to Catalog > Products and select a product to enable eWay Recurring & Subscriptions for.
- Enable eWay Recurring and Subscriptions: Select YES to enable eWay Recurring and Subscriptions for the selected product.
- Allow Customers Define Start Date: Select YES to allow customers define start date of the subscription.
- eWay Recurring & Subscriptions in Frontend
Once the settings are configured properly, the customers can see subscription options on the product page to set and continue purchase.
- eWay Recurring & Subscriptions on Cart Page
Once the options are selected from frontend, subscription details can be seen on cart page.
- eWay Recurring & Subscriptions on Checkout Page
On the checkout page, customers can select the eWay payment method and add card details to place the order.
- eWay Recurring Order Details in My Account
Once the subscription order is placed, all the subscription-related details can be seen in My Account section under My Subscriptions tab.
- On click of event ID, detailed order related details like subscription date, period, frequency, completed and pending subscription orders and other information can be seen.
- On click of related orders, customers can see order status and more subscription details.
- On click of subscription order ID, subscription products, payments, and credit card details can be seen.
- Editing Subscription Details from My Account
From the My Account section, customers can edit subscription, payment and credit card details by clicking on Edit.
- Subscription Details in Backend
Once the subscription order is placed successfully, admin can see subscription order details along with all the subscription information under Sales > Orders > Order view in the backend.
- Manage Subscription Schedules
Admin can also see schedules of the various subscriptions from the backend. Go to eWay Recurring and Subscriptions > Manage Subscription Schedules to have a look at subscriptions scheduled for today, pending and completed subscriptions.
- Today’s Schedule
All the subscriptions scheduled for the same day on which admin is logged in can be seen here with the status.
- Pending Schedules
All the pending subscriptions by customers are seen enlisted here.
- Completed Schedules
All the already paid and completed subscription schedules can be seen enlisted here.
- Manage Subscribers
All the subscription customers along with the details are stored in a separate grid in the backend. Go to eWay Recurring and Subscriptions > Manage Subscribers to see the details of the subscribers, products purchased and other related information.
- Customer
All the customer related details along with eWay ID is saved here. Admin can delete the customer from here.
- Events
All the subscription events of the selected customer can be seen here. Admin can edit or delete selected events from here.
- Update Event Details
On click of edit, all the event details can be seen. Admin can change the details and click the Update button to update and save the edited details.
- Next Subscription Payment Reminder
A day before the next subscription payment is to be captured, customers are notified with the Email notification.
- Payment Failure Notification Email
While trying to capture the payment for the subscription, if the payment fails due to credit card failure, the customers are notified with payment failure notification Email.
- Credit Card Expiry Notification Email
If the saved credit card with the subscription is about to expire, the extension sends an Email notification to the customers to update card details.
- Subscription Cancellation Notification Email
If the customers or admin cancels the subscription any time, customers are notified for the subscription cancellation with an Email.