Class Reference (WHMCS 9.0)

Reference for WHMCS's developer-facing model classes.

• CustomField — Custom Fields model class

• Announcement — A client-facing general announcement.

• CurrentUser — Utility class for assessing the authentication state or identity of the current actor

• Currency — A currency.
• Invoice — A customer's invoice.
• Quote — A quote for client services.

• Item — Invoice line items Each invoice is made up of individual line items.

• DisputeInterface — DisputeInterface is used as part of the WHMCS\Billing\Payment\Dispute object to ensure that all required methods are present for output.
• Transaction — A payment transaction.

• DisputeCollection

• Information — The information class is used to provide additional data for a transaction from a gateway module.

• Item — Quote line items Each quote is made up of individual line items, like an Invoice.

• VatNumber

• VerificationInterface

• ItemInterface

• Setting — An individual setting stored in the tblconfiguration table.

• CustomFieldValue — Custom Fields Values model class

• AdditionalField — Domain additional fields.
• Domain — A customer's domain.
• Extra — Used to store information related to the domain that is not an additional field.

• Domain — Store information regarding the domain that can be used within the product without requiring additional Registrar calls.

• ResultsList
• SearchResult — Search results from a domain lookup query Contains the data of a domain and information about it potential availability Also can potentially get a list of like-domain suggests

• Premium — Pricing markup for premium domains

• Category — A download category All files available for download in WHMCS must be within at least one Category.
• Download — A downloadable file.

• Register — Register

• Message — An Email Message Messages are sent out for various reasons, including for events such as invoice creation and Email Campaigns.
• Template — Functionality related to mail templates.

• AbstractWidget — Abstract Widget.
• Queue — Module Queue

• Setting — Class Setting

• NotificationModuleInterface — Notification Module Interface All Notification modules must implement this interface
• SenderModuleInterface

• BalanceCollection — The BalanceCollection object is used to return data through a gateway module to display balance information on the Transactions List page in the WHMCS Admin area.
• BalanceInterface — BalanceInterface is used as part of the WHMCS\Module\Gateway\Balance object to ensure that all required methods are present for output.

• DescriptionTrait

• DescriptionTrait — Collection of behaviors common to all notification modules that help fulfill \WHMCS\Notification\Notification\NotificationModuleInterface

• CustomAction
• CustomActionCollection — The CustomActionCollection object is used to return data through a server module to display Custom Action items.

• NetworkIssue — A network issue.

• Rule — A notification rule.

• NotificationAttributeInterface — Interface that describes attributes of a notification
• NotificationInterface — Interface that describes a notification

• Addon — tbladdons model class
• Group — A product group A product group contains one or more order-able products and determines how those products are displayed in order forms to clients.
• Product — A product A product represents a sellable item in WHMCS.

• Price — Price per cycle formatting helper

• AbstractTask — AbstractTask

• Addon — Service addons Please note that "Service Addons" are completely separate from "WHMCS Addons," which add functionality to WHMCS.
• CancellationRequest — A service cancellation request Should a Client decide to cancel a Service, they create a CancellationRequest.
• Service — A client-owned service.

• MetricInterface — MetricInterface
• ProviderInterface — ProviderInterface
• UnitInterface — UnitInterface
• UsageInterface — UsageInterface

• Metric — Metric
• Usage — Usage

• AbstractUnit — AbstractUnit
• Bytes — MegaBytes
• FloatingPoint — FloatingPoint
• GigaBytes — GigaBytes
• KiloBytes — KiloBytes
• MegaBytes — MegaBytes
• WholeNumber — WholeNumber

• Admin — An administrative user An administrative user is responsible for operation and maintenance of a WHMCS installation.
• AdminLog — An administrative user login Each log entry in this table represents a single login session for an administrative user.
• Alert — A user level alert Alerts are intended to be displayed in the product as quick notifications generated on the fly for WHMCS users.
• Client — A client user.

• Affiliate — Client affiliate information If a WHMCS operator turns on the affiliate payment system, then a client account can become an affiliate.
• Contact — A client contact Client users may have more than one set of contact information on their account.
• Group — A Client Group.

• Price — Price Formatter.

• Item — An item in one of WHMCS's client area menus.

• AssetUtil — AssetUtil