Personal tools
Namespaces

Variants
Actions

Cloud Billing For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Update Instructions)
(34 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<meta name="keywords" content="client profile viewer for whmcs, client profile viewer configuration, whmcs client profile viewer management, whmcs client profile viewer installation, whmcs client profile viewer common problems, about whmcs client profile viewer, whmcs client profile viewer documentation, whmcs client profile viewer faq, whmcs client profile viewer help, whmcs client profile viewer guide, whmcs client profile viewer wiki, whmcs client profile viewer tutorial, whmcs client profile viewer tips, whmcs client profile viewer wiki"></meta>
+
<meta name="keywords" content="aws billing for whmcs, cloud billing for whmcs, azure billing for whmcs, google cloud billing for whmcs, microsoft csp billing for whmcs, amazon web services whmcs, amazon web services billing whmcs, amazon aws whmcs, amazon aws billing whmcs, cloud billing configuration, whmcs cloud billing management, whmcs cloud billing installation, whmcs cloud billing common problems, about whmcs cloud billing, whmcs cloud billing documentation, whmcs cloud billing faq, whmcs cloud billing help, whmcs cloud billing guide, whmcs cloud billing wiki, whmcs cloud billing tutorial, whmcs cloud billing tips"></meta>
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Client Profile Viewer For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Cloud Billing For WHMCS Solution."></meta>
  
<h4 style="color: #ff0000; font-weight:bold; text-align:center;">Article update is ongoing on this page, watch out for broken links, unclear descriptions and images!<br/>
+
=About [https://www.modulesgarden.com/products/whmcs/cloud-billing Cloud Billing For WHMCS]=
We are sorry for the inconvenience caused.</h4>
+
 
+
=About [https://www.modulesgarden.com/products/whmcs/client-profile-viewer Client Profile Viewer For WHMCS]=
+
 
{|
 
{|
|style="padding: 10px 0px 10px 0px;"|'''Client Profile Viewer For WHMCS''' is a module which has been created to gather all the key information about each of your clients in one simple tooltip.<br />
+
|style="padding: 10px 0px 10px 0px;"|'''Cloud Billing For WHMCS''' is a sophisticated module that consists of:
Contact details, purchased products and services, income – all of these and many more organized in convenient widgets will be displayed each time you hover over a client's name.<br />
+
The module enables you to not only conveniently preview the information about each customer but also modify it according to your needs.
+
 
|}
 
|}
<!-- fixed -->
 
*'''Addon Module Features:'''
 
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ View Widgets With Client Details In Tooltip On Mouseover
+
|style="padding: 0px 0px 0px 30px;"|✔ AWS Billing For WHMCS
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Drag & Drop Configuration Of Each Widget To Change Order
+
|style="padding: 0px 0px 0px 30px;"|✔ Google Cloud Billing For WHMCS
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Access Various Parts Of System On Click
+
|style="padding: 0px 0px 0px 30px;"|✔ Microsoft Azure Billing For WHMCS
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Configure Admin Roles Assigned To Each Configuration
+
|style="padding: 0px 0px 0px 30px;"|✔ Microsoft CSP Billing For WHMCS ''(coming soon)''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Configure Hide Tooltip Option
+
|style="padding: 10px 0px 10px 0px;"|'''Cloud Billing For WHMCS''' offers you a powerful billing model management of Google Cloud, Amazon Web Services and Microsoft Azure to broaden your target audience.<br/> The module allows you to gather all the services in one place, connect to the external platforms in two different ways - with the use of your account or your customer account.<br /> Except for setting percentage billing margin for WHMCS products per service, you are given the possibility to generate detailed reports on billing management, earnings, resource usage per service, and much more.
 
|}
 
|}
 +
*'''Core Features:'''
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define Delay Time To Show Tooltip
+
|style="padding: 10px 0px 0px 30px;"|✔ Efficiently Bill Customers For Management Of:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ Automatically Flag Client Tickets To Assigned Admin
+
|style="padding: 0px 0px 0px 45px;"|✔ Amazon Web Services (AWS)
 
|}
 
|}
*'''Widgets:'''
 
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Income
+
|style="padding: 0px 0px 0px 45px;"|✔ Google Cloud Services
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Invoices
+
|style="padding: 0px 0px 0px 45px;"|✔ Microsoft Azure Services
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Quotes
+
|style="padding: 0px 0px 0px 30px;"|✔ Earn Profits From Percentage Margins Defined Per Service
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Tickets
+
|style="padding: 0px 0px 0px 30px;"|✔ Keep Customers Updated On Current And Upcoming Costs
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Services Amount
+
|style="padding: 0px 0px 10px 30px;"|✔ Monitor Expenses, Earnings, And Resource Usage On Graphs
 
|}
 
|}
 +
 +
*'''Admin Area Features:'''
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Client Admin Notes
+
|style="padding: 10px 0px 0px 30px;"|✔ View Dashboard Summaries:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Client Notes
+
|style="padding: 0px 0px 0px 45px;"|✔ Invoices And Earnings Per Last Week/Month/Quarter/Year
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Notes
+
|style="padding: 0px 0px 0px 45px;"|✔ Expenses And Earnings
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Status
+
|style="padding: 0px 0px 0px 45px;"|✔ Earnings Per Service
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Quick Actions
+
|style="padding: 0px 0px 0px 45px;"|✔ Most Profitable Clients
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Profile Tabs
+
|style="padding: 0px 0px 0px 45px;"|✔ Latest Invoices
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Person Assigned
+
|style="padding: 0px 0px 0px 45px;"|✔ Paid API Requests Usage
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Log In As Client
+
|style="padding: 0px 0px 0px 30px;"|✔ Create Pricing Groups With Multiple Pricing Margins Per Services
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Credit Card Information
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign WHMCS Products To Selected Pricing Groups
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Send Email
+
|style="padding: 0px 0px 0px 30px;"|✔ Select Billing Method For Product:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Send SMS - Integrated With SMS Center For WHMCS [https://www.modulesgarden.com/products/whmcs/sms-center (read more)]
+
|style="padding: 0px 0px 0px 45px;"|✔ On WHMCS Invoice Generation
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ Multibrand - Integrated With Multibrand For WHMCS [https://www.modulesgarden.com/products/whmcs/multibrand (read more)]
+
|style="padding: 0px 0px 0px 45px;"|✔ On First Day Of Month
 
|}
 
|}
*'''Widgets Configuration:'''
 
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Income:
+
|style="padding: 0px 0px 0px 45px;"|✔ On Last Day Of Month
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Select Range Of Income Statistic
+
|style="padding: 0px 0px 0px 45px;"|✔ Manually
 
|}
 
|}
{|
+
{|
|style="padding: 0px 0px 0px 30px;"|✔ Tickets:
+
|style="padding: 0px 0px 0px 30px;"|✔ Create And Manage Service Relations Between:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Select Statuses Of Tickets To Count And Display
+
|style="padding: 0px 0px 0px 45px;"|✔ Client And Their WHMCS Products
 
|}
 
|}
{|
+
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Columns To Display Tabs
+
|style="padding: 0px 0px 0px 45px;"|✔ Pricing Groups
 
|}
 
