Installing ictVoIP Billing

Important

Before you install, ensure:

• You have a valid ictVoIP Billing license key.

• WHMCS meets the supported version and PHP requirements.

• You have SFTP/SSH or file-manager access to the WHMCS document root.

• A full WHMCS database and file backup has been completed.

Tip

Upgrading an existing installation? See Upgrading ictVoIP Billing and FusionPBX Integration for the recommended upgrade procedure covering the ictVoIP Billing addon, FusionPBX server module, and API files.

Complete Installation Guide for ictVoIP Billing System

This guide provides step-by-step instructions for installing and configuring the ictVoIP Billing system on your WHMCS platform.

System Requirements

Supported WHMCS Versions: * WHMCS 8.12+

PHP Requirements: * PHP 8.1+ (see PHP Requirements & Health Check for full PHP requirements)

Web Server: * Apache 2.4+ * LiteSpeed * Nginx (with proper configuration)

Prerequisites: * WHMCS with HTTPS enabled * Basic understanding of WHMCS administration * Access to WHMCS admin panel

Note

This guide assumes you have a basic WHMCS installation with HTTPS enabled and understand WHMCS platform administration.

Purchase & Download

1. Purchase or start a Trial

If you haven’t already purchased the ictVoIP Billing addon module or wish to request a trial version, you can request so here:

ictVoIP Billing Software Contact Us

2. Download the Package

To purchase or begin a trial setup an account and download the latest release package from your client area: * Package: ictvoip_billing_release-1.4_PHP8.1-8.3.zip * Location: Your client area licenses section

Installation Process

For a complete step-by-step installation checklist, including environment requirements, package upload, file extraction, and initial verification, see the Quick Install guide.

Once the files have been deployed to your WHMCS document root, continue with the steps below to activate and configure the ictVoIP Billing addon.

Database Setup

When the ictVoIP Billing addon is activated for the first time, it will automatically create and initialize the required database tables, including country codes and configuration tables.

License Activation

Step 1: Access Addon Modules

Navigate to your WHMCS admin panel: * System Settings → Apps & Integrations → Addon Modules

Step 2: Activate the Module

1. Find “ictVoIP Billing” in the addon modules list

2. Click Activate

3. Click Configure

Step 3: Enter License Key

Enter your ictVoIP Billing license key in the configuration:

License Key: YOUR-ICTVOIP-LICENSE-KEY

Step 4: Configure Access Control

Set the appropriate access control groups for your administrators and save the configuration.

Note

Upgrading from v1.3.3: When upgrading from ictVoIP Billing v1.3.3 (or any 1.3.x build) to v1.5.0 or later, you must re-run the addon activation inside WHMCS after uploading the new files. If the addon is already active, click Deactivate, then Activate again. This ensures that all new database tables and columns required by the new version are created and updated.

See also

For the complete upgrade procedure, including FusionPBX server module and API updates, see Upgrading ictVoIP Billing and FusionPBX Integration.

System Health Check

After installing and activating the ictVoIP Billing addon, you can run the System Health Check to verify proper configuration and setup of the addon and server modules.

The health check is run from the ictVoIP Billing admin dashboard by clicking the ictVoIP Health Check button at the top of the Provider/PBX selection screen.

What it checks

The report gathers information across these areas:

• WHMCS environment — WHMCS version, PHP and ionCube versions, active ionCube loaders, and required PHP extensions.

• ictVoIP Billing addon — version, license key status, and activation state.

• Database — required mod_ictvoipbilling_* tables, custom client fields, country codes, and the Low Balance Alert email template.

• PBX server modules — whether the FusionPBX/FS PBX WHMCS server modules are installed and their versions.

• PBX server APIs — HTTPS probes against the configured FusionPBX and FS PBX servers to verify that the WHMCS IP is whitelisted and that each API endpoint (destinations, outbound, dialplans, access controls) responds with a version string.

JSON version probe

You can query the health-check script itself for a lightweight JSON status:

GET /modules/addons/ictvoipbilling/healthcheck.php?action=version

It returns:

{
  "name": "ictvoipbilling healthcheck",
  "version": "1.4.x",
  "build": "r04 2026-07-02 17:40",
  "success": true
}

This is useful for uptime monitoring and automated probes.

