Upgrading ictVoIP Billing and FusionPBX Integration

This guide explains how to upgrade:

The ictVoIP Billing Addon for WHMCS from v1.3.3 to v1.4.0.
The FusionPBX Server Module from v1.3.3 to v1.4.0, including the FusionPBX API files.
WHMCS from v8.x to v9 (optional, but fully supported).

Both components should be upgraded in the same maintenance window so that all versions remain in sync.

Note

WHMCS v9 Compatibility: ictVoIP Billing v1.4.0 is fully compatible with WHMCS v9. All Client Services management views (Tenant Domains, Extensions, Gateways, Destinations, ACL) and server modules (autobill_v2, autobill_v3) have been tested and verified. No breaking changes were detected during the WHMCS v9 upgrade process.

Before You Start

Schedule a maintenance window.
Take full backups of:
- The WHMCS database and files.
- Each FusionPBX server database and configuration.
Ensure you have:
- ictVoIP Billing Addon v1.4.0 package (for WHMCS).
- FusionPBX Server Module v1.4.0 package (for WHMCS).
- FusionPBX API / integration files v1.4.0 (for each FusionPBX server).

Upgrade the ictVoIP Billing Addon (WHMCS)

Upload the new addon files
- Upload the v1.4.0 addon package to your WHMCS installation.
- Overwrite the existing modules/addons/ictvoipbilling folder and any related paths included in the package.
Deactivate and reactivate the addon
- In WHMCS Admin go to:
  
  Apps & Integrations → Addon Modules
- Find ictVoIP Billing.
- Click Deactivate.
- Then click Activate again.
This step runs the install/upgrade routines and initializes or updates all required database tables for v1.4.0.
Re-enter your license key
- Open the ictVoIP Billing addon settings page.
- Enter your license key again and save.
- Confirm that the license validates successfully.

Upgrade the FusionPBX Server Module (WHMCS)

Upload the new server module files
- Upload the v1.4.0 FusionPBX server module to WHMCS (for example into modules/servers/fusionpbx).
- Overwrite the existing v1.3.3 files.
Confirm server configuration
- In WHMCS Admin, open the server configuration for each FusionPBX server that uses this module.
- Verify hostname, credentials, and SSL settings are still correct.
Activate/Verify the license
- Go to Setup > Products/Services > Products/Services.
- Edit each product that uses the FusionPBX server module.
- In the Module Settings tab, locate the License Key field.
- If this is a new server or the domain/IP has changed:
  - Click the Activate button (green) to register the new domain/IP with your license.
- Click the Verify button (blue) to confirm the license is active.
- Ensure you see “License Active” with your domain and expiry date.
- Save the product settings.

Note

The Activate button is required when moving WHMCS to a new server or domain. Each license key can only be active on one domain/IP at a time.

Update the FusionPBX API Files (Each FusionPBX Server)

The FusionPBX API and theme files are distributed in the FusionPBX Server module package (ictvoip_fusionPBX_module-release-v1.4_PHP8.1-8.3.zip). Use the included installer script for proper installation and patching.

Extract and upload the installer folders
- Extract the package on your local machine.
- Navigate into FusionPBX Host/fpbx_apis-theme/.
- Using SFTP (e.g., WinSCP), upload the following folders to /root/ on each FusionPBX server:
  - ictvoip_fpbx5-3_apis – API integration files
  - ictvoip_fpbx5-3_theme – Optional branding/theme files

Run the API installer script

cd /root/ictvoip_fpbx5-3_apis
chmod +x install_apis.sh
./install_apis.sh

Review the installation
- Examine the log file generated by the installer.
- Watch for any warnings or errors during the install process.
- The script handles file placement, permissions, and patching automatically.

Note

If you also want to apply the ictVoIP theme, repeat the process for the ictvoip_fpbx5-3_theme folder using its own installer script.

Post-Upgrade Testing

Test connection from WHMCS to FusionPBX

Open the ictVoIP Billing addon in WHMCS.
Go to the FusionPBX provider or server settings section.
Use the built-in Test Connection or a simple data fetch, such as listing domains or tenants.
Confirm that:
- The connection succeeds without errors.
- Domains / tenants / basic data are returned correctly.

Verify tenant and gateway synchronisation

In the ictVoIP Billing addon:
- Open the Tenants / Tenant Domains page and run a Sync from FusionPBX for a test tenant.
- Open the Gateways page and run a Sync from FusionPBX for a known tenant and server.
Confirm that:
- No PHP or API errors are reported.
- Tenant and gateway information displays as expected.

Optional: Billing sanity check

If available, run a test or preview billing operation (without generating real invoices).
Confirm that:
- No database or schema errors occur.
- CDRs can be read as expected.

Rollback (If Needed)

If you encounter a critical issue during the maintenance window:

Restore the WHMCS database and files from your pre-upgrade backup.
Restore each FusionPBX server database and API files from their backups.
Re-run the basic connection and synchronisation tests to confirm stability.