Request Access
Sign in
Request Access

Customers

Create customer

Guides

API Reference

API Reference

Getting Started
Authentication
Versioning
Changes
Webhooks

Latest Live API

Account
Billing
Collections
Customer
Invoices
Notifications
Product
Taxes
Usage

Version 2024-07-30

Account
Billing
Collections
Customer
- Customers
- Organizations
- Customer Aliases
- Contacts
Invoices
Notifications
Product
Taxes
Usage

Customers

Create customer

Create a new customer, who you can send money to and receive money from.

POST

customers

Authorization

string

Authorization

Required

string

Your API credentials. Eg. Basic {credentials}.

Sequence-Version

enum<string>

Sequence-Version

enum<string>

Use this header to select an API version

object

Required

object

Add Example Value

legalName

string

legalName

Required

string

Legal name

Add Example Value

address

object

address

Required

object

Address

Add Example Value

line1

string

line1

Required

string

Address line 1

Add Example Value

town

string

town

Required

string

Town or city

Add Example Value

state

enum<string>

state

enum<string>

State (required for USA only)

Add Example Value

postcode

string

postcode

Required

string

Postal code

Add Example Value

country

enum<string>

country

Required

enum<string>

Country code (ISO 3166-1 alpha-2)

Add Example Value

url

string

url

string

URL

Add Example Value

label

string

label

string

Label

Add Example Value

taxStatus

enum<string>

taxStatus

Required

enum<string>

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

Add Example Value

customerAliases

array

customerAliases

array

Customer aliases

Add Example Value

integrationIds

array

integrationIds

array

IDs in external integrations

Add Example Value

parentId

string

parentId

string

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

Add Example Value

contacts

array

contacts

Required

array

Contacts to create for this customer. This will replace all existing contacts for this customer.

Add Example Value

pushToIntegrations

array

pushToIntegrations

array

Automatically create customer in these linked integrations

Add Example Value

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

Body

application/json

legalName

string

required

Legal name

address

object

required

Address

address.line1

string

required

Address line 1

address.town

string

required

Town or city

address.postcode

string

required

Postal code

address.country

enum<string>

required

Country code (ISO 3166-1 alpha-2)

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XK,

YE,

YT,

ZA,

ZM,

ZW

address.state

enum<string>

State (required for USA only)

Available options:

AL,

AK,

AZ,

AR,

CA,

CO,

CT,

DC,

DE,

FL,

GA,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY,

AB,

BC,

MB,

NB,

NL,

NS,

NT,

NU,

ON,

PE,

QC,

SK,

YT

taxStatus

enum<string>

required

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

Available options:

TAXED,

TAX_EXEMPT,

REVERSE_CHARGED

contacts

object[]

required

Contacts to create for this customer. This will replace all existing contacts for this customer.

contacts.name

string

required

Full name of this contact

contacts.email

string

required

Email address of this contact

contacts.billingPreference

enum<string>

required

Billing preference. Whether this contact receives billing communications. Options are NONE, STANDARD or PRIMARY. For a given customer, if any contacts receive billing communications then at least one contact must be designated PRIMARY for billing.

Available options:

PRIMARY,

STANDARD,

NONE

url

string

URL

label

string

Label

customerAliases

string[]

Customer aliases

integrationIds

object[]

IDs in external integrations

integrationIds.service

enum<string>

required

Available options:

Amazon_Redshift,

Google_BigQuery,

Google_Sheets,

HubSpot,

NetSuite,

QuickBooks_Online,

Salesforce,

Slack,

Snowflake,

Stripe,

Xero,

Avalara,

Anrok

integrationIds.id

string

required

parentId

string

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

pushToIntegrations

enum<string>[]

Automatically create customer in these linked integrations

Available options:

Xero

Response

201 - application/json

string

required

Unique ID

createdAt

string

required

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

organizations

object[]

required

Organizations that this customer is a member of

organizations.id

string

required

Organization ID

organizations.owner

object

required

ID of the customer that will own the organization.

organizations.owner.id

string

required

Customer ID

organizations.owner.name

string

required

Customer legal name

organizations.members

object[]

required

Members of the customer organization, excluding the owner. These are the children in a parent-child relationship.

organizations.members.id

string

required

Customer ID

organizations.members.name

string

required

Customer legal name

legalName

string

required

Legal name

address

object

required

Address

address.line1

string

required

Address line 1

address.town

string

required

Town or city

address.postcode

string

required

Postal code

address.country

enum<string>

required

Country code (ISO 3166-1 alpha-2)

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XK,

YE,

YT,

ZA,

ZM,

ZW

address.state

enum<string>

State (required for USA only)

Available options:

AL,

AK,

AZ,

AR,

CA,

CO,

CT,

DC,

DE,

FL,

GA,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY,

AB,

BC,

MB,

NB,

NL,

NS,

NT,

NU,

ON,

PE,

QC,

SK,

YT

integrationIds

object[]

required

External services which are linked to this customer

integrationIds.service

enum<string>

required

Available options:

Amazon_Redshift,

Google_BigQuery,

Google_Sheets,

HubSpot,

NetSuite,

QuickBooks_Online,

Salesforce,

Slack,

Snowflake,

Stripe,

Xero,

Avalara,

Anrok

integrationIds.id

string

required

integrationIds.lastSynced

string

integrationIds.isPending

boolean

required

taxStatus

enum<string>

required

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

Available options:

TAXED,

TAX_EXEMPT,

REVERSE_CHARGED

contacts

object[]

required

Contacts for this customer

contacts.id

string

required

Unique ID

contacts.name

string

required

Full name of this contact

contacts.email

string

required

Email address of this contact

contacts.billingPreference

enum<string>

required

Available options:

PRIMARY,

STANDARD,

NONE

contacts.createdAt

string

required

Time of creation. Formatted as an ISO 8601 timestamp.

contacts.updatedAt

string

required

Time of last update. Formatted as an ISO 8601 timestamp.

contacts.archivedAt

string

Time of archive. Formatted as an ISO 8601 timestamp.

url

string

URL

domain

string

Customer's primary domain name

label

string

Label

List customers Get customer

twitter github linkedin