Sign in

v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB
Customers

Create a new customer

Create a customer record. The externalId should be unique and map to your application's user ID.

post/api/customers

Request body

externalIdstring required

Tenant's user ID

emailstring required
namestring
countrystring
currencystring required

ISO currency code

metadataobject

Custom metadata

netPaymentTermsnumber

Net payment terms in days (overrides org and plan defaults)

createdAtstring

Backdate createdAt (ISO 8601). For data imports.

Example request

{
  "externalId": "user_12345",
  "email": "customer@example.com",
  "name": "Jane Doe",
  "country": "NG",
  "currency": "NGN",
  "netPaymentTerms": 30
}

Response

Customer created successfully

idstring required
externalIdstring required
emailstring required
namestring
countrystring
currencystring required
metadataobject
createdAtstring required
updatedAtstring required

Example response

{
  "id": "clx1234567890",
  "externalId": "user_12345",
  "email": "customer@example.com",
  "name": "Jane Doe",
  "country": "US",
  "currency": "USD"
}