Advanced Billing For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About Advanced Billing For WHMCS

Advanced Billing For WHMCS allows you to set up additional billing options for your products like bandwidth or CPU usage, basing on actual server resource usage.

In other words, the module will let you charge customers on the grounds of the resources used by them. It offers also hourly billing, ticket billing, credit billing and recurring billing.
The module will also automatically generate invoices on the basis of the data gathered by the synchronization. It is integrated with many modules including cPanel and SolusVM.

  • Core Features:
✔ Hourly Billing For Any WHMCS Module
✔ Ticket Billing
✔ Configure Billing Per Product
✔ Manage Extensions And Configure Them Per Product
✔ View Current List Of Billable Items For Next Invoices
✔ View Resources Usage History Of Any Item
✔ Manage Awaiting Invoices And Convert Them To Invoices
✔ Define Time Period Between Resource Usage Checks
✔ Define Whether To Store Logs In Files Or In Database
✔ View Logs
  • 'Recurring Billing' Extension Features:
✔ Bill On Account Terminate
✔ Bill When Invoice Is Generated For Hosting
✔ Bill Each X Day Of Month
✔ Bill Each X Days
✔ Automatically Generate An Invoice
✔ Define Invoice Payment Due Date
✔ Automatically Apply Credits
  • 'Credit Billing' Extension Features:
✔ Generate Invoice Each X Days
✔ Define Minimal Amount Of Credit To Charge
✔ Send Email When Client's Credit Balance Falls Below Defined Credit Amount
✔ Automatically Suspend Account When Client Is Out Of Credits
✔ Define Invoice Payment Due Date
✔ List Summary Credit Billing Charges Of Any Hosting
✔ Refund Credit Payment To Client
✔ Automatically Refill Client's Credit Balance Using Their Credit Card
✔ Client Can Enable/Disable Auto Refilling And Define A Single Refill Amount
  • 'Resource Usage' Extension Features:
✔ Define Period For Counted Resource Usage
✔ Define Resource Usage Counting Precision
✔ Show History Of Resource Usage
✔ Define Amount Of Usage Records Displayed Per Page
  • 'Graphs' Extension Features:
✔ View Graphs In Admin And Client Area
✔ Generate Time Graphs Of Chosen Resource Usage
✔ Show Data For Selected Time Period
✔ View Disk Storage Used To Archive Data
✔ Flush Archived Data
  • Available Extensions:
Product Auto Upgrade - Live Upgrade/Downgrade Of Products Depending On The Used Resources
Proxmox Cloud Autoscaling - Scale Proxmox Servers Within Defined Limits On The Fly
  • Supported Modules:
✔ cPanel & cPanel Extended Integration: Hourly, Bandwidth, Storage, Databases, Addon Domains, Subdomains, Parked Domains, Domain Forwarders, FTP Accounts, Installed Applications, Email Accounts
✔ DirectAdmin & DirectAdmin Extended Integration: Hourly, Bandwidth, Storage, Subdomains, Domain Pointers, FTP Accounts, MySQL Databases, Virtual Domains, Mailing Lists, POP Accounts, Email Forwarders, Email Autoresponders
OpenStack VPS Integration: Hourly, VCPU Cores, Memory Usage, CPU Utilization, Incoming Bandwidth, Outgoing Bandwidth, Disk Root Used, Disk I/O Read, Disk I/O Write, Floating IP, Fixed IP, Backups Number
✔ Plesk & Plesk Extended Integration: Hourly, Subdomains, Disk Space, Email Boxes, Sites, Redirects, Mail Groups, Autoresponders, Mailing Lists, Users, Databases, Webapps, Traffic
Proxmox Cloud Integration: Disk Usage, Disk Size, Bandwidth IN, Bandwidth OUT, Memory Usage, Memory Size, Backups, CPU Number, CPU Usage
Proxmox VPS Integration: Hourly, Disk Usage, Bandwidth IN, Bandwidth OUT, Memory Usage, Backups Usage, CPU Number, CPU Usage
Rackspace Email Extended Integration: Hourly, Mailbox Storage, Mailboxes, Sync Licenses, Blackberry Licenses, Exchange Storage, Exchange Mailboxes
✔ SolusVM & SolusVM Extended VPS Integration: Hourly, Disk Usage, Memory Usage (except KVM virtualization), Bandwidth Used
SolusVM Extended Cloud Integration: Available Disk Size, Disk Usage, Available Bandwidth, Available Memory, Cores, IP Addresses, Disk Usage, Memory Usage (except KVM virtualization), Bandwidth Used
Virtuozzo VPS Integration: Templates, CPU Usage, Memory, Bandwidth IN, Bandwidth OUT, Disk Used, Backups Usage
Zimbra Email Integration: Hourly, Mailboxes, Aliases, Storage
  • General Info:
✔ Store Usage Records In WHMCS Or External MongoDB Database
✔ Count Usage Of All Accounts Assigned To Reseller - cPanel, cPanel Extended, DirectAdmin & DirectAdmin Extended
✔ Multi-Language Support
✔ Supports PHP 5.4 Up To PHP 7
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V6 and V7

Installation

In this tutorial we will show you how to successfully install and manage Advanced Billing 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.
AB2 1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.
It does not apply to open source versions.

Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'.

AB2 2.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

AB 3.png
4. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Click 'Setup' then choose 'Addon Modules'.
Afterwards find 'Advanced Billing' and press 'Activate' button.

AB 5.png
5. In the next step you need to configure your module, to do so, press 'Configure' button.

Select database driver for usage records:

  • WHMCS Database
  • External MongoDB Database

In case you choose MongoDB you will also have to provide:

  • Hostname
  • Database Name
  • Username
  • Password

Choose desired admin roles groups to grant access to the module and 'Save Changes'.

AB 6.png
6. Now, proceed to Extensions section to find more about configuring license.
7. The last step is setting up a cron job, you can find it in your WHMCS → 'Addons' 'Advanced Billing' 'Configuration' page.
AB 7.png
Well done, you have just successfully installed Advanced Billing For WHMCS!
If you have used previous version of Advanced Billing For WHMCS and you want to migrate data to the current one,

please see section How To Update section and follow the instruction there.

Configuration and Management

Now let's learn more about module's functionalities. We will present you the possibilities of our product on cPanel Extended For WHMCS example.

Please note that billing features are different in each module but the core functionality of Advanced Billing is the same for each.
Firstly, choose your module from 'Enable Advanced Billing For' dropdown menu as it is shown on the following screen.
For presentation purposes we have chosen 'cPanel Premium' with cPanel Extended module.

AB 8.png

Core

Our module core has been designed in a way to allow collecting the records and invoices' management.

Any extra features are handled by extensions, which can be easily enabled/disabled, and are always configured per product.

Product List

On the products list, there are all the products with Advanced Billing enabled.

If the product's submodule is not supported, 'default' mode will be used instead, which enables you to bill your client for hourly usage of the product only.
Except listed products with their submodules you will find there options to:

  • control the status of your product billing, enable/disable Advanced Billing for a product
  • manage cron frequency
  • use action buttons:
    • Pricing
    • Settings
    • View Items
AB 9.png

Settings

Under Settings button there are visible Module Settings only for cPanel/cPanel Extended modules and other extensions if enabled. We will discuss them later on.
AB 10 1.png
Here you can set Application Manager (Softaculous/Installatron) and cPanel theme.

Simply enter a theme name as shown on the screen below.

AB 10.png

Used Resource Pricing

When you move to 'Pricing' section, you can set up billing for specific server resource usage like bandwidth.
AB 11.png
Manage each usage record by setting up its:
  • Free Limit - is used to set the amount of usage records for which a customer will not be charged.

In our example, a customer will not be charged for 1GB (1024MB) bandwidth.

  • Price - defines how much your client will have to pay for specific resource. Note that we provide two types of charging: units per hour and units used since the last cron run.

For example, user pays for subdomain quantity each hour, but when traffic is generated, bandwidth used since the last cron run will have to be paid once only.

  • Display Unit - category defines the manner record usage will be displayed in. It does not affect free limit and pricing, they are calculated in basic unit.

If you select 'GB' , free limit will be still 1024 MB, and price will be MB/hr, not GB/hr.

  • Status - allows you to enable/disable billing for this resource.

