|
|
| (612 intermediate revisions by 6 users not shown) |
| Line 1: |
Line 1: |
| − | <meta name="keywords" content="advanced billing for whmcs, advanced billing configuration, advanced billing management, advanced billing installation, advanced billing guide, modulesgarden advanced billing, advanced billing wiki, advanced billing tutorial, advanced billing tips, whmcs billing module wiki, advanced billing common problems, about advanced billing, advanced billing documentation, advanced billing faq, advanced billing help"></meta> | + | <meta name="keywords" content="hosting quota notifications for whmcs, hosting quota notifications configuration, whmcs hosting quota notifications management, whmcs hosting quota notifications installation, whmcs hosting quota notifications common problems, about whmcs hosting quota notifications, whmcs hosting quota notifications documentation, whmcs hosting quota notifications faq, whmcs hosting quota notifications help, whmcs hosting quota notifications guide, whmcs hosting quota notifications wiki, whmcs hosting quota notifications tutorial, whmcs hosting quota notifications tips, whmcs hosting quota notifications wiki"></meta> |
| − | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Advanced Billing For WHMCS Module."></meta> | + | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Hosting Quota Notifications For WHMCS Module."></meta> |
| | | | |
| − | =About [http://www.modulesgarden.com/products/whmcs/advanced_billing/features Advanced Billing For WHMCS]= | + | =About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]= |
| | {| | | {| |
| − | |style="padding: 10px 0px 10px 0px;"|'''Advanced Billing For WHMCS''' allows you to set up additional billing options for your products like bandwidth or CPU usage, basing on actual server resource usage.<br /> | + | |style="padding: 10px 0px 10px 0px;"|'''Hosting Quota Notifications For WHMCS''' allows you to send automatic notifications to your clients whenever they exceed previously set bandwidth or disk usage. |
| − | In other words, the module will let you charge customers on the grounds of the resources used by them. It offers also hourly billing, ticket billing, credit billing and recurring billing.<br />
| + | Notifications can be sent in two ways: upon exceeding given resource tier or after exceeding given resource limit in a specified time period.<br /> |
| − | The module will also automatically generate invoices on the basis of the data gathered by the synchronization. It is integrated with many modules including cPanel and SolusVM.
| + | You can also define email templates and view details of each sent notification owing to logs. |
| | |} | | |} |
| − | <!--Comment--> | + | <!--a comment maybe? --> |
| − | *'''Core Features:''' | + | *'''Admin Area Features:''' |
| | {| | | {| |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Hourly Billing For Any WHMCS Module | + | |style="padding: 10px 0px 0px 30px;"|✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Ticket Billing | + | |style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Configure Billing Per Product | + | |style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting: |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Manage Extensions And Configure Them Per Product | + | |style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ View Current List Of Billable Items For Next Invoices | + | |style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ View Resources Usage History Of Any Item | + | |style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Manage Awaiting Invoices And Convert Them To Invoices | + | |style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Define Time Period Between Resource Usage Checks | + | |style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Define Whether To Store Logs In Files Or In Database
| + | |style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 30px;"|✔ View Logs | + | |
| − | |}
| + | |
| − | *''''Recurring Billing' Extension Features:'''
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Bill On Account Terminate
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Bill When Invoice Is Generated For Hosting
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Bill Each X Day Of Month
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Bill Each X Days
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Automatically Generate An Invoice
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Define Invoice Payment Due Date
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 30px;"|✔ Automatically Apply Credits
| + | |
| − | |}
| + | |
| − | *''''Credit Billing' Extension Features:'''
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Generate Invoice Each X Days
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Define Minimal Amount Of Credit To Charge
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Send Email When Client's Credit Balance Falls Below Defined Credit Amount
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Automatically Suspend Account When Client Is Out Of Credits
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Define Invoice Payment Due Date
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ List Summary Credit Billing Charges Of Any Hosting
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Refund Credit Payment To Client
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Automatically Refill Client's Credit Balance Using Their Credit Card
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 30px;"|✔ Client Can Enable/Disable Auto Refilling And Define A Single Refill Amount
| + | |
| − | |}
| + | |
| − | *''''Resource Usage' Extension Features:'''
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Define Period For Counted Resource Usage
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Define Resource Usage Counting Precision
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Show History Of Resource Usage
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 30px;"|✔ Define Amount Of Usage Records Displayed Per Page
| + | |
| − | |}
| + | |
| − | *'''Supported Modules:'''
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 0px 30px;"|✔ [http://www.modulesgarden.com/products/whmcs/product_auto_upgrade/features Product Auto Upgrade] - Standalone Extension: - '''(Supported By Advanced Billing Up To 2.5.8)''' Automatically Adjust And Upgrade/Downgrade The Products Of Your Clients According To The Server Resource Usage
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ cPanel & [http://www.modulesgarden.com/products/whmcs/cpanel_extended/features cPanel Extended] Integration: Hourly, Bandwidth, Storage, Databases, Addon Domains, Subdomains, Parked Domains, Domain Forwarders, FTP Accounts, Installed Applications, Email Accounts
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ DirectAdmin & [http://www.modulesgarden.com/products/whmcs/directadmin_extended/features DirectAdmin Extended] Integration: Hourly, Bandwidth, Storage, Subdomains, Domain Pointers, FTP Accounts, MySQL Databases, Virtual Domains, Mailing Lists, POP Accounts, Email Forwarders, Email Autoresponders
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ [http://www.modulesgarden.com/products/whmcs/openstack_vps/features OpenStack VPS] Integration: Hourly, VCPU Cores, Memory Usage, CPU Utilization, Incoming Bandwidth, Outgoing Bandwidth, Disk Root Used, Disk I/O Read, Disk I/O Write, Floating IP, Fixed IP, Backups Number
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Plesk & [http://www.modulesgarden.com/products/whmcs/parallels_plesk_panel_extended/features Plesk Extended] Integration: Hourly, Subdomains, Disk Space, Email Boxes, Sites, Redirects, Mail Groups, Autoresponders, Mailing Lists, Users, Databases, Webapps, Traffic
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ [http://www.modulesgarden.com/products/whmcs/proxmox_cloud/features Proxmox Cloud] Integration: Disk Usage, Disk Size, Bandwidth IN, Bandwidth OUT, Memory Usage, Memory Size, Backups, CPU Number, CPU Usage
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ [http://www.modulesgarden.com/products/whmcs/proxmox_vps/features Proxmox VPS] Integration: Hourly, Disk Usage, Bandwidth IN, Bandwidth OUT, Memory Usage, Backups Usage, CPU Number, CPU Usage
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ [http://www.modulesgarden.com/products/whmcs/rackspace_email_extended/features Rackspace Email Extended] Integration: Hourly, Mailbox Storage, Mailboxes, Sync Licenses, Blackberry Licenses, Exchange Storage, Exchange Mailboxes
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ SolusVM & [http://www.modulesgarden.com/products/whmcs/solusvm_extended_vps/features SolusVM Extended VPS] Integration: Hourly, Disk Usage, Memory Usage (except KVM virtualization), Bandwidth Used
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ [http://www.modulesgarden.com/products/whmcs/solusvm_extended_cloud/features SolusVM Extended Cloud] Integration: Available Disk Size, Disk Usage, Available Bandwidth, Available Memory, Cores, IP Addresses, Disk Usage, Memory Usage (except KVM virtualization), Bandwidth Used
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ [http://www.modulesgarden.com/products/whmcs/parallels_cloud_server/features Virtuozzo] Integration: Templates, CPU Usage, Memory, Bandwidth IN, Bandwidth OUT, Disk Used, Backups Usage
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 30px;"|✔ [http://www.modulesgarden.com/products/whmcs/zimbra_email/features Zimbra Email] Integration: Hourly, Mailboxes, Aliases, Storage
| + | |
| | |} | | |} |
| | *'''General Info:''' | | *'''General Info:''' |
| | {| | | {| |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Store Usage Records In WHMCS Or External MongoDB Database | + | |style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Count Usage Of All Accounts Assigned To Reseller - cPanel, [http://www.modulesgarden.com/products/whmcs/cpanel_extended/features cPanel Extended], DirectAdmin & [http://www.modulesgarden.com/products/whmcs/directadmin_extended/features DirectAdmin Extended]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
| + | |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2 |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6 | + | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7 |
| | |} | | |} |
| | | | |
| | =Installation= | | =Installation= |
| | {| | | {| |
| − | |style="padding: 10px 0px 0px 0px;"|'''In this tutorial we will show you how to successfully install and manage Advanced Billing For WHMCS.'''<br /> | + | |style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.''' <br /> |
| | We will guide you step by step through the whole installation and configuration process. | | We will guide you step by step through the whole installation and configuration process. |
| | |} | | |} |
| | + | ==Installation== |
| | {| | | {| |
| − | |style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Advanced Billing For WHMCS.''' | + | |style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.''' |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB2_1.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br /> | + | |style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/> |
| − | Files in your WHMCS directory should look like these.
| + | '' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.''' |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB2_2.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''3. Now you have to activate the module in your WHMCS system.'''<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br /> |
| − | Log in to your WHMCS admin area. Click '' 'Setup' '' then choose '' 'Addon Modules'. ''<br />
| + | The content of PHP version files should look like this. |
| − | Afterwards find '' 'Advanced Billing' '' and press '' 'Activate' '' button.
| + | |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_5.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''4. In the next step you need to configure your module, to do so, press '' 'Configure' '' button.<br/> | + | |style="padding: 0px 0px 15px 15px;"|'''4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br /> |
| − | Select database driver for usage records:
| + | File is located in '' 'modules/addons/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' . |
| − | *WHMCS Database
| + | |
| − | *External MongoDB Database<br/>
| + | |
| − | In case you choose MongoDB you will also have to provide:
| + | |
| − | *Hostname
| + | |
| − | *Database Name
| + | |
| − | *Username
| + | |
| − | *Password<br/>
| + | |
| − | Choose desired admin roles groups to grant access to the module and '' 'Save Changes'. ''
| + | |
| − | |}'''
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_6.png]]
| + | |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''5. Now, proceed to [[#Extensions|Extensions]] section to find more about configuring license. | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]] |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 15px;"|'''6. The last step is setting up a cron job, you can find it in your WHMCS → '' 'Addons' '' → '' 'Advanced Billing' '' → '' 'Configuration' '' page. '''
| + | |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_7.png]] | + | |style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a 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;"|'''Well done, you have just successfully installed Advanced Billing For WHMCS! '''
| + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]] |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 15px;"|'''If you have used previous version of Advanced Billing For WHMCS and you want to migrate data to the current one,<br/> | + | |
| − | please see section [[#How To Update|How To Update]] section and follow the instruction there.
| + | |
| | |} | | |} |
| | | | |
| − | =Configuration and Management= | + | ==Configuration of Addon== |
| | {| | | {| |
| − | |style="padding: 10px 0px 15px 15px;"|Now let's learn more about module's functionalities. We will present you the possibilities of our product on cPanel Extended For WHMCS example.<br /> | + | |style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br /> |
| − | Please note that billing features are different in each module but the core functionality of Advanced Billing is the same for each.<br />
| + | Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button. |
| − | Firstly, choose your module from '' 'Enable Advanced Billing For' '' dropdown menu as it is shown on the following screen.<br />
| + | |
| − | For presentation purposes we have chosen '' 'cPanel Premium' '' with cPanel Extended module.
| + | |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB_8.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]] |
| | |} | | |} |
| − | ==Core==
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 30px 15px;"|Our module core has been designed in a way to allow collecting the records and invoices' management.<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br /> |
| − | Any extra features are handled by extensions, which can be easily enabled/disabled, and are always configured per product.
| + | To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''. |
| | |} | | |} |
| − | ===Product List===
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 15px 15px;"|On the products list, there are all the products with Advanced Billing enabled.<br/>
| + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]] |
| − | If the product's submodule is not supported, '' 'default' '' mode will be used instead, which enables you to bill your client for hourly usage of the product only.<br />
| + | |
| − | Except listed products with their submodules you will find there options to:
| + | |
| − | *control the status of your product billing, enable/disable Advanced Billing for a product
| + | |
| − | *manage cron frequency
| + | |
| − | *use action buttons:
| + | |
| − | **Pricing
| + | |
| − | **Settings
| + | |
| − | **View Items
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB_9.png]]
| + | |
| − | |}
| + | |
| − | ====Settings====
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 15px 15px;"|Under Settings button there are visible '' Module Settings'' only for cPanel/cPanel Extended modules and other extensions if enabled. We will discuss them later on.<br />
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 25px;"|[[File:AB_10_1.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|Here you can set Application Manager (Softaculous/Installatron) and cPanel theme.<br />
| + | |
| − | Simply enter a theme name as shown on the screen below.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB_10.png]] | + | |
| | |} | | |} |
| | | | |
| − | ====Used Resource Pricing====
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 15px 15px;"|When you move to '' 'Pricing' '' section, you can set up billing for specific server resource usage like bandwidth.<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br /> |
| | + | You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_11.png]] | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]] |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|Manage each usage record by setting up its:
| + | |
| − | *'''Free Limit''' - is used to set the amount of usage records for which a customer will not be charged.<br />
| + | |
| − | In our example, a customer will not be charged for 1GB (1024MB) bandwidth.<br />
| + | |
| − | *'''Price''' - defines how much your client will have to pay for specific resource. Note that we provide two types of charging: units per hour and units used since the last cron run.<br />
| + | |
| − | For example, user pays for subdomain quantity each hour, but when traffic is generated, bandwidth used since the last cron run will have to be paid once only.<br />
| + | |
| − | *'''Display Unit''' - category defines the manner record usage will be displayed in. It does not affect free limit and pricing, they are calculated in basic unit.<br />
| + | |
| − | If you select '' 'GB' '', free limit will be still 1024 MB, and price will be MB/hr, '''not''' GB/hr.<br />
| + | |
| − | *'''Status''' - allows you to enable/disable billing for this resource.<br />
| + | |
| − | To proceed, choose your usage records, units, status, set up the prices and free limits. Afterwards, press '' 'Save'. ''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_11_1.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 15px;"|As you could notice, there is also '' 'Configure' '' column.<br />
| + | |
| − | It allows you to set up different free limits and pricing depending on resource origin.<br />
| + | |
| − | Currently, only '' 'Viruozzo' '' and '' 'Openstack VPS' '' submodules support this feature.
| + | |
| | |} | | |} |
| | | | |
| − | ===Items=== | + | =Configuration and Management= |
| | {| | | {| |
| − | |style="padding: 10px 0px 15px 15px;"|To view counted usage, go to '' 'Items' '' tab.<br /> | + | |style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Hosting Quota Notifications For WHMCS.''' |
| − | Each cron run will create an item for each customer, if it does not exist at the moment, and add new records to existing ones.<br />
| + | |
| − | In that way you can see current server resources usage from the last billing period.<br />
| + | |
| − | Automatic generation of invoices is based precisely on previously created items.<br />
| + | |
| − | To view more details click on '' 'View Details' '' as shown on the following screen.<br />
| + | |
| − | You can also easily remove billing for specific hosting. To do so, press '' 'Delete Records' '' in '' 'Actions' '' column.
| + | |
| | |} | | |} |
| | + | ==Configuration== |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_13.png]] | + | |style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br /> |
| | + | You can enable/disable any of them, as well as alter or completely remove them.<br /> |
| | + | Press '' 'Create New Group' '' to proceed. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 15px;"| In details, you can learn some detailed information on Bandwidth, Storage, Domains and other enabled records.<br/> | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]] |
| − | See the price and usage, last cron run date and total records summary.<br/>
| + | |
| − | Press '' 'Delete' '' button to remove entries.
| + | |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_14.png]] | + | |style="padding: 0px 0px 15px 15px;"|Now, you can define all products related to this configuration and email template which will be used to notify your clients.<br /> |
| | + | You can choose between two types of resource usage counting:<br /> |
| | + | *Fixed - define amount of resources over specific time period. If client usage growth has exceeded the given limit in specified time, a notification will be sent. |
| | + | *Tiered - defines amount of resources. If client exceeds given limit, a notification will be sent. |
| | |} | | |} |
| − |
| |
| − | ===Invoices===
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 15px 15px;"|Under '' 'Invoices' '' section you can manage any of your awaiting invoices. They can be generated automatically and manually.<br /> | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]] |
| − | On the screen below you can see a previously generated invoice for our cPanel Extended account.<br />
| + | |
| − | To view detailed information about particular invoice press '' 'Show Details' '' button.
| + | |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_17.png]] | + | |style="padding: 0px 0px 15px 15px;"|For example, shown below module uses fixed counting type.<br /> |
| | + | As you can see, we have defined limits for both bandwidth and disk.<br /> |
| | + | Settings shown below result in sending notification to client upon: |
| | + | *bandwidth usage growth by 5GB during 21 days. |
| | + | *disk usage growth by 100GB over period of 14 days. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|This is the place where you can verify and modify awaiting invoices. It's advised to check whether invoices are correct to avoid any risk.<br /> | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]] |
| | |} | | |} |
| | + | ==Logs== |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_18.png]] | + | |style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|Let's generate an invoice for your customer manually now.<br /> | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]] |
| − | For this purpose simply click on '' 'Generate' '' next to a chosen invoice.
| + | |
| | |} | | |} |
| | + | ==Notifications== |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_18_1.png]] | + | |style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br /> |
| | + | The only requirement is their type being set to '' 'Product/Service' ''.<br /> |
| | + | Additionally, you can use {if} statement, as shown below: |
| | + | {if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if} |
| | + | {if $disk_over}Your disks usage is over {$disk_over}MB{if $disk_current} (current: {$disk_current}MB){/if}.{/if} |
| | + | It will allow you to use this email template for bandwidth and disk notifications at the same time. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 30px 15px;"|After changing product's package, invoice is automatically generated for an old package. | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]] |
| | |} | | |} |
| | | | |
| − | ===Settings=== | + | =Tips= |
| | {| | | {| |
| − | |style="padding: 10px 0px 30px 15px;"|Under '' 'Settings' '' tab you can find pages such as '' 'Logs', 'Integration' '' and '' 'Extensions'. '' | + | |style="padding: 10px 0px 30px 15px;"| |
| | |} | | |} |
| | | | |
| − | ====Integration Code==== | + | =Update Instructions= |
| | {| | | {| |
| − | |style="padding: 10px 0px 15px 15px;"|'' 'Integration' '' page contains codes required to integrate Advanced Billing For WHMCS with your client area.<br /> | + | |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/> |
| − | The first of them allows displaying product pricing during placing an order.
| + | 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/> |
| | + | 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/> |
| | |} | | |} |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_21.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|If the code has been inserted correctly, this is how an exemplary order form will look like:
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_21_1.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|The second code is responsible for showing usage records in the client area. <br />
| |
| − | ''Note: To display usage records in the client area, you need to enable '' 'Usage Records' '' extension for the product.''<br/>
| |
| − | Remember that there are separate codes for WHMCS V5 and V6. Insert codes accordingly to your system version.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_22.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|If the code has been inserted correctly, this is how exemplary resource usage should be displayed:
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB_23.png]]
| |
| − | |}
| |
| − | ====Items Archive====
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|On this page you can find information regarding archived usage records.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_42.png]]
| |
| − | |}
| |
| − |
| |
| − | ====Logs====
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|In '' 'Logs' '' you will find information about the module activity.<br/>
| |
| − | You can view logs in a form of '' 'Database' '' or '' 'File', '' simply choose one as marked on the screen below.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_19_1.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|View informative logs, error logs and critical logs.<br />
| |
| − | New log files are created every day to help you find information you are looking for.<br/>
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB_19.png]]
| |
| − | |}
| |
| − |
| |
| − | ==Extensions==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|In this section we will describe each extension step by step.<br />
| |
| − | '''Important:''' Only three of them are included in Advanced Billing For WHMCS product, you can turn them on under '' 'Settings' → 'Extensions' '' section.<br/>
| |
| − | The rest of the extensions can be obtained separately.<br />
| |
| − | Default extensions included in Advanced Billing For WHMCS are '' 'Recurring Billing', 'Usage Records' '' and '' 'Credit Billing'. ''<br />
| |
| − | Each extension is configured per product, therefore you can use different sets of extensions according to your needs.<br />
| |
| − | To start using an extension, you need to activate it firstly, proceed to '' 'Settings' '' → '' 'Extensions' '' page.<br />
| |
| − | Afterwards, '' 'enable' '' the extension you wish to use, new options will appear in Advanced Billing For WHMCS.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_24.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|If you skip steps 3-4 of the installation instruction, you have to configure the license for each of the 3 base extensions.<br />
| |
| − | Note that each of them uses Advanced Billing license key.<br />
| |
| − | Press '' 'Configure', '' paste your license and confirm changes.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB_25.png]]
| |
| − | |}
| |
| − |
| |
| − | ===[http://www.modulesgarden.com/products/whmcs/product_auto_upgrade/features Product Auto Upgrade (Sold Separately)]===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|''Product Auto Upgrade For WHMCS extension is currently '''NOT''' supported by Advanced Billing For WHMCS 3.0.0!''
| |
| − | The main functionality of Product Auto Upgrade For WHMCS extension is automatic upgrade/downgrade of a product according to its usage.<br />
| |
| − | For more information about Product Auto Upgrade For WHMCS, visit its [http://www.docs.modulesgarden.com/Product_Auto_Upgrade_For_WHMCS Wiki].
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB2_51.png]]
| |
| − | |}
| |
| − | ===[http://www.modulesgarden.com/products/whmcs/proxmox_cloud_autoscaling/features Proxmox Cloud Autoscaling (Sold Separately)]===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|'''Proxmox Cloud Autoscaling For WHMCS''' enables automatic alterations of servers provisioned by Proxmox Cloud For WHMCS depending on their load.<br/>
| |
| − | The module will allow you to set out rules on VPS resources according to which servers will be modified through resizing or cloning.<br/>In addition, you will be able to grant your clients permission to change rules or toggle module functionality.
| |
| − | <br/><br/>
| |
| − | For more information about Proxmox Cloud Autoscaling For WHMCS, visit its [http://www.docs.modulesgarden.com/Proxmox_Cloud_Autoscaling_For_WHMCS Wiki].
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB_PCA.png]]
| |
| − | |}
| |
| − |
| |
| − | ===Credit Billing===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|'' 'Credit Billing' '' extension allows you to charge for a product from client credit balance.<br/>
| |
| − | To turn it on for a single product, press '' 'Settings' '' button next to the chosen product. If the extension is enabled, a new tab will appear.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_27_1.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"|
| |
| − | *'''Enable Credit Billing''' - this option enables/disables credit billing for this module (if credit billing is enabled, standard billing will be turned off).<br />
| |
| − | *'''Create Invoices Each''' - this option defines how often invoice will be generated for this product (30 days is a default value).<br />
| |
| − | *'''Minimum Credit''' - minimum amount that will be charged from client account credit balance.<br />
| |
| − | *'''Low Credit Notification''' - if this value is higher than credits on client account, email to your client about low credit amount will be sent.<br />
| |
| − | *'''Email Interval''' - defines how often low credit notification email will be sent.<br />
| |
| − | *'''Autosuspend''' - when credit balance reaches 0, product ordered by client is automatically suspended and invoice with lacking amount is generated.<br />
| |
| − | *'''Due Date''' - the number of days when your customers have to pay the invoice.<br />
| |
| − | <!--*'''Autorefill''' - if enabled, client's credit balance will be refilled from his credit card each time it became empty.<br />
| |
| − | *'''Gateway''' - gateway used to charge client's credit card.<br />
| |
| − | *'''Minimum Amount''' - minimum amount to charge from client's CC.<br />
| |
| − | *'''Maximum Amount''' - maximum amount to charge from client's CC.<br />
| |
| − | '''Note: Clients can define if they wish to use autorefill functionality as well as choose amount to refill in a single run.''-->
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_27.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"|When '' 'Autosuspend' '' is marked and your client's credit balance reaches 0, the client's product will be suspended. Additionally, invoice with lacking payment will be generated.<br />
| |
| − | If it is unmarked and credit balance reaches 0, the client's product will not be suspended and invoice will be generated according to the number of days set in '' 'Create Invoices Each' '' field.
| |
| − | |}
| |
| − | ====Credits====
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|All information related to credit payment for hosting can be found in '' 'Credits' '' tab that will appear in your menu when enabled.<br/>
| |
| − | As you can see, there are two columns with credits.<br />
| |
| − | The first one, '' 'Internal Credit' '' contains credits which were not used for payment, but are reserved for it. It was created to increase accuracy of credit billing.<br />
| |
| − | The second column, '' 'Already Paid For Hosting' '' contains summary credit payment for hosting.<br />
| |
| − | You can order refund of any hosting through pressing '' 'Refund' '' button next to it. Client will receive sum of '' 'Internal Credit' '' and '' 'Already Paid For Hosting' '' rounded down to 0.01.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB_28.png]]
| |
| − | |}
| |
| − |
| |
| − | ===Recurring Billing===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|This extension allows you to set up recurring billing for product.<br />
| |
| − |
| |
| − | *'''Enable Recurring Billing''' - check to enable this billing type (remember that Recurring Billing and Credit Billing cannot be both enabled in one time)<br />
| |
| − | *'''Bill on Termination''' - when account connected with your module is terminated, invoice for account will be generated.<br />
| |
| − | *'''Billing Type''' - enables you to choose how to bill your client.<br />
| |
| − | **'''Bill on Invoice Generation''' - customer will receive an invoice at the same time as the invoice for their hosting account.<br />
| |
| − | **'''Bill On Specific Day''' - will generate invoices each month on the day specified in the '''Billing Type Value'''.<br />
| |
| − | **'''Bill Each X Days''' - as its name suggests, it generates invoice each X days where X is a number specified in '''Billing Type Value''' field.<br />
| |
| − | *'''Due Date''' - the number of days in which your customers will have to pay the invoice.<br />
| |
| − | *'''Autogenerate Invoice''' - an important feature which if enabled, automatically sends previously generated invoices directly to your customers.<br />
| |
| − | *'''Auto Apply Credits''' - automatically applies any available credits when invoice is created, works only if '' 'Autogenerate Invoice' '' is enabled.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB_29.png]]
| |
| − | |}
| |
| − |
| |
| − | ===Usage Records===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|This extension displays usage records and usage records history in the client area products page.<br />
| |
| − | To use it, besides enabling in, you need to place an integration code.<br />
| |
| − | This extension is configured per product, proceed to the product configuration in Advanced Billing.<br />
| |
| − | As you can see, new tab is available here.
| |
| − | *'''Enable''' - enables usage records being displayed for that product in the client area.
| |
| − | *'''Display Summary From''' - defines period from which usage records will be counted.
| |
| − | *'''Usage Records Precision''' - defines precision of usage records
| |
| − | *'''Records History''' - displays history of usage records.
| |
| − | *'''Usage Records Per Page''' - defines how many usage records should be displayed per page.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_30.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|On the following screen you can see a sample of usage records and usage records history in the client area.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB_23.png]]
| |
| − | |}
| |
| − | ===Graphs===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|Enable '' 'Graphs' '' extension to get access to graphical view of usage records for every configured product in your Advanced Billing module.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_42.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|When
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB_43.png]]
| |
| − | |}
| |
| − |
| |
| − | ==Hourly Billing==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|Hourly billing allows you to charge your customers for each hour of use of the product (hourly billing calculations are basing on product '' 'Registration Date' '').<br />
| |
| − | You can enable hourly billing for any product type.<br />
| |
| − | Regardless of whether it is a server, web hosting account or other, customer will be billed for each hour of using the product.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB_32.png]]
| |
| − | |}
| |
| − |
| |
| − | ==Ticket Billing==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|Ticket billing works exactly as it sounds. When enabled, it bills your customers for each opened ticket.<br />
| |
| − | Remember that you must have a product with Ticket Billing submodule assigned to it.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_33_1.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|As in the case of hourly billing, you can enable ticket billing for any product type.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB_33.png]]
| |
| − | |}
| |
| − |
| |
| − | ==Sample Configuration==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 30px 15px;"|In this section we will show you two samples of configuration of Advanced Billing.
| |
| − | |}
| |
| − | ===Two Weeks Billing===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|In order to set up generating invoice for resource usage each 2 weeks, follow this steps:<br />
| |
| − | 1. Go to '' 'Addons' '' → '' 'Advanced Billing' '' and select your product from '' 'Enable Advanced Billing For:' ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_34.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|2. Go to '' 'Products List' → (your product's) 'Settings' → 'Recurring Billing' '', enable the extension together with '' 'Bill on Termination' '' option.<br />
| |
| − | Additionally, choose '' 'Bill Every X Days' '' from '' 'Billing Type' '' dropdown menu and enter '' '14' '' into the '' 'Billing Type Value' '' textbox.<br/>
| |
| − | Afterwards, press '' 'Save' '' the changes.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_35.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|3. Remember to enter your pricing settings.<br />
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_36.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|You have just successfully configured billing!<br />
| |
| − | You should see something like on the screen below in your Advanced Billing main page.<br/>
| |
| − | Note that you may alter Cron Frequency per product here.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB_37.png]]
| |
| − | |}
| |
| − |
| |
| − | ===20$ Billing===
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|To bill your client as often as possible follow these steps:<br />
| |
| − | 1.Go to '' 'Addons' '' → '' 'Advanced Billing' '' and select your product from '' 'Enable Advanced Billing For:' ''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_34.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|2. Go to '' 'Products List' → (your product's) 'Settings' → 'Credit Billing' '' and press '' 'Enable'. ''<br />
| |
| − | Afterwards, enter '' '1' '' into '' 'Create Invoices Each', '20' '' into '' 'Minimum Credit' '' and '' '50' '' into '' 'Low Credit Notification'. ''<br />
| |
| − | With these settings your client will be billed from credit balance as soon as the payment for resource usage has reached 20$.<br />
| |
| − | They will also receive an email if their credit balance falls below 50$.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_39.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|3. Remember to set up your pricing.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:AB_40.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|You have just successfully configured billing!<br />
| |
| − | In your Advanced Billing '' 'Configuration' '' tab you should see something similar to the following screen.<br/>
| |
| − | Note that you may alter Cron Frequency per product here.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:AB_41.png]]
| |
| − | |}
| |
| − |
| |
| − | ==How To Update==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 30px 15px;"|In order to upgrade, simply follow the basic steps below:<br/>
| |
| − | 1. Copy new files to a correct directory in your WHCMS.<br/>
| |
| − | 2. Proceed to '' 'Setup' → 'Addon Moduels', '' find '' 'Advanced Billing' '' on the list, press '' 'Configure' '' to select a proper database you wish to use.<br/>
| |
| − | 3. Move to the addon: '' 'Addons' → 'Advanced Billing' '' and run the below script:
| |
| − |
| |
| − | /your_whmcs/modules/addons/AdvancedBilling/migrationScript.php
| |
| − |
| |
| − | Data from your previous version of Advanced Billing will be migrated to the latest one.
| |
| − | |}
| |
| − |
| |
| − | =Tips=
| |
| − | {|
| |
| − | |style="padding: 10px 0px 5px 15px;"|1. Deactivation of the module removes products' configuration, usage records and awaiting invoices.<br />
| |
| − | In order to update the module, simply follow instruction in '' 'How To Update' '' .
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 15px;"|2. '' 'Installed Applications' '' usage record supports both Softaculous and Installatron.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 15px;"|3. You can set up as many products as you want.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 15px;"|4. If your client uses currency that is not WHMCS base currency (for example, WHMCS base currency is €, while client uses $):
| |
| − | An invoice for such client will be generated in the chosen currency, while usage record and calculation in Advanced Billing will use base currency.
| |
| − | |}
| |
| − |
| |
| | =Common Problems= | | =Common Problems= |
| − | <!--
| |
| − | {|
| |
| − | |style="padding: 10px 0px 5px 15px;"|1. When you see an error message as shown on the screen below, that means your '' 'cron' '' directory privileges are insufficient.<br />
| |
| − | To fix this, allow <strong>Read</strong> permissions to directory. In most cases chmod 755 solves the problem.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 25px;"|[[File:AB2_39.png]]
| |
| − | |}
| |
| − | -->
| |
| − | {|
| |
| − | |style="padding: 0px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
| |
| − | |}
| |
| | {| | | {| |
| − | |style="padding: 0px 0px 30px 15px;"|2. You are unable to find specified line in clientareaproductdetails.tpl.<br /> | + | |style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.''' |
| − | ''Cause 1:'' You are using Classic or Portal template.<br /> | + | |
| − | ''Solution 1:'' In this case place required code after this line: | + | |
| − | <nowiki><div align="center">{$moduleclientarea}</div></nowiki><br />
| + | |
| − | ''Cause 2:'' You are using heavily customized template.<br />
| + | |
| − | ''Solution 2:'' Create a ticket and one of our specialists will help you set up the module.
| + | |
| | |} | | |} |
