WHMCS

https://github.com/whmcs/developer-docs
Admin
WHMCS is a comprehensive client management and billing automation platform for online businesses,...
Tokens:452,152
Snippets:2,836
Trust Score:8.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example Request (CURL)

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/whmcsdetails.md

CURL request to the WHMCS API to obtain installation details. Uses the 'WhmcsDetails' action and requires authentication credentials.

```php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'WhmcsDetails',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);
```

--------------------------------

### HelloWorld class file for autoloading

Source: https://github.com/whmcs/developer-docs/blob/master/modules/module-class-autoloading.md

Example class file stored in the 'lib' subdirectory of a sample addon module. It defines a HelloWorld class with a printHello method that prints 'Hello World'.

```php
namespace WHMCS\Module\Addon\SampleAddonModule;

/**
 * Hello World Class
 *
 * @copyright Copyright (c)
 * @license http://www.whmcs.com/license/ WHMCS Eula
 */
class HelloWorld {

    /**
     * Print hello world.
     */
    public function printHello()
    {
        print 'Hello World';
    }

}
```

--------------------------------

### Get Ticket Response

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/getticket.md

Example JSON response for the Get Ticket API call, showing ticket details, replies, and notes.

```APIDOC
## [GET] /api/v1/tickets/{ticketid}

### Description
Retrieves a support ticket and its replies and notes.

### Method
GET

### Endpoint
/api/v1/tickets/{ticketid}

### Parameters
#### Path Parameters
- **ticketid** (integer) - Required - The ID of the ticket to retrieve.

### Response
#### Success Response (200)
- **result** (string) - The result of the operation (e.g., "success").
- **ticketid** (string) - The ticket ID.
- **tid** (string) - The ticket number.
- **c** (string) - The ticket code.
- **deptid** (string) - The department ID.
- **deptname** (string) - The department name.
- **userid** (string) - The user ID.
- **contactid** (string) - The contact ID.
- **name** (string) - The client name.
- **email** (string) - The client email.
- **cc** (string) - The CC field.
- **date** (string) - The ticket creation date.
- **subject** (string) - The ticket subject.
- **status** (string) - The ticket status.
- **priority** (string) - The ticket priority.
- **admin** (string) - The admin name.
- **lastreply** (string) - The last reply date.
- **flag** (string) - The flag.
- **service** (string) - The service.
- **replies** (object) - The replies object.
  - **reply** (array) - Array of reply objects.
    - **replyid** (string) - The reply ID.
    - **userid** (string) - The user ID.
    - **contactid** (string) - The contact ID.
    - **name** (string) - The name.
    - **email** (string) - The email.
    - **requestor_name** (string) - The requestor name.
    - **requestor_email** (string) - The requestor email.
    - **requestor_type** (string) - The requestor type.
    - **date** (string) - The reply date.
    - **message** (string) - The reply message.
    - **attachment** (string) - The attachment filename.
    - **attachments** (array) - Array of attachment objects.
      - **filename** (string) - The attachment filename.
      - **index** (integer) - The attachment index.
    - **attachments_removed** (boolean) - Whether attachments were removed.
    - **admin** (string) - The admin name.
    - **rating** (string) - The rating.
- **notes** (object) - The notes object.
  - **note** (array) - Array of note objects.
    - **noteid** (string) - The note ID.
    - **date** (string) - The note date.
    - **message** (string) - The note message.
    - **attachment** (string) - The attachment filename.
    - **attachments** (array) - Array of attachment objects.
    - **attachments_removed** (boolean) - Whether attachments were removed.
    - **admin** (string) - The admin name.

#### Response Example
```json
{
    "result": "success",
    "ticketid": "1",
    "tid": "516757",
    "c": "KPqH7yG3",
    "deptid": "1",
    "deptname": "Sample Support Department",
    "userid": "1",
    "contactid": "0",
    "name": "Cynthia Reilly",
    "email": "testuser@whmcs.com",
    "cc": "",
    "date": "2016-01-01 06:26:29",
    "subject": "This is a sample ticket",
    "status": "Closed",
    "priority": "Medium",
    "admin": "",
    "lastreply": "2016-01-01 06:30:16",
    "flag": "0",
    "service": "",
    "replies": {
        "reply": [
            {
                "replyid": "0",
                "userid": "1",
                "contactid": "0",
                "name": "Cynthia Reilly",
                "email": "testuser@whmcs.com",
                "requestor_name": "Cynthia Reilly",
                "requestor_email": "testuser@whmcs.com",
                "requestor_type": "Owner",
                "date": "2016-01-01 06:26:29",
                "message": "Hey, \r\n\r\nThis is the first ticket message!\r\n\r\nThanks\r\n\r\nCynthia",
                "attachment": "123456_attachment_name.png",
                "attachments": [
                    {
                        "filename": "attachment_name.png",
                        "index": 0
                    }
                ],
                "attachments_removed": true,
                "admin": ""
            },
            {
                "replyid": "1",
                "userid": "1",
                "contactid": "0",
                "name": "",
                "email": "",
                "requestor_name": "Demo Admin",
                "requestor_email": "",
                "requestor_type": "Operator",
                "date": "2016-01-01 06:27:01",
                "message": "Hello, \r\n\r\nThis is the first ticket reply by an admin user!\r\n\r\nThanks\r\n\r\nDemo Admin",
                "attachment": "",
                "attachments": [
                    []
                ],
                "attachments_removed": false,
                "admin": "Demo Admin",
                "rating": "0"
            },
            {
                "replyid": "2",
                "userid": "1",
                "contactid": "0",
                "name": "",
                "email": "",
                "requestor_name": "Cynthia Reilly",
                "requestor_email": "testuser@whmcs.com",
                "requestor_type": "Owner",
                "date": "2016-01-01 06:30:16",
                "message": "Hey, \r\n\r\nThis is a second reply!\r\n\r\nThanks\r\n\r\nCynthia",
                "attachment": "",
                "attachments": [
                    []
                ],
                "attachments_removed": false,
                "admin": "",
                "rating": "0"
            }
        ]
    },
    "notes": {
        "note": [
            {
                "noteid": "1",
                "date": "2016-01-01 06:26:42",
                "message": "This is a ticket note",
                "attachment": "",
                "attachments": [
                    []
                ],
                "attachments_removed": false,
                "admin": "Demo Admin"
            }
        ]
    }
}
```

### Version History
| Version | Changelog |
| ------- | --------- |
| 1.0 | Initial Version |
| 7.10 | Added new return parameter `attachments`. |
| 8.0 | Added new return parameters `requestor_name`, `requestor_type`, and `requestor_email`. |
```