|}
{|
+
{|
|style="padding: 0px 0px 0px 30px;"|✔ Services Amount:
+
|style="padding: 0px 0px 0px 45px;"|✔ Used API Credentials
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define If Product/Domain Status Is Shown
+
|style="padding: 0px 0px 0px 45px;"|✔ Billing Type:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define Additional Links To Show
+
|style="padding: 0px 0px 0px 60px;"|✔ Amazon Web Services:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Visible Lines
+
|style="padding: 0px 0px 0px 75px;"|✔ Default - Bill Resource Usage Across All Services With Particular Tag Name And Tag Value
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Client Admin Notes:
+
|style="padding: 0px 0px 0px 75px;"|✔ Organization - Bill Resource Usage Across All Services In Particular Company
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define Visible Note Length In Tooltip
+
|style="padding: 0px 0px 0px 75px;"|✔ Custom Details - Bill Resource Usage Across All Services Accessible Via Credentials
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Notes:
+
|style="padding: 0px 0px 0px 60px;"|✔ Google Cloud:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Enable/Disable Notes For All, Group Notes And My Notes
+
|style="padding: 0px 0px 0px 75px;"|✔ Label - Bill Resource Usage Across All Services With Particular Label
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define Notes Length Displayed In Tooltip
+
|style="padding: 0px 0px 0px 75px;"|✔ Custom Details - Bill Resource Usage Across All Services Accessible Via Credentials
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define Limits Of Notes Displayed In Tooltip Per Group
+
|style="padding: 0px 0px 0px 60px;"|✔ Microsoft Azure:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define The Limits Of Notes Per Group
+
|style="padding: 0px 0px 0px 75px;"|✔ Default - Bill Resource Usage Across All Services With Particular Tag Name And Tag Value
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Status:
+
|style="padding: 0px 0px 0px 75px;"|✔ Custom Details - Bill Resource Usage Across All Services Accessible Via Credentials
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define Whether To Show Client Status Before Their Name
+
|style="padding: 0px 0px 0px 30px;"|✔ View Service Details:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define Whether To Color Client Name
+
|style="padding: 0px 0px 0px 45px;"|✔ Total Paid And Charged Amount Per Client
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Quick Actions:
+
|style="padding: 0px 0px 0px 45px;"|✔ Current Usage With Cost And Charged Amount Per Service
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define Visible Options
+
|style="padding: 0px 0px 0px 45px;"|✔ Charges Per Service Graph
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Profile Tabs:
+
|style="padding: 0px 0px 0px 45px;"|✔ Generated Invoices Per Service
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define Visible Options
+
|style="padding: 0px 0px 0px 30px;"|✔ View Created Invoices Per Client
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Columns To Display Tabs
+
|style="padding: 0px 0px 0px 30px;"|✔ Provide Multiple API Credentials
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Invoices:
+
|style="padding: 0px 0px 0px 45px;"|✔ Run API Connection Test
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Visible Lines
+
|style="padding: 0px 0px 0px 30px;"|✔ View Service Details, Usage And Charges From Client's Products/Services Tab
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Columns To Display Tabs
+
|style="padding: 0px 0px 0px 30px;"|✔ Access Your License Information With Selected Plan Based On Current Income
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Select Statuses Of Invoices To Count And Display
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Billing Data Collecting Cron Frequency Per Day
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Quotes:
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Debug Mode For API Request Logging
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Visible Lines
+
|style="padding: 0px 0px 0px 30px;"|✔ View Billing Service Logs Of Auto-Assignment To Pricing Groups:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Columns To Display Tabs
+
|style="padding: 0px 0px 0px 45px;"|✔ Manually Change Service Assignment
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 45px;"|✔ Select Stages Of Invoices To Count And Display
+
|style="padding: 0px 0px 10px 30px;"|✔ View Module Logs
 
|}
 
|}
 +
 +
*'''Client Area Features:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ View Current Resource Usage Per Service
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View Charges Per Service Graph:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Select Service Types
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 45px;"|✔ Define Graph Scope
 +
|}
 +
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 10px 0px 0px 30px;"|✔ Supports All Offered AWS, Google Cloud, And Microsoft Azure Services
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports Multiple AWS, Google Cloud, And Microsoft Azure Accounts
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 7.1 Up To PHP 7.4
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V7.9 And Later
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/client-profile-viewer#open-source-version Open Source Version]
+
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V8.9 Back To WHMCS V8.6
 
|}
 
|}
  
=Installation=
+
*'''Requirements:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/client-profile-viewer Client Profile Viewer For WHMCS.]''' <br/>
+
|style="padding: 10px 0px 0px 30px;"|✔ Amazon Web Services Account
We will guide you step by step through the whole installation and configuration process.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
+
|style="padding: 0px 0px 0px 30px;"|✔ Google Cloud Account
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_1.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Microsoft Azure Account
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
+
|style="padding: 0px 0px 30px 30px;"|✔ ionCube Loader V12 Or Later
In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later.<br/> <!-- If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. -->
+
 
|}
 
|}
 +
 +
=Installation and Configuration=
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:PHP71_74.png]]
+
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/cloud-billing Cloud Billing For WHMCS] smoothly.''' <br />
 +
We will guide you step by step through the whole process.
 
|}
 
|}
 +
 +
==Installation==
 +
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3.<br/>
+
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_73.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_1.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 15px;"|<!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/client-profile-viewer#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' --> '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the extension into the main WHMCS directory.<br />
 +
Extracted files in your WHMCS directory should look like this:
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory.
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_2.png]]
The content of the package to upload should look like this.  
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP2_2.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Cloud Billing For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
 +
The file is located in '' 'modules/addons/CloudBilling/license_RENAME.php'.''  Rename it from '' 'license_RENAME.php' '' to '' 'license.php'.''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Client Profile Viewer For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_3.png]]
File is located in '' 'modules/addons/clientsprofiler/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_3.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
 +
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'.''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' file ''.'''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_4.png]]
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' ''.  
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_4.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''5. In the next step, set up the  '' 'storage' '' folder as recursively writable.'''<br />
 +
This folder is available at '' 'your_whmcs/modules/addons/CloudBilling/' ''.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system. '''<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_5.png]]
Log in to your WHMCS admin area. Go to '' 'System Settings' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Client Profile Viewer' '' and press '' 'Activate' '' button.
+
 
|}
 
|}
 +
 +
==Activating Addon Module==
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_5.png]]
+
|style="padding: 10px 0px 20px 15px;"|'''6. Now, you have to activate the module in your WHMCS system.'''<br />
 +
Log in to your WHMCS admin area. Go to '' 'System Settings' '' → '' 'Addon Modules'. '' Afterward, find '' 'Cloud Billing' '' and press the '' 'Activate' '' button.<br />
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_6.png]]
To do so, click on '' 'Configure' '' button, define the access control and grant permissions to manage the module to desired admin roles. Press '' 'Save Changes'.''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_6.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''7. In the next step, you need to grant access to this module.'''<br />
 +
To do so, click on the '' 'Configure' '' button, go to the '' 'Access Control' '' area and check the required admin role groups. Press '' 'Save Changes'.''<br />
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Client Profile Viewer For WHMCS!'''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_7.png]]
You can access your module under '' 'Addons' '' → '' 'Client Profile Viewer' ''.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_7.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''8. Good job! You have just successfully installed Cloud Billing For WHMCS! Now in your WHMCS press '' 'Addons' '' and then '' 'Cloud Billing'. '' '''
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_8.png]]
 +
|}
 +
<!--
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''9. Before you finish the configuration process, you need to set up the following folders as recursively writable:<br />
 +
<pre>'your_whmcs/modules/addons/CloudBilling/storage/logs'
 +
'your_whmcs/modules/addons/CloudBilling/storage/app'
 +
'your_whmcs/modules/addons/CloudBilling/storage/crons'</pre>
 +
|}-->
  
=Configuration and Management=
+
==AWS Billing For WHMCS==
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|'''Client Profile Viewer For WHMCS is a module which allows you to quickly display clients' details across the WHMCS.<br/>
+
|style="padding: 10px 0px 20px 15px;"|'''9. In order to continue the configuration process. At first, proceed to the '' 'API Credentials' '' section as presented on the screen.<br/>
Additionally, you can easily configure access to the clients' information depending on the admin role.
+
 
|}
 
|}
==Configuration==
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can manage tooltip configurations as well as add new ones.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_9.png]]
Each configuration can have multiple admin roles assigned while one admin role can be assigned to a single configuration only.<br/>
+
As you can see on the following screen, you can view the list of enabled widgets and assigned admin roles of each configuration.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_8.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''To complete the previous step and connect to the platform properly, you need to generate your AWS access details.'''<br/>
 +
Underneath, you will find detailed instructions on where to find this information.
 
|}
 
|}
===Add Configuration===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|To add a new configuration, press '' 'Add New Configuration' '' button.
+
|style="padding: 0px 0px 20px 15px;"|'''10. Log in to your [https://aws.amazon.com/console/ Amazon AWS Management Console] and find '' 'My Security Credentials' '' section under your account name dropdown.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ALS_6.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|Afterwards, fill in '' 'Configuration Name'.''<br/>
+
|style="padding: 0px 0px 20px 15px;"|'''11. There, move to the '' 'Access Keys (access key ID and secret access key)' '' section.
Add admin roles through choosing each of them from a dropdown menu and pressing '' 'Add'.''<br/>
+
Additionally, select widgets in the configuration the same way you have added admin roles.  
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ALS_7.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|If you wish to change the order in which widgets are displayed, simply drag widget to a desired location and drop it, do not forget to save the changes in the end.  
+
|style="padding: 0px 0px 20px 15px;"|'''12. If you do not have any active keys yet, then press the '' 'Create New Access Key' '' button to generate a new set of details.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_11.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ALS_8.png]]
 
|}
 
|}
 
===Advanced Configuration===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Some of the widgets may have additional configuration, more information about them can be found in this subsection.
+
|style="padding: 0px 0px 20px 15px;"|'''13. A modal with Access Key ID and Secret Access Key will appear, so copy this information and keep it safe. You may also download a suitable file with these details. '''<br/>
 +
