Skip to main content

User Guide

MX Metrics for WHMCS

Revenue Analytics & Profitability Tracking

Version 1.2 · Complete documentation

Last updated: January 2026

Installation

Estimated time: 5 minutes

Requirements: WHMCS 8.0+, PHP 8.0+

Step 1: Upload Files

  1. 1.Extract mx_metrics.zip
  2. 2.Upload the mx_metrics/ folder to /modules/addons/

Expected folder structure:

/whmcs/modules/addons/mx_metrics/
├── mx_metrics.php
├── hooks.php
├── hooks/
├── widgets/
├── lib/
└── templates/

Step 2: Activate & License

  1. 1.Go to Setup → Addon Modules
  2. 2.Find "MX Metrics" and click Activate
  3. 3.Click Configure and enter your license key
  4. 4.Set Access Control to "Full Administrator"
  5. 5.Click Save Changes
MX Metrics addon configuration screen showing license key field and access control settings
Click to zoom

Addon configuration with license key

Done! The widgets will appear on your Dashboard automatically.

Dashboard Widgets

MX Metrics adds 4 widgets to your WHMCS Dashboard. Each widget answers a specific business question.

WHMCS Dashboard showing all MX Metrics widgets
Click to zoom

Dashboard with all MX Metrics widgets

1. MRR & ARR Widget

“Am I actually making money?”

MRR and ARR widget showing revenue and costs breakdown
Click to zoom

MRR - Monthly Recurring Revenue from all active services

ARR - Annual Recurring Revenue (MRR × 12)

Recurring Services Cost - Sum of all service costs

Fixed Expenses - Your business expenses by category

Net Recurring Profit - Revenue minus all costs

Tip: Use the Monthly/Annually toggle to switch between views.

2. Top Clients by Revenue

“Who are my most valuable clients?”

Top clients by revenue widget
Click to zoom

Shows your top clients ranked by revenue

Toggle between Monthly, Annually, or All-Time views

Click any client name to open their profile

3. Recurring Revenue Breakdown

“Which products drive my business?”

Revenue breakdown by product widget
Click to zoom

Revenue breakdown by product/service type

Shows active service count and percentage

Sort by Revenue or Popularity

4. High Support Clients

“Who costs me the most in support?”

High support clients widget showing ticket counts
Click to zoom

Clients ranked by total support tickets

Helps identify high-maintenance accounts

Use this data to justify pricing adjustments

Cost Management

MX Metrics tracks costs at three levels: fixed business expenses, product-level costs, and service-level overrides.

Fixed Expenses (Business Costs)

Track your recurring business expenses like servers, licenses, marketing, and staff costs.

Cost management admin panel with expense groups
Click to zoom

Cost Management panel in Addons → MX Metrics

How to add expenses:

  1. 1.Go to Addons → MX Metrics
  2. 2.Click the Cost Management tab
  3. 3.Click + Add New Group to create a category (e.g., "Infrastructure")
  4. 4.Click + Add New Expense to add individual costs

Example groups: Infrastructure (servers, CDN, backups), Software & Licenses (WHMCS, cPanel), Operations (staff, contractors), Marketing (ads, affiliates)

Product Default Cost

Set a default monthly cost for each product. This cost applies to all services of that product type.

Product configuration showing Monthly Cost field
Click to zoom

Monthly Cost field on the product Pricing tab

How to set product cost:

  1. 1.Go to Setup → Products/Services → Products/Services
  2. 2.Click on a product to edit it
  3. 3.Go to the Pricing tab
  4. 4.Enter the Monthly Cost (what you pay for this service)
  5. 5.Save Changes

Service Cost Override

Override the default cost for individual services. Useful when you have negotiated different rates with suppliers.

Service edit page showing cost override field
Click to zoom

Service Cost Override field on the service edit page

How to override a service cost:

  1. 1.Go to Clients → Services (or open a client's profile)
  2. 2.Click on a service to edit it
  3. 3.Find the Service Cost Override field
  4. 4.Enter the cost (leave blank to use product default)

Cost Priority: Service Override > Product Default > None (shows warning in widget)

Settings

Configure MX Metrics behavior from the addon's Settings tab.

Available Settings

Show Cost Breakdown

Enable or disable the profitability section in the MRR & ARR widget. When disabled, only MRR/ARR values are shown.

Frequently Asked Questions

Why do I see a warning icon next to Net Profit?

This means some services don't have a cost defined. The warning shows how many items and their revenue. Your actual profit may be lower because these costs are missing.

How is MRR calculated?

MRR is calculated by summing all active services and converting them to monthly values. Quarterly services are divided by 3, annually by 12, etc. Domains are also included based on their registration period.

Can I hide the cost breakdown from staff?

Yes. Go to Addons → MX Metrics → Settings tab and disable "Show Cost Breakdown". The MRR/ARR widget will only show revenue, not costs or profit.

What happens if I don't set any costs?

The widgets will still work and show MRR/ARR. The cost breakdown will show $0 and a warning will indicate that costs are missing.

Does MX Metrics affect WHMCS performance?

No. MX Metrics uses optimized database queries and caches results for 10 minutes. Dashboard loads remain fast.

Which WHMCS versions are supported?

MX Metrics supports WHMCS 8.0 and newer. We recommend using the latest stable version (8.8+) for best compatibility.

Need Help?

Our support team is ready to assist you with any questions about MX Metrics.

Contact SupportView Product Page