whmcs.php¶

Модуль интеграции с WHMCS для управления услугами, биллингом и клиентами: отмена заказов, управление кредитами, смена тарифных планов и работа с контактами.

Методы API¶

Метод	Действие	Описание
`add_cancel_request`	создание запроса на отмену	Создает запрос на отмену услуги (сервера) в системе WHMCS.
`add_contact`	добавление контакта	Добавляет дополнительного контактного лица к клиенту.
`add_os_addon`	добавление OS аддона	Добавляет лицензию операционной системы как addon к существующему серверу.
`apply_credit`	применение кредита	Применяет средства с баланса аккаунта к оплате конкретного инвойса.
`cancel_order`	отмена заказа	Отменяет заказ в WHMCS, если он находится в статусе Pending/Unpaid и не содержит активных лицензий.
`change_preset`	смена пресета	Инициирует процесс смены конфигурационного пресета сервера.
`client_change_billing_cycle`	смена цикла биллинга клиентом	Позволяет клиенту самостоятельно сменить цикл оплаты (например, на более длинный).
`create_addfunds`	создание инвойса на пополнение баланса	Создает инвойс для пополнения баланса (Add Funds) в WHMCS.
`create_product_invoice`	создание инвойса на продукт	Создает инвойс для конкретного продукта (услуги) в WHMCS.
`delete_cancellation_request`	удаление запроса на отмену	Удаляет существующий запрос на отмену услуги (сброс статуса ожидания).
`delete_contact`	удаление контакта клиента	Удаляет дополнительный контакт пользователя из WHMCS.
`generate_due_invoice`	генерация предстоящего инвойса	Принудительно генерирует следующий инвойс для сервера в WHMCS.
`get_billing_data`	получение биллинговых данных сервера	Возвращает подробную информацию о текущем биллинге, включая данные EU B2C и лицензии.
`get_cancellation_requests`	получение списка запросов на отмену	Возвращает список активных запросов на отмену для сервера или пользователя.
`get_client`	получение информации о клиенте	Возвращает подробную информацию об авторизованном клиенте, включая данные из WHMCS и внутренние теги.
`get_clients`	получение списка клиентов	Возвращает список клиентов с фильтрацией по статусу.
`get_contacts`	получение контактов клиента	Возвращает список дополнительных контактов для указанного клиента.
`get_emails`	получение списка email-адресов клиента	Возвращает список email-адресов, связанных с клиентом.
`get_invoice`	получение инвойса	Возвращает данные конкретного инвойса из WHMCS.
`get_invoices`	получение списка инвойсов	Возвращает список всех инвойсов клиента.
`get_migration_progress`	получение прогресса миграции	Возвращает статистику по статусам пользователей в процессе миграции.
`get_order_to_move`	получение данных заказа для миграции	Возвращает данные заказа из WHMCS, подготовленные для процесса миграции.
`get_product_invoice`	получение инвойсов продукта	Возвращает список всех инвойсов, связанных с конкретным продуктом (сервером).
`get_products`	получение продуктов по группе	Возвращает список доступных продуктов для указанной группы (gid).
`get_related_invoices`	получение связанных инвойсов	Возвращает список всех инвойсов, привязанных к аккаунту клиента.
`get_upgrade_preset_cost`	получение стоимости апгрейда	Возвращает список цен на различные конфигурации (пресеты) для улучшения сервера.
`getcredits`	получение баланса кредитов	Возвращает информацию о доступных средствах (кредитах) на аккаунте клиента.
`getpaymentgw`	получение платежных шлюзов	Возвращает список доступных методов оплаты для конкретного инвойса.
`mass_pay`	массовая оплата инвойсов	Создает один общий инвойс для массовой оплаты нескольких выбранных инвойсов.
`payment_to_month_first_day`	смена даты оплаты на первое число месяца	Настраивает дату платежа сервера на первый день месяца.
`preview_client_billing_cycle_change`	превью изменения цикла оплаты для клиента	Рассчитывает стоимость и детали при смене платежного цикла клиентом.
`refund_check`	проверка статуса возврата	Проверяет, находится ли запрос на возврат в процессе обработки (через статус тикета JIRA).
`request_cancellation`	запрос на отмену услуги	Инициирует процесс отмены сервера и проверяет условия (наличие задолженностей, статус лицензий).
`request_refund`	запрос на возврат средств	Инициирует процесс возврата неиспользованных денежных средств с баланса клиента. Проверяет наличие открытых тикетов в JIRA и лимиты кредитного баланса в WHMCS.
`request_subscription_cancellation`	запрос отмены подписки	Запрашивает отмену автоматического продления (подписки) банковской картой.
`reset_password`	сброс пароля	Инициирует процесс сброса пароля клиента. Если токен уже использован, позволяет установить новый пароль.
`transactions`	получение транзакций	Возвращает список финансовых транзакций клиента.
`unpaidinvoices`	обработка неоплаченных инвойсов	Запуск процесса обработки (напоминания) по неоплаченным инвойсам за указанный период.
`update_client`	обновление клиента	Обновление данных профиля клиента в WHMCS и локальной базе.
`update_contact`	обновление контакта	Обновление данных дополнительного контакта клиента.
`update_product`	обновление продукта/сервера	Обновление параметров сервера (статус, дата продления, домен и т.д.).
`updatevat`	обновление VAT	Обновление данных по налогу (VAT) в системе.
`verify_address`	верификация адреса	Проверяет адрес клиента через Google Maps API для подтверждения его корректности.
`verify_email`	верификация email	Проверяет корректность email-адреса и отправляет код верификации или подтверждает изменение почты.