--------------------------------

### Example Response JSON for Get Quotes

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/getquotes.md

Example JSON response for the Get Quotes API. Shows a successful response with two quotes, including client information, items, and various fields. The 'client' key was added in version 8.7 and returns selected client information if an existing client is associated with the quote.

```json
{
    "result": "success",
    "totalresults": 2,
    "startnumber": 0,
    "numreturned": 2,
    "quotes": {
        "quote": [
            {
                "id": 2,
                "subject": "",
                "stage": "Draft",
                "validuntil": "2023-01-30",
                "userid": 1,
                "client": {
                    "id": 1,
                    "firstname": "Richard",
                    "lastname": "Example",
                    "companyname": "Example Inc.",
                    "email": "amalia@example.com",
                    "datecreated": "2022-12-30",
                    "groupid": 0,
                    "status": "Active"
                },
                "firstname": "",
                "lastname": "",
                "companyname": "",
                "email": "",
                "address1": "",
                "address2": "",
                "city": "",
                "state": "",
                "postcode": "",
                "country": "US",
                "phonenumber": "",
                "tax_id": "",
                "currency": 1,
                "subtotal": "15.86",
                "tax1": "0.00",
                "tax2": "0.00",
                "total": "15.86",
                "proposal": "",
                "customernotes": "",
                "adminnotes": "",
                "datecreated": "2022-12-30",
                "lastmodified": "2022-12-30",
                "datesent": "0000-00-00",
                "dateaccepted": "0000-00-00",
                "items": {
                    "item": [
                        {
                            "id": 1,
                            "description": "Apple",
                            "quantity": "1",
                            "unitprice": "1.23",
                            "discount": "0.00",
                            "taxable": 1
                        },
                        {
                            "id": 2,
                            "description": "Pear",
                            "quantity": "3",
                            "unitprice": "5.00",
                            "discount": "2.50",
                            "taxable": 0
                        }
                    ]
                }
            },
            {
                "id": 1,
                "subject": "",
                "stage": "Draft",
                "validuntil": "2023-01-29",
                "userid": 0,
                "client": null,
                "firstname": "William",
                "lastname": "Smith",
                "companyname": "",
                "email": "",
                "address1": "",
                "address2": "",
                "city": "",
                "state": "",
                "postcode": "",
                "country": "US",
                "phonenumber": "",
                "tax_id": "",
                "currency": 1,
                "subtotal": "0.00",
                "tax1": "0.00",
                "tax2": "0.00",
                "total": "0.00",
                "proposal": "",
                "customernotes": "",
                "adminnotes": "",
                "datecreated": "2022-12-29",
                "lastmodified": "2022-12-30",
                "datesent": "0000-00-00",
                "dateaccepted": "0000-00-00",
                "items": {
                    "item": []
                }
            }
        ]
    }
}
```