To proceed, choose your usage records, units, status, set up the prices and free limits. Afterwards, press 'Save'.

AB 11 1.png
As you could notice, there is also 'Configure' column.

It allows you to set up different free limits and pricing depending on resource origin.
Currently, only 'Viruozzo' and 'Openstack VPS' submodules support this feature.

Items

To view counted usage, go to 'Items' tab.

Each cron run will create an item for each customer, if it does not exist at the moment, and add new records to existing ones.
In that way you can see current server resources usage from the last billing period.
Automatic generation of invoices is based precisely on previously created items.
To view more details click on 'View Details' as shown on the following screen.
You can also easily remove billing for specific hosting. To do so, press 'Delete Records' in 'Actions' column.

AB 13.png
In details, you can learn some detailed information on Bandwidth, Storage, Domains and other enabled records.

See the price and usage, last cron run date and total records summary.
Press 'Delete' button to remove entries.

AB 14.png

Invoices

Under 'Invoices' section you can manage any of your awaiting invoices. They can be generated automatically and manually.

On the screen below you can see a previously generated invoice for our cPanel Extended account.
To view detailed information about particular invoice press 'Show Details' button.

AB 17.png
This is the place where you can verify and modify awaiting invoices. It's advised to check whether invoices are correct to avoid any risk.
AB 18.png
Let's generate an invoice for your customer manually now.

For this purpose simply click on 'Generate' next to a chosen invoice.

AB 18 1.png
After changing product's package, invoice is automatically generated for an old package.

Settings

Under 'Settings' tab you can find pages such as 'Logs', 'Integration' and 'Extensions'.

Integration Code

'Integration' page contains codes required to integrate Advanced Billing For WHMCS with your client area.

The first of them allows displaying product pricing during placing an order.

AB 21.png
If the code has been inserted correctly, this is how an exemplary order form will look like:
AB 21 1.png
The second code is responsible for showing usage records in the client area.

Note: To display usage records in the client area, you need to enable 'Usage Records' extension for the product.
Remember that there are separate codes for WHMCS V5 and V6. Insert codes accordingly to your system version.

AB 22.png
If the code has been inserted correctly, this is how exemplary resource usage should be displayed:
AB 23.png

Items Archive

On this page you can find information regarding archived usage records. Once a client pays for the usage, the usage history is automatically moved to the archive.

There is a number of archived items together with space they take on the disk.

AB 23 1.png
Use 'Flush' option to clear the archive and remove all stored here data.
AB 23 2.png

Logs

In 'Logs' you will find information about the module activity.

You can view logs in a form of 'Database' or 'File', simply choose one as marked on the screen below.

AB 19 1.png
View informative logs, error logs and critical logs.

New log files are created every day to help you find information you are looking for.

AB 19.png

Extensions

In this section we will describe each extension step by step.

Important: Only four of them are included in Advanced Billing For WHMCS product, you can turn them on under 'Settings' → 'Extensions' section.
These extensions are visible on the below screen for your note. The rest of the extensions can be obtained separately.
Default extensions included in Advanced Billing For WHMCS are 'Recurring Billing', 'Usage Records', 'Credit Billing' and 'Graphs.'
Each extension is configured per product, therefore you can use different sets of extensions according to your needs.
To start using an extension, you need to activate it firstly, proceed to 'Settings' 'Extensions' page.
Afterwards, 'enable' the extension you wish to use, new options will appear in Advanced Billing For WHMCS.

AB 24.png
If you skip steps 3-4 of the installation instruction, you have to configure the license for each of the 4 base extensions.

Note that each of them uses Advanced Billing license key.
Press 'Configure', paste your license and confirm changes.

AB 25.png

Credit Billing

'Credit Billing' extension allows you to charge for a product from client credit balance.

To turn it on for a single product, press 'Settings' button next to the chosen product. If the extension is enabled, a new tab will appear.

AB 27 1.png
  • Enable Credit Billing - this option enables/disables credit billing for this module (if credit billing is enabled, standard billing will be turned off).
  • Create Invoices Each - this option defines how often invoice will be generated for this product (30 days is a default value).
  • Minimum Credit - minimum amount that will be charged from client account credit balance.
  • Low Credit Notification - if this value is higher than credits on client account, email to your client about low credit amount will be sent.
  • Email Interval - defines how often low credit notification email will be sent.
  • Autosuspend - when credit balance reaches 0, product ordered by client is automatically suspended and invoice with lacking amount is generated.
  • Due Date - the number of days when your customers have to pay the invoice.
