Customers
Create customer
- Explore demo
- Speak to an expert
- Changelog
- Blog
Account
Billing
Collections
Customers
Invoices
Notifications & Webhooks
Product
Seats
Taxes
Usage
Version 2024-01-01
Version 2024-05-09
Latest API
All API versions
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}.
object
*
Required
object
Add Example Value
legalName
string
*
legalName
Required
string
Legal name
Add Example Value
contactName
string
contactName
string
Contact name
Add Example Value
address
object
*
address
Required
object
Address
Add Example Value
line1
string
*
line1
Required
string
Address line 1
Add Example Value
line2
string
line2
string
Address line 2
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
email
string
*
email
Required
string
Add Example Value
billingEmails
array
*
billingEmails
Required
array
Billing email addresses
Add Example Value
telephone
string
telephone
string
Telephone
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
curl --request POST \
--url https://eu.sequencehq.com/api/customers \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"legalName": "John Doe",
"contactName": "John Doe",
"address": {
"line1": "Flat 1",
"line2": "123 Fake Street",
"town": "New York",
"state": "NY",
"postcode": "AB1 2EF",
"country": "US"
},
"email": "john@example.com",
"billingEmails": [
"exampleCorpInvoices@example.com"
],
"telephone": "john@example.com",
"url": "https://example.com/",
"label": "Example customer",
"taxStatus": "TAXED",
"customerAliases": [
"b1c87177-088a-40ec-8917-9809343f3f9c"
],
"integrationIds": [
{
"service": "Xero",
"id": "123456789"
},
{
"service": "Stripe",
"id": "cus_OCtCxqQDgu1uX9"
},
{
"service": "HubSpot",
"id": "123456789"
}
]
}'{
"id": "e309e948-088e-4d77-b654-cd85498f1555",
"createdAt": "2022-06-28T16:47:00Z",
"legalName": "John Doe",
"contactName": "John Doe",
"address": {
"line1": "Flat 1",
"line2": "123 Fake Street",
"town": "New York",
"state": "NY",
"postcode": "AB1 2EF",
"country": "US"
},
"email": "john@example.com",
"telephone": "02010001000",
"url": "https://example.com/",
"label": "Example customer",
"integrationIds": [
{
"service": "Xero",
"id": "ID",
"lastSynced": "2022-06-28T16:47:00Z"
},
{
"service": "Stripe",
"id": "cus_OCtCxqQDgu1uX9",
"lastSynced": "2022-06-28T16:47:00Z"
}
],
"archivedAt": "2022-06-28T16:47:00Z",
"billingEmails": [
"exampleCorpInvoices@example.com"
],
"taxStatus": "TAXED"
}Headers
Authorization
string
requiredYour API credentials. Eg. Basic {credentials}.
Body
application/json
legalName
string
requiredLegal name
contactName
string
Contact name
address
object
requiredAddress
address.line1
string
requiredAddress line 1
address.line2
string
Address line 2
address.town
string
requiredTown or city
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, ON, PE, QC, SK address.postcode
string
requiredPostal code
address.country
enum<string>
requiredCountry 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 email
string
requiredbillingEmails
string[]
requiredBilling email addresses
telephone
string
Telephone
url
string
URL
label
string
Label
taxStatus
enum<string>
requiredTax status applicable to customer. Can be one of TAXED, EXEMPT or REVERSE_CHARGED. The default is TAXED.
Available options:
TAXED, TAX_EXEMPT, REVERSE_CHARGED customerAliases
string[]
Customer aliases.
integrationIds
object[]
IDs in external integrations
integrationIds.service
enum<string>
requiredAvailable options:
Amazon_Redshift, Google_BigQuery, Google_Sheets, HubSpot, NetSuite, QuickBooks_Online, Salesforce, Slack, Snowflake, Stripe, Xero integrationIds.id
string
requiredintegrationIds.lastSynced
string
Response
201 - application/json
id
string
requiredUnique ID
createdAt
string
requiredCreated at
legalName
string
requiredLegal name
contactName
string
Contact Name
address
object
requiredAddress
address.line1
string
requiredAddress line 1
address.line2
string
Address line 2
address.town
string
requiredTown or city
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, ON, PE, QC, SK address.postcode
string
requiredPostal code
address.country
enum<string>
requiredCountry 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 email
string
requiredMain contact email address
telephone
string
Telephone
url
string
URL
label
string
Label
integrationIds
object[]
requiredExternal services which are linked to this customer
integrationIds.service
enum<string>
requiredAvailable options:
Amazon_Redshift, Google_BigQuery, Google_Sheets, HubSpot, NetSuite, QuickBooks_Online, Salesforce, Slack, Snowflake, Stripe, Xero integrationIds.id
string
requiredintegrationIds.lastSynced
string
archivedAt
string
Date and time the Customer was archived
billingEmails
string[]
requiredBilling email addresses
taxStatus
enum<string>
requiredTax status applicable to customer. Can be one of TAXED, EXEMPT or REVERSE_CHARGED. The default is TAXED.
Available options:
TAXED, TAX_EXEMPT, REVERSE_CHARGED curl --request POST \
--url https://eu.sequencehq.com/api/customers \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"legalName": "John Doe",
"contactName": "John Doe",
"address": {
"line1": "Flat 1",
"line2": "123 Fake Street",
"town": "New York",
"state": "NY",
"postcode": "AB1 2EF",
"country": "US"
},
"email": "john@example.com",
"billingEmails": [
"exampleCorpInvoices@example.com"
],
"telephone": "john@example.com",
"url": "https://example.com/",
"label": "Example customer",
"taxStatus": "TAXED",
"customerAliases": [
"b1c87177-088a-40ec-8917-9809343f3f9c"
],
"integrationIds": [
{
"service": "Xero",
"id": "123456789"
},
{
"service": "Stripe",
"id": "cus_OCtCxqQDgu1uX9"
},
{
"service": "HubSpot",
"id": "123456789"
}
]
}'{
"id": "e309e948-088e-4d77-b654-cd85498f1555",
"createdAt": "2022-06-28T16:47:00Z",
"legalName": "John Doe",
"contactName": "John Doe",
"address": {
"line1": "Flat 1",
"line2": "123 Fake Street",
"town": "New York",
"state": "NY",
"postcode": "AB1 2EF",
"country": "US"
},
"email": "john@example.com",
"telephone": "02010001000",
"url": "https://example.com/",
"label": "Example customer",
"integrationIds": [
{
"service": "Xero",
"id": "ID",
"lastSynced": "2022-06-28T16:47:00Z"
},
{
"service": "Stripe",
"id": "cus_OCtCxqQDgu1uX9",
"lastSynced": "2022-06-28T16:47:00Z"
}
],
"archivedAt": "2022-06-28T16:47:00Z",
"billingEmails": [
"exampleCorpInvoices@example.com"
],
"taxStatus": "TAXED"
}