Hosting Renewals For WHMCS
Line 5: | Line 5: | ||
=About [https://www.modulesgarden.com/products/whmcs/hosting-renewals Hosting Renewals For WHMCS]= | =About [https://www.modulesgarden.com/products/whmcs/hosting-renewals Hosting Renewals For WHMCS]= | ||
{| | {| | ||
− | |style="padding: 10px 0px 5px 0px;"|'''Hosting Renewals For WHMCS''' is a module which | + | |style="padding: 10px 0px 5px 0px;"|'''Hosting Renewals For WHMCS''' is a module which enables you to handle the billing cycles, recurring payments and renewals of services belonging to your customers in a unique and user-friendly way.<br /> |
− | The module will | + | The module will grant your clients the ability to control the activation of their automatic renewals, they will also be able to decide on the renewals of their web hosting services, not to mention it will take less time to change the billing cycle.<br /> |
− | + | Thanks to Hosting Renewals, you will posses the faculty of configuring billing cycle, changing rules, preparing various discounts and your customers will start receiving fit for purpose email notifications. | |
|} | |} | ||
<!--a comment maybe? --> | <!--a comment maybe? --> | ||
Line 15: | Line 15: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Renew Domain And Addons Along With Service |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 10px 30px;"|✔ Change Billing Cycle & View Price Difference | + | |style="padding: 0px 0px 0px 30px;"|✔ Toggle Auto Renewals |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 30px;"|✔ Change Billing Cycle & View Discounted Price Difference | ||
|} | |} | ||
*'''Admin Area Features:''' | *'''Admin Area Features:''' | ||
{| | {| | ||
− | |style="padding: 10px 0px 0px 30px;"|✔ | + | |style="padding: 10px 0px 0px 30px;"|✔ Choose Available Billing Cycles |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Configure Client Area Features | + | |style="padding: 0px 0px 0px 30px;"|✔ Configure Client Area Features |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Define Application Of Discount For The Change Of Billing Cycle |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Discounts - One Time And Recurring |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Toggle Or Force Domain Renewal Along With Service |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Toggle Or Force Addons Renewal Along With Service |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Toggle Upfront Renewal |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Toggle Recurring Amount From Service Setting |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Disable Auto Renewal For New Services |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Send Email Reminders About Upcoming Renewals |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Define | + | |style="padding: 0px 0px 0px 30px;"|✔ Define Multiple Email Templates For Email Reminders |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Perform Bulk Changes On Multiple Services |
|} | |} | ||
− | |||
{| | {| | ||
− | |style="padding: | + | |style="padding: 0px 0px 0px 45px;"|✔ Change Settings |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 45px;"|✔ | + | |style="padding: 0px 0px 0px 45px;"|✔ Add Reminders |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 45px;"|✔ | + | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Auto Renewal |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 10px 30px;"|✔ View Logs |
|} | |} | ||
+ | *'''General Info:''' | ||
{| | {| | ||
− | |style="padding: | + | |style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Supports | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7 |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7 | ||
|} | |} | ||
Line 84: | Line 90: | ||
{| | {| | ||
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Hosting Renewals For WHMCS.''' <br /> | |style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Hosting Renewals For WHMCS.''' <br /> | ||
− | We will guide you step by step through the whole installation and configuration process. <br /> | + | We will guide you step by step through the whole installation and configuration process. <br/><br/> |
+ | '' '''Note:''' If you are still using any of the module's previous versions '''prior to v3.x''', [https://www.docs.modulesgarden.com/Hosting_Renewals_2.X_For_WHMCS follow these instructions].'' | ||
|} | |} | ||
{| | {| | ||
Line 90: | Line 97: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_1.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''2. Extract the downloaded file into the main WHMCS directory.'''<br /> |
− | + | The content of the package should look like this. | |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:xdfs.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|'''3. | + | |style="padding: 0px 0px 15px 15px;"|'''3. When you install Hosting Renewals For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br /> |
− | + | File is located in '' 'modules/addons/HostingRenewals/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. '' | |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_3.png]] |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br /> |
+ | Enter your license key between the quotation marks as presented on the following screen. You can find your license key in your client area'' → 'My Products'. '' | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_4.png]] |
− | + | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''5. Now, you have to set up chmod for the '' 'storage' '' folder located in '' 'your_whmcs/modules/addons/HostingRenewals'. '' '''<br /> |
+ | You will be now allowed to read the activity logs in the module. | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_4_1.png]] |
− | + | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''6. The next step concerns setting up a cron job (every hour suggested).'''<br /> |
+ | Cron will be used for the reminders which you will set later on.<br /> | ||
+ | Use cron job below but switch '' 'your_whmcs' '' with your root WHMCS path.<br /> | ||
+ | php -q /your_whmcs/modules/addons/HostingRenewals/cron/cron.php | ||
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''7. Next, you have to activate the module in your WHMCS system.'''<br /> | |style="padding: 0px 0px 15px 15px;"|'''7. Next, you have to activate the module in your WHMCS system.'''<br /> | ||
− | Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' | + | Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterward, find '' 'Hosting Renewals' '' and press the '' 'Activate' '' button. |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_5.png]] |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''8. In the next step you need to permit access to this module.'''<br /> | |style="padding: 0px 0px 15px 15px;"|'''8. In the next step you need to permit access to this module.'''<br /> | ||
− | To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. '' | + | To do so, click on the '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. '' |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_6.png]] |
|} | |} | ||
{| | {| | ||
Line 146: | Line 152: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:HR3_7.png]] |
|} | |} | ||
Line 158: | Line 164: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|You can enable Hosting Renewals For WHMCS only for the products that have recurring payments configured.<br /> | |style="padding: 10px 0px 15px 15px;"|You can enable Hosting Renewals For WHMCS only for the products that have recurring payments configured.<br /> | ||
− | Proceed to '' 'Addons' '' → '' 'Hosting Renewals' '' → '' ' | + | Proceed to '' 'Addons' '' → '' 'Hosting Renewals' '' → '' 'Product Settings' '' and choose from the list the product you wish to enable for renewals. |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_8.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 15px;"|Press the symbol marked on the screen to configure the rules of your product. |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_8_11.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|If | + | |style="padding: 0px 0px 15px 15px;"|Available options:<br /> |
− | + | # Serves simply to enable/disable renewals for the product.<br /> | |
− | + | # If selected, clients are allowed to enable/disable automatic renewals.<br /> | |
+ | # If selected, clients are allowed to change the billing cycle.<br /> | ||
+ | # Once enabled, automatic renewals will be consequently disabled for all new services.<br /> | ||
+ | # Renew a domain along with the renewal of the service it belongs to.<br /> | ||
+ | # Allows your clients to renew an addon while setting the renewal of the related service.<br /> | ||
+ | # Enable the renewal of a new domain.<br /> | ||
+ | # If this option is enabled, the renewals of addons can be arranged.<br /> | ||
+ | # Allow clients to renew the service before its renewal date.<br /> | ||
+ | # If selected, renewal reminders are not delivered when automatic renewal is on.<br /> | ||
+ | # When selected, the custom recurring amount from the service's settings will be used, [https://www.docs.modulesgarden.com/images/8/80/Hr_on.png see this picture].<br /> Any other way, the default one configured along with the product's arrangements will be applied.([https://www.docs.modulesgarden.com/images/7/72/HR_oFF.png check it here])<br /> However, it does not apply to the setup of addons and domains.<br /> | ||
+ | # Enable your clients to change the billing cycle in case of an existing unpaid invoice.<br /> | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_8_1.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"| | + | |style="padding: 0px 0px 15px 15px;"|If you enabled the option allowing to change the billing cycle in the client area, you must also decide between which billing cycles the switch can be made.<br /> |
− | + | On the screen below you can see the '' 'Choose Available Billing Cycles' '' table with available billing cycles.<br />Clients will be able to choose between billing cycles from the column of their current billing cycle.<br />For example, settings on the following screen will enable clients to switch any billing cycle they like. | |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_8_2.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"| | + | |style="padding: 0px 0px 15px 15px;"|Thanks to the 'Mass Action' feature you are allowed to simultaneously control the settings of multiple products.<br /> |
− | + | Take a look at the screenshot below. | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:HR3_18_2.png]] |
|} | |} | ||
+ | |||
+ | ==Reminders== | ||
{| | {| | ||
− | |style="padding: | + | |style="padding: 10px 0px 15px 15px;"|It is wise to inform your clients about an incoming due date, you can do it by setting up '' 'Reminders' ''.<br /> |
+ | Since along with the module activation not a single email template is created for email notifications, you are advised to generate some by yourself<br /> | ||
+ | You can easily create additional email templates for notifications.<br /> | ||
+ | Move to '' 'Setup' '' section in your WHMCS admin area and press '' 'Email Templates' ''. | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_823.png]] |
|} | |} | ||
− | |||
− | |||
{| | {| | ||
− | |style="padding: | + | |style="padding: 0px 0px 20px 15px;"|Afterward, choose '' 'Product/Service' '' as an email template type and enter the name under which this email template will be visible in your WHMCS.<br/> |
− | + | Click on the '' 'Create' '' button. | |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_10_3.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"| | + | |style="padding: 0px 0px 15px 15px;"|You will be moved to email template edition page. Start by filling in your company name, email address and email subject.<br /> |
− | + | Next, create your email template content in the textbox marked on the following screen.<br /> | |
+ | Press the '' 'Save Changes' '' button. | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_11.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|You can also use '' 'Merge Fields' '' in your email template.<br /> |
+ | To view the full list of fields, scroll down. These codes are replaced with the actual data during sending email. | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_12.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|Once you have successfully created your new template and picked its billing cycle, we can move to adding a reminder itself.<br /> |
− | + | Simply click the ''Add Reminder'' button to do so. | |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_112.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"| | + | |style="padding: 0px 0px 15px 15px;"|The ''Status'' field should be automatically set to active, please note, however, that you can disable the reminder any time you want.<br /> |
− | + | Next, choose the desired template from the dropdown menu of custom templates including the previously created '' 'Last Day Notification' ''.<br /> | |
− | + | The section named ''Period'' refers to the number of days before the end of the cycle intended for sending a reminder.<br /> | |
+ | Finally, press the '' 'Add' '' button. | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:HR3_9.png]] |
|} | |} | ||
+ | |||
+ | ==Discounts== | ||
{| | {| | ||
− | |style="padding: | + | |style="padding: 10px 0px 15px 15px;"|In the '' 'Discounts' '' section you may set up various discounts for any alterations of renewals of services. |
− | + | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_15.png]] |
|} | |} | ||
− | |||
− | |||
{| | {| | ||
− | |style="padding: | + | |style="padding: 0px 0px 20px 15px;"|To start creating and modifying your discount click on ''Add Discount''. |
− | To | + | |
− | + | ||
− | + | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_12_5.png]] |
|} | |} | ||
− | |||
− | |||
{| | {| | ||
− | |style="padding: | + | |style="padding: 0px 0px 15px 15px;"|'''Start with selecting primary attributes including the name and the products eligible for the discount.'''<br /> |
+ | Then, choose whether the discount is supposed to be a ''Percentage'' or a ''Fixed'' one.<br /> | ||
+ | In the next step, decide on its value.<br /><br /> | ||
+ | '''Now, you are required to select between two types of discounts:'''<br /> | ||
+ | 1. One time discount - it applies to a single billing cycle only.<br /> | ||
+ | 2. Recurring discount - it will be applied to all billing cycle payments, until your client again changes the billing cycle.<br /> | ||
+ | For example, if a client switches to a quarterly billing cycle from any other cycle, they will receive a $35 discount for a payment in the first billing period.<br /> | ||
+ | ''Note: Discount applies only to the price of the service, both addons and domains even whilst being renewed accordingly, are '''not''' qualified for the discount.'' | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_12_6.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|As you can see on the following screen, all discounts are listed below.<br /> |
− | + | Each of them can be either removed or edited by pressing the appropriate button. | |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:HR3_126.png]] |
|} | |} | ||
+ | |||
+ | ==Logs== | ||
{| | {| | ||
− | |style="padding: 0px | + | |style="padding: 10px 0px 15px 15px;"|All module activities are recorded in '' 'Logs' ''.<br /> |
+ | ''Note: You will have no visible logs here if there are no logged actions yet.'' | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_12_2.png]] |
|} | |} | ||
− | |||
− | |||
{| | {| | ||
− | |style="padding: | + | |style="padding: 0px 0px 15px 15px;"|In case you no longer wish to see a particular log you can easily remove it.<br /> Select a particular entry and click on the bin icon as presented on the screen below . |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_12_3.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 15px;"|In order to delete multiple logs at the same time you can simply take advantage of the 'Mass Remove Action'. |
− | + | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:HR3_12_14.png]] |
|} | |} | ||
− | == | + | ==Client Area== |
{| | {| | ||
− | |style="padding: 10px 0px 20px 15px;"| | + | |style="padding: 10px 0px 20px 15px;"|Depending on the configuration per product your clients will be allowed to manage their renewals in their client area.<br/> |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_17.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|They can see the current status and use available buttons to perform allowed actions: |
− | + | *Renew service | |
+ | *Turn on/off the auto renewal | ||
+ | *Change a billing cycle | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_18.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 15px;"|Press the ''Choose Billing Cycle'' button in order to change a current billing cycle to a new one.<br /> |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_19.png]] |
|} | |} | ||
− | |||
− | |||
{| | {| | ||
− | |style="padding: | + | |style="padding: 0px 0px 15px 15px;"|In the next place, choose a new billing cycle from the dropdown menu. <br /> |
+ | Clients will also have their domains and addons renewed, undesired items can be simply unchecked, unless you have chosen either the '' 'Force Domain Renewal' ''<br /> or '' 'Force Addons Renewal' '' during customizing your '' 'Product Settings' '' at the [https://www.docs.modulesgarden.com/images/c/c3/Hr_see.png previous] stage of the configuration. | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_26.png]] |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"| | + | |style="padding: 0px 0px 20px 15px;"|Once you do that, check the total amount and click ''Confirm''.<br/>As you can see, the chosen option includes the previously configured discount. |
− | + | ||
− | + | ||
− | + | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_27.png]] |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 15px 15px;"|A new invoice has been created.<br /> | ||
+ | Therefore, the billing cycle is now set to 'Annually'.<br /> | ||
+ | Note, however, that only the cycle related to the service itself has been modified, unlike the cycle of either the addons or domains.<br /> | ||
+ | These will be separately billed, according to the introduced cycle's alteration:<br/ > 'Monthly' → 'Annually' results in new 12 cycles visible on the invoice. | ||
|} | |} | ||
− | |||
− | |||
{| | {| | ||
− | |style="padding: | + | |style="padding: 0px 0px 20px 25px;"|[[File:HR3_28.png]] |
− | + | ||
− | + | ||
|} | |} | ||
Line 366: | Line 365: | ||
|style="padding: 0px 0px 5px 15px;"|2. Hosting Renewals For WHMCS supports all billing cycles, from monthly to triennially.<br /> | |style="padding: 0px 0px 5px 15px;"|2. Hosting Renewals For WHMCS supports all billing cycles, from monthly to triennially.<br /> | ||
Depending on the chosen billing cycle, displayed value of a renew button is changing according to the following code which is located in '' 'language' '' directory in your language file:<br /> | Depending on the chosen billing cycle, displayed value of a renew button is changing according to the following code which is located in '' 'language' '' directory in your language file:<br /> | ||
− | $ | + | |
− | $ | + | $_LANG['addonCA']['hostingActions']['Monthly'] = '1 Month'; |
− | $ | + | $_LANG['addonCA']['hostingActions']['Quarterly'] = '3 Months'; |
− | $ | + | $_LANG['addonCA']['hostingActions']['Semi-Annually'] = '6 Months'; |
− | $ | + | $_LANG['addonCA']['hostingActions']['Annually'] = '1 Year'; |
− | $ | + | $_LANG['addonCA']['hostingActions']['Biennially'] = '2 Years'; |
+ | $_LANG['addonCA']['hostingActions']['Triennially'] = '3 Years'; | ||
+ | |||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 15px;"|3. If you want a template message to be sent to users with the auto-renewal '' 'on' '' or '' 'off' '' option, you may use the below example:<br/> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
{if $hosting_auto_renew eq "on"} Service will be automatically renewed in {$service_next_due_date} days. | {if $hosting_auto_renew eq "on"} Service will be automatically renewed in {$service_next_due_date} days. | ||
{else} Service will expire in {$service_next_due_date} days. {/if} | {else} Service will expire in {$service_next_due_date} days. {/if} | ||
Line 393: | Line 386: | ||
To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/> | To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/> | ||
|} | |} | ||
+ | ==Migration== | ||
+ | {| | ||
+ | |style="padding: 10px 0px 30px 15px;"| While using the 2.X version of our module, note that no data can be migrated due to the fact that we did not implement the migration from any of the previous versions of Hosting Renewals, so the module needs to be configured from scratch.<br /> | ||
+ | '' '''Note:''' Remember that in case you wish to switch to the latest version, you need to reissue your license first.'' | ||
+ | |} | ||
+ | |||
=Common Problems= | =Common Problems= | ||
{| | {| | ||
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.''' | |style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.''' | ||
|} | |} |
Revision as of 17:19, 22 December 2017
Contents |
About Hosting Renewals For WHMCS
Hosting Renewals For WHMCS is a module which enables you to handle the billing cycles, recurring payments and renewals of services belonging to your customers in a unique and user-friendly way. The module will grant your clients the ability to control the activation of their automatic renewals, they will also be able to decide on the renewals of their web hosting services, not to mention it will take less time to change the billing cycle. |
- Client Area Features:
✔ Renew Services Before Due Date |
✔ Renew Domain And Addons Along With Service |
✔ Toggle Auto Renewals |
✔ Change Billing Cycle & View Discounted Price Difference |
- Admin Area Features:
✔ Choose Available Billing Cycles |
✔ Configure Client Area Features |
✔ Define Application Of Discount For The Change Of Billing Cycle |
✔ Choose Between Two Types Of Discounts - One Time And Recurring |
✔ Toggle Or Force Domain Renewal Along With Service |
✔ Toggle Or Force Addons Renewal Along With Service |
✔ Toggle Upfront Renewal |
✔ Toggle Recurring Amount From Service Setting |
✔ Disable Auto Renewal For New Services |
✔ Send Email Reminders About Upcoming Renewals |
✔ Define Multiple Email Templates For Email Reminders |
✔ Perform Bulk Changes On Multiple Services |
✔ Change Settings |
✔ Add Reminders |
✔ Toggle Auto Renewal |
✔ View Logs |
- General Info:
✔ Multi-Language Support |
✔ Supports PHP 5.6 Up To PHP 7 |
✔ Supports WHMCS Template Six |
✔ Supports WHMCS V7 |
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 the module. |
2. Extract the downloaded file into the main WHMCS directory. The content of the package should look like this. |
3. When you install Hosting Renewals For WHMCS for the first time you have to rename 'license_RENAME.php' file. File is located in 'modules/addons/HostingRenewals/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'. |
4. In order to configure your license key, you have to edit a previously renamed 'license.php' file. Enter your license key between the quotation marks as presented on the following screen. You can find your license key in your client area → 'My Products'. |
5. Now, you have to set up chmod for the 'storage' folder located in 'your_whmcs/modules/addons/HostingRenewals'. You will be now allowed to read the activity logs in the module. |
6. The next step concerns setting up a cron job (every hour suggested). Cron will be used for the reminders which you will set later on. php -q /your_whmcs/modules/addons/HostingRenewals/cron/cron.php |
7. Next, you have to activate the module in your WHMCS system. Log in to your WHMCS admin area. Go to 'Setup' → 'Addon Modules'. Afterward, find 'Hosting Renewals' and press the 'Activate' button. |
8. In the next step you need to permit access to this module. To do so, click on the 'Configure' button, tick 'Full Administrator' and press 'Save Changes'. |
9. You have just successfully installed Hosting Renewals! Access your module now at 'Addons' → 'Hosting Renewals'. |
Configuration and Management
Hosting Renewals For WHMCS module allows your customers to fully manage their billing cycles and recurring payments. Read through the below instructions to learn how to turn on/off auto-renewals, alter billing cycles and manage customized email notifications. |
Configuration
You can enable Hosting Renewals For WHMCS only for the products that have recurring payments configured. Proceed to 'Addons' → 'Hosting Renewals' → 'Product Settings' and choose from the list the product you wish to enable for renewals. |
Press the symbol marked on the screen to configure the rules of your product. |
Available options:
|
If you enabled the option allowing to change the billing cycle in the client area, you must also decide between which billing cycles the switch can be made. On the screen below you can see the 'Choose Available Billing Cycles' table with available billing cycles. |
Thanks to the 'Mass Action' feature you are allowed to simultaneously control the settings of multiple products. Take a look at the screenshot below. |
Reminders
It is wise to inform your clients about an incoming due date, you can do it by setting up 'Reminders' . Since along with the module activation not a single email template is created for email notifications, you are advised to generate some by yourself |
Afterward, choose 'Product/Service' as an email template type and enter the name under which this email template will be visible in your WHMCS. Click on the 'Create' button. |
You will be moved to email template edition page. Start by filling in your company name, email address and email subject. Next, create your email template content in the textbox marked on the following screen. |
You can also use 'Merge Fields' in your email template. To view the full list of fields, scroll down. These codes are replaced with the actual data during sending email. |
Once you have successfully created your new template and picked its billing cycle, we can move to adding a reminder itself. Simply click the Add Reminder button to do so. |
The Status field should be automatically set to active, please note, however, that you can disable the reminder any time you want. Next, choose the desired template from the dropdown menu of custom templates including the previously created 'Last Day Notification' . |
Discounts
In the 'Discounts' section you may set up various discounts for any alterations of renewals of services. |
To start creating and modifying your discount click on Add Discount. |
Start with selecting primary attributes including the name and the products eligible for the discount. Then, choose whether the discount is supposed to be a Percentage or a Fixed one. |
As you can see on the following screen, all discounts are listed below. Each of them can be either removed or edited by pressing the appropriate button. |
Logs
All module activities are recorded in 'Logs' . Note: You will have no visible logs here if there are no logged actions yet. |
In case you no longer wish to see a particular log you can easily remove it. Select a particular entry and click on the bin icon as presented on the screen below . |
In order to delete multiple logs at the same time you can simply take advantage of the 'Mass Remove Action'. |
Client Area
Depending on the configuration per product your clients will be allowed to manage their renewals in their client area. |
They can see the current status and use available buttons to perform allowed actions:
|
Press the Choose Billing Cycle button in order to change a current billing cycle to a new one. |
In the next place, choose a new billing cycle from the dropdown menu. Clients will also have their domains and addons renewed, undesired items can be simply unchecked, unless you have chosen either the 'Force Domain Renewal' |
Once you do that, check the total amount and click Confirm. As you can see, the chosen option includes the previously configured discount. |
A new invoice has been created. Therefore, the billing cycle is now set to 'Annually'. |
Tips
1. If your client turns off auto renewal and does not run the renewal manually, then the 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. Depending on the chosen billing cycle, displayed value of a renew button is changing according to the following code which is located in 'language' directory in your language file: $_LANG['addonCA']['hostingActions']['Monthly'] = '1 Month'; $_LANG['addonCA']['hostingActions']['Quarterly'] = '3 Months'; $_LANG['addonCA']['hostingActions']['Semi-Annually'] = '6 Months'; $_LANG['addonCA']['hostingActions']['Annually'] = '1 Year'; $_LANG['addonCA']['hostingActions']['Biennially'] = '2 Years'; $_LANG['addonCA']['hostingActions']['Triennially'] = '3 Years'; |
3. If you want a template message to be sent to users with the auto-renewal 'on' or 'off' option, you may use the below example:{if $hosting_auto_renew eq "on"} Service will be automatically renewed in {$service_next_due_date} days. {else} Service will expire in {$service_next_due_date} days. {/if} |
Update Instructions
Essential guidance through the process of updating the module is offered here. Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price! |
Migration
While using the 2.X version of our module, note that no data can be migrated due to the fact that we did not implement the migration from any of the previous versions of Hosting Renewals, so the module needs to be configured from scratch. Note: Remember that in case you wish to switch to the latest version, you need to reissue your license first. |
Common Problems
1. When you have problems with connection, check whether your SELinux or firewall does not block ports. |