Personal tools
Namespaces

Variants
Actions

Hosting Renewals For WHMCS

From ModulesGarden Wiki
Revision as of 09:50, 11 June 2014 by Gregor (Talk | contribs)

Jump to: navigation, search

Contents

About Hosting Renewals For WHMCS

Hosting Renewals For WHMCS is an interesting module which gives your clients a possibility to manage their billing cycles, recurring invoices and service renewals.

Module will let your customers to turn on/off automatic renewals, decide whether and when renew their web hosting services and even change billing cycle.
You can decide which features will be available for your clients at which product!
Our product offers also sending custom email notifications to your clients to inform them about upcoming renewals.

  • Features:
✔ Allow Clients To Manually Renew Services Before The Due Date
✔ Allow Clients To Turn On/Off Automatic Renewals
✔ Allow Clients To Change Billing Cycle
✔ Configuration Of Billing Cycle Changeable From The Client Area
✔ Configuration Of The Client Area Features Per Product
✔ Automatic Disable Auto Renewal For New Products
✔ Disable/Enable Automatic Renewal For All Instances Of Product Using One Button
✔ Send Email Notifications Of Upcoming Renewals
✔ Multiple Email Templates For Email Notification
✔ Logs
  • Additionally:
✔ Multi-Language Support
✔ Supports WHMCS V5 and Later

Installation

This tutorial will show you how to successfully install and configure Hosting Renewals For WHMCS.

We will guide you step by step through the whole installation and configuration process.

1. Log in to your client area and download Hosting Renewals For WHMCS.
HR1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like this.

HR2.png
3. When you install Hosting Renewals for the first time you have to rename 'license_RENAME.php' file.

File is located at 'modules/addons/hosting_renewals/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

HR3.png
4. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

Enter your licence key between quotation marks as presented on the following screen. You can find your license key at your client area → 'My Products' .

HR4.png
5. Now, you have to set up chmod for the 'logs' folder located at 'your_whmcs/modules/addons/hosting_renewals' .

It will allows your module to create activity logs.

HR4 1.png
6. Next, you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' 'Addon Modules' . Afterwards, find 'Hosting Renewals' and press 'Activate' button.

HR5.png
7. In the next step you need to permit access to this module.

To do so, click on 'Configure' button, tick 'Full Administrator' and press 'Save Changes' .

HR6.png
8. You have just successfully installed Hosting Renewals!

You can access your module at 'Addons' 'Hosting Renewals' .

HR7.png

Configuration and Management

Hosting Renewals For WHMCS allows your customers to renew hosting when they are pleased.

You can also define, if you want to leave autorenew on or disable it.

Configuration

You can enable Hosting Renewals For WHMCS only for product with recurring pricing.

To add product, go to 'Addons' 'Hosting Renewals' 'Configuration' and choose product from a dropdown menu.

HR8.png
As soon as you will place integration code, your clients will be able to renew hosting upfront, enable/disable auto renewal and change billing cycle.

All of these features can be disabled at 'Hosting Renewals' 'Configuration' → specific product.
In this way, two products can have different Hosting Renewal features available for client usage.
1. Enables configuration, you can disable selected configuration through unmarking this checkbox.
2. Allows your client to enable/disable auto renewal from the client area.
3. Allows your client to renew hosting before the due date.
4. Allows client to change billing cycle. Available billing cycles can be set up in 'Change Billing Cycle Rules' table.
5. Disable auto renewal for a new hosting.
6. Renew domain along with service it is assigned to.
After making changes do not forget to confirm them through pressing 'Save Changes' .

HR8 1.png
If you have enabled ability to change billing cycle from the client area, you have to define between which billing cycles switch can be made.

Records at each column of 'Change Billing Cycle Rules' table are billing cycle which will be available to choose if current billing cycle is a column in which the records are.
For example, settings on the following screen will enable client to switch any billing cycle only to longer one.

HR8 2.png
Additionally, you can enable/disable auto renewal for all products from a selected configuration.

To do so, press 'Enable Auto Renewal' / 'Disable Auto Renewal' button as shown on the following screen.

HR8 3.png
It is wise to inform your client about incoming due date and you can do it through setting notification emails.