'' '''Note:''' This is the only place where you can find the corresponding secret key later. It will not be visible next to the Key ID in the panel.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Client Admin Notes'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:ALS_9.png]]
*'' 'First Letters' '' - defines the number of letters of a note shown in the main tooltip. All notes are available after pressing '' '+' '' button.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_13.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''14. Now, come back the '' 'API Credentials' '' section and press the '' 'Add Credentials' '' button. In the new pop-up window, provide a name, API Key, API Secret.  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Client Custom Notes'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_10.png]]
*'' 'My Notes' '' - shows '' 'My Notes' '' in the main tooltip.
+
|}
*'' 'Group Notes' '' - displays notes visible for my admin role in the main tooltip.
+
{|
*'' 'Notes For All' '' - if checked, global notes will be visible in the main tooltip.<br /><br />
+
|style="padding: 0px 0px 20px 15px;"|In the new pop-up window, provide a name, API Key, API Secret. Press '' 'Add' '' when ready.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_12.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''15. To check if the entered data is correct, click on the '' 'Test Connection' '' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_13.png]]
 +
|}
 +
==Google Cloud Billing For WHMCS==
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|Before you can go on, you must configure your google service account appropriately and then generate your Google Cloud access details. You will need them to create connection between the module and the Google Cloud server.
 +
|}
 +
===Billing Export===
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Underneath, you will find instructions on how to export billing data and create datasets. This step is obligatory and without proper configuration here the module will not work correctly.
  
*'' 'My Notes Limit' '' - defines limit for notes added to '' 'My Notes' '' group.
+
'''9. At first, proceed to '' 'Billing' 'Billing Export' '' section of your project. There under '' 'Daily Cost Detail' '' press '' 'Edit Settings'.'''''
*'' 'Group Notes Limit' '' - defines limit for notes added to '' 'Group Notes' '' group.
+
*'' 'Notes For All Limit' '' - defines limit for notes added to '' 'Notes For All' '' group.<br /><br />
+
 
+
*'' 'My Notes View Limit' '' - defines number of '' 'My Notes' '' shown in the main widget.
+
*'' 'Group Notes View Limit' '' - defines number of '' 'Group Notes' '' shown in the main widget.
+
*'' 'Notes For All View Limit' '' - defines number of '' 'Notes For All' '' shown in the main widget.<br /><br />
+
 
+
*'' 'Notes View Length Limit' '' - defines length of notes, from each group, shown in the main widget.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_13_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_13_1.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Client Custom Status'''
+
|style="padding: 0px 0px 15px 15px;"|'''10. Now create a BigQuery dataset.'''<br/>
*'' 'Inline' '' -  if checked, status is displayed before client's name.
+
This step is crucial for the whole module managemnt. Billing datasets are generated now, they will be assigned to services in the module to allow their billing.
*'' 'Color' '' -  if checked, client's first and last name are displayed using selected status color.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_13_2.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Income'''
+
|style="padding: 0px 0px 20px 15px;"|Press '' 'Create Dataset'.''
*'' 'Range' '' -  enables you to define a time period for invoices taken into consideration.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_13_3.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Services Amount'''
+
|style="padding: 0px 0px 20px 15px;"|Enter the dataset ID and select localisation ''(the same for the project and the dataset).''
Define a number of lines you want to be displayed on the widget.  
+
|}
*'' 'Product Status' '' - shows product's status
+
{|
*'' 'Domain Status' '' - shows domain's status
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_13_3_1.png]]
*'' 'Product Domain' '' - shows domain of a product<br /><br />
+
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|A new table with billing data should appear in the Explorer in a while.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_13_3_2.png]]
 +
|}
  
*'' 'Product Domain WWW' '' - shows product's domain www link
+
===API Credentials===
*'' 'Product WHOIS' '' - shows product's domain whois link
+
{|
*'' 'Product IntoDNS' '' - shows product's domain intoDNS link<br /><br />
+
|style="padding: 10px 0px 15px 15px;"|'''11. Next, you will have to create your personal login credentials.'''<br/>
 +
You will need them to successfully connect the Cloud Billing module with the platform.<br/>
 +
Move to '' 'APIs & Service' 'Credentials'. '' There press '' '+ Create Credentials' → 'Service Account'. ''  
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_13_4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''12. Provide the service account details and press '' 'Create'.'' You will be automatically moved to the next step.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_13_5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''13. Grant the service account access to the project, add these roles:'''
 +
* BigQuery Job User
 +
* BigQuery Resource Viewer
 +
* BigQuery Data Editor
  
*'' 'Domain WWW' '' - shows domain www link
+
If you need you may grant users access to the service account, however, this step is not required. Press '' 'Done' '' when everything is ready.
*'' 'Domain WHOIS' '' - shows domain whois link
+
*'' 'Domain IntoDNS' '' - shows domain intoDNS link
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_13_6.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Profile Tabs'''<br/>
+
|style="padding: 0px 0px 20px 15px;"|'''14. Next, open the service account details by pressing the icon. You will have to add a new JSON key to the just generated credentials.'''
*Tabs Map:
+
*:Select tabs that will be allowed to redirect to from the Client's profile tooltip
+
*Columns:
+
*:Declare the number of columns to view the chosen tabs
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_13_7.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Quick Actions'''
+
|style="padding: 0px 0px 20px 15px;"|'''15. When you have the service account details open, find '' 'Add Key' '' at the page bottom. Select '' 'Create new key'.'' '''
*Select which of the available actions shall be allowed form the client's profile tooltip
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_13_8.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Tickets'''
+
|style="padding: 0px 0px 20px 15px;"|'''16. Select the key type - '' 'JSON' '' and create it. A JSON format file will be immediately saved on your disk.'''<br/>
*Columns:
+
Keep it save as there is no way to download it again. You will need it in a moment.
*:Declare the number of columns to view the chosen tabs
+
*checkboxes - marking a checkbox enables counting that type of tickets as well as shows direct link to the ticket's list of that type.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_13_9.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Quotes'''
+
|style="padding: 0px 0px 15px 15px;"|Underneath you may see how an exemplary content of a JSON file may look like.
*Define:
+
*:the number of columns to view the chosen tabs
+
*:the number of visible lines
+
*Select required statuses of quotes, only quotes with pointed here statuses will appear in the final widget.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_25_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_13_10.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Invoices'''
+
|style="padding: 0px 0px 20px 15px;"|'''17. Move to your '' 'WHMCS' → 'Addons' → 'Cloud Billing'.'' There open the '' 'API Credentials' '' section and add new credentials.'''
*Define:
+
*:the number of columns to view the chosen tabs
+
*:the number of visible lines
+
**checkboxes - marking a checkbox enables counting selected types of invoice.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_25_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_13_11.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|[https://www.modulesgarden.com/products/whmcs/sms-center '''Send SMS (Sold Separately)''']
+
|style="padding: 0px 0px 15px 15px;"|'''18. Select credentials type - in our case, that will be '' 'Google Cloud' '' and type in your custom name for this entry.'''<br/>
*'' 'Send SMS' '' - allows sending text messages to clients, type in the text in a box on pressing the '' '+' '' button.
+
In the '' 'JSON File Content' '' field paste the input of the file that you have just saved, make sure you are pasting the exact content of that file, otherwise, the connection will fail.
*:''Please note that this widget works properly only with SMS Center For WHMCS module purchased, activated and correctly configured!''
+
*:''For more information on SMS Center For WHMCS, visit its [https://www.docs.modulesgarden.com/SMS_Center_For_WHMCS Wiki].''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_25.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_13_12.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|[https://www.modulesgarden.com/products/whmcs/multibrand '''Multibrand (Sold Separately)''']
+
|style="padding: 0px 0px 20px 15px;"|'''19. New Credentials appear on the list, test the connection to make sure everything is working as expected.'''
*'' 'Multibrand' '' - allows direct logging into a brand the client is assigned to.
+
*:''Please note that this widget works properly only with Multibrand For WHMCS module purchased, activated and correctly configured!''
+
*:''For more information on Multibrand For WHMCS, visit its [https://www.docs.modulesgarden.com/Multibrand_For_WHMCS Wiki].''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_14_6.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_13_13.png]]
 
|}
 
|}
  
==Settings==
+
==Microsoft Azure For WHMCS==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'' 'Settings' '' page contains global settings for the module such as:<br/>
+
|style="padding: 10px 0px 15px 15px;"|In order to successfully connect to Microsoft Azure server, you need to configure your Azure account appropriately and then generate your access details.<br/> You will need them in the next steps of the module configuration.
*'''Hide Tooltip''' - if checked, tooltip automatically disappears when the cursor is moved outside of it.<br/>
+
*'''Show After''' - defines delay time for showing the tooltip.<br/>
+
*'''Hide After''' - defines delay time for hiding the tooltip when the cursor is outside.
+
*'''Number Of Columns''' - decide whether the widgets will be displayed in a single column view or will it be divided into two or three-column view.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_16.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''9. In order to continue the configuration process. At first, proceed to the '' 'API Credentials' '' section as presented on the screen.'''<br/>
 +
As you can see, you will need several API detail to connect:
 +
* Subscription ID
 +
* Directory ID
 +
* Client ID
 +
* Client Secret<br/>
 +
Take a look at the instructions below to find out where to generate or find these values.
 
|}
 
|}
 
