Skip to main content
PUT
Update customer

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

sequence-version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Path Parameters

id
string
required

Customer ID

Body

application/json

Legal name

Example:

"John Doe"

taxStatus
enum<string>
required

Tax status applicable to customer. Can be one of TAXED, TAX_EXEMPT or REVERSE_CHARGED. The default is TAXED.

Available options:
TAXED,
TAX_EXEMPT,
REVERSE_CHARGED
Example:

"TAXED"

contacts
object[]
required

Contacts to create for this customer. This will replace all existing contacts for this customer. When any contact sends purposes, exactly one contact must have BILLING in purposes. When only the deprecated billingPreference is sent, at most one contact can be 'PRIMARY', and one is required if any contact is 'STANDARD'.

Example:
address
object
deprecated

Address

Example:
addresses
object[]

The customer's addresses, each with the purposes it serves. At most one address can be BILLING and at most one SHIPPING, and one address can be both. When sent, this list replaces all of the customer's addresses and the deprecated address field is ignored. Send an empty list to remove every address. null is not accepted. When this field is left out, the deprecated address field becomes the customer's only address, serving billing: sending an address replaces every address with it, and leaving address out or sending null removes every address, shipping included.

Example:
url
string | null

URL

Example:

"https://example.com/"

label
string | null

Label

Example:

"Example customer"

customerAliases
string[] | null

Customer aliases

Example:
integrationIds
object[] | null

IDs in external integrations

Example:
parentId
string | null

ID of a parent customer. Populate this field to create a new customeras a child customer of another, existing customer.

Example:

"50af5191-05a3-42a5-802a-6b59091157af"

pushToIntegrations
enum<string>[] | null

Automatically create customer in these linked integrations

Available options:
Xero
Example:
status
enum<string> | null

Customer status:

  • DRAFT means the customer has been extracted from a contract and has not yet been approved. It cannot be used while it is in DRAFT.
  • ACTIVE is the default state when a customer is created via API or dashboard.
Available options:
DRAFT,
ACTIVE
Example:

"ACTIVE"

customProperties
object | null

Custom key-value properties. Providing this field replaces all existing custom properties. Omitting it leaves them unchanged.

Example:

Response

OK

id
string
required

Unique ID

Example:

"e309e948-088e-4d77-b654-cd85498f1555"

createdAt
string
required

Time at which the customer was initially created, in ISO 8601 format

Example:

"2021-01-02T10:55:00Z"

organizations
object[]
required

Organizations that this customer is a member of

Example:

Legal name

Example:

"Fintech Payment Processing"

address
object
required
deprecated

Address

Example:
addresses
object[]
required

The customer's addresses, each with the purposes it serves. At most one address is BILLING and at most one SHIPPING, and one address can be both. Empty when the customer has no addresses. The deprecated address field holds the BILLING address, or a placeholder with an empty line1, town and postcode when there is none.

Example:
integrationIds
object[]
required

External services which are linked to this customer

Example:
taxStatus
enum<string>
required

Tax status applicable to customer. Can be one of TAXED, TAX_EXEMPT or REVERSE_CHARGED. The default is TAXED.

Available options:
TAXED,
TAX_EXEMPT,
REVERSE_CHARGED
Example:

"TAXED"

contacts
object[]
required

Contacts for this customer

Example:
status
enum<string>
required

Customer status:

  • DRAFT means the customer has been extracted from a contract and has not yet been approved. It cannot be used while it is in DRAFT.
  • ACTIVE is the default state when a customer is created via API or dashboard.
Available options:
DRAFT,
ACTIVE
Example:

"ACTIVE"

customProperties
object
required

Custom key-value properties for this customer

Example:
url
string | null

URL

Example:

"https://example.com/"

domain
string | null

Customer's primary domain name

Example:

"example.com"

label
string | null

Label

Example:

"Example customer"

archivedAt
string | null

Time at which the customer was archived, in ISO 8601 format

Example:

"2025-08-28T12:00:00Z"