--------------------------------

### Example theme.yaml configuration

Source: https://github.com/whmcs/developer-docs/blob/master/themes/theme-parameters.md

Example theme.yaml file that sets the theme as a child of the Twenty-One Parent Theme and specifies theme information, dependencies, and provided assets. Must be valid YAML with the indentation style shown.

```yaml
name: "Example"
description: "My Company's Branding"
author: "Hosting Company, L.L.C."
config:
  parent: twenty-one
dependencies:
  bootstrap: 4.5.2
provides:
  jquery: 1.12
  fontawesome: 5

```

--------------------------------

### Example Request (Local API)

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/addclient.md

Shows how to call the AddClient API using the local API function. It includes the command and post data array with client details. The response is printed using print_r.

```php
$command = 'AddClient';
$postData = array(
    'firstname' => 'John',
    'lastname' => 'Doe',
    'email' => 'john.doe@example.com',
    'address1' => '123 Main Street',
    'city' => 'Anytown',
    'state' => 'State',
    'postcode' => '12345',
    'country' => 'US',
    'phonenumber' => '800-555-1234',
    'password2' => 'password',
    'clientip' => '1.2.3.4',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);
```

--------------------------------

### OrderAddonPricingOverride hook example

Source: https://github.com/whmcs/developer-docs/blob/master/hooks-reference/shopping-cart.md

Registers a hook for the 'OrderAddonPricingOverride' event. The callback can return an array with 'setup' and 'recurring' keys to override addon pricing. The example shows how to check for product and addon purchases and return custom pricing.

```php
<?php

use WHMCS\Service\Service;

add_hook('OrderAddonPricingOverride', 1, function($vars) {
    $return = [];
    if (array_key_exists('proddata', $vars)) {
        /**
         * This is a product and addon purchase
         */
        if ($vars['addonid'] == 1 && $vars['proddata']['pid'] == 1) {
            $return = ['setup' => '1.00', 'recurring' => '5.00',];
        }
    } else {
        /**
         * This is an addon only purchase for existing service
         */
        $serviceData = Service::find($vars['serviceid']);
        if ($serviceData && $vars['addonid'] == 1 && $serviceData->packageId == 1) {
            $return = ['setup' => '1.00', 'recurring' => '5.00',];
        }
    }
    return $return;
});
```

--------------------------------

### Example Request (Local API)

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/addproduct.md

Use this Local API example to call the AddProduct command. It sets up the command and post data array with product details, then calls localAPI and prints the results. The admin username is optional for WHMCS 7.2 and later.

```php
$command = 'AddProduct';
$postData = array(
    'type' => 'other',
    'gid' => '1',
    'name' => 'Sample Product',
    'welcomeemail' => '5',
    'paytype' => 'recurring',
    'pricing' => array(1 => array('monthly' => 1.00, 'msetupfee' => 1.99, 'quarterly' => 2.00, 'qsetupfee' => 1.99, 'semiannually' => 3.00, 'ssetupfee' => 1.99, 'annually' => 4.00, 'asetupfee' => 1.99, 'biennially' => 5.00, 'bsetupfee' => 1.99, 'triennially' => 6.00, 'tsetupfee' => 1.99)),
'recommendations' => array(array('id' => 1, 'order' => 0), array('id' => 2, 'order' => 1)),
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);
```