whmcs/add_cancel_request¶

Создает запрос на отмену услуги (сервера) в системе WHMCS.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add_cancel_request`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера для отмены
cancel_type	❌	string	Тип отмены. По умолчанию: End of Billing Period
reason	✅	string	Причина отмены.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=add_cancel_request" \
--data "token=YOUR_TOKEN" \
--data "id=123" \
--data "reason=Customer requested cancellation"

Пример успешного ответа

{
"result": "OK",
"action": "add_cancel_request",
"message": "Успешно создан запрос на отмену"
}

Примеры ошибок

{
"code": -1,
"message": "Server not found: 123"
}

whmcs/add_contact¶

Добавляет дополнительного контактного лица к клиенту.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add_contact`
token	✅	string	Токен авторизации
profile_data[firstname]	✅	string	Имя контакта. Должно соответствовать регулярному выражению /^[\p{L}\p{N}-.()',\s]+$/u
profile_data[lastname]	❌	string	Фамилия контакта. Должна соответствовать регулярному выражению /^[\p{L}\p{N}-.()',\s]+$/u
profile_data[email]	✅	string	Email контакта. Должен быть валидным email-адресом.
profile_data[password1]	✅	string	Пароль контакта (первый)
profile_data[password2]	✅	string	Подтверждение пароля контакта
profile_data[phonenumber]	❌	string	Номер телефона контакта. Должен быть в международном формате и поддерживаться SMS-сервисом.
type	✅	string	Параметр type для проверки наличия запроса
profile_data	✅	`array<string>`	Данные профиля нового контакта, включая имя, фамилию, email и пароль.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=add_contact" \
--data "token=YOUR_TOKEN" \
--data "profile_data[firstname]=John" \
--data "profile_data[lastname]=Doe" \
--data "profile_data[email]=john@example.com" \
--data "profile_data[password1]=secret123" \
--data "profile_data[password2]=secret123" \
--data "type=some_type"

Пример успешного ответа

{
"result": "success",
"contactid": 123,
"firstname": "John",
"lastname": "Doe",
"email": "john@example.com"
}

Примеры ошибок

{
"code": -1,
"message": "fill_required_fields"
}

whmcs/add_os_addon¶

Добавляет лицензию операционной системы как addon к существующему серверу.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add_os_addon`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера
os_id	✅	integer	ID операционной системы из списка доступных
billing_cycle	✅	string	Период оплаты. Допустимые значения: annually, monthly, quarterly, semi-annually, semiannually

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=add_os_addon" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "os_id=VALUE" \
--data "billing_cycle=VALUE"

Пример успешного ответа

{
"result": "OK",
"id": 123,
"message": "OS addon created"
}

Примеры ошибок

{
"code": -1,
"message": "invalid OS"
}

whmcs/apply_credit¶

Применяет средства с баланса аккаунта к оплате конкретного инвойса.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `apply_credit`
token	✅	string	Токен авторизации
invoice_id	✅	integer	ID инвойса для оплаты
amount	✅	number	Сумма кредита

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=apply_credit" \
--data "token=HOSTKEY_TOKEN" \
--data "invoice_id=VALUE" \
--data "amount=VALUE"

Пример успешного ответа

{
"result": "success",
"status": "Paid"
}

Примеры ошибок

{
"code": -1,
"message": "$module/$action: invalid invoice id"
}

whmcs/cancel_order¶

Отменяет заказ в WHMCS, если он находится в статусе Pending/Unpaid и не содержит активных лицензий.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `cancel_order`
token	✅	string	Токен авторизации
id	✅	integer	ID заказа для отмены (unsigned integer)

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=cancel_order" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345"

Пример успешного ответа

{
"result": "OK",
"message": {
"balance_refunded": 0.0
}
}

Примеры ошибок

{
"code": -1,
"message": "Invalid order id"
}

whmcs/change_preset¶

Инициирует процесс смены конфигурационного пресета сервера.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `change_preset`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера
preset_id	✅	string	ID нового пресета

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=change_preset" \
--data "token=VALUE" \
--data "id=VALUE" \
--data "preset_id=VALUE"

Пример успешного ответа

{
"invoice_id": 0,
"error": null
}

Примеры ошибок

{
"code": -1,
"message": "Невозможно улучшить сервер не из пресета"
}

whmcs/client_change_billing_cycle¶

Позволяет клиенту самостоятельно сменить цикл оплаты (например, на более длинный).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `client_change_billing_cycle`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера
new_billing_cycle	✅	string	Новый цикл оплаты. Допустимые значения: annually, monthly, quarterly, semi-annually, semiannually.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=client_change_billing_cycle" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345" \
--data "new_billing_cycle=annually"

Пример успешного ответа

{
"result": "OK",
"message": "Billing cycle changed successfully",
"old_cycle": "monthly",
"old_price": 49.99,
"new_cycle": "annually",
"new_price": 150.0,
"currency_code": "USD",
"formula_details": "...",
"next_due_date": "2023-12-31",
"invoice_generated": true,
"invoice_id": 12345
}

Примеры ошибок

{
"code": -1,
"message": "This action is only available for customers"
}

whmcs/create_addfunds¶

Создает инвойс для пополнения баланса (Add Funds) в WHMCS.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `create_addfunds`
token	✅	string	Токен авторизации
amount	✅	number	Сумма пополнения.
description	❌	string	Описание платежа.
subscribe	❌	boolean	Включить автоматическое списание (автопродление).

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=create_addfunds" \
--data "token=YOUR_TOKEN" \
--data "amount=50.0"

Пример успешного ответа

{
"result": "OK",
"invoice": {
"id": 123,
"amount": 50.0,
"status": "Unpaid"
},
"message": "Invoice 123 created"
}

Примеры ошибок

{
"code": -1,
"message": "$module/$action: minimal payment amount is X."
}

whmcs/create_product_invoice¶

Создает инвойс для конкретного продукта (услуги) в WHMCS.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `create_product_invoice`
token	✅	string	Токен авторизации
amount	✅	number	Сумма инвойса.
product_id	✅	integer	ID продукта в WHMCS.
description	❌	string	Описание инвойса.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=create_product_invoice" \
--data "token=HOSTKEY_TOKEN" \
--data "amount=100.50" \
--data "product_id=123" \
--data "description=Payment for service"

Пример успешного ответа

{
"result": "OK",
"invoice": 456,
"message": "Invoice 456 created"
}

Примеры ошибок

{
"code": -1,
"message": "create_product_invoice: failed to create product invoice: error_msg"
}

whmcs/delete_cancellation_request¶

Удаляет существующий запрос на отмену услуги (сброс статуса ожидания).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete_cancellation_request`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера.
full	❌	boolean	Флаг для возврата упрощенного статуса результата операции в ответе.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=delete_cancellation_request" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

Пример успешного ответа

{
"result": "OK",
"action": "delete_cancellation_request",
"message": "Cancellation request removed"
}

Примеры ошибок

{
"code": -1,
"message": "server id doesn't have a relid data"
}

whmcs/delete_contact¶

Удаляет дополнительный контакт пользователя из WHMCS.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete_contact`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера (для проверки прав).
contact_id	✅	integer	ID контакта для удаления.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=delete_contact" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "contact_id=VALUE"

Пример успешного ответа

{
"result": "OK",
"action": "delete_contact",
"clientid": 10,
"status": "success"
}

Примеры ошибок

{
"code": -1,
"message": "verification failed, subcontact not found"
}

whmcs/generate_due_invoice¶

Принудительно генерирует следующий инвойс для сервера в WHMCS.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `generate_due_invoice`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера.
addonids	❌	`array<integer>`	Список идентификаторов активных аддонов для генерации инвойса.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=generate_due_invoice" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "addonids[]=1" \
--data "addonids[]=2"

Пример успешного ответа

{
"result": "OK",
"invoices": [
{
"id": 789,
"amount": 25.0,
"status": "Unpaid"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "next_invoice_unpaid_exists"
}

whmcs/get_billing_data¶

Возвращает подробную информацию о текущем биллинге, включая данные EU B2C и лицензии.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_billing_data`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера.
notes	❌	string	Параметр `notes`
groupdata	❌	array	Параметр `groupdata`
customer_name	❌	string	Имя клиента (может быть скрыто)
eu_b2c	❌	integer	Флаг принадлежности к EU B2C (1 или 0)
eu_withdrawal	❌	integer	Флаг применения правил вывода средств ЕС (1 или 0)
billing_cycle	❌	string	Биллинговый цикл. Допустимые значения: annually, monthly, quarterly, semi-annually, semiannually
eu_withdrawal_licenses	❌	array	Список лицензий для вывода средств ЕС

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X GET \
--data "action=get_billing_data" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"action": "get_billing_data",
"customer_name": "John Doe",
"eu_b2c": 0,
"eu_withdrawal": 0,
"eu_withdrawal_licenses": [
{
"name": "License Name",
"amount": 10.5,
"currency": "EUR"
}
],
"days_left": 30,
"customer_email": "client@example.com",
"lock_billing_cycle_change": false
}

Примеры ошибок

{
"code": -1,
"message": "invalid request"
}

whmcs/get_cancellation_requests¶

Возвращает список активных запросов на отмену для сервера или пользователя.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_cancellation_requests`
token	✅	string	Токен авторизации
id	❌	integer	ID сервера (если указан, возвращаются запросы для этого сервера).
period_from	❌	string	Дата начала периода.
period_to	❌	string	Дата окончания периода.
cancellation_type	❌	string	Тип отмены (например, End of Billing Period).
billing_status	❌	string	Статус биллинга.
full	❌	boolean	Флаг для получения расширенного ответа с полным статусом результата.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X GET \
--data "action=get_cancellation_requests" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "success",
"action": "get_cancellation_requests",
"message": [
{
"relid": 123,
"cr_date": "2024-01-01 12:00:00",
"cr_reason": "User request",
"cr_type": "End of Billing Period",
"due_date": "2024-02-01"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Server not found"
}

whmcs/get_client¶

Возвращает подробную информацию об авторизованном клиенте, включая данные из WHMCS и внутренние теги.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_client`
token	✅	string	Токен авторизации
email	❌	string	Email клиента для поиска (используется как account_id, если client_id не задан)
client	✅	string	Параметр `client`
billing_location	✅	string	Параметр `billing_location`
groupdata	✅	string	Параметр `groupdata`
internal	✅	string	Параметр `internal`
full	❌	boolean	Флаг для получения расширенной информации о клиенте.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X GET \
--data "action=get_client" \
--data "token=VALUE" \
--data "client=VALUE" \
--data "billing_location=VALUE" \
--data "groupdata=VALUE" \
--data "internal=VALUE"

Пример успешного ответа

{
"result": "OK",
"client": {
"id": 123,
"firstname": "Ivan",
"lastname": "Ivanov",
"email": "user@example.com",
"currency_code": "USD",
"status": "Active",
"groupid": 1,
"corporate": 0,
"userid": 456,
"ip": "127.0.0.1",
"location": "test_loc"
},
"billing_location": "whmcs_itb",
"groupdata": {
"id": 1,
"name": "Group Name"
},
"internal": {
"firstname": "Ivan",
"lastname": "Ivanov",
"email": "user@example.com",
"corporate": 0,
"active_since": "2024-01-01"
},
"refund_policy": "Policy text"
}

Примеры ошибок

{
"code": 502,
"message": "Request failed for account_id@location: error message"
}

whmcs/get_clients¶

Возвращает список клиентов с фильтрацией по статусу.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_clients`
token	✅	string	Токен авторизации
status	❌	string	Статус клиента. Допустимые значения: Active (по умолчанию), enable
location	❌	string	Географическое местоположение или дата-центр для фильтрации клиентов.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X GET \
--data "action=get_clients" \
--data "token=YOUR_TOKEN" \
--data "status=Active" \
--data "location=Amsterdam"

Пример успешного ответа

{
"result": "OK",
"list": []
}

Примеры ошибок

{
"code": -1,
"message": "Error getting clients"
}

whmcs/get_contacts¶

Возвращает список дополнительных контактов для указанного клиента.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_contacts`
token	✅	string	Токен авторизации
email	❌	string	Email дополнительного контакта для фильтрации списка контактов клиента.
full	❌	boolean	Флаг для получения полного набора данных о контактах.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X GET \
--data "action=get_contacts" \
--data "token=YOUR_TOKEN" \
--data "email=test@example.com" \
--data "full=true"

Пример успешного ответа

{
"permission_contacts_granted": true,
"result": "OK",
"contacts": [
{
"id": 5,
"email": "contact@example.com",
"firstname": "John",
"lastname": "Doe"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "fail to get contacts list"
}

whmcs/get_emails¶

Возвращает список email-адресов, связанных с клиентом.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_emails`
token	✅	string	Токен авторизации
params	❌	`array<string>`	Контейнер с параметрами запроса

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X GET \
--data "action=get_emails" \
--data "token=YOUR_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "get_emails",
"data": {
"email": "user@example.com"
}
}

Примеры ошибок

{
"code": 400,
"message": "Illegal customer id"
}

whmcs/get_invoice¶

Возвращает данные конкретного инвойса из WHMCS.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_invoice`
token	✅	string	Токен авторизации
invoice_id	✅	integer	Уникальный идентификатор инвойса в WHMCS
userid	✅	string	Параметр `userid`
customer	✅	string	Параметр `customer`
currencycode	✅	string	Параметр `currencycode`
firstname	✅	string	Параметр `firstname`
lastname	✅	string	Параметр `lastname`
location	❌	string	Местоположение или серверная площадка для получения данных счета.
load_client_data	❌	integer	Флаг загрузки дополнительных данных клиента вместе с информацией о счете.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X GET \
--data "action=get_invoice" \
--data "token=VALUE" \
--data "invoice_id=VALUE" \
--data "userid=VALUE" \
--data "customer=VALUE" \
--data "currencycode=VALUE" \
--data "firstname=VALUE" \
--data "lastname=VALUE"

Пример успешного ответа

{
"result": "OK",
"status": "Paid",
"items": {
"item": [
{
"relid": 123,
"inv_id": -1
}
]
},
"currencycode": "USD",
"billing": "location_name",
"customer": null,
"userid": 123,
"firstname": "John",
"lastname": "Doe"
}

Примеры ошибок

{
"code": -1,
"message": "get_invoice: invalid invoice id [id] at [location]"
}

whmcs/get_invoices¶

Возвращает список всех инвойсов клиента.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_invoices`
token	✅	string	Токен авторизации
totalresults	❌	integer	Общее количество найденных инвойсов
numreturned	❌	integer	Количество возвращенных инвойсов в текущем ответе
invoices	❌	array	Список данных об инвойсах

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X GET \
--data "action=get_invoices" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"totalresults": 5,
"numreturned": 5,
"invoices": {
"invoice": [
{
"id": 101,
"status": "Paid",
"total": 29.99
}
]
}
}

Примеры ошибок

{
"code": -1,
"message": "incorrect billing response, try again."
}

whmcs/get_migration_progress¶

Возвращает статистику по статусам пользователей в процессе миграции.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_migration_progress`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X GET \
--data "action=get_migration_progress" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "get_migration_progress",
"data": {
"status_name": {
"user_count": 150,
"total_amount": 4500.5
}
}
}

Примеры ошибок

{
"code": -1,
"message": "Not found"
}

whmcs/get_order_to_move¶

Возвращает данные заказа из WHMCS, подготовленные для процесса миграции.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_order_to_move`
token	✅	string	Токен авторизации
id	✅	integer	ID заказа для миграции
location	❌	string	Идентификатор или название локации для переноса заказа.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=get_order_to_move" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"action": "get_order_to_move",
"order": {
"id": 123,
"userid": 456,
"items": [
{
"product": "VPS",
"domain": "example.com",
"status": "Active"
}
]
},
"top": 789
}

Примеры ошибок

{
"code": -1,
"message": "Order not found"
}

whmcs/get_product_invoice¶

Возвращает список всех инвойсов, связанных с конкретным продуктом (сервером).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_product_invoice`
token	✅	string	Токен авторизации
id	✅	integer	ID продукта (сервера)
product	✅	string	Параметр `product`
paymentmethod	✅	string	Параметр `paymentmethod`

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=get_product_invoice" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "product=VALUE" \
--data "paymentmethod=VALUE"

Пример успешного ответа

{
"result": "OK",
"action": "get_product_invoice",
"invoices": [
{
"id": 10,
"amount": 50.0,
"status": "Paid",
"billing": "whmcs_ru"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Invalid server id"
}

whmcs/get_products¶

Возвращает список доступных продуктов для указанной группы (gid).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_products`
token	✅	string	Токен авторизации
id	✅	integer	ID локации (billing location)
gid	❌	integer	ID группы продуктов. По умолчанию 0.
location	❌	string	Географическое местоположение или дата-центр для фильтрации доступных продуктов.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=get_products" \
--data "token=YOUR_TOKEN" \
--data "id=123" \
--data "gid=5" \
--data "location=Amsterdam"

Пример успешного ответа

{
"result": "success",
"products": {
"product": [
{
"id": 1,
"name": "Standard VPS",
"price": {
"EUR": 10.0,
"RUB": 950.0
}
}
]
}
}

Примеры ошибок

{
"code": 400,
"message": "Billing error: {\"result\":\"-1\",\"error\":\"Invalid billing location [location]\"}"
}

whmcs/get_related_invoices¶

Возвращает список всех инвойсов, привязанных к аккаунту клиента.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_related_invoices`
token	✅	string	Токен авторизации
id	❌	integer	ID сервера (если указан, используется его account_id)
account_id	✅	integer	Идентификатор аккаунта клиента в биллинговой системе
invoices	✅	string	Параметр `invoices`
user_id	❌	integer	Уникальный идентификатор пользователя для фильтрации связанных инвойсов.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=get_related_invoices" \
--data "token=HOSTKEY_TOKEN" \
--data "account_id=12345" \
--data "invoices=some_value"

Пример успешного ответа

{
"result": "OK",
"action": "get_related_invoices",
"invoices": [
{
"id": 50,
"userid": 123,
"status": "Paid"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "$module/$action: server $id are not linked to the billing"
}

whmcs/get_upgrade_preset_cost¶

Возвращает список цен на различные конфигурации (пресеты) для улучшения сервера.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_upgrade_preset_cost`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=get_upgrade_preset_cost" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"upgrade_options": [
{
"id": 123,
"name": "Upgrade to 8GB RAM",
"description": "Description of the preset",
"price": 16.5,
"upgrade_price": 5.0,
"web_group": "vm"
}
],
"base_cost": 15.0,
"extra_costs": 2.5,
"taxrate": 0.2,
"ndd": "2023-12-31",
"discount": 1.0,
"current_web_group": "vm",
"current_preset_name": "Standard VM"
}

Примеры ошибок

{
"code": -1,
"message": "Error calculating prices"
}

whmcs/getcredits¶

Возвращает информацию о доступных средствах (кредитах) на аккаунте клиента.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `getcredits`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=getcredits" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"message": {
"result": "success",
"error": null
}
}

Примеры ошибок

{
"code": -1,
"message": "failed to retrive account history at [location], please contact support - [error]"
}

whmcs/getpaymentgw¶

Возвращает список доступных методов оплаты для конкретного инвойса.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `getpaymentgw`
token	✅	string	Токен авторизации
invoice_id	✅	integer	ID инвойса
status	✅	string	Параметр `status`
userid	✅	string	Параметр `userid`

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=getpaymentgw" \
--data "token=VALUE" \
--data "invoice_id=VALUE" \
--data "status=VALUE" \
--data "userid=VALUE"

Пример успешного ответа

{
"result": "OK",
"methods": [
{
"name": "stripe",
"call": "https://invapi.hostkey.com?invoice_id=123"
},
{
"name": "banktransfer",
"call": "<span style='text-align:left'><p data-intl='please_wire_funds_in_favor'>Please wire funds in favor of:&nbsp;</p>...</span>"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "failed to retrive payment gw list: [error_message]"
}

whmcs/mass_pay¶

Создает один общий инвойс для массовой оплаты нескольких выбранных инвойсов.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `mass_pay`
token	✅	string	Токен авторизации
invoices	✅	`array<integer>`	Массив ID инвойсов для оплаты. Принимает несколько значений: invoices[]=1&invoices[]=2

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=mass_pay" \
--data "token=YOUR_TOKEN" \
--data "invoices[]=123" \
--data "invoices[]=456"

Пример успешного ответа

{
"result": "OK",
"invoiceid": 12345
}

Примеры ошибок

{
"code": -1,
"message": "mass_pay_requires_2_invoices"
}

whmcs/payment_to_month_first_day¶

Настраивает дату платежа сервера на первый день месяца.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `payment_to_month_first_day`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера (equipment ID)

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=payment_to_month_first_day" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345"

Пример успешного ответа

{
"result": "OK",
"action": "payment_to_month_first_day"
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка выполнения операции"
}

whmcs/preview_client_billing_cycle_change¶

Рассчитывает стоимость и детали при смене платежного цикла клиентом.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `preview_client_billing_cycle_change`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера
new_billing_cycle	✅	string	Новый платежный цикл.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=preview_client_billing_cycle_change" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "new_billing_cycle=VALUE"

Пример успешного ответа

{
"result": "OK",
"action": "preview_client_billing_cycle_change",
"new_price": 49.99,
"monthly_price": 59.99,
"current_cycle": "monthly",
"new_cycle": "annually",
"currency_code": "USD",
"formula_details": "Calculation details..."
}

Примеры ошибок

{
"code": -1,
"message": "Server not found"
}

whmcs/refund_check¶

Проверяет, находится ли запрос на возврат в процессе обработки (через статус тикета JIRA).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `refund_check`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=refund_check" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"message": "refund_pending"
}

Примеры ошибок

{
"code": -1,
"message": "Refund request failed"
}

whmcs/request_cancellation¶

Инициирует процесс отмены сервера и проверяет условия (наличие задолженностей, статус лицензий).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `request_cancellation`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера
cancellation_type	❌	string	Тип отмены.
cancellation_reason	❌	string	Причина отмены. Допустимые значения: RU
invoices	✅	string	Параметр `invoices`
refund	✅	number	Сумма возврата средств
currency	✅	string	Валюта платежа
service_price	✅	number	Стоимость услуги с учетом налогов (если применимо)
refund_message	✅	string	Текст сообщения о возврате средств для клиента
refund_message_short	✅	string	Краткий текст сообщения о возврате средств
clientid	✅	integer	ID клиента в WHMCS
billing	✅	string	Локация биллинга (whmcs или другая)
email	✅	string	Email клиента для уведомления
refund_message_inv	✅	string	Текст сообщения о возврате в инвойсе
invoice_id	✅	integer	ID последнего инвойса для возврата
tax	✅	number	Сумма налога
vat_extra	✅	boolean	Флаг наличия дополнительного НДС (VAT extra)
last_invoice	✅	integer	ID последнего инвойса
prev_invoice_id	✅	integer	ID предыдущего инвойса
relid	✅	integer	Связанный ID (account_id)
withheld_amount	✅	number	Удержанная сумма за использование ресурсов
period_start	✅	string	Дата начала расчетного периода
vat_msg	✅	string	Сообщение о налоге (VAT)
rec_before_tax	✅	number	Сумма до вычета налогов
d_deploy_time	✅	string	Дата развертывания сервера
d_bill_time	✅	string	Время выставления счета
d_reccuring	✅	string	Период рекуррентного платежа (billing cycle)
d_period	✅	string	Billing cycle (annually, monthly, quarterly, semi-annually, semiannually)
cbp_adjusted	✅	string	Сообщение о корректировке периода (CBP adjusted)
user_id	❌	integer	Уникальный идентификатор пользователя в системе.
terminate_reason_custom	❌	string	Пользовательская причина расторжения услуги, используемая при отсутствии стандартной причины.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=request_cancellation" \
--data "token=VALUE" \
--data "id=VALUE" \
--data "invoices=VALUE" \
--data "refund=VALUE" \
--data "currency=VALUE" \
--data "service_price=VALUE" \
--data "refund_message=VALUE" \
--data "refund_message_short=VALUE" \
--data "clientid=VALUE" \
--data "billing=VALUE" \
--data "email=VALUE" \
--data "refund_message_inv=VALUE" \
--data "invoice_id=VALUE" \
--data "tax=VALUE" \
--data "vat_extra=VALUE" \
--data "last_invoice=VALUE" \
--data "prev_invoice_id=VALUE" \
--data "relid=VALUE" \
--data "withheld_amount=VALUE" \
--data "period_start=VALUE" \
--data "vat_msg=VALUE" \
--data "rec_before_tax=VALUE" \
--data "d_deploy_time=VALUE" \
--data "d_bill_time=VALUE" \
--data "d_reccuring=VALUE" \
--data "d_period=VALUE" \
--data "cbp_adjusted=VALUE"

Пример успешного ответа

{
"result": "OK"
}

Примеры ошибок

{
"code": -1,
"message": "Server are being cancelled at the moment, please wait or contact support"
}

whmcs/request_subscription_cancellation¶

Запрашивает отмену автоматического продления (подписки) банковской картой.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `request_subscription_cancellation`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=request_subscription_cancellation" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

Пример успешного ответа

{
"result": "OK",
"ticket": "JIRA-12345"
}

Примеры ошибок

{
"code": -1,
"message": "sub_cancel_not_allowed_billing"
}

whmcs/reset_password¶

Инициирует процесс сброса пароля клиента. Если токен уже использован, позволяет установить новый пароль.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `reset_password`
token	✅	string	Токен сброса пароля (если не пустой)
email	❌	string	Email клиента для отправки ссылки на сброс
location	❌	string	Локация биллинга. Допустимые значения: Auto.
pass	❌	string	Новый пароль (используется при наличии токена)
code	❌	string	Код двухфакторной аутентификации (2FA)
reset_token	❌	string	Уникальный токен для сброса пароля пользователя.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=reset_password" \
--data "token=YOUR_TOKEN"

Пример успешного ответа

{
"result": "OK",
"message": "Password reset link was sent to the registred email."
}

Примеры ошибок

{
"code": -1,
"message": "Invalid password reset token, please try again."
}

whmcs/transactions¶

Возвращает список финансовых транзакций клиента.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `transactions`
transaction_id	❌	string	ID конкретной транзакции
token	✅	string	API-токен аутентификации
invoice_id	❌	integer	Идентификатор счета для фильтрации транзакций.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=transactions" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"transactions": [
{
"id": 123,
"amount": 50.0,
"date": "2024-01-01T10:00:00Z",
"description": "Payment for invoice #1"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "transactions: failed to retrive transactions - error_message"
}

whmcs/unpaidinvoices¶

Запуск процесса обработки (напоминания) по неоплаченным инвойсам за указанный период.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `unpaidinvoices`
period	✅	integer	Период в днях (от 0 до 5)
status	❌	string	Статус инвойса. По умолчанию: Unpaid.
notify_client	❌	boolean	Отправлять ли уведомление клиенту
location	❌	string	Идентификатор локации для выполнения операции по неоплаченным счетам.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=unpaidinvoices" \
--data "period=3" \
--data "status=Unpaid" \
--data "notify_client=true"

Пример успешного ответа

{
"result": -1,
"message": "5 invoices failed in a row, stopped at {invoice_id}"
}

Примеры ошибок

{
"code": -1,
"message": "5 invoices failed in a row, stopped at {invoice_id}"
}

whmcs/update_client¶

Обновление данных профиля клиента в WHMCS и локальной базе.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update_client`
profile_data[email]	❌	string	Email клиента (используется для сравнения и проверки уникальности)
profile_data[contact_id]	❌	integer	ID контакта
profile_data[firstname]	❌	string	Имя клиента (billing_firstname)
profile_data[lastname]	❌	string	Фамилия клиента (billing_lastname)
profile_data[billing_email]	❌	string	Email для биллинга
profile_data[co_smsnum]	❌	string	Номер телефона (SMS number)
profile_data[tg_username]	❌	string	Имя пользователя Telegram
profile_data[co_secret]	❌	string	Секретное слово для верификации
profile_data[ips]	❌	string	Список IP-адресов для ACL
token	✅	string	API-токен аутентификации
email	❌	string	Электронная почта пользователя для связи.
message	❌	string	Текстовое сообщение или комментарий к обновлению данных.
profile_data	❌	`array<string>`	Массив с данными профиля клиента для обновления.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=update_client" \
--data "token=YOUR_TOKEN" \
--data "profile_data[email]=test@example.com" \
--data "profile_data[firstname]=John"

Пример успешного ответа

{
"result": "success",
"billing_email": "example@mail.com",
"message": "Profile settings updated successfully"
}

Примеры ошибок

{
"code": -1,
"message": "invalid email"
}

whmcs/update_contact¶

Обновление данных дополнительного контакта клиента.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update_contact`
profile_data[email]	✅	string	Email контакта (обязательно)
profile_data[contact_id]	✅	integer	ID контакта
profile_data[firstname]	❌	string	Имя контакта. Если не указано, поле остается без изменений.
profile_data[lastname]	❌	string	Фамилия контакта. Если не указано, поле остается без изменений.
profile_data[phonenumber]	❌	string	Номер телефона контакта в международном формате.
profile_data[password1]	❌	string	Первая часть пароля для проверки соответствия.
profile_data[password2]	❌	string	Вторая часть пароля для подтверждения смены данных.
token	✅	string	API-токен аутентификации
email	✅	string	Электронная почта контактного лица для обновления данных.
client_id	❌	integer	Идентификатор клиента в системе WHMCS.
profile_data	✅	`array<string>`	Массив данных профиля контактного лица для обновления.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=update_contact" \
--data "profile_data[email]=example@mail.com" \
--data "profile_data[contact_id]=123" \
--data "token=YOUR_TOKEN" \
--data "email=user@example.com" \
--data "client_id=456" \
--data "profile_data[]=some_value" \
--data "profile_data[]=another_value"

Пример успешного ответа

{
"result": "success",
"contactid": 123
}

Примеры ошибок

{
"code": -1,
"message": "fill_required_fields"
}

whmcs/update_product¶

Обновление параметров сервера (статус, дата продления, домен и т.д.).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update_product`
element	✅	string	Поле для обновления. Допустимые значения: domain, dedicatedip, subscriptionid, due_date, overidesuspenduntil, billing_status, serviceusername, servicepassword, ns1, ns2, assignedips, notes, suspendreason, billing_cycle.
data	✅	string	Новое значение поля
token	✅	string	API-токен аутентификации
reason	❌	string	Причина приостановки или разблокировки сервиса
amount	❌	number	Сумма для обновления при изменении цикла оплаты
autosuspend	❌	string	Управление автоматической приостановкой обслуживания при отсутствии оплаты.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=update_product" \
--data "element=domain" \
--data "data=example.com" \
--data "token=YOUR_TOKEN"

Пример успешного ответа

{
"result": "success",
"inv_id": 123,
"serviceid": 456
}

Примеры ошибок

{
"code": -1,
"message": "invalid server's billing account id"
}

whmcs/updatevat¶

Обновление данных по налогу (VAT) в системе.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `updatevat`
-	-	-	Других параметров нет

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=updatevat"

Пример успешного ответа

{
"result": "OK",
"code": "VAT_UPDATED, NOT_ALLOWED_YET, NO_CHANGE_REQUIRED"
}

Примеры ошибок

{
"code": -1,
"message": "Error during VAT update"
}

whmcs/verify_email¶

Проверяет корректность email-адреса и отправляет код верификации или подтверждает изменение почты.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `verify_email`
token	✅	string	Токен авторизации запроса.
email	✅	string	Email адрес для верификации или новый email клиента.
data	❌	string	Код подтверждения (для завершения процесса верификации).

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=verify_email" \
--data "token=VALUE" \
--data "email=VALUE" \
--data "data=VALUE"

Пример успешного ответа

{
"result": "OK",
"state": "verified",
"status": "Email address is verified."
}

Примеры ошибок

{
"code": -1,
"message": "Email verification failed: incorrect code"
}

whmcs/verify_address¶

Проверяет адрес клиента через Google Maps API для подтверждения его корректности.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `verify_address`
token	✅	string	Токен авторизации запроса.
location	❌	string	Географическое положение или локация клиента для проверки адреса.
client_id	❌	integer	Уникальный идентификатор клиента в системе.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=verify_address" \
--data "token=YOUR_TOKEN"

Пример успешного ответа

{
"result": "OK",
"state": "verified",
"status": "Address is correct: [formatted_address]"
}

Примеры ошибок

{
"code": -1,
"message": "Адрес не найден или некорректен"
}

whmcs/request_refund¶

Инициирует процесс возврата неиспользованных денежных средств с баланса клиента. Проверяет наличие открытых тикетов в JIRA и лимиты кредитного баланса в WHMCS.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `request_refund`
token	✅	string	Токен авторизации
id	✅	integer	ID клиента или сущности
amount	✅	number	Сумма возврата. Должна быть больше 0 и не превышать доступный кредит в WHMCS.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=request_refund" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "amount=VALUE"

Пример успешного ответа

{
"result": "OK",
"ticket": "JIRA-12345"
}

Примеры ошибок

{
"code": -1,
"message": "refund_fail_invalid_amount"
}