AB 27.png
When 'Autosuspend' is marked and your client's credit balance reaches 0, the client's product will be suspended. Additionally, invoice with lacking payment will be generated.

If it is unmarked and credit balance reaches 0, the client's product will not be suspended and invoice will be generated according to the number of days set in 'Create Invoices Each' field.

Credits

All information related to credit payment for hosting can be found in 'Credits' tab that will appear in your menu when enabled.

As you can see, there are two columns with credits.
The first one, 'Internal Credit' contains credits which were not used for payment, but are reserved for it. It was created to increase accuracy of credit billing.
The second column, 'Already Paid For Hosting' contains summary credit payment for hosting.
You can order refund of any hosting through pressing 'Refund' button next to it. Client will receive sum of 'Internal Credit' and 'Already Paid For Hosting' rounded down to 0.01.

AB 28.png

Recurring Billing

This extension allows you to set up recurring billing for product.
  • Enable Recurring Billing - check to enable this billing type (remember that Recurring Billing and Credit Billing cannot be both enabled in one time)
  • Bill on Termination - when account connected with your module is terminated, invoice for account will be generated.
  • Billing Type - enables you to choose how to bill your client.
    • Bill on Invoice Generation - customer will receive an invoice at the same time as the invoice for their hosting account.
    • Bill On Specific Day - will generate invoices each month on the day specified in the Billing Type Value.
    • Bill Each X Days - as its name suggests, it generates invoice each X days where X is a number specified in Billing Type Value field.
  • Due Date - the number of days in which your customers will have to pay the invoice.
  • Autogenerate Invoice - an important feature which if enabled, automatically sends previously generated invoices directly to your customers.
  • Auto Apply Credits - automatically applies any available credits when invoice is created, works only if 'Autogenerate Invoice' is enabled.
AB 29.png

Usage Records

This extension displays usage records and usage records history in the client area products page.

To use it, besides enabling in, you need to place an integration code.
This extension is configured per product, proceed to the product configuration in Advanced Billing.
As you can see, new tab is available here.

  • Enable - enables usage records being displayed for that product in the client area.
  • Display Summary From - defines period from which usage records will be counted.
  • Usage Records Precision - defines precision of usage records
  • Records History - displays history of usage records.
  • Usage Records Per Page - defines how many usage records should be displayed per page.
AB 30.png
On the following screen you can see a sample of usage records and usage records history in the client area.
AB 23.png

Graphs

Enable 'Graphs' extension to get access to graphical view of usage records for every configured service in your Advanced Billing module.
AB 42.png
When enabled, a new entry on your navigation menu appears → 'Graphs'.
AB 43.png
Please note that before proceeding, you must also enable 'Graphs' extension for the product. To do so move to 'Configuration' → 'Products List' → 'Settings' → 'Graphs'.
There enable the extension and save the changes.
AB 43 1.png
Under 'Graphs' you will find an extended list of all services in your system.
Press 'Show Graph' button and you will be moved to the generated line chart.
AB 44.png
You will immediately see a line chart generated for default resource usage and time period.
You may change the requirements at any time to see a customized version of the graph with data that you actually need and from a desired time period.
Use options on the left side of the graph to personalize the chart statistics.
AB 45.png
Line charts are available not only to administrators in their panel but also to your clients.
Find 'Resource Usage Chart' in the products details and preview teh generated graph.
Just like in admin area client may specify time range and select resources which they wish to see in graphical mode.
AB 46.png

Product Auto Upgrade (Sold Separately)

Product Auto Upgrade For WHMCS extension is automatic upgrade/downgrade of a product according to its usage.

It will allow you to set rules related to the server resource usage according to which the module will resize your products and their configurable options.
You will be also able to let your clients decide if they want their products to be modified as well as enable them to set the rules on their own.
For more information about Product Auto Upgrade For WHMCS, visit its Wiki.

AB2 51.png

