WHMCS MCP Server Tools Reference

List and filter clients by status, group, or search term. Returns paginated results with basic client information.

Get detailed information for a specific client including their services, invoices, support tickets, and custom field values.

Create a new client with contact details, address, and custom fields. Optionally send a welcome email.

Update client information like email, phone, address, notes, or custom fields. Partial updates are supported.

Permanently delete a client and all associated data. This action cannot be undone.

List all available WHMCS products with pricing and configuration details.

Create a new product in the WHMCS catalog. Requires a name and a product group ID. Note: WHMCS exposes no UpdateProduct or DeleteProduct API, so edits and removals must be done in the WHMCS admin UI after creation.

List services for a specific client with filtering by product, status, or server. Includes domain and pricing details.

Update a service including status, billing cycle, next due date, or package assignment.

Provision and activate a service on the assigned server. Triggers the module create function.

Suspend a service for non-payment or abuse. Optionally specify a reason that is logged.

Unsuspend a previously suspended service and restore access.

Permanently terminate a service and remove from server. This action cannot be undone.

Upgrade or downgrade a service to a different product package.

Change the password for a service account on the provisioning server.

List invoices with filtering by status, date range, or client. Shows totals and payment status.

Get detailed invoice including line items, payments, transactions, and notes.

Create a new invoice for a client with custom line items, due date, and payment terms.

Record a payment against an invoice with optional transaction ID and gateway reference.

Add one or more line items to an existing invoice. Each item includes description, amount, and optional tax.

Update invoice status, due date, payment method, or notes. Partial updates are supported.

Apply client credit balance to reduce an invoice total. Adjusts both the invoice and the client credit.

List payment transactions with filtering by invoice, client, or date range.

List all quotes with filtering by status, validity, or client.

Get detailed quote information including line items, validity period, and acceptance status.

Create a new quote for a client with custom line items and validity period.

Update quote details, line items, or status. Partial updates are supported.

Send quote to client via email for review and acceptance.

Accept a quote and convert it to an invoice for billing.

List all orders with filtering by status, date range, or client. Returns order totals and payment status.

Get detailed order information including line items, payment status, and associated invoices.

Create a new order for a client with specified products, addons, and billing cycle.

Accept a pending order after fraud check. Optionally triggers service provisioning.

Cancel an order and optionally refund the payment. Removes pending services.

Delete a cancelled or fraud order. Cannot delete active orders with provisioned services.

List support tickets with filtering by status, department, priority, or client.

Get ticket details including all replies, attachments, and internal notes.

Create a new support ticket for a client or as an admin with department and priority.

Add a reply to an existing ticket as admin or client. Optionally change status.

Update ticket subject, status, priority, department, or flag. Partial updates are supported.

Permanently delete a ticket and all its replies and notes. This action cannot be undone.

Add an internal admin note to a ticket. Notes are not visible to the client.

List support ticket departments with IDs, names, awaiting-reply counts, and open-ticket counts. Call before creating or filtering tickets so the AI passes real department IDs instead of guessing.

List configured ticket statuses, including any custom statuses the admin has added. Use these exact titles when filtering tickets or setting status.

List domains owned by clients with optional filters (client ID, domain ID, domain name, pagination). Returns registrar, status, and expiry information.

Register a domain through the configured registrar. Destructive and irreversible: commits real money. Seeded disabled and shipped with a warning that AI clients must surface before invoking.

Transfer a domain into your registrar. Destructive: commits real money and triggers a registrar-side transfer process. Optional EPP code parameter.

Renew a domain at the registrar. Destructive: commits real money. Optional renewal period in years.

Perform a WHOIS lookup against any domain name to check availability and current registrar information. Safe and read-only.

Retrieve the nameservers (ns1 through ns5) currently configured against a domain.

Update a domains nameservers. Requires ns1 and ns2 plus the domain ID or name. ns3 through ns5 are optional.

Check whether a domain is locked at the registrar (transfer-out protection).

Enable or disable the registrar lock on a domain. Toggle transfer-out protection on or off.

Retrieve the full TLD pricing matrix. Optionally scope to a currency ID or a client ID (uses the clients own currency).

List affiliate accounts with referral counts, pending and paid commission totals, and visitor stats. Optional filter by client ID.

Activate an existing client as an affiliate so they can earn commissions on referred sales. Note: the WHMCS affiliate API uses userid to mean client ID.

List promotion and discount codes with type, value, applicable products, expiry, and usage stats. Pass a code to fetch a single promotion.

Check which MX addons are installed and licensed on the WHMCS instance. Call this first to discover what tools are available.

Get WHMCS system status including version, active clients, products, orders, and uptime statistics.

List all WHMCS admin users with their roles and last login timestamps.

List all configured payment gateways and their active status.

List all currencies configured in WHMCS with exchange rates and formatting.

View recent WHMCS activity log entries. Useful for auditing admin actions and system events.

Write a custom entry to the WHMCS activity log for tracking admin actions.

List email templates by type (general, product, domain, invoice, support, etc.).

Send an email to a client using a predefined WHMCS email template.

List admin to-do items with filtering by status and assignment.

List all configured servers with their type, hostname, and active service count.

Get financial summary including MRR, ARR, costs, and net profit for your WHMCS instance.

Get revenue breakdown by product or service showing MRR, ARR, client count, and percentage.

Get top clients ranked by recurring revenue or lifetime value.

Get clients with the most support tickets. Useful for identifying high-maintenance accounts.

Get detailed cost breakdown by expense group including fixed expenses and service costs.

List proposals with optional filtering by status, search term, date range, and amount range.

Get detailed proposal information including line items and client data.

Create a new proposal as a draft. Include line items with description, quantity, unit price, and billing cycle.

Update an existing proposal. Only provided fields will be changed. Include full items array to replace all line items.

Delete a proposal and all related data including items, client data, and signatures. This action is irreversible.

Send a draft proposal to the client via email. Changes status from draft to sent.

Decline a proposal with an optional reason. The client will be notified.

Cancel an active proposal. Useful when a deal falls through or terms change.

Get the activity log and viewing statistics for a proposal, including when the client viewed it.

List or get email templates used for proposal notifications.

Update an email template used for proposal notifications.