canonical: https://jentic.com/apis/whmcs.com/whmcs

# WHMCS Client Management API

The WHMCS API allows you to perform operations and actions within WHMCS from external third party and custom code. This includes managing clients, domains, invoices, tickets, orders, and more. All API requests are made via POST to the api.php endpoint with authentication credentials and action parameters. The API exposes 1 endpoints.

## For AI agents

Programmatically execute API action. Covers 1 operations.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- Execute API Action
- Manage payments data programmatically
- Integrate WHMCS Client Management API into automated workflows
- Query and filter WHMCS Client Management API records by parameters
- Monitor WHMCS Client Management API operational status and events

## Use cases

### Payments Operations

Use the WHMCS Client Management API to perform payments operations programmatically. The API provides 1 endpoints covering core functionality including execute API action.

Example prompt: Call POST /api.php to execute API action

### Data Retrieval and Monitoring

Query WHMCS Client Management API resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary WHMCS Client Management API endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call WHMCS Client Management API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.

Example prompt: Search Jentic for 'execute API action', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api.php` | Execute API Action |

## Key resources

- **api.php** — Operations related to api.php

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 67 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 90 / 100
  - Developer Experience & Jentic Compatibility: 56 / 100
  - AI-Readiness & Agent Experience: 43 / 100
  - Agent Usability: 94 / 100
  - Security: 100 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/whmcs.com/whmcs/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the WHMCS Client Management API by hand means pointing at your own WHMCS installation URL, POSTing form actions to api.php, and parsing its responses yourself. Through Jentic you install once, import the WHMCS Client Management API from the API Directory, store the connection details once, and your agent calls it.
- **Permission scoping:** This API exposes a single api.php action endpoint, so scope the agent to the operations it needs, such as reading client records, rather than to one client. You choose the operations it may call, so write or delete actions are not included unless you add them.
- **Credential handling:** Your WHMCS connection details are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'run a WHMCS client action', and Jentic returns the matching WHMCS operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the WHMCS Client Management API use?

The WHMCS Client Management API uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I execute API action with the WHMCS Client Management API?

Yes. Use the POST /api.php endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the WHMCS Client Management API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I execute API action through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'execute API action'. Jentic returns the matching WHMCS Client Management API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the WHMCS Client Management API have?

The WHMCS Client Management API exposes 1 endpoints covering api.php operations.

### Can I limit what my agent is allowed to do with the WHMCS Client Management API?

Yes. Because you run Jentic One yourself, your own rules decide which WHMCS operations and credentials your agent may use. The WHMCS Client Management API is exposed through a single api.php action endpoint, so you scope the agent to only the actions it needs, such as reading client records, rather than granting it everything. Write or delete actions are not available to the agent unless you explicitly add them.