Recurring Contract Billing For WHMCS
Article update is ongoing on this page, watch out for broken links, unclear descriptions and images!
We are sorry for the inconvenience caused.
Contents |
About Recurring Contract Billing For WHMCS
| Recurring Contract Billing For WHMCS will allow you to draw up fixed-term contracts for your clients in relation to the offered products and services. You will be able to define which products require contract acceptance, then set the time span of each contract along with its possible discount and penalty amount. |
- Admin Area Features:
| ✔ Create Multiple Contracts Per Product |
| ✔ View And Manage Signed Contracts |
| ✔ Configure Contract Signature Types |
| ✔ Define Time & Modify Contract End Notifications |
| ✔ Modify Contract Renewal Notifications |
| ✔ Define Time After Which Contract Is Defined As Broken |
| ✔ View Logs |
- Contact Features:
| ✔ Define Contract Content In Multiple Languages |
| ✔ Assign Product To Contract |
| ✔ Define Promo And Penalty Types |
| ✔ Define Multiple Contracts Sets: |
| ✔ Define Contract Length - Up To 10 Years |
| ✔ Define Promo And Penalty Amounts |
| ✔ Define Days Before Expiration To Cancel Contract Without Penalty |
| ✔ Define Trial Period Length |
| ✔ Define Time To Send Renewal Notification |
| ✔ View Total And Recurring Prices |
| ✔ View Amount Of Penalty |
| ✔ Choose Contract Signature Type: |
| ✔ Checkbox |
| ✔ File Upload |
| ✔ Adobe Sign |
| ✔ DocuSign |
| ✔ Allow Orders Without Contract |
| ✔ Define Renewal Type |
| ✔ Renewal Without Contract |
| ✔ Renewal With Contract |
| ✔ Cancel |
| ✔ Toggle Availability Of Cancellation Request |
- Client Area Features:
| ✔ Choose Contract Length During Order |
| ✔ View Contract Content Before Accepting It |
| ✔ View Details Of All Signed Contracts |
| ✔ View History Of Any Signed Contract |
- General Info:
| ✔ Multi-Language Support |
| ✔ Supports PHP 7.2 Up To PHP 7.4 |
| ✔ Supports WHMCS Themes "Six" And "Twenty-One" |
| ✔ Supports WHMCS V8.1 And Later |
| ✔ Easy Module Upgrade To Open Source Version |
Installation
| This tutorial will show you how to successfully install and configure Recurring Contract Billing For WHMCS. We will guide you step by step through the whole installation and configuration process. |
Installation
| 1. Log in to our client area and download the module. |
|
| 2. In the downloaded file you might find one or two packages that support different PHP versions. In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later. |
|
| Previous updates of the module may contain two packages dedicated to various PHP versions. The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4. |
|
| Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'. |
| 3. Extract the package and upload its content into the main WHMCS directory.
The content of the package to upload should look like this. |
|
| 4. When you install Recurring Contract Billing For WHMCS for the first time you have to rename 'license_RENAME.php' file. File is located in 'modules/addons/recurring_billing/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'. |
|
| 5. The next step is setting up 'storage' folder as writable. It is located in 'your_whmcs/modules/addons/recurringBilling/'. |
|
| 6. In order to configure your license key, you have to edit the previously renamed 'license.php' file. Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'. |
|
Activation
| 7. Now, you have to activate the module in your WHMCS system. Log in to your WHMCS admin area and proceed to 'Setup' → 'Addon Modules'. |
|
| 8. In the next step you need to permit access to this module. To do so, click on 'Configure' button, tick checkboxes to assign desired admin roles. |
|
9. Now it is time to insert proper integration codes.
Module requires alterations into your order form template. Open your currently used order form and follow the instructions.
{if $securityquestions && !$loggedin}
Insert this code snippet above that line:
<div class="sub-heading" id="recurring-biling-contracts">
<span>{$contractTitle}</span>
</div>
{$contractOutput}
This is how a properly inserted code should look like: |
|
| Note: For illustration purposes we have used modern orderform, please make changes in the form you are using! Remember that the content of other order forms may slightly vary from the description above! Check the 'Utilities' → 'Integration' tab in your module for valid code. |
| 10. You have just successfully installed Recurring Contract Billing For WHMCS! |
Configuration and Management
| Once you have properly installed and activated the product you may move to its actual configuration. Read the below sections to learn how to use Recurring Billing Extended For WHMCS completely. |
Configuration
| In order to start using your Recurring Billing Extended For WHMCS move to 'Addons → Recurring Billing'. By default, you will be moved to the addon's dashboard with a guide opened. You will find there short notes on how to configure the product. |
|
| Hide the guide when you have completed the configuration and learned how to reconstruct the process. |
Contract Content
| First off all, create your first contract's content. To do so, move to 'Contract Content' section and press 'Add New' button. |
|
Here you can compose the content of a contract.
Do not forget to 'Save' the changes once you have finished. |
|
| Your newly created contract draft is now visible on the list. Use action buttons to edit the contract or delete it if you are sure it is useless. |
|
Sign Types
| In this tab you can configure the methods of signing contracts, which you will then be able to use for creating a contract template. You can configure the following methods:
Note: The checkbox sign method does not require any configuration, so it is not visible in this tab, but you will still be able to select it when creating a contract template. |
|
Adobe Sign
| The Enterprise plan of Adobe Sign is required to use this option. Take the following steps to set it up: 1. Log in to your Adobe Sign profile. |
|
|
4. Enter the 'Name' and 'Display Name' of your application and select 'CUSTOMER' domain. Press 'Save' when ready. https://yourdomain.com/includes/RecurringBilling/getCode.php Note: Provided URI also has to start with https:// . You will find the already customized address in your module sign types configuration. |
|
|
9. Now return to the configuration of the WHMCS module and enter the previously obtained data. |
|
|
10. You will have to confirm your access to the authorization for Adobe Sign. |
|
|
10. Finally, if you provided all data correctly you should receive the notice that authorization has been completed successfully. |
DocuSign
| You need to have at least the Basic API plan of DocuSign to use this option. 1. You can set it up in to ways: 2. After successful login to the selected environment, select 'API and Keys' tab from the left menu. |
|
|
4. Provide your app name. |
|
|
5. You should now see the 'Integration Key' . Save the 'Integration Key' which is your 'Client ID' that you will use at a later stage of the configuration. https://yourdomain.com/includes/RecurringBilling/getCodeESignature.php Note: You will find the already customized address in your module sign types configuration. |
|
|
8. Now return to the configuration of the WHMCS module and where you can enter the previously obtained data, but first choose if you are using demo environment.
Do not forget to 'Save' first because only then you will be able to click the 'Authorization' button. |
|
|
10. You will have to confirm your access authorization for DocuSign. |
|
|
11. Finally, if you provided all data correctly you should receive notice that authorization has been completed successfully. |
File Upload
| Here you can configure the minimum and maximum size of files uploaded by your clients as contract signs. Note: Currently all image, MS Word and PDF formats are supported for upload.
So, if you want to allow uploaded files e.g. being in between 1 and 8 megabytes in size provide '1048576' and '8388608' values accordingly. |
|
Contract Templates
| Now, that you have a contract's content draft, move to 'Contract Templates'. In this section you can predefine which contract content draft a specific product a template will refer to. |
|
| Fill out the contract template form. Name the template, as mentioned before, choose content name from the ones you prepared previously (see 'Contract Content' section). Select product that this template will be available with. Note: You can assign only one template to a single product, it is not possible to alter the product assignment once you save the changes! Define one of the methods by which your customers will be able to sign contracts. Choose from the following:
Note: Don't forget to set up their initial configuration.
Finally, you may decide whether ta allow your clients to cancel the contract while it is active or not. |
|
| Once you have added a new template, you have to fill out contract's details. An appropriate box should appear next to the template form. You will find there a payment type and the price, number of signed contracts and a checkbox, |
|
In this form you can define:
Next to each of the options (except 'Trial Period') there will appear counted pricing of product. |
|
Configuration
| The last step mentioned in the 'Guide' is setting up 'Notifications' and 'Penalty'. These options can be found under 'Configuration' tab in 'Utilities' section. If you wish to provide the phrase under which a client will sign a contract (this phrase has to be included in its content), please use the 'DocuSign Phrase' configuration. |
|
| Select which email notifications you want your clients to receive, enter number of days before due date to send the notification. Move to 'Setup' → 'Email Templates' → 'General Messages' in your WHMCS to view and edit the notifications. You will find them under 'Ending Contract Notification' name. |
|
| Define number of days when a client can be late with payment. If a client misses to make payment for longer than the specified here number of days, a penalty will be imposed on such client. Note: penalty type and amount are specified in 'Contract Template' details. |
|
| Here you can also turn off the guide or turn it on again once you have hidden it. 'Save' the changes once your configuration is ready. |
|
Management
| In the following sections we will try to explain how previously configured contracts are forced on clients. |
Client Area
Place Order
| To illustrate the process, let's say a client orders one of your products with recurring payment (it is important that you have previously prepared a contract for this product). |
|
| On the order form, there is a box where a client needs to select one of the available billing cycles. |
|
| Once a billing cycle is chosen, in 'Additional Required Information' a client must select contract length from the available. |
|
| Before accepting any Terms of Use, a client may view the contract and read it. |
|
| Once familiar with the content of the contract accept 'Contract Terms of Use', only then you will be allowed to view the cart with the selected product. Note: 'Checkbox' method is used in the following example. |
|
| If you do not accept the terms of use you will not be allowed to move to the cart. |
|
| In the cart all contracts are available to view, make sure you accepted all of them before you check out. Otherwise, you will not be allowed to proceed. |
|
Service Contracts
| To view all accepted contracts, find 'Service Contracts' section. Note, if you are working with WHMCS V 5 x.x., you will find 'Service Contracts' tab in your navigation menu under 'Billing' section. |
|
| There is a full list of client's contracts with the most important information about them. Use action buttons to:
|
|
| View the contract's details page: |
|
| View PDF version: |
|
| History of any changes in the contract content: View PDF to see the previous version of the contract. |
|
Admin Area
| Come back to your admin area addon view to manage signed contracts. |
Signed Contracts
| In 'Signed Contracts' section you will find a list of all contracts accepted by your clients. On the main page you can see name of the client with service used, recurring payment amount for their product and contract details such as signing and ending dates, length and status. |
|
| On this page you can see once again details of a contract accepted between a client and you. |
|
| Here, you are allowed to modify the content of this very contract. Note that used 'Contract Content' will not be altered, only this signed item. |
|
| In case you decide to make any changes to the contract, the previous (before changes) version of the contract is added to the 'History'. Thanks to that, you may always come back to the original, restore it (changes made will be overwritten with the previous content) or view PDF version. |
|
Dashboard
| On the Dashboard of your addon you will find the most important information in a nutshell. These are:
|
|
Logs
| In 'Logs' section you have a full view on any attempted action on any contract. |
|
Advanced Billing For WHMCS Integration
| It is possible to combine your Recurring Billing For WHMCS module with one of our most favored products which is Advanced Billing For WHMCS. In order to configure the two modules to work together move to 'Advanced Billing addon' → 'Configuration' and find the product you want to work with. |
|
| When ready, Recurring Billing For WHMCS will be in constant cooperation with the other module within the configured product. If you want to combine the functionalities of the two modules for more than one product, please remember to select 'Bill On Invoice Generation' option for all of them! |
Tips
| 1. If you mark checkbox 'Select to permit orders without contract' in a contract template, while placing an order a client will be allowed to select 'I do not want to sign a contract' option form 'Contract Length'. No 'Terms of Use' will have to be accepted then and the client will not be charged according to the contract's details. |
|
2. The contracts are automatically broken in two cases:
|
| 3. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process. |
| 4. Please remember that the 'Accept Contract' checkbox with the possibility to view the contract in the preview of placing an order is visible only for logged in users. For not logged in users, it will be visible when they proceed to the checkout step. |
| 5. To assure correct integration of the module with the 'Lagom Client Theme', the following integration code must be added into ' viewcart.tpl'. Open the ' viewcart.tpl' file at /templates/orderforms/lagom2/viewcart.tpl directory, find following line (89): <input type="hidden" name="submit" value="true" /> Insert the following code below that line:
<div class="section mg-recurring-billing">
<div class="section-header">
<div class="section-title h3" id="recurring-biling-contracts">
<span>{$contractTitle}</span>
</div>
</div>
<div class="section-body">
{$contractOutput}
</div>
{literal}
<style>
.mg-recurring-billing p {
display: flex;
align-items: center;
}
</style>
{/literal}
</div>
|
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! |
Common Problems
| 1. When you have problems with connection, check whether your SELinux or firewall does not block ports. |
| 2. Remember that Recurring Billing Extended For WHCMS contracts can be applied to products with recurring payment type only. |
|