vocabulary:
  name: WHMCS Vocabulary
  description: >-
    Vocabulary and taxonomy for WHMCS (Web Host Manager Complete Solution), a leading
    web hosting automation platform for billing, client management, support, domain
    management, and provisioning.
  version: 1.0.0
  created: '2026-05-03'
  modified: '2026-05-03'
  tags:
    - Web Hosting
    - Billing Automation
    - Client Management
    - Domain Management
    - Support

terms:
  - term: Client
    definition: >-
      A customer account in WHMCS representing a hosting customer. Clients have
      billing details, services, domains, invoices, and support tickets associated
      with their account.
    tags:
      - Core Entity
      - Account Management

  - term: Product
    definition: >-
      A hosting product or service offered through WHMCS, such as shared hosting,
      VPS, dedicated servers, or any custom service. Products belong to product groups.
    tags:
      - Core Entity
      - Billing

  - term: Order
    definition: >-
      A purchase transaction in WHMCS containing one or more products, domains,
      or add-ons. Orders go through a workflow from pending to active.
    tags:
      - Core Entity
      - Billing

  - term: Invoice
    definition: >-
      A billing document in WHMCS sent to clients for payment. Invoices have
      statuses: Unpaid, Paid, Cancelled, Refunded, Collections, or Draft.
    tags:
      - Core Entity
      - Billing

  - term: Ticket
    definition: >-
      A support request submitted by or for a client in WHMCS. Tickets are
      assigned to departments and tracked through Open, Answered, Customer-Reply,
      and Closed statuses.
    tags:
      - Core Entity
      - Support

  - term: Domain
    definition: >-
      A domain name registered or transferred through WHMCS, managed via
      registrar modules. Domain actions include register, renew, transfer, and release.
    tags:
      - Core Entity
      - Domain Management

  - term: Module
    definition: >-
      A WHMCS extension that provides integration with external systems. Module types
      include provisioning (servers), payment gateways, registrars, and add-ons.
    tags:
      - Extensibility
      - Integration

  - term: Provisioning Module
    definition: >-
      A WHMCS module that connects to a server or service platform (e.g., cPanel, Plesk)
      to automatically create, suspend, unsuspend, and terminate hosting accounts.
    tags:
      - Module
      - Automation

  - term: Payment Gateway
    definition: >-
      A WHMCS module integration with a payment processor (PayPal, Stripe, Authorize.Net)
      to process invoice payments from clients.
    tags:
      - Billing
      - Integration

  - term: Registrar Module
    definition: >-
      A WHMCS module that connects to a domain registrar to automate domain
      registration, renewal, transfer, and management.
    tags:
      - Module
      - Domain Management

  - term: Add-on
    definition: >-
      An optional service that can be attached to a client's hosting product for
      additional recurring billing, such as extra storage or SSL certificates.
    tags:
      - Billing
      - Product

  - term: API Credential
    definition: >-
      An identifier/secret key pair generated in the WHMCS admin area to authenticate
      API requests from external applications. Replaces legacy username/password auth.
    tags:
      - Authentication
      - Security

  - term: SSO Token
    definition: >-
      A single sign-on token generated by the WHMCS API to allow a client to log
      into the WHMCS client area without entering their password. Used for custom
      portal integrations.
    tags:
      - Authentication
      - Integration

  - term: Hook
    definition: >-
      A WHMCS event callback system that allows custom code to execute when specific
      actions occur in WHMCS, such as InvoicePaid, ClientAdd, or TicketOpen.
    tags:
      - Extensibility
      - Events

  - term: Template
    definition: >-
      A Smarty-based theme template for customizing the appearance of the WHMCS
      client area and order forms.
    tags:
      - Customization
      - UI

  - term: Automation
    definition: >-
      WHMCS's scheduled task system that runs automatic invoice generation, domain
      renewal reminders, service termination, and other recurring operations.
    tags:
      - Automation
      - System

  - term: Credit
    definition: >-
      A positive balance on a client's account that can be applied to future invoices.
      Credits can be added manually or applied via refunds.
    tags:
      - Billing
      - Finance

  - term: TLD
    definition: >-
      Top-Level Domain. WHMCS supports configuring pricing, registrar, and
      availability settings for each TLD extension (.com, .net, .org, etc.).
    tags:
      - Domain Management

