{"templateId":"markdown","versions":[{"version":"9.0","label":"9.0","link":"/classes","default":true,"active":true,"folderId":"9d7dc099"},{"version":"8.13","label":"8.13","link":"/classes/8.13","default":false,"active":false,"folderId":"9d7dc099"}],"sharedDataIds":{"sidebar":"sidebar-classes/@8.13/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Class Reference (WHMCS 9.0)","description":"Developer documentation for the WHMCS API — the","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"class-reference-whmcs-90","__idx":0},"children":["Class Reference (WHMCS 9.0)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reference for WHMCS's developer-facing model classes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcs","__idx":1},"children":["WHMCS"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/customfield"},"children":["CustomField"]}," — Custom Fields model class"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsannouncement","__idx":2},"children":["WHMCS\\Announcement"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/announcement/announcement"},"children":["Announcement"]}," — A client-facing general announcement."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsauthentication","__idx":3},"children":["WHMCS\\Authentication"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/authentication/currentuser"},"children":["CurrentUser"]}," — Utility class for assessing the authentication state or identity of the current actor"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsbilling","__idx":4},"children":["WHMCS\\Billing"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/billing/currency"},"children":["Currency"]}," — A currency."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/billing/invoice"},"children":["Invoice"]}," — A customer's invoice."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/billing/quote"},"children":["Quote"]}," — A quote for client services."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsbillinginvoice","__idx":5},"children":["WHMCS\\Billing\\Invoice"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/billing/invoice/item"},"children":["Item"]}," — Invoice line items Each invoice is made up of individual line items."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsbillingpayment","__idx":6},"children":["WHMCS\\Billing\\Payment"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/billing/payment/disputeinterface"},"children":["DisputeInterface"]}," — DisputeInterface is used as part of the WHMCS\\Billing\\Payment\\Dispute object to ensure that all required methods are present for output."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/billing/payment/transaction"},"children":["Transaction"]}," — A payment transaction."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsbillingpaymentdispute","__idx":7},"children":["WHMCS\\Billing\\Payment\\Dispute"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/billing/payment/dispute/disputecollection"},"children":["DisputeCollection"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsbillingpaymenttransaction","__idx":8},"children":["WHMCS\\Billing\\Payment\\Transaction"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/billing/payment/transaction/information"},"children":["Information"]}," — The information class is used to provide additional data for a transaction from a gateway module."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsbillingquote","__idx":9},"children":["WHMCS\\Billing\\Quote"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/billing/quote/item"},"children":["Item"]}," — Quote line items Each quote is made up of individual line items, like an Invoice."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsbillingvat","__idx":10},"children":["WHMCS\\Billing\\VAT"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/billing/vat/vatnumber"},"children":["VatNumber"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsbillingvatverification","__idx":11},"children":["WHMCS\\Billing\\VAT\\Verification"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/billing/vat/verification/verificationinterface"},"children":["VerificationInterface"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcscartitem","__idx":12},"children":["WHMCS\\Cart\\Item"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/cart/item/iteminterface"},"children":["ItemInterface"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsconfig","__idx":13},"children":["WHMCS\\Config"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/config/setting"},"children":["Setting"]}," — An individual setting stored in the tblconfiguration table."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcscustomfield","__idx":14},"children":["WHMCS\\CustomField"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/customfield/customfieldvalue"},"children":["CustomFieldValue"]}," — Custom Fields Values model class"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsdomain","__idx":15},"children":["WHMCS\\Domain"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/domain/additionalfield"},"children":["AdditionalField"]}," — Domain additional fields."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/domain/domain"},"children":["Domain"]}," — A customer's domain."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/domain/extra"},"children":["Extra"]}," — Used to store information related to the domain that is not an additional field."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsdomainregistrar","__idx":16},"children":["WHMCS\\Domain\\Registrar"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/domain/registrar/domain"},"children":["Domain"]}," — Store information regarding the domain that can be used within the product without requiring additional Registrar calls."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsdomainsdomainlookup","__idx":17},"children":["WHMCS\\Domains\\DomainLookup"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/domains/domainlookup/resultslist"},"children":["ResultsList"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/domains/domainlookup/searchresult"},"children":["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"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsdomainspricing","__idx":18},"children":["WHMCS\\Domains\\Pricing"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/domains/pricing/premium"},"children":["Premium"]}," — Pricing markup for premium domains"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsdownload","__idx":19},"children":["WHMCS\\Download"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/download/category"},"children":["Category"]}," — A download category All files available for download in WHMCS must be within at least one Category."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/download/download"},"children":["Download"]}," — A downloadable file."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcslog","__idx":20},"children":["WHMCS\\Log"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/log/register"},"children":["Register"]}," — Register"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsmail","__idx":21},"children":["WHMCS\\Mail"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/mail/message"},"children":["Message"]}," — An Email Message Messages are sent out for various reasons, including for events such as invoice creation and Email Campaigns."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/mail/template"},"children":["Template"]}," — Functionality related to mail templates."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsmodule","__idx":22},"children":["WHMCS\\Module"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/module/abstractwidget"},"children":["AbstractWidget"]}," — Abstract Widget."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/module/queue"},"children":["Queue"]}," — Module Queue"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsmoduleaddon","__idx":23},"children":["WHMCS\\Module\\Addon"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/module/addon/setting"},"children":["Setting"]}," — Class Setting"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsmodulecontracts","__idx":24},"children":["WHMCS\\Module\\Contracts"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/module/contracts/notificationmoduleinterface"},"children":["NotificationModuleInterface"]}," — Notification Module Interface All Notification modules must implement this interface"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/module/contracts/sendermoduleinterface"},"children":["SenderModuleInterface"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsmodulegateway","__idx":25},"children":["WHMCS\\Module\\Gateway"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/module/gateway/balancecollection"},"children":["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."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/module/gateway/balanceinterface"},"children":["BalanceInterface"]}," — BalanceInterface is used as part of the WHMCS\\Module\\Gateway\\Balance object to ensure that all required methods are present for output."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsmodulemailsender","__idx":26},"children":["WHMCS\\Module\\MailSender"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/module/mailsender/descriptiontrait"},"children":["DescriptionTrait"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsmodulenotification","__idx":27},"children":["WHMCS\\Module\\Notification"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/module/notification/descriptiontrait"},"children":["DescriptionTrait"]}," — Collection of behaviors common to all notification modules that help fulfill \\WHMCS\\Notification\\Notification\\NotificationModuleInterface"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsmoduleserver","__idx":28},"children":["WHMCS\\Module\\Server"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/module/server/customaction"},"children":["CustomAction"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/module/server/customactioncollection"},"children":["CustomActionCollection"]}," — The CustomActionCollection object is used to return data through a server module to display Custom Action items."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsnetwork","__idx":29},"children":["WHMCS\\Network"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/network/networkissue"},"children":["NetworkIssue"]}," — A network issue."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsnotification","__idx":30},"children":["WHMCS\\Notification"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/notification/rule"},"children":["Rule"]}," — A notification rule."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsnotificationcontracts","__idx":31},"children":["WHMCS\\Notification\\Contracts"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/notification/contracts/notificationattributeinterface"},"children":["NotificationAttributeInterface"]}," — Interface that describes attributes of a notification"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/notification/contracts/notificationinterface"},"children":["NotificationInterface"]}," — Interface that describes a notification"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsproduct","__idx":32},"children":["WHMCS\\Product"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/product/addon"},"children":["Addon"]}," — tbladdons model class"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/product/group"},"children":["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."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/product/product"},"children":["Product"]}," — A product A product represents a sellable item in WHMCS."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsproductpricing","__idx":33},"children":["WHMCS\\Product\\Pricing"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/product/pricing/price"},"children":["Price"]}," — Price per cycle formatting helper"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsschedulingtask","__idx":34},"children":["WHMCS\\Scheduling\\Task"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/scheduling/task/abstracttask"},"children":["AbstractTask"]}," — AbstractTask"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsservice","__idx":35},"children":["WHMCS\\Service"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/service/addon"},"children":["Addon"]}," — Service addons Please note that \"Service Addons\" are completely separate from \"WHMCS Addons,\" which add functionality to WHMCS."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/service/cancellationrequest"},"children":["CancellationRequest"]}," — A service cancellation request Should a Client decide to cancel a Service, they create a CancellationRequest."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/service/service"},"children":["Service"]}," — A client-owned service."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsusagebillingcontractsmetrics","__idx":36},"children":["WHMCS\\UsageBilling\\Contracts\\Metrics"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/usagebilling/contracts/metrics/metricinterface"},"children":["MetricInterface"]}," — MetricInterface"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/usagebilling/contracts/metrics/providerinterface"},"children":["ProviderInterface"]}," — ProviderInterface"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/usagebilling/contracts/metrics/unitinterface"},"children":["UnitInterface"]}," — UnitInterface"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/usagebilling/contracts/metrics/usageinterface"},"children":["UsageInterface"]}," — UsageInterface"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsusagebillingmetrics","__idx":37},"children":["WHMCS\\UsageBilling\\Metrics"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/usagebilling/metrics/metric"},"children":["Metric"]}," — Metric"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/usagebilling/metrics/usage"},"children":["Usage"]}," — Usage"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsusagebillingmetricsunits","__idx":38},"children":["WHMCS\\UsageBilling\\Metrics\\Units"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/usagebilling/metrics/units/abstractunit"},"children":["AbstractUnit"]}," — AbstractUnit"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/usagebilling/metrics/units/bytes"},"children":["Bytes"]}," — MegaBytes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/usagebilling/metrics/units/floatingpoint"},"children":["FloatingPoint"]}," — FloatingPoint"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/usagebilling/metrics/units/gigabytes"},"children":["GigaBytes"]}," — GigaBytes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/usagebilling/metrics/units/kilobytes"},"children":["KiloBytes"]}," — KiloBytes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/usagebilling/metrics/units/megabytes"},"children":["MegaBytes"]}," — MegaBytes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/usagebilling/metrics/units/wholenumber"},"children":["WholeNumber"]}," — WholeNumber"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsuser","__idx":39},"children":["WHMCS\\User"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/user/admin"},"children":["Admin"]}," — An administrative user An administrative user is responsible for operation and maintenance of a WHMCS installation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/user/adminlog"},"children":["AdminLog"]}," — An administrative user login Each log entry in this table represents a single login session for an administrative user."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/user/alert"},"children":["Alert"]}," — A user level alert Alerts are intended to be displayed in the product as quick notifications generated on the fly for WHMCS users."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/user/client"},"children":["Client"]}," — A client user."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsuserclient","__idx":40},"children":["WHMCS\\User\\Client"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/user/client/affiliate"},"children":["Affiliate"]}," — Client affiliate information If a WHMCS operator turns on the affiliate payment system, then a client account can become an affiliate."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/user/client/contact"},"children":["Contact"]}," — A client contact Client users may have more than one set of contact information on their account."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/user/client/group"},"children":["Group"]}," — A Client Group."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsviewformatter","__idx":41},"children":["WHMCS\\View\\Formatter"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/view/formatter/price"},"children":["Price"]}," — Price Formatter."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsviewmenu","__idx":42},"children":["WHMCS\\View\\Menu"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/view/menu/item"},"children":["Item"]}," — An item in one of WHMCS's client area menus."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whmcsviewtemplate","__idx":43},"children":["WHMCS\\View\\Template"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/classes/whmcs/view/template/assetutil"},"children":["AssetUtil"]}," — AssetUtil"]}]}]},"headings":[{"value":"Class Reference (WHMCS 9.0)","id":"class-reference-whmcs-90","depth":1},{"value":"WHMCS","id":"whmcs","depth":2},{"value":"WHMCS\\Announcement","id":"whmcsannouncement","depth":2},{"value":"WHMCS\\Authentication","id":"whmcsauthentication","depth":2},{"value":"WHMCS\\Billing","id":"whmcsbilling","depth":2},{"value":"WHMCS\\Billing\\Invoice","id":"whmcsbillinginvoice","depth":2},{"value":"WHMCS\\Billing\\Payment","id":"whmcsbillingpayment","depth":2},{"value":"WHMCS\\Billing\\Payment\\Dispute","id":"whmcsbillingpaymentdispute","depth":2},{"value":"WHMCS\\Billing\\Payment\\Transaction","id":"whmcsbillingpaymenttransaction","depth":2},{"value":"WHMCS\\Billing\\Quote","id":"whmcsbillingquote","depth":2},{"value":"WHMCS\\Billing\\VAT","id":"whmcsbillingvat","depth":2},{"value":"WHMCS\\Billing\\VAT\\Verification","id":"whmcsbillingvatverification","depth":2},{"value":"WHMCS\\Cart\\Item","id":"whmcscartitem","depth":2},{"value":"WHMCS\\Config","id":"whmcsconfig","depth":2},{"value":"WHMCS\\CustomField","id":"whmcscustomfield","depth":2},{"value":"WHMCS\\Domain","id":"whmcsdomain","depth":2},{"value":"WHMCS\\Domain\\Registrar","id":"whmcsdomainregistrar","depth":2},{"value":"WHMCS\\Domains\\DomainLookup","id":"whmcsdomainsdomainlookup","depth":2},{"value":"WHMCS\\Domains\\Pricing","id":"whmcsdomainspricing","depth":2},{"value":"WHMCS\\Download","id":"whmcsdownload","depth":2},{"value":"WHMCS\\Log","id":"whmcslog","depth":2},{"value":"WHMCS\\Mail","id":"whmcsmail","depth":2},{"value":"WHMCS\\Module","id":"whmcsmodule","depth":2},{"value":"WHMCS\\Module\\Addon","id":"whmcsmoduleaddon","depth":2},{"value":"WHMCS\\Module\\Contracts","id":"whmcsmodulecontracts","depth":2},{"value":"WHMCS\\Module\\Gateway","id":"whmcsmodulegateway","depth":2},{"value":"WHMCS\\Module\\MailSender","id":"whmcsmodulemailsender","depth":2},{"value":"WHMCS\\Module\\Notification","id":"whmcsmodulenotification","depth":2},{"value":"WHMCS\\Module\\Server","id":"whmcsmoduleserver","depth":2},{"value":"WHMCS\\Network","id":"whmcsnetwork","depth":2},{"value":"WHMCS\\Notification","id":"whmcsnotification","depth":2},{"value":"WHMCS\\Notification\\Contracts","id":"whmcsnotificationcontracts","depth":2},{"value":"WHMCS\\Product","id":"whmcsproduct","depth":2},{"value":"WHMCS\\Product\\Pricing","id":"whmcsproductpricing","depth":2},{"value":"WHMCS\\Scheduling\\Task","id":"whmcsschedulingtask","depth":2},{"value":"WHMCS\\Service","id":"whmcsservice","depth":2},{"value":"WHMCS\\UsageBilling\\Contracts\\Metrics","id":"whmcsusagebillingcontractsmetrics","depth":2},{"value":"WHMCS\\UsageBilling\\Metrics","id":"whmcsusagebillingmetrics","depth":2},{"value":"WHMCS\\UsageBilling\\Metrics\\Units","id":"whmcsusagebillingmetricsunits","depth":2},{"value":"WHMCS\\User","id":"whmcsuser","depth":2},{"value":"WHMCS\\User\\Client","id":"whmcsuserclient","depth":2},{"value":"WHMCS\\View\\Formatter","id":"whmcsviewformatter","depth":2},{"value":"WHMCS\\View\\Menu","id":"whmcsviewmenu","depth":2},{"value":"WHMCS\\View\\Template","id":"whmcsviewtemplate","depth":2}],"frontmatter":{"title":"Class Reference","markdown":{"toc":{"hide":true}},"seo":{"title":"Class Reference (WHMCS 9.0)"}},"lastModified":"2026-08-05T15:24:03.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/classes","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}