==Tooltip==
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Tooltip will be displayed across the WHMCS admin area, wherever client's name is displayed.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:MA_1.png]]
On the following screen you can see a client tooltip in '' 'Clients' '' → '' 'View/Search Clients' ''. <br/>
+
As you know, tooltip is made of widgets, let us discuss over each of them.<br/>
+
''Note: Most of the widget titles are links to specific parts of the WHMCS system.''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_17.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''10. Start with logging in to your [https://portal.azure.com/ Microsoft Azure panel]. Find the '' 'Subscriptions' '' section on the home page.'''
 
|}
 
|}
 
===Assigned Admin To Client===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Allows you to assign admin to a specific client. The assigned admin is visible only from the tooltip.
+
|style="padding: 0px 0px 20px 25px;"|[[File:MA_2.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_18.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''11. If you do not have any active subscriptions yet, '' 'Add' '' a new one. Then copy its ID and keep for later use.'''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 0px;"|Once an admin is assigned they can automatically assign new tickets to the client and then stop assigning them.
+
|style="padding: 0px 0px 20px 25px;"|[[File:MA_3.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_18_1.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''12. Go back to the '' 'Home' '' page and find '' 'Azure Active Directory'.''  '''
 
|}
 
|}
 
===Client Custom Status===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Enables you to assign custom status and color to a client.
+
|style="padding: 0px 0px 20px 25px;"|[[File:MA_4.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''13. In the '' 'Overview' '' section, which is opened by default, you will find the '' Tenant ID' '' - again copy it and keep safe.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MA_5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''14. Stay on the same page, and in the side menu find the '' 'App registrations' '' tab. '''<br/>
 +
Open '' 'Owned Applications' '' tab and press application name to see its details.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MA_6.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''15. The application essentials will be now visible. Copy the '' 'Application (Client) ID'.''  ''' <br/>
 +
In the module this value will be used in the '' 'Client ID' '' field.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MA_7.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''16. The last step is generating the Client Secret Value.''' <br/>
 +
Move to the '' 'Certificates & Secrets' '' tab → '' 'Client Secrets'.'' There press '' 'New Client Secret'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MA_9.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''17. In the new pop-up window, provide description and set up the expiration date. If you have not reached the limit yet, a new Client Secret will be added.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MA_10.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Once ready, the '' 'Value' '' will be visible for a very short moment so copy it and keep in a safe place for later use.<br/>
 +
That is all, now you have all the details required to connect your Cloud Billing module with the Microsoft Azure sever.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MA_11.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''18. Move back to your ''WHMCS → Addons → Cloud Billing → API Credentials.'' Fill out the details for '' 'Microsoft Azure'.'' '''<br/>
 +
Remember to test the connection once the API credentials have been saved.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MA_12.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|'''Make sure that you have the same currency added in your WHMCS as the one used on the Microsoft Azure server.''' <br/> If the currency is missing, there will errors occur.
 
|}
 
|}
  
===Log In As Client===
+
=Management=
 +
==Pricing Groups==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|This widget allows you to quickly log in as a client.<br/>
+
|style="padding: 10px 0px 20px 15px;"|In this section, you can easily create new pricing groups. To do so, please click on the button as shown below.
Press '' 'Log In As Client' '' to do so.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_14.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Here, you will be asked to provide a group name and set up the default pricing margin. <br/>
 +
'''Note:''' ''The default pricing margin means the percentage that will be added to the invoice.<br/> If you do not define the margin for a particular product, then the module will use the margin which is given in the  'Others'  field. ''  <br/>
 +
'''Example: If  the Amazon's charge is 10$ and we set up 20% margin, the client will receive an invoice for 12$.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_15.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|If you wish to add more payable services, click on the '' 'Add Billing Service' '' button to add a new one.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_16.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Next, you can choose the services that will be payable.
 +
'''Note:''' '' Please remember that if you do not select any service type from the drop-down list, the pricing margin that you enter will be automatically assigned to the 'Other' service type. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_17.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Pricing groups may be easily edited. If you wish to delete any of your pricing groups, firstly, make sure that the particular pricing group is not used anywhere. Otherwise, you will not be able to delete it.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_18.png]]
 
|}
 
|}
  
===List Of Users===
+
==Products==
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|This widget includes a list of all users, with their email addresses, associated with the client's account.
+
|style="padding: 10px 0px 20px 15px;"|The '' 'Products' '' section grants you a possibility to add a new product and assign a pricing group to it. Moreover, you can select one of four available billing methods which will be allotted to the newly created product.  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_0.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_19.png]]
 
|}
 
|}
===Profile Tabs===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Quick redirection to tabs in client's profile.
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_20.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_1.png]]
+
|style="padding: 0px 0px 20px 15px;"|This image presents what the summary of your products should look like:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_21.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|If you wish to disable a particular product, just click the following button:<br/>
 +
'''Note:''' '' Please remember that a disabled product may be activated again anytime. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_22.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|If you need to introduce some changes to your product, then click on the '' 'Edit' '' button. If some products are no longer necessary, then '' 'Delete' '' them.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_23.png]]
 
|}
 
|}
  
 
+
==Services==
 
+
===Client Notes - Admin Notes, Notes And Custom Notes===
+
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|The screen presents three different widgets in fact, each of them displays notes from a different part of the system.<br/>
+
|style="padding: 10px 0px 20px 15px;"|Under this tab, new services can be added. To do so, click the '' 'Add Service' '' button.
*Client Admin Notes - manages notes from the client's profile → '' 'Summary' '', additionally it allows you to define a maximum number of letters displayed in the tooltip.
+
*Client Notes - manages notes from the client profile → '' 'Notes'.''
+
*Client Custom Notes - enables you to add and edit notes visible in the tooltip only for you, your admin role or all admins.<br/>
+
Additionally, as you can see on the following screen, you can see the number of notes added and a maximum number of notes you can add.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_20.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_24.png]]
 
|}
 
|}
===Credit Card Information===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'' 'Credit Card Information' '' widget displays you all credit cards assigned to a particular client.
+
|style="padding: 0px 0px 10px 15px;"|In the newly opened window, you will be asked to complete the following information:<br />
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_20_1.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''Amazon type services:'''
 +
*'' 'Client' '' - select one of your clients,
 +
*'' 'Service' '' - choose one service which was ordered by your client,
 +
*'' 'Pricing Group' '' - decide which of the previously created pricing groups should be allotted to this service,
 +
*'' 'Credentials' '' - if you created more than one credentials then you can define which one will be assigned to this service,
 +
*'' 'Billing Type' '' - determines the way of searching the resources that your clients will be billed for, there are three options available:
 +
**'' 'Default' '' – all resources containing a tag name provided by you will be billed,<br /> For instance, when you enter ‘WHMCS’ in the '' 'Tag Name' '' field and '2' in the '' 'Tag Value' '' field, the entry with this exactly value of the service will be automatically searched for in a dedicated platform
 +
**'' 'Organization' '' – all resources in a particular company will be billed, type in the organization ID then
 +
**'' 'Custom details' '' – all resources in a particular account will be billed. The module connects to AWS and sums everything that is available there,
 +
*'' 'Organization ID' '' - enter the ID if you have selected '' 'Organization' '' in the '' 'Billing Type' '' selection
 +
*'' 'Tag Name' '' – if you wish your services to be filtered according to the particular tag name.
 +
*'' 'Tag Value' '' – enter the value for the tag provided in the '' 'Tag Name' '' field, then while filtering the services to be billed, services with the provided tag name and precised value will be selected<br/>'''''Important:''' Make sure the used tag has been activated under 'AWS Billing Dashboard' → 'Cost Allocation Tags'.''<br/> '''''Important 2:''' The tag name entered in the Cloud Billing module must be exactly the same as the tag name provided in the EC2 [https://www.docs.modulesgarden.com/Amazon_EC2_For_WHMCS#tag_name_20] or Lightsail [https://www.docs.modulesgarden.com/Amazon_Lightsail_For_WHMCS#tagname_20] products module settings, whether it is a default 'WHMCS' or a custom one.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_25.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''Google Cloud type services:'''
 +
*'' 'Client' '' - select one of your clients,
 +
*'' 'Service' '' - choose one service which was ordered by your client,
 +
*'' 'Pricing Group' '' - decide which of the previously created pricing groups should be allotted to this service,
 +
*'' 'Credentials' '' - if you created more than one credentials then you can define which one will be assigned to this service,
 +
*'' 'Billing Type' '' - determines the way of searching the resources that your clients will be billed for, there are two options available:
 +
**'' 'Label' '' – all resources containing labels provided by you will be billed,<br /> For instance, when you enter ‘WHMCS’ in the '' 'Label' '' field, this entry with the value of the service will be automatically searched for in a dedicated platform
 +
**'' 'Project (Custom details)' '' – all resources in a particular project will be billed. The module connects to Google Cloud and sums everything that is available there,
 +
*'' 'Project Dataset' '' - Choose from available the dataset that will be assigned to this service
 +
