WHMCS icon

WHMCS

Interact with the WHMCS billing & automation API

Client → Create

AI-generated

Summary

Create a new WHMCS client

Inputs

  • firstname (required) — First name of the client.
  • lastname (required) — Last name of the client.
  • email (required) — Email address of the client.
  • password2 (required) — New client portal password.
  • address1 — Address 1.
  • city — City.
  • groupid — Client Group ID.
  • companyname — Company Name.
  • country — Country (two‑letter ISO code, e.g. US).
  • currency — Currency ID.
  • phonenumber — Phone Number.
  • postcode — Postcode.
  • noemail — Skip Welcome Email.
  • state — State.
  • customParameters — Additional WHMCS parameters (key/value pairs).

Output shape

a single created client record

Returns the newly created client object including its generated ID; errors are propagated as node errors.

Examples

Example 1: Create a new client with minimal required fields

Set firstname, lastname, email, and password2 then execute.

Example 2: Create a client with additional address information

Fill firstname, lastname, email, password2, address1, city, country, and currency before execution.

Example 3: Create a client and add custom parameters

Add customParameters such as {"customfields": "VIP"} to include extra data.

Links

Discussion