--------------------------------

### StartTaskTimer JSON Response

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/starttasktimer.md

Example JSON response for a successful StartTaskTimer request. Contains the result 'success' and the message 'Start Timer Has Been Set'.

```json
{
    "result": "success",
    "message": "Start Timer Has Been Set"
}
```

--------------------------------

### Example Response JSON for GetAnnouncements

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/getannouncements.md

Example JSON response for a successful GetAnnouncements request. Shows the result, total results, start number, number returned, and an array of announcement entries with fields such as id, date, title, announcement, published, parentid, language, created_at, and updated_at.

```json
{
    "result": "success",
    "totalresults": "1",
    "startnumber": "0",
    "numreturned": "1",
    "announcements[announcement][0][id]": "1",
    "announcements[announcement][0][date]": "2016-02-24 21:27:04",
    "announcements[announcement][0][title]": "Thank you for choosing WHMCS!",
    "announcements[announcement][0][announcement]": "<p>Welcome to <a title=\"WHMCS\" href=\"https:\/\/whmcs.com\" target=\"_blank\">WHMCS<\/a>! You have made a great choice and we want to help you get up and running as quickly as possible.<\/p><p>This is a sample announcement. Announcements are a great way to keep your customers informed about news and special offers. You can edit or delete this announcement by logging into the admin area and navigating to <em>Support &gt; Announcements<\/em>.<\/p><p>If at any point you get stuck, our support team is available 24x7 to assist you. Simply visit <a title=\"www.whmcs.com\/support\" href=\"https:\/\/www.whmcs.com\/support\" target=\"_blank\">www.whmcs.com\/support<\/a> to request assistance.<\/p>",
    "announcements[announcement][0][published]": "1",
    "announcements[announcement][0][parentid]": "0",
    "announcements[announcement][0][language]": "",
    "announcements[announcement][0][created_at]": "0000-00-00 00:00:00",
    "announcements[announcement][0][updated_at]": "0000-00-00 00:00:00"
}
```

--------------------------------

### Create Hook File: touch ~/includes/hooks/helloworld.php

Source: https://github.com/whmcs/developer-docs/blob/master/hooks/getting-started.md

Creates the helloworld.php file in the /includes/hooks/ directory. Prefixing the filename with an underscore excludes the hook file from execution.

```bash
touch ~/includes/hooks/helloworld.php
```

--------------------------------

### GetActivityLog JSON Response Example

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/getactivitylog.md

Example JSON response returned by the GetActivityLog API when the request succeeds. Contains the result, total results count, starting number, and an array of activity entries with details such as id, clientId, userId, adminId, date, description, username, and ipaddress.

```json
{
    "result": "success",
    "totalresults": 2,
    "startnumber": 0,
    "activity": {
        "entry": [
            {
                "id": 2,
                "clientId": 0,
                "userId": 0,
                "adminId": 1,
                "date": "2021-01-01 06:56:49",
                "description": "Cron Job: Check for Updates: No new updates available",
                "username": "admin",
                "ipaddress": "172.18.0.1",
                "userid": 0
            },
            {
                "id": 1,
                "clientId": 0,
                "userId": 0,
                "adminId": 1,
                "date": "2021-01-01 06:56:49",
                "description": "Cron Job: Perform WHMCS Update Check",
                "username": "admin",
                "ipaddress": "172.18.0.1",
                "userid": 0
            }
        ]
    }
}
```

--------------------------------

### Example Request (CURL)

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/upgradeproduct.md

Shows how to call the UpgradeProduct API using cURL. The request includes authentication credentials, service ID, payment method, new product billing cycle, type, new product ID, and config options. The response is returned in JSON format.