You can set up to five notification emails and specify time of their sending to client depending from a chosen billing cycle.
Additionally, you can set up different email templates for each email notification.
On the screen below you can see settings for product with monthly, quarterly, semi-annually and annually pricing types.
For each one of them client receives only 2 notification emails.
First notification will be sent a week before the due date for monthly and quarterly billing cycles, and 2 weeks before the due date for semi-annually and annually billing cycles.
Second notification will be sent for each of billing cycles a day before the due date.
Save settings through pressing 'Save Changes' button.

HR9.png
You should see new buttons in your admin area.

Please note that displayed value of the button is changing according to chosen billing cycle.

HR9 1.png

Templates

During module activation only one email template is created for email notifications.

You can create additional email templates for notifications. Go to 'Templates' tab and press 'Add Template' button.

HR10.png
If you have already prepared email templates for notification, select it from a dropdown menu and press 'Add' button.

As soon as you do that, it will be visible next to 'Upcoming Renewal Notice' email template and you will be able to assign it to notification.

HR10 1.png
If you want to prepare a new email template, press 'Create New Template' button.
HR10 2.png
Afterwards, choose 'Product' as an email template type and enter name under which email template it will be visible in WHMCS.
HR10 3.png
Here you can create your email template.

Start by filling your company name, email address and email subject.
Afterwards, write your email template content in a textbox marked on the following screen.
When you are done, press 'Save Changes' button.

HR11.png
You can also use 'Merge Fields' in your email template.

To access full list of fields, scroll down. These codes are replaced with actual data during sending email.

HR12.png

Assigning Email Templates

You can assign any of email templates added at 'Templates' tab to desired notification.

To do so, enter product configuration at 'Hosting Renewal' 'Configuration' and select email templates from a dropdown menu next to desired notification.
Confirm changes through pressing 'Save Changes' button.
On the screen below you can see previously created 'Last Day Notification' email template assigned to notification sent a day before due date.

HR12 1.png

Logs

All module activities can be recorded in log files. To enable this feature, mark 'Enable File Logging' checkbox.
HR12 2.png
You can view any of the logs. Simply, choose it from 'File' dropdown menu and press 'Show' button.

Note: You will be unable to choose log file if there is no logged actions.

HR12 3.png
Exemplary info log is shown on the following screen.
HR12 4.png

Discounts

'Discounts' tab allows you to set up various discounts for changing billing cycle.

You can select two type of items:
1. Product - which will apply to product selected at the 'Item' field.
2. Product Group - apply to all products in product group which is selected at the 'Item' field.
You can set up two types of discounts:
1. One time discount - which will apply to only one billing cycle.
2. Recurring discount - apply to all billing cycle payments, until your client will again change billing cycle.
Now, we will set up one time discount for 'Support Service M' and 'Support Service L' if client will switch to quarterly billing cycle from any other cycle.
Clients will receive 50% discount for payment in first billing cycle.

HR12 5.png
As you can see on the following screen, all discounts are listed below.

Each of them can be easily removed through pressing 'Delete' button.

HR12 6.png

Integration Code

Integration described below allows your customers to manually renew product, turn on/off auto renewal and change billing cycle from their client area.
HR13.png
Correctly placed code in 'default' order form template is presented on the following screen.
HR14.png
In the client area it should look like on the screen below.

Please note that displayed value of the button is changing according to chosen billing cycle.

HR15.png

Tips

1. If your client will turn off autorenew and he will not manually run renewal, then service status will change to suspended/terminated after a certain time period.

Time period depends on WHMCS settings at 'Setup' 'Automation Settings' 'Automatic Module Functions '.

2. Hosting Renewals For WHMCS supports all billing cycles, from monthly to triennially.

Dependant on the chosen billing cycle, displayed value of renew button is changing according to the following code which is located in 'language' directory at your language file:

$LANG['cyclemonthly']='1 Month';
$LANG['cyclequarterly']='3 Months';
$LANG['cyclesemiannually']='6 Months';
$LANG['cycleannually']='1 Year';
$LANG['cyclebiennially']='2 Years';
$LANG['cycletriennially']='3 Years';

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Hosting Renewals For WHMCS