api-commands:
  clients:
    - AddClient
    - UpdateClient
    - DeleteClient
    - GetClients
    - GetClientsDetails
    - CloseClient
    - GetContacts
    - AddContact
    - DeleteContact
    - UpdateContact

  orders:
    - AddOrder
    - GetOrders
    - CancelOrder
    - DeleteOrder
    - AcceptOrder
    - PendingOrder
    - FraudOrder
    - GetProducts
    - GetPromotions
    - GetOrderStatuses

  billing:
    - CreateInvoice
    - UpdateInvoice
    - GetInvoice
    - GetInvoices
    - AddInvoicePayment
    - GenInvoices
    - CreateQuote
    - UpdateQuote
    - DeleteQuote
    - GetQuotes
    - AcceptQuote
    - SendQuote
    - AddCredit
    - GetCredits
    - CapturePayment
    - AddPayMethod
    - UpdatePayMethod
    - DeletePayMethod
    - GetPayMethods
    - AddTransaction
    - GetTransactions
    - AddBillableItem

  domains:
    - DomainRegister
    - DomainRenew
    - DomainTransfer
    - DomainRelease
    - DomainWhois
    - DomainGetNameservers
    - DomainUpdateNameservers
    - DomainGetWhoisInfo
    - DomainUpdateWhoisInfo
    - DomainGetLockingStatus
    - DomainUpdateLockingStatus
    - DomainToggleIdProtect
    - DomainRequestEPP
    - GetTLDPricing
    - GetRegistrars
    - UpdateClientDomain
    - CreateOrUpdateTLD

  support:
    - OpenTicket
    - GetTicket
    - GetTickets
    - UpdateTicket
    - DeleteTicket
    - AddTicketReply
    - UpdateTicketReply
    - DeleteTicketReply
    - AddTicketNote
    - GetTicketNotes
    - DeleteTicketNote
    - BlockTicketSender
    - MergeTicket
    - GetSupportDepartments
    - GetSupportStatuses
    - GetTicketCounts
    - GetTicketAttachment
    - GetTicketPredefinedCats
    - GetTicketPredefinedReplies

  services:
    - ModuleCreate
    - ModuleTerminate
    - ModuleSuspend
    - ModuleUnsuspend
    - ModuleChangePw
    - ModuleChangePackage
    - ModuleCustom
    - UpdateClientProduct
    - UpgradeProduct
    - UpdateClientAddon
    - GetClientsProducts
    - GetClientsAddons
    - GetCancelledPackages

  system:
    - WhmcsDetails
    - GetStats
    - GetAdminDetails
    - GetAdminUsers
    - GetConfigurationValue
    - SetConfigurationValue
    - GetActivityLog
    - GetAutomationLog
    - LogActivity
    - SendEmail
    - SendAdminEmail
    - GetCurrencies
    - GetEmailTemplates
    - GetPaymentMethods
    - GetStaffOnline
    - GetToDoItems
    - GetToDoItemStatuses
    - UpdateToDoItem
    - UpdateAdminNotes
    - AddBannedIp
    - GetHealthStatus
    - GetServers
    - EncryptPassword
    - DecryptPassword
    - TriggerNotificationEvent

  authentication:
    - ValidateLogin
    - CreateSsoToken
    - CreateOAuthCredential
    - UpdateOAuthCredential
    - DeleteOAuthCredential
    - ListOAuthCredentials
    - ResetPassword

  users:
    - AddUser
    - UpdateUser
    - GetUsers
    - DeleteUserClient
    - GetPermissionsList
    - GetUserPermissions
    - UpdateUserPermissions
    - CreateClientInvite

  projects:
    - CreateProject
    - GetProject
    - GetProjects
    - UpdateProject
    - AddProjectTask
    - UpdateProjectTask
    - DeleteProjectTask
    - AddProjectMessage
    - StartTaskTimer
    - EndTaskTimer

  affiliates:
    - AffiliateActivate
    - GetAffiliates

  modules:
    - ActivateModule
    - DeactivateModule
    - GetModuleConfigurationParameters
    - GetModuleQueue
    - UpdateModuleConfiguration