```php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'UpgradeProduct',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'serviceid' => '1',
            'paymentmethod' => 'paypal',
            'newproductbillingcycle' => 'monthly',
            'type' => 'product',
            'newproductid' => '11',
            'configoptions' => [1 => 4, 2 => 5],
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);
```

--------------------------------

### Example Response JSON for GetModuleConfigurationParameters

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/getmoduleconfigurationparameters.md

Example JSON response showing a successful result with an array of configuration parameters for the PayPal gateway module, including field types such as text and yesno.

```json
{
    "result": "success",
    "parameters[0][name]": "FriendlyName",
    "parameters[0][displayName]": "FriendlyName",
    "parameters[0][fieldType]": "text",
    "parameters[1][name]": "email",
    "parameters[1][displayName]": "PayPal Email",
    "parameters[1][fieldType]": "text",
    "parameters[2][name]": "forceonetime",
    "parameters[2][displayName]": "Force One Time Payments",
    "parameters[2][fieldType]": "yesno",
    "parameters[3][name]": "forcesubscriptions",
    "parameters[3][displayName]": "Force Subscriptions",
    "parameters[3][fieldType]": "yesno",
    "parameters[4][name]": "requireshipping",
    "parameters[4][displayName]": "Require Shipping Address",
    "parameters[4][fieldType]": "yesno",
    "parameters[5][name]": "overrideaddress",
    "parameters[5][displayName]": "Client Address Matching",
    "parameters[5][fieldType]": "yesno",
    "parameters[6][name]": "apiusername",
    "parameters[6][displayName]": "API Username",
    "parameters[6][fieldType]": "text",
    "parameters[7][name]": "apipassword",
    "parameters[7][displayName]": "API Password",
    "parameters[7][fieldType]": "text",
    "parameters[8][name]": "apisignature",
    "parameters[8][displayName]": "API Signature",
    "parameters[8][fieldType]": "text",
    "parameters[9][name]": "sandbox",
    "parameters[9][displayName]": "Sandbox Mode",
    "parameters[9][fieldType]": "yesno"
}
```

--------------------------------

### StartTaskTimer Local API Request

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/starttasktimer.md

Example Local API request to start a task timer. Uses the localAPI function with the command 'StartTaskTimer' and the required parameters. The adminUsername is optional for WHMCS 7.2 and later.

```php
$command = 'StartTaskTimer';
$postData = array(
    'projectid' => '1',
    'timerid' => '1',
    'adminid' => '2',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);
```

--------------------------------

### Example Request (Local API)

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/domaingetwhoisinfo.md

Use this example to call the DomainGetWhoisInfo action using the WHMCS Local API. It sets the command and post data, optionally specifies an admin username (required for WHMCS 7.2 and later), and prints the results.

```php
$command = 'DomainGetWhoisInfo';
$postData = array(
    'domainid' => '1',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);
```

--------------------------------

### StartTaskTimer CURL Request

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/starttasktimer.md

Example CURL request to start a task timer. Uses the WHMCS API endpoint with action 'StartTaskTimer', providing projectid, timerid, and adminid. The response is returned in JSON format.

```php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'StartTaskTimer',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'projectid' => '1',
            'timerid' => '1',
            'adminid' => '2',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);
```

--------------------------------

### Save and retrieve Service Properties in provisioning module functions

Source: https://github.com/whmcs/developer-docs/blob/master/provisioning-modules/service-properties.md

Shows how to use $params['model']->serviceProperties->save() to store an order number and ->get() to retrieve it. The save method looks up a custom field by name and creates it if not found. The example includes samplemodule_CreateAccount and samplemodule_SuspendAccount functions.

```php
/**
 * @param array $params
 *
 * @return string
 */
function samplemodule_CreateAccount(array $params)
{
    try {
        // Perform actions to provision service and receive back an order number
        $orderNumber = '12345';

        // Save order number to Service Properties
        $params['model']->serviceProperties->save(['Order Number' => $orderNumber]);

        return 'success';
    } catch (\Exception $e) {
        return $e->getMessage();
    }
}

function samplemodule_SuspendAccount(array $params)
{
	try {
		// Utilise Service Properties to retrieve the Order Number
		$orderNumber = $params['model']->serviceProperties->get('Order Number');

		// Perform actions using order number here

		return 'success';
        } catch (\Exception $e) {
            return $e->getMessage();
        }
}
```