*'' 'Project' '' - Enter the project ID name, instance that will be assigned to this service must belong to this project
 +
*'' 'Label' '' – if you wish your services to be filtered according to the particular label <br/>
 +
*'' 'Label Value' '' – enter the value for the label provided in the '' 'Label' '' field, then while filtering the services to be billed, services with the provided label and precised value will be selected <br/> Note that the label value does not have to be a numerical value only, you may use any value that is set in the Google Cloud platform.<br/> '''''Important:''' The label entered in the Cloud Billing module must be exactly the same as the label manually created in the virtual machine details on the Google Cloud Platform.<br/> Remember to add an appropriate ID number to the label in the Google Cloud Platform when creating it. You will find it in the last position of the service details URL, e.g.: '<nowiki>http://your_whmcs/test/admin/....id=7</nowiki>' ''<br/> For example:<br/> ''Label: WHMCS'' (module)<br/> ''Label Value: 7'' (module) <br/> ''Label: WHMCS 7'' (Google Cloud platform)
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_25_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''Microsoft Azure services:'''
 +
*'' 'Client' '' - select one of your clients,
 +
*'' 'Service' '' - choose one service which was ordered by your client,
 +
*'' 'Pricing Group' '' - decide which of the previously created pricing groups should be allotted to this service,
 +
*'' 'Credentials' '' - if you created more than one credentials then you can define which one will be assigned to this service,
 +
*'' 'Billing Type' '' - determines the way of searching the resources that your clients will be billed for, there are two options available:
 +
**'' 'Default' '' – all resources in a particular account subscription containing a tag name provided by you will be billed,<br /> For instance, when you enter ‘WHMCS’ in the '' 'Tag Name' '' field and '2' in the '' 'Tag Value' '' field, the entry with this exactly value of the service will be automatically searched for in a dedicated platform
 +
**'' 'Custom details' '' – all resources in a particular account subscription will be billed
 +
*'' 'Tag Name' '' – if you wish your services to be filtered according to the particular tag name.
 +
*'' 'Tag Value' '' – enter the value for the tag provided in the '' 'Tag Name' '' field, then while filtering the services to be billed, services with the provided tag name and precised value will be selected
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_25_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Here you can check what the newly added service looks like:<br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_26.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"| If you wish to check more details, press the following button. <br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_27.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"| Now, you will be redirected to a new subpage. <br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_28.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"| Please remember that there is a difference between '' 'Cost' '' and '' 'Charge Amount' '' in the '' 'Current Usage' ''section.  <br />
 +
*'' 'Cost' '' refers to the amount that is billed by Amazon.
 +
* '' 'Charge Amount' ''  is the amount that your client will be billed.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|If any values for usage have been counted, there will be a possibility to create invoices. To generate an invoice, simply press the icon as shown in the picture: <br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_29.png]]
 
|}
 
|}
  
===Income===
+
==Settings==
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|'' 'Income' '' widget displays the summary value of paid invoices as well as those still waiting for payment.
+
|style="padding: 10px 0px 20px 15px;"|In order to collect the data properly, the following cron tasks may be needed.
 +
''' Note:''' '' Please remember that the following picture is only a suggestion how to set up cron and of course it can be modified by you.<br /> Keep in mind that each cron should be used once a day because Amazon charges for every API request. '' <br />
 +
'''Note:'''  It is possible to collect your '' 'Billing Data' '' from the preferred period of time. To do so, add date range  '''--from --to''' at the end of your cron command as shown in the following example:<br />
 +
<pre>  php -q /your_whmcs/modules/addons/CloudBilling/cron/cron.php billing --from 2020-01-05 --to 2020-01-10</pre>
 +
Once you enter this command, you will receive the '' 'Billing Data' ''  from 05.01.2020 to 10.01.2020. <br />
 +
'''To obtain precise information, we highly recommend performing the '' 'Billing Data Collecting' '' cron at 22:00 UTC time and the '' 'Invoicing' '' cron at 23:00 UTC time. ''' <br/> <br/>
 +
You may also define the '' 'Cron Setup' '' by providing one of the following values: 1, 2, 3, 4, 6, 8 that can be selected from the dropdown menu. <br/> These are the factors of 24. As an example, if you choose '4' then the cron task will be run 4 times within 24 hours (about every 6 hours).
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_21.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_30.png]]
 
|}
 
|}
  
 +
==Dashboard==
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|It is possible to count the number of your API requests as well as their cost. This option is located at the bottom of the ‘Dashboard’ section.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_31.png]]
 +
|}
  
===Services===
+
==Invoices==
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"| All generated invoices are gathered in the '' 'Invoices' '' tab.  <br /> Here you can check the most essential information of a particular invoice such as '' 'ID' '', '' 'Client' '', '' 'Status' '', '' 'Amount' '' and the creation date. The search box allows you to filter invoices of a particular client.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_32.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|In order to check the details of a specific invoice, please click the info button as presented below: <br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_33.png]]
 +
|}
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Here you can find client's products, product addons and domains counted by their status.<br/>
+
|style="padding: 0px 0px 20px 15px;"|Next, you will be redirected to the details of the selected invoice.  
Additionally, you can view all the items in the tooltip along with various links as shown on the screen below.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_23.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_34.png]]
 
|}
 
|}
  
===Tickets===
+
==Logs==
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|'' 'Tickets' '' widget counts your client's tickets by status and provides a direct link to them.
+
|style="padding: 10px 0px 20px 15px;"|The '' 'Logs' 'Logs' '' section stores the history of all actions performed in the module. <br /> If you wish to filter the history by one of these options: '' 'ID' '', '' 'Service ID' '', '' 'Message' '', '' 'Type' '', '' 'Date' '', simply click on the preferred one.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_24.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_35.png]]
 
|}
 
|}
===Invoices===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|'' 'Invoices' '' widget displays the client's invoices selected by status and provides a direct link to them.
+
|style="padding: 0px 0px 20px 15px;"|There is a possibility to delete the selected item from the '' 'Logs' '' section by pressing the following icon.<br />
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_26_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_36.png]]
 
|}
 
|}
===Quick Actions===
+
===Billing Services Logs===
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Move directly form clients profile tooltip to a chosen action section.
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' → 'Billing Services Logs' '' you can find information on services that have been billed in other way, that is the cost of a single service has been moved to another service (a service with a different name) in the module.<br/>  When you open the log details ('+' button), you get the option to manually add this billing service to a pricing group.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_43.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Define the pricing margin and confirm to add this service to a pricing group.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_44.png]]
 
|}
 
|}
  
===Quotes===
+
==Documentation==
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|'' 'Quotes' '' widget shows the client's quotes divided into groups by status and includes a direct link to them.
+
|style="padding: 10px 0px 20px 15px;"|Once you click on the '' 'Documentation' '' section, you will be redirected to the website you are currently reading.  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_24_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_37.png]]
 
|}
 
|}
  
===Recent Emails===
+
==Admin Area==
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|In '' 'Recent Email' '' widget you will find a list of the last 7 email messages delivered the client. The list includes the date and the title of the message.
+
|style="padding: 10px 0px 20px 15px;"|Cloud Billing For WHMCS allows you to monitor and manage your customer services from the admin area of your WHMCS system.  
 +
This includes supervision of such features as:
 +
 
 +
*Module commands to allow easy and quick management of the service,
 +
*Service details
 +
*Current Usage
 +
*Charges per Service
 +
*Resources Costs
 +
*Service Invoices
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_28_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_37_1.png]]
 
|}
 
|}
===Send Email===
+
 
 +
==Client Area==
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|'' 'Send Email' '' widget grants you the possibility to send emails effortlessly.
+
|style="padding: 10px 0px 20px 15px;"|In the client area, proceed to  '' 'My Products&Services' '' → '' 'Product Details' ''. <br /> Here, you can check the '' 'Current Usage' '' as well as '' 'Charges per Service' '' which can be modified according to your preferences.  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_28.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_38.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Once clicked on the edit icon, a new pop-up will show up.<br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_39.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Here, you can select a type of your service and choose a time frame for a graph from these available ones: '' 'Current Month' '', '' 'Last Month' '', '' 'Last Quarter' '', '' 'This Year' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_40.png]]
 
|}
 
|}
  
===Send SMS===
+
<!-- == Cloud Billing ==
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|'' 'Send SMS' '' widget allows quick sending text messages. This functionality is available only if SMS Center For WHMCS is activated!
+
|style="padding: 10px 0px 20px 15px;"|Under this section you can easily analyze the '' 'Current Usage' '', '' 'Charges per Services' '', '' 'Services List' ''.<br />
 +
Please remember that from this place in the module, you can also modify the '' 'Charges per Services' '' section as it was described previously. To do so, simply click on the edit icon and define the data to be displayed.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_26.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_41.png]]
 
|}
 
|}
===Multibrand===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Client Profile Viewer is integrated with [https://www.modulesgarden.com/products/whmcs/multibrand Multibrand for WHMCS] module. <br/>'' 'Multibrand' '' widget appears only if the module is active and the widget appropriately configured in the addon.<br/>
+
|style="padding: 0px 0px 20px 15px;"|In the '' 'Services List' ''part you are able to find the selected services and check their details by pressing the appropriate icon:
As you can see on the screen below, you may log in to the client's brands directly from the tooltip.<br/> Please note that the '' 'Log In As Client' '' button is not visible when this feature is on.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_26_0.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_42.png]]
 
|}
 
|}
 +
-->
  
 
=Tips=
 
=Tips=
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|1. If you wish some specific information like income to be visible at the top of the tooltip, simply change its position in the configuration.<br/>
+
|style="padding: 10px 0px 15px 15px;"|'''1. Module method of searching for precise information on the billed items for ''AWS, Google'' and ''Microsoft Azure'' services.'''<br/> <!-- In the '' 'Logs' '' section you can find all information on added services. Look for entries of the '' 'Info' '' type, such as: ''Billing service "Compute Engine - E2 Instance Core running in Finland" does not exist in pricing group Google Cloud (ID: 3). Treated as "Compute Engine".''<br/> In this example ''Compute Engine - E2 Instance Core running in Finland'' billing service has been added to a pricing group, and will be treated as ''Compute Engine'' service in the module.-->
Drag and drop the desired widget box in a required position.  
+
 
 +
''AWS, Google'' and ''Azure'' APIs return services' names in the following manner: '''xxx - yyy - zzz''', for example:
 +
* '' 'Compute Engine - E2 Instance Core running in Finland' '' - Google
 +
* '' 'standard hdd managed disks - s4 lrs - us east' ''  - Azure
 +
* '' 'Amazon Simple Storage Service - Requests-Tier1' '' - AWS
 +
* '' 'virtual machines bs series - b1ls - us east' '' - Azure
 +
* '' 'Compute Engine - E2 Instance Core running free tier discount' '' - Google <br/>
 +
 
 +
In the first step, the whole name is searched in the pricing group, if it is not localized, the searching begins before the last '-' sign, and again is searched in the pricing group. In case it s still not found, the service is considered as '' 'Others'.''<br/>
 +
 
 +
'''Exemplary searching flow of a Microsoft Azure service:'''  <br/>
 +
'''1.''' First step - '' 'virtual machines bs series - b1ls - us east' '' is looked for in the pricing group<br/>
 +
'''2.''' If it is not found, '' 'virtual machines bs series - b1ls' '' is looked for in the pricing group<br/>
 +
'''3.''' If not found again, '' 'virtual machines bs series' '' is looked for in the pricing group. This service will surely be found as in case of Azure, it is automatically added to a pricing group when it is created.<br/> Again, in case of Azure, there are no items marked as '' 'Others'.''<br/>
 +
 
 +
'''Exemplary searching flow of an AWS service:'''  <br/>
 +
'''1.''' First step - '' 'EC2 - Other - USW2-DataTransfer-Regional-Bytes' '' service is looked for in the pricing group<br/>
 +
'''2.''' If it is not found, '' 'EC2 - Other' '' is looked for in the pricing group<br/>
 +
'''3.''' If not found again, '' 'EC2' '' is looked for in the pricing group.<br/>
 +
If it is still not found, then it is treated as service from '' 'Others' '' group.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|In '' 'Logs' '' there is a dedicated section for '' 'Billing Services Logs'.'' <br/>You can find there information on services that have been billed in other way, that is the cost of a single service have been moved to another service (a service with a different name) in the module. <br/>You can find there entries like these:
 +
1. Billing service "Compute Engine - E2 Instance Core running in Finland" does not exist in pricing group Google Cloud (ID: 3). Treated as "Compute Engine".
 +
2. Billing service "standard hdd managed disks - s4 lrs - us east" does not exist in pricing group :pricing_group:. Treated as "Others".
 +
When you open the log details ('+' button), you get the option to manually add this billing service to a pricing group with the defined pricing margin.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_43_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_44.png]]
 
|}
 
|}
  
 
=Update Instructions=
 
=Update Instructions=
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
+
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
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!<br/>
+
Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.
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/>
+
 
|}
 
|}
 +
 
=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 10:07, 19 April 2024

Contents

About Cloud Billing For WHMCS

Cloud Billing For WHMCS is a sophisticated module that consists of:
✔ AWS Billing For WHMCS
✔ Google Cloud Billing For WHMCS
✔ Microsoft Azure Billing For WHMCS
✔ Microsoft CSP Billing For WHMCS (coming soon)
Cloud Billing For WHMCS offers you a powerful billing model management of Google Cloud, Amazon Web Services and Microsoft Azure to broaden your target audience.
The module allows you to gather all the services in one place, connect to the external platforms in two different ways - with the use of your account or your customer account.
Except for setting percentage billing margin for WHMCS products per service, you are given the possibility to generate detailed reports on billing management, earnings, resource usage per service, and much more.
  • Core Features:
✔ Efficiently Bill Customers For Management Of:
✔ Amazon Web Services (AWS)
✔ Google Cloud Services
✔ Microsoft Azure Services
✔ Earn Profits From Percentage Margins Defined Per Service
✔ Keep Customers Updated On Current And Upcoming Costs
✔ Monitor Expenses, Earnings, And Resource Usage On Graphs
  • Admin Area Features:
✔ View Dashboard Summaries:
✔ Invoices And Earnings Per Last Week/Month/Quarter/Year
✔ Expenses And Earnings
✔ Earnings Per Service
✔ Most Profitable Clients
✔ Latest Invoices
✔ Paid API Requests Usage
✔ Create Pricing Groups With Multiple Pricing Margins Per Services
✔ Assign WHMCS Products To Selected Pricing Groups
✔ Select Billing Method For Product:
✔ On WHMCS Invoice Generation
✔ On First Day Of Month
✔ On Last Day Of Month
✔ Manually
✔ Create And Manage Service Relations Between:
✔ Client And Their WHMCS Products
✔ Pricing Groups
✔ Used API Credentials
✔ Billing Type:
✔ Amazon Web Services:
✔ Default - Bill Resource Usage Across All Services With Particular Tag Name And Tag Value
✔ Organization - Bill Resource Usage Across All Services In Particular Company
✔ Custom Details - Bill Resource Usage Across All Services Accessible Via Credentials
✔ Google Cloud:
✔ Label - Bill Resource Usage Across All Services With Particular Label
✔ Custom Details - Bill Resource Usage Across All Services Accessible Via Credentials
✔ Microsoft Azure:
✔ Default - Bill Resource Usage Across All Services With Particular Tag Name And Tag Value
✔ Custom Details - Bill Resource Usage Across All Services Accessible Via Credentials
✔ View Service Details:
✔ Total Paid And Charged Amount Per Client
✔ Current Usage With Cost And Charged Amount Per Service
✔ Charges Per Service Graph
✔ Generated Invoices Per Service
✔ View Created Invoices Per Client
✔ Provide Multiple API Credentials
✔ Run API Connection Test
✔ View Service Details, Usage And Charges From Client's Products/Services Tab
✔ Access Your License Information With Selected Plan Based On Current Income
✔ Set Billing Data Collecting Cron Frequency Per Day
✔ Toggle Debug Mode For API Request Logging
✔ View Billing Service Logs Of Auto-Assignment To Pricing Groups:
✔ Manually Change Service Assignment
✔ View Module Logs
  • Client Area Features:
✔ View Current Resource Usage Per Service
✔ View Charges Per Service Graph:
✔ Select Service Types
✔ Define Graph Scope
  • General Info:
✔ Supports All Offered AWS, Google Cloud, And Microsoft Azure Services
✔ Supports Multiple AWS, Google Cloud, And Microsoft Azure Accounts
✔ Multi-Language Support
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
✔ Supports WHMCS V8.9 Back To WHMCS V8.6
  • Requirements:
✔ Amazon Web Services Account
✔ Google Cloud Account
✔ Microsoft Azure Account
✔ ionCube Loader V12 Or Later

Installation and Configuration

This tutorial will show you how to successfully install and configure Cloud Billing For WHMCS smoothly.

We will guide you step by step through the whole process.

Installation

1. Log in to our client area and download the module.
AWS 1.png
2. Upload and extract the extension into the main WHMCS directory.

Extracted files in your WHMCS directory should look like this:

AWS 2.png
3. When you install Cloud Billing For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

The file is located in 'modules/addons/CloudBilling/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

AWS 3.png
4. 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'.

AWS 4.png
5. In the next step, set up the 'storage' folder as recursively writable.

This folder is available at 'your_whmcs/modules/addons/CloudBilling/' .

AWS 5.png

Activating Addon Module

6. Now, you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'System Settings' 'Addon Modules'. Afterward, find 'Cloud Billing' and press the 'Activate' button.

AWS 6.png
7. In the next step, you need to grant access to this module.

To do so, click on the 'Configure' button, go to the 'Access Control' area and check the required admin role groups. Press 'Save Changes'.

AWS 7.png
8. Good job! You have just successfully installed Cloud Billing For WHMCS! Now in your WHMCS press 'Addons' and then 'Cloud Billing'.
AWS 8.png

AWS Billing For WHMCS

9. In order to continue the configuration process. At first, proceed to the 'API Credentials' section as presented on the screen.
AWS 9.png
To complete the previous step and connect to the platform properly, you need to generate your AWS access details.

Underneath, you will find detailed instructions on where to find this information.

10. Log in to your Amazon AWS Management Console and find 'My Security Credentials' section under your account name dropdown.
ALS 6.png
11. There, move to the 'Access Keys (access key ID and secret access key)' section.
ALS 7.png
12. If you do not have any active keys yet, then press the 'Create New Access Key' button to generate a new set of details.
ALS 8.png
13. A modal with Access Key ID and Secret Access Key will appear, so copy this information and keep it safe. You may also download a suitable file with these details.

Note: This is the only place where you can find the corresponding secret key later. It will not be visible next to the Key ID in the panel.

ALS 9.png
14. Now, come back the 'API Credentials' section and press the 'Add Credentials' button. In the new pop-up window, provide a name, API Key, API Secret.
AWS 10.png
In the new pop-up window, provide a name, API Key, API Secret. Press 'Add' when ready.
AWS 12.png
15. To check if the entered data is correct, click on the 'Test Connection' button.
AWS 13.png

Google Cloud Billing For WHMCS

Before you can go on, you must configure your google service account appropriately and then generate your Google Cloud access details. You will need them to create connection between the module and the Google Cloud server.

Billing Export

Underneath, you will find instructions on how to export billing data and create datasets. This step is obligatory and without proper configuration here the module will not work correctly.

9. At first, proceed to 'Billing' → 'Billing Export' section of your project. There under 'Daily Cost Detail' press 'Edit Settings'.

AWS 13 1.png
10. Now create a BigQuery dataset.

This step is crucial for the whole module managemnt. Billing datasets are generated now, they will be assigned to services in the module to allow their billing.

AWS 13 2.png
Press 'Create Dataset'.
AWS 13 3.png
Enter the dataset ID and select localisation (the same for the project and the dataset).
AWS 13 3 1.png
A new table with billing data should appear in the Explorer in a while.
AWS 13 3 2.png

API Credentials

11. Next, you will have to create your personal login credentials.

You will need them to successfully connect the Cloud Billing module with the platform.
Move to 'APIs & Service' → 'Credentials'. There press '+ Create Credentials' → 'Service Account'.

AWS 13 4.png
12. Provide the service account details and press 'Create'. You will be automatically moved to the next step.
AWS 13 5.png
13. Grant the service account access to the project, add these roles:
  • BigQuery Job User
  • BigQuery Resource Viewer
  • BigQuery Data Editor

If you need you may grant users access to the service account, however, this step is not required. Press 'Done' when everything is ready.

AWS 13 6.png
14. Next, open the service account details by pressing the icon. You will have to add a new JSON key to the just generated credentials.
AWS 13 7.png
15. When you have the service account details open, find 'Add Key' at the page bottom. Select 'Create new key'.
AWS 13 8.png
16. Select the key type - 'JSON' and create it. A JSON format file will be immediately saved on your disk.

Keep it save as there is no way to download it again. You will need it in a moment.

AWS 13 9.png
Underneath you may see how an exemplary content of a JSON file may look like.
AWS 13 10.png
17. Move to your 'WHMCS' → 'Addons' → 'Cloud Billing'. There open the 'API Credentials' section and add new credentials.
AWS 13 11.png
18. Select credentials type - in our case, that will be 'Google Cloud' and type in your custom name for this entry.

In the 'JSON File Content' field paste the input of the file that you have just saved, make sure you are pasting the exact content of that file, otherwise, the connection will fail.

AWS 13 12.png
19. New Credentials appear on the list, test the connection to make sure everything is working as expected.
AWS 13 13.png

Microsoft Azure For WHMCS

In order to successfully connect to Microsoft Azure server, you need to configure your Azure account appropriately and then generate your access details.
You will need them in the next steps of the module configuration.
9. In order to continue the configuration process. At first, proceed to the 'API Credentials' section as presented on the screen.

As you can see, you will need several API detail to connect:

  • Subscription ID
  • Directory ID
  • Client ID
  • Client Secret

Take a look at the instructions below to find out where to generate or find these values.

MA 1.png
10. Start with logging in to your Microsoft Azure panel. Find the 'Subscriptions' section on the home page.
MA 2.png
11. If you do not have any active subscriptions yet, 'Add' a new one. Then copy its ID and keep for later use.
MA 3.png
12. Go back to the 'Home' page and find 'Azure Active Directory'.
MA 4.png
13. In the 'Overview' section, which is opened by default, you will find the Tenant ID' - again copy it and keep safe.
MA 5.png
14. Stay on the same page, and in the side menu find the 'App registrations' tab.

Open 'Owned Applications' tab and press application name to see its details.

MA 6.png
15. The application essentials will be now visible. Copy the 'Application (Client) ID'.

In the module this value will be used in the 'Client ID' field.

MA 7.png
16. The last step is generating the Client Secret Value.

Move to the 'Certificates & Secrets' tab → 'Client Secrets'. There press 'New Client Secret'.

MA 9.png
17. In the new pop-up window, provide description and set up the expiration date. If you have not reached the limit yet, a new Client Secret will be added.
MA 10.png
Once ready, the 'Value' will be visible for a very short moment so copy it and keep in a safe place for later use.

That is all, now you have all the details required to connect your Cloud Billing module with the Microsoft Azure sever.

MA 11.png
18. Move back to your WHMCS → Addons → Cloud Billing → API Credentials. Fill out the details for 'Microsoft Azure'.

Remember to test the connection once the API credentials have been saved.

MA 12.png
Make sure that you have the same currency added in your WHMCS as the one used on the Microsoft Azure server.
If the currency is missing, there will errors occur.

Management

Pricing Groups

In this section, you can easily create new pricing groups. To do so, please click on the button as shown below.
AWS 14.png
Here, you will be asked to provide a group name and set up the default pricing margin.

Note: The default pricing margin means the percentage that will be added to the invoice.
If you do not define the margin for a particular product, then the module will use the margin which is given in the 'Others' field.

Example: If the Amazon's charge is 10$ and we set up 20% margin, the client will receive an invoice for 12$.

AWS 15.png
If you wish to add more payable services, click on the 'Add Billing Service' button to add a new one.
AWS 16.png
Next, you can choose the services that will be payable.

Note: Please remember that if you do not select any service type from the drop-down list, the pricing margin that you enter will be automatically assigned to the 'Other' service type.

AWS 17.png
Pricing groups may be easily edited. If you wish to delete any of your pricing groups, firstly, make sure that the particular pricing group is not used anywhere. Otherwise, you will not be able to delete it.
AWS 18.png

Products

The 'Products' section grants you a possibility to add a new product and assign a pricing group to it. Moreover, you can select one of four available billing methods which will be allotted to the newly created product.
AWS 19.png
AWS 20.png
This image presents what the summary of your products should look like:
AWS 21.png
If you wish to disable a particular product, just click the following button:

Note: Please remember that a disabled product may be activated again anytime.

AWS 22.png
If you need to introduce some changes to your product, then click on the 'Edit' button. If some products are no longer necessary, then 'Delete' them.
AWS 23.png

Services

Under this tab, new services can be added. To do so, click the 'Add Service' button.
AWS 24.png
In the newly opened window, you will be asked to complete the following information:
Amazon type services:
  • 'Client' - select one of your clients,
  • 'Service' - choose one service which was ordered by your client,
  • 'Pricing Group' - decide which of the previously created pricing groups should be allotted to this service,
  • 'Credentials' - if you created more than one credentials then you can define which one will be assigned to this service,
  • 'Billing Type' - determines the way of searching the resources that your clients will be billed for, there are three options available:
    • 'Default' – all resources containing a tag name provided by you will be billed,
      For instance, when you enter ‘WHMCS’ in the 'Tag Name' field and '2' in the 'Tag Value' field, the entry with this exactly value of the service will be automatically searched for in a dedicated platform
    • 'Organization' – all resources in a particular company will be billed, type in the organization ID then
    • 'Custom details' – all resources in a particular account will be billed. The module connects to AWS and sums everything that is available there,
  • 'Organization ID' - enter the ID if you have selected 'Organization' in the 'Billing Type' selection
  • 'Tag Name' – if you wish your services to be filtered according to the particular tag name.
  • 'Tag Value' – enter the value for the tag provided in the 'Tag Name' field, then while filtering the services to be billed, services with the provided tag name and precised value will be selected
    Important: Make sure the used tag has been activated under 'AWS Billing Dashboard' → 'Cost Allocation Tags'.
    Important 2: The tag name entered in the Cloud Billing module must be exactly the same as the tag name provided in the EC2 [1] or Lightsail [2] products module settings, whether it is a default 'WHMCS' or a custom one.
AWS 25.png
Google Cloud type services:
  • 'Client' - select one of your clients,
  • 'Service' - choose one service which was ordered by your client,
  • 'Pricing Group' - decide which of the previously created pricing groups should be allotted to this service,
  • 'Credentials' - if you created more than one credentials then you can define which one will be assigned to this service,
  • 'Billing Type' - determines the way of searching the resources that your clients will be billed for, there are two options available:
    • 'Label' – all resources containing labels provided by you will be billed,
      For instance, when you enter ‘WHMCS’ in the 'Label' field, this entry with the value of the service will be automatically searched for in a dedicated platform
    • 'Project (Custom details)' – all resources in a particular project will be billed. The module connects to Google Cloud and sums everything that is available there,
  • 'Project Dataset' - Choose from available the dataset that will be assigned to this service
  • 'Project' - Enter the project ID name, instance that will be assigned to this service must belong to this project
  • 'Label' – if you wish your services to be filtered according to the particular label
  • 'Label Value' – enter the value for the label provided in the 'Label' field, then while filtering the services to be billed, services with the provided label and precised value will be selected
    Note that the label value does not have to be a numerical value only, you may use any value that is set in the Google Cloud platform.
    Important: The label entered in the Cloud Billing module must be exactly the same as the label manually created in the virtual machine details on the Google Cloud Platform.
    Remember to add an appropriate ID number to the label in the Google Cloud Platform when creating it. You will find it in the last position of the service details URL, e.g.: 'http://your_whmcs/test/admin/....id=7'

    For example:
    Label: WHMCS (module)
    Label Value: 7 (module)
    Label: WHMCS 7 (Google Cloud platform)
AWS 25 1.png
Microsoft Azure services:
  • 'Client' - select one of your clients,
  • 'Service' - choose one service which was ordered by your client,
  • 'Pricing Group' - decide which of the previously created pricing groups should be allotted to this service,
  • 'Credentials' - if you created more than one credentials then you can define which one will be assigned to this service,
  • 'Billing Type' - determines the way of searching the resources that your clients will be billed for, there are two options available:
    • 'Default' – all resources in a particular account subscription containing a tag name provided by you will be billed,
      For instance, when you enter ‘WHMCS’ in the 'Tag Name' field and '2' in the 'Tag Value' field, the entry with this exactly value of the service will be automatically searched for in a dedicated platform
    • 'Custom details' – all resources in a particular account subscription will be billed
  • 'Tag Name' – if you wish your services to be filtered according to the particular tag name.
  • 'Tag Value' – enter the value for the tag provided in the 'Tag Name' field, then while filtering the services to be billed, services with the provided tag name and precised value will be selected
AWS 25 2.png
Here you can check what the newly added service looks like:
AWS 26.png
If you wish to check more details, press the following button.
AWS 27.png
Now, you will be redirected to a new subpage.
AWS 28.png
Please remember that there is a difference between 'Cost' and 'Charge Amount' in the 'Current Usage' section.
  • 'Cost' refers to the amount that is billed by Amazon.
  • 'Charge Amount' is the amount that your client will be billed.
If any values for usage have been counted, there will be a possibility to create invoices. To generate an invoice, simply press the icon as shown in the picture:
AWS 29.png

Settings

In order to collect the data properly, the following cron tasks may be needed.

Note: Please remember that the following picture is only a suggestion how to set up cron and of course it can be modified by you.
Keep in mind that each cron should be used once a day because Amazon charges for every API request.

Note: It is possible to collect your 'Billing Data' from the preferred period of time. To do so, add date range --from --to at the end of your cron command as shown in the following example:

  php -q /your_whmcs/modules/addons/CloudBilling/cron/cron.php billing --from 2020-01-05 --to 2020-01-10

Once you enter this command, you will receive the 'Billing Data' from 05.01.2020 to 10.01.2020.
To obtain precise information, we highly recommend performing the 'Billing Data Collecting' cron at 22:00 UTC time and the 'Invoicing' cron at 23:00 UTC time.

You may also define the 'Cron Setup' by providing one of the following values: 1, 2, 3, 4, 6, 8 that can be selected from the dropdown menu.
These are the factors of 24. As an example, if you choose '4' then the cron task will be run 4 times within 24 hours (about every 6 hours).

AWS 30.png

Dashboard

It is possible to count the number of your API requests as well as their cost. This option is located at the bottom of the ‘Dashboard’ section.
AWS 31.png

Invoices

All generated invoices are gathered in the 'Invoices' tab.
Here you can check the most essential information of a particular invoice such as 'ID' , 'Client' , 'Status' , 'Amount' and the creation date. The search box allows you to filter invoices of a particular client.
AWS 32.png
In order to check the details of a specific invoice, please click the info button as presented below:
AWS 33.png
Next, you will be redirected to the details of the selected invoice.
AWS 34.png

Logs

The 'Logs' → 'Logs' section stores the history of all actions performed in the module.
If you wish to filter the history by one of these options: 'ID' , 'Service ID' , 'Message' , 'Type' , 'Date' , simply click on the preferred one.
AWS 35.png
There is a possibility to delete the selected item from the 'Logs' section by pressing the following icon.
AWS 36.png

Billing Services Logs

Under 'Logs' → 'Billing Services Logs' you can find information on services that have been billed in other way, that is the cost of a single service has been moved to another service (a service with a different name) in the module.
When you open the log details ('+' button), you get the option to manually add this billing service to a pricing group.
AWS 43.png
Define the pricing margin and confirm to add this service to a pricing group.
AWS 44.png

Documentation

Once you click on the 'Documentation' section, you will be redirected to the website you are currently reading.
AWS 37.png

Admin Area

Cloud Billing For WHMCS allows you to monitor and manage your customer services from the admin area of your WHMCS system.

This includes supervision of such features as:

  • Module commands to allow easy and quick management of the service,
  • Service details
  • Current Usage
  • Charges per Service
  • Resources Costs
  • Service Invoices
AWS 37 1.png

Client Area

In the client area, proceed to 'My Products&Services' 'Product Details' .
Here, you can check the 'Current Usage' as well as 'Charges per Service' which can be modified according to your preferences.
AWS 38.png
Once clicked on the edit icon, a new pop-up will show up.
AWS 39.png
Here, you can select a type of your service and choose a time frame for a graph from these available ones: 'Current Month' , 'Last Month' , 'Last Quarter' , 'This Year' .
AWS 40.png


Tips

1. Module method of searching for precise information on the billed items for AWS, Google and Microsoft Azure services.

AWS, Google and Azure APIs return services' names in the following manner: xxx - yyy - zzz, for example:

  • 'Compute Engine - E2 Instance Core running in Finland' - Google
  • 'standard hdd managed disks - s4 lrs - us east' - Azure
  • 'Amazon Simple Storage Service - Requests-Tier1' - AWS
  • 'virtual machines bs series - b1ls - us east' - Azure
  • 'Compute Engine - E2 Instance Core running free tier discount' - Google

In the first step, the whole name is searched in the pricing group, if it is not localized, the searching begins before the last '-' sign, and again is searched in the pricing group. In case it s still not found, the service is considered as 'Others'.

Exemplary searching flow of a Microsoft Azure service:
1. First step - 'virtual machines bs series - b1ls - us east' is looked for in the pricing group
2. If it is not found, 'virtual machines bs series - b1ls' is looked for in the pricing group
3. If not found again, 'virtual machines bs series' is looked for in the pricing group. This service will surely be found as in case of Azure, it is automatically added to a pricing group when it is created.
Again, in case of Azure, there are no items marked as 'Others'.

Exemplary searching flow of an AWS service:
1. First step - 'EC2 - Other - USW2-DataTransfer-Regional-Bytes' service is looked for in the pricing group
2. If it is not found, 'EC2 - Other' is looked for in the pricing group
3. If not found again, 'EC2' is looked for in the pricing group.
If it is still not found, then it is treated as service from 'Others' group.

In 'Logs' there is a dedicated section for 'Billing Services Logs'.
You can find there information on services that have been billed in other way, that is the cost of a single service have been moved to another service (a service with a different name) in the module.
You can find there entries like these:
1. Billing service "Compute Engine - E2 Instance Core running in Finland" does not exist in pricing group Google Cloud (ID: 3). Treated as "Compute Engine".
2. Billing service "standard hdd managed disks - s4 lrs - us east" does not exist in pricing group :pricing_group:. Treated as "Others".

When you open the log details ('+' button), you get the option to manually add this billing service to a pricing group with the defined pricing margin.

AWS 43 1.png
AWS 44.png

Update Instructions

An essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Cloud Billing For WHMCS