CSV export

When logged in as an admin, the health-check page includes an Export Report (CSV) button.

The exported CSV is the standard format used by ictVoIP Canada support for technical troubleshooting. When opening a support ticket, generate the full CSV report and attach it to the request.

• Full export — action=healthcheck_export downloads ictvoip_healthcheck_report.csv with the report date, WHMCS version, addon version, server-module versions, and one row per check (Section, Check, Status, Details). This is the report ictVoIP Canada support will normally ask for.

• Minimal export — action=healthcheck_export_min downloads a tiny CSV used by support to quickly verify that the export pipeline itself works.

Show Diagnostics

Click Show Diagnostics on the health-check page to include extra technical detail in the report. This can be helpful when troubleshooting 500 errors or support requests.

Portable health check

The modules/addons/ictvoipbilling/healthcheck_portable.php file can be opened directly in a browser. It is designed for older or partially-installed deployments where the addon cannot fully load through WHMCS.

The portable check attempts to:

1. Locate the WHMCS configuration.php file and initialise the database connection.

2. Read the WHMCS version from tblconfiguration.

3. Verify the ictVoIP Billing addon is active and read the stored license key.

4. Check for the required custom client fields and the mod_ictvoipbilling_country_codes table.

5. Probe the configured FusionPBX and FS PBX servers over HTTPS/HTTP and report reachable API endpoints.

Use the portable health check when the normal health-check page fails to load because of a fatal error or a missing dependency.

Manual Verify Checks

1. Check Module Status

Verify the module is properly installed: * Navigate to System Settings → Apps & Integrations → Addon Modules * Ensure “ictVoIP Billing” shows as Active

2. Test Admin Access

• Navigate to ictVoIP Billing in your admin menu

• Verify you can access the dashboard

• Check that all menu items are visible

3. Verify Database Tables

Confirm the required tables were created:

SHOW TABLES LIKE '%ictvoipbilling%';

For day-to-day administration of tenants, extensions, gateways, and related provisioning tasks, see the Client Services Admin Area documentation.

Server Provisioning Settings & Tests

Within the ictVoIP Billing admin area, the Client Services or Server Provisioning Settings screens allow you to configure and validate connections to your PBX servers (for example, FusionPBX hosts) using the standard WHMCS server records.

At a high level, these screens provide: * Server Credentials Management – Reads and updates the WHMCS tblservers record for the selected PBX server (username, encrypted password, and API access hash), using WHMCS encryption for password storage and avoiding plaintext passwords in logs. * Credential Test (FusionPBX Login) – Uses either a username/password combination or an API access hash (depending on your integration pattern) to validate that the configured credentials can successfully log in to the PBX web interface over HTTPS and returns a simple pass/fail result so you can correct credentials before enabling automated provisioning. * Whitelist / API Reachability Test – Performs a lightweight HTTP check against one or more PBX API endpoints to confirm that the WHMCS server is allowed by the PBX IP whitelist and reports whether the PBX returned a version/status response (whitelist OK) or an access-denied/login page (indicating the WHMCS IP may not be fully whitelisted).

These tools do not change PBX configuration themselves; they are designed to help you verify that the underlying FusionPBX (or other PBX) API access is correctly configured before relying on automated provisioning and billing.

Troubleshooting

Common Issues:

• Module not appearing: Check file permissions and ensure all files were copied correctly

• License activation failed: Verify the license key is correct and has not expired

• Database errors: Ensure the country codes table was created and initialized successfully

• Access denied: Check that your admin user has the correct access control group assigned

Support:

If you encounter issues during installation, please contact our support team with: * WHMCS version * PHP version * Error messages (if any) * Steps taken during installation

Next Steps

After successful installation and a clean System Health Check, proceed to:

1. Server Configuration - Set up your PBX servers (see Server Management)

2. Provider Setup - Configure your VoIP providers (see Provider Management)

3. Tariff Management - Set up your pricing structure

4. Package Configuration - Create service packages and assign them to clients

5. Admin Area Overview - Review the Admin Area guide for a summary of configuration options and tools (see Admin Area)

6. Client Services Admin Area - Use the Client Services dashboard for day-to-day management of tenants, extensions, gateways, and related provisioning tasks (see Client Services Admin Area)