--------------------------------

### Example Request (CURL)

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/addclient.md

Shows how to call the AddClient API using cURL in PHP. It includes the required authentication parameters and client details. The response is printed using print_r.

```php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'AddClient',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'firstname' => 'John',
            'lastname' => 'Doe',
            'email' => 'john.doe@example.com',
            'address1' => '123 Main Street',
            'city' => 'Anytown',
            'state' => 'State',
            'postcode' => '12345',
            'country' => 'US',
            'phonenumber' => '800-555-1234',
            'password2' => 'password',
            'clientip' => '1.2.3.4',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);
```

--------------------------------

### GET /api-reference/getaffiliates/

Source: https://github.com/whmcs/developer-docs/blob/master/api/api-index.md

Gets affiliates.

```APIDOC
## [GET] /api-reference/getaffiliates/

### Description
Retrieves affiliates.

### Method
GET

### Endpoint
/api-reference/getaffiliates/
```

--------------------------------

### Example Request (CURL)

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/modulechangepackage.md

Sends a ModuleChangePackage request using cURL in PHP. Requires the serviceid parameter and API authentication credentials. The response is returned as JSON.

```php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'ModuleChangePackage',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'serviceid' => '1',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);
```

--------------------------------

### Example Request (Local API)

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/domainregister.md

Use this PHP example to call the DomainRegister command through the WHMCS Local API. It sets the command and post data with the domain ID, and optionally passes an admin username for WHMCS 7.2 and later. The result is printed with print_r.

```php
$command = 'DomainRegister';
$postData = array(
    'domainid' => '1',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);
```

--------------------------------

### GET /api-reference/getusers/

Source: https://github.com/whmcs/developer-docs/blob/master/api/api-index.md

Gets users.

```APIDOC
## [GET] /api-reference/getusers/

### Description
Retrieves users.

### Method
GET

### Endpoint
/api-reference/getusers/
```

--------------------------------

### GET /api-reference/getprojects/

Source: https://github.com/whmcs/developer-docs/blob/master/api/api-index.md

Gets projects.

```APIDOC
## [GET] /api-reference/getprojects/

### Description
Retrieves projects.

### Method
GET

### Endpoint
/api-reference/getprojects/
```

--------------------------------

### ActivateModule Example Request (CURL)

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/activatemodule.md

Example CURL request to activate a module. Uses the 'ActivateModule' action with moduleType 'gateway' and moduleName 'paypal', and sets configuration parameters. Requires authentication credentials and the API endpoint.

```php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'ActivateModule',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'moduleType' => 'gateway',
            'moduleName' => 'paypal',
            'parameters' => array('email' => 'billing@example.com', 'forcesubscriptions' => true),
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);
```

--------------------------------

### Example Response JSON for GetTLDPricing

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/gettldpricing.md

Example JSON response showing a successful result with currency information and pricing for TLDs (com, net, org, biz, info). The pricing array includes register, transfer, renew prices, and addon flags.

