CustomerInput

A new customer.

name
Type: string
min length:
1
max length:
1000
required

Display name.
billingAddress
Type: nullable

Billing address.

Properties: 6
creationState
Type: "draft" or "active"enum

draft while you're still setting the customer up, active when it's ready.
defaultCurrency
Type: string

ISO 4217 currency code to bill the customer in; any case, stored in upper case. Defaults to your organisation's currency. Can't be changed later.
email
Type: string
max length:
320Format: email

Billing email address.
externalId
Type: string | null
min length:
1
max length:
255

Your ID for the customer. Must not be another customer's external ID, alias or unit key, ignoring case. The customer's root unit is keyed by it.
legalName
Type: string | null
min length:
1
max length:
1000

Registered legal name, for invoices.
metadata
Type: nullable

Your own key-value data, or null.

Properties: 1
phone
Type: string
max length:
100

Phone number.
vatNumber
Type: string | null
min length:
1
max length:
100

VAT or other tax registration number.
website
Type: string
max length:
1000

Website.