Proxmox Cloud Autoscaling (Sold Separately)

Proxmox Cloud Autoscaling For WHMCS enables automatic alterations of servers provisioned by Proxmox Cloud For WHMCS depending on their load.

The module will allow you to set out rules on VPS resources according to which servers will be modified through resizing or cloning.
In addition, you will be able to grant your clients permission to change rules or toggle module functionality.

For more information about Proxmox Cloud Autoscaling For WHMCS, visit its Wiki.

AB PCA.png

Hourly Billing

Hourly billing allows you to charge your customers for each hour of use of the product (hourly billing calculations are basing on product 'Registration Date' ).

You can enable hourly billing for any product type.
Regardless of whether it is a server, web hosting account or other, customer will be billed for each hour of using the product.

AB 32.png

Ticket Billing

Ticket billing works exactly as it sounds. When enabled, it bills your customers for each opened ticket.

Remember that you must have a product with Ticket Billing submodule assigned to it.

AB 33 1.png
As in the case of hourly billing, you can enable ticket billing for any product type.
AB 33.png

Sample Configuration

In this section we will show you two samples of configuration of Advanced Billing.

Two Weeks Billing

In order to set up generating invoice for resource usage each 2 weeks, follow this steps:

1. Go to 'Addons' 'Advanced Billing' and select your product from 'Enable Advanced Billing For:'

AB 34.png
2. Go to 'Products List' → (your product's) 'Settings' → 'Recurring Billing' , enable the extension together with 'Bill on Termination' option.

Additionally, choose 'Bill Every X Days' from 'Billing Type' dropdown menu and enter '14' into the 'Billing Type Value' textbox.
Afterwards, press 'Save' the changes.

AB 35.png
3. Remember to enter your pricing settings.
AB 36.png
You have just successfully configured billing!

You should see something like on the screen below in your Advanced Billing main page.
Note that you may alter Cron Frequency per product here.

AB 37.png

20$ Billing

To bill your client as often as possible follow these steps:

1.Go to 'Addons' 'Advanced Billing' and select your product from 'Enable Advanced Billing For:'

AB 34.png
2. Go to 'Products List' → (your product's) 'Settings' → 'Credit Billing' and press 'Enable'.

Afterwards, enter '1' into 'Create Invoices Each', '20' into 'Minimum Credit' and '50' into 'Low Credit Notification'.
With these settings your client will be billed from credit balance as soon as the payment for resource usage has reached 20$.
They will also receive an email if their credit balance falls below 50$.

AB 39.png
3. Remember to set up your pricing.
AB 40.png
You have just successfully configured billing!

In your Advanced Billing 'Configuration' tab you should see something similar to the following screen.
Note that you may alter Cron Frequency per product here.

AB 41.png

How To Update

If you switch from Advanced Billing v2.x to v3.x, data from your previous version of the module must be migrated to the latest one.
To do so, simply follow the basic steps below:

1. Copy new files to a correct directory in your WHCMS.
2. Proceed to 'Setup' → 'Addon Moduels', find 'Advanced Billing' on the list, press 'Configure' to select a proper database you wish to use.
3. Move to the addon: 'Addons' → 'Advanced Billing' and run the below script:

/your_whmcs/modules/addons/AdvancedBilling/migrationScript.php


If you already own Advanced Billing v3.x and want to have a newer one, just overwrite the files as it is done upon regular update.

Tips

1. Deactivation of the module removes products' configuration, usage records and awaiting invoices.

In order to update the module, simply follow instruction in 'How To Update' .

2. 'Installed Applications' usage record supports both Softaculous and Installatron.
3. You can set up as many products as you want.
4. If your client uses currency that is not WHMCS base currency (for example, WHMCS base currency is €, while client uses $):

An invoice for such client will be generated in the chosen currency, while usage record and calculation in Advanced Billing will use base currency.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. You are unable to find specified line in clientareaproductdetails.tpl.

Cause 1: You are using Classic or Portal template.
Solution 1: In this case place required code after this line:

<div align="center">{$moduleclientarea}</div>

Cause 2: You are using heavily customized template.
Solution 2: Create a ticket and one of our specialists will help you set up the module.

Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
Advanced Billing For WHMCS