WHMCS · Schema

WHMCS Client

A WHMCS client account representing a customer of the hosting provider.

Web HostingBilling AutomationClient ManagementDomain ManagementSupport TicketsProvisioning

Properties

Name	Type	Description
id	integer	Unique client identifier.
firstname	string	Client first name.
lastname	string	Client last name.
email	string	Client primary email address.
companyname	string	Client company name.
address1	string	Client billing address line 1.
address2	string	Client billing address line 2.
city	string	Client billing city.
state	string	Client billing state or region.
postcode	string	Client billing postal or zip code.
country	string	Client country (ISO 3166 2-letter code).
phonenumber	string	Client phone number.
status	string	Client account status.
credit	number	Account credit balance.
taxexempt	boolean	Whether the client is tax exempt.
groupid	integer	Client group ID.
currency	integer	Currency ID assigned to the client.
notes	string	Internal notes about the client.
datecreated	string	Date client account was created.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/whmcs/main/json-schema/whmcs-client-schema.json",
  "title": "WHMCS Client",
  "description": "A WHMCS client account representing a customer of the hosting provider.",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique client identifier."
    },
    "firstname": {
      "type": "string",
      "description": "Client first name."
    },
    "lastname": {
      "type": "string",
      "description": "Client last name."
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Client primary email address."
    },
    "companyname": {
      "type": "string",
      "description": "Client company name."
    },
    "address1": {
      "type": "string",
      "description": "Client billing address line 1."
    },
    "address2": {
      "type": "string",
      "description": "Client billing address line 2."
    },
    "city": {
      "type": "string",
      "description": "Client billing city."
    },
    "state": {
      "type": "string",
      "description": "Client billing state or region."
    },
    "postcode": {
      "type": "string",
      "description": "Client billing postal or zip code."
    },
    "country": {
      "type": "string",
      "description": "Client country (ISO 3166 2-letter code).",
      "minLength": 2,
      "maxLength": 2,
      "pattern": "^[A-Z]{2}$"
    },
    "phonenumber": {
      "type": "string",
      "description": "Client phone number."
    },
    "status": {
      "type": "string",
      "enum": ["Active", "Inactive", "Closed"],
      "description": "Client account status."
    },
    "credit": {
      "type": "number",
      "format": "float",
      "description": "Account credit balance."
    },
    "taxexempt": {
      "type": "boolean",
      "description": "Whether the client is tax exempt."
    },
    "groupid": {
      "type": "integer",
      "description": "Client group ID."
    },
    "currency": {
      "type": "integer",
      "description": "Currency ID assigned to the client."
    },
    "notes": {
      "type": "string",
      "description": "Internal notes about the client."
    },
    "datecreated": {
      "type": "string",
      "format": "date",
      "description": "Date client account was created."
    }
  },
  "required": ["id", "firstname", "lastname", "email", "status"],
  "additionalProperties": true
}