```json
{
    "result": "success",
    "currency": {
        "id": 1,
        "code": "USD",
        "prefix": "$",
        "suffix": " USD",
        "format": 1,
        "rate": "1.00000"
    },
    "pricing": {
        "com": {
            "tld": "com",
            "categories": [
                "Popular"
            ],
            "addons": {
                "dns": false,
                "email": false,
                "idprotect": false
            },
            "group": "",
            "register": {
                "1": "14.95"
            },
            "transfer": {
                "1": "14.95"
            },
            "renew": {
                "1": "14.95"
            },
            "grace_period": null,
            "redemption_period": null
        },
        "net": {
            "tld": "net",
            "categories": [
                "Popular"
            ],
            "addons": {
                "dns": false,
                "email": false,
                "idprotect": false
            },
            "group": "",
            "register": {
                "1": "14.95"
            },
            "transfer": {
                "1": "14.95"
            },
            "renew": {
                "1": "14.95"
            },
            "grace_period": null,
            "redemption_period": null
        },
        "org": {
            "tld": "org",
            "categories": [
                "Popular"
            ],
            "addons": {
                "dns": false,
                "email": false,
                "idprotect": false
            },
            "group": "",
            "register": {
                "1": "14.95"
            },
            "transfer": {
                "1": "14.95"
            },
            "renew": {
                "1": "14.95"
            },
            "grace_period": null,
            "redemption_period": null
        },
        "biz": {
            "tld": "biz",
            "categories": [
                "Popular"
            ],
            "addons": {
                "dns": false,
                "email": false,
                "idprotect": false
            },
            "group": "",
            "register": {
                "1": "14.95"
            },
            "transfer": {
                "1": "14.95"
            },
            "renew": {
                "1": "14.95"
            },
            "grace_period": null,
            "redemption_period": null
        },
        "info": {
            "tld": "info",
            "categories": [
                "Popular"
            ],
            "addons": {
                "dns": false,
                "email": false,
                "idprotect": false
            },
            "group": "",
            "register": {
                "1": "14.95"
            },
            "transfer": {
                "1": "14.95"
            },
            "renew": {
                "1": "14.95"
            },
            "grace_period": null,
            "redemption_period": null
        }
    }
}
```

--------------------------------

### GET /api-reference/getproject/

Source: https://github.com/whmcs/developer-docs/blob/master/api/api-index.md

Gets a project.

```APIDOC
## [GET] /api-reference/getproject/

### Description
Retrieves a project.

### Method
GET

### Endpoint
/api-reference/getproject/
```

--------------------------------

### Example Response JSON

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/getclientsaddons.md

Shows the JSON response structure for a successful GetClientsAddons request, including addon details such as id, qty, userid, orderid, serviceid, addonid, name, setupfee, recurring, billingcycle, tax, status, regdate, nextduedate, nextinvoicedate, paymentmethod, paymentmethodname, and notes.

```json
{
    "result": "success",
    "serviceid": "",
    "clientid": "1",
    "totalresults": "1",
    "addons[addon][0][id]": "1",
    "addons[addon][0][qty]": "1",
    "addons[addon][0][userid]": "1",
    "addons[addon][0][orderid]": "0",
    "addons[addon][0][serviceid]": "1",
    "addons[addon][0][addonid]": "0",
    "addons[addon][0][name]": "Addon 1",
    "addons[addon][0][setupfee]": "0.00",
    "addons[addon][0][recurring]": "15.00",
    "addons[addon][0][billingcycle]": "Monthly",
    "addons[addon][0][tax]": "",
    "addons[addon][0][status]": "Active",
    "addons[addon][0][regdate]": "2015-12-03",
    "addons[addon][0][nextduedate]": "2016-10-03",
    "addons[addon][0][nextinvoicedate]": "2016-10-03",
    "addons[addon][0][paymentmethod]": "paypal",
    "addons[addon][0][paymentmethodname]": "PayPal",
    "addons[addon][0][notes]": ""
}
```

--------------------------------

### GET /api-reference/getemails/

Source: https://github.com/whmcs/developer-docs/blob/master/api/api-index.md

Gets emails.

```APIDOC
## [GET] /api-reference/getemails/

### Description
Retrieves emails.

### Method
GET

### Endpoint
/api-reference/getemails/
```

--------------------------------

### UpdateClientAddon - Example Response JSON

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/updateclientaddon.md

Example JSON response for a successful update. Contains the result 'success' and the ID of the updated addon.

```json
{
    "result": "success",
    "id": "1"
}
```

--------------------------------

### GET /api-reference/getcontacts/

Source: https://github.com/whmcs/developer-docs/blob/master/api/api-index.md

Gets contacts.

```APIDOC
## [GET] /api-reference/getcontacts/

### Description
Retrieves contacts.

### Method
GET

### Endpoint
/api-reference/getcontacts/
```

--------------------------------

### CreateClientInvite Example Request (Local API)

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/createclientinvite.md

Use this local API example to call CreateClientInvite within WHMCS. The $adminUsername is optional for WHMCS 7.2 and later. The response is printed with print_r.

```php
$command = 'CreateClientInvite';
$postData = array(
    'client_id' => '1',
    'email' => 'john.doe@example.net',
    'permissions' => 'products,manageproducts,managedomains,tickets',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);
```

--------------------------------

### GET /api-reference/getclients/

Source: https://github.com/whmcs/developer-docs/blob/master/api/api-index.md

Gets clients.

```APIDOC
## [GET] /api-reference/getclients/

### Description
Retrieves a list of clients.

### Method
GET

### Endpoint
/api-reference/getclients/
```

--------------------------------

### GET /api-reference/getstats/

Source: https://github.com/whmcs/developer-docs/blob/master/api/api-index.md

Gets statistics.

```APIDOC
## [GET] /api-reference/getstats/

### Description
Retrieves system statistics.

### Method
GET

### Endpoint
/api-reference/getstats/
```

--------------------------------

### Simple Example: yourmodulename_link function

Source: https://github.com/whmcs/developer-docs/blob/master/payment-gateways/third-party-gateway.md

A simple demonstration of a link function that forwards the user to https://www.example.com/checkout using a form post with invoice data.

```php
function yourmodulename_link($params) {
    return '<form method="post" action="https://www.example.com/checkout">
        <input type="invoice_number" value="' . $params['invoiceid'] . '" />
        <input type="description" value="' . $params['description'] . '" />
        <input type="amount" value="' . $params['amount'] . '" />
        <input type="currency" value="' . $params['currency'] . '" />
        <input type="submit" value="' . $params['langpaynow'] . '" />
        </form>';
}
```

--------------------------------

### GET /api-reference/getcurrencies/

Source: https://github.com/whmcs/developer-docs/blob/master/api/api-index.md

Gets currencies.

```APIDOC
## [GET] /api-reference/getcurrencies/

### Description
Retrieves all available currencies.

### Method
GET

### Endpoint
/api-reference/getcurrencies/
```

--------------------------------

### Example Response JSON

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/getprojects.md

Example JSON response from the GetProjects API call, showing a successful result with project details.

```json
{
    "result": "success",
    "totalresults": 1,
    "startnumber": 0,
    "numreturned": 1,
    "projects": [
        {
            "id": 1,
            "userid": 0,
            "title": "First Project",
            "ticketids": "",
            "invoiceids": "",
            "notes": "",
            "adminid": 1,
            "status": "Pending",
            "created": "2020-06-24",
            "duedate": "2020-06-24",
            "completed": 0,
            "lastmodified": "2020-06-24 10:26:23",
            "watchers": ""
        }
    ]
}
```

--------------------------------

### Example Request (Local API)

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/addclientnote.md

Use this example to add a client note using the WHMCS Local API. It defines the command and post data, then calls localAPI() with an optional admin username for WHMCS 7.2 and later. The result is printed using print_r().

```php
$command = 'AddClientNote';
$postData = array(
    'userid' => '1',
    'notes' => 'Note to add',
    'sticky' => true,
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);
```

--------------------------------

### GET /api-reference/getuserpermissions/

Source: https://github.com/whmcs/developer-docs/blob/master/api/api-index.md

Gets user permissions.

```APIDOC
## [GET] /api-reference/getuserpermissions/

### Description
Retrieves permissions for a user.

### Method
GET

### Endpoint
/api-reference/getuserpermissions/
```

--------------------------------

### Example Response JSON

Source: https://github.com/whmcs/developer-docs/blob/master/api-reference/getpermissionslist.md

Example JSON response showing a successful GetPermissionsList call, including the status and the list of permissions.

```json
{
    "status": "success",
    "permissions": {
        "permission": [
            "profile",
            "contacts",
            "products",
            "manageproducts",
            "productsso",
            "domains",
            "managedomains",
            "invoices",
            "quotes",
            "tickets",
            "affiliates",
            "emails",
            "orders"
        ]
    }
}
```

--------------------------------

### GET /api-reference/getpermissionslist/

Source: https://github.com/whmcs/developer-docs/blob/master/api/api-index.md

Gets permissions list.

```APIDOC
## [GET] /api-reference/getpermissionslist/

### Description
Retrieves the list of permissions.

### Method
GET

### Endpoint
/api-reference/getpermissionslist/
```
Tokens:
Raw