POST
/
customers
curl --request POST \
  --url https://eu.sequencehq.com/api/customers \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "legalName": "John Doe",
  "address": {
    "line1": "Flat 1",
    "line2": "123 Fake Street",
    "town": "New York",
    "state": "NY",
    "postcode": "AB1 2EF",
    "country": "US"
  },
  "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"
    }
  ],
  "parentId": "50af5191-05a3-42a5-802a-6b59091157af",
  "contacts": [
    {
      "name": "John Smith",
      "email": "john.smith@example.com",
      "billingPreference": "PRIMARY"
    },
    {
      "name": "Anna Smith",
      "email": "anna.smith@example.com",
      "billingPreference": "STANDARD"
    },
    {
      "name": "Penny Smith",
      "email": "penny.smith@example.com",
      "billingPreference": "NONE"
    }
  ],
  "pushToIntegrations": [
    "Xero"
  ],
  "status": "ACTIVE"
}'
{
  "id": "e309e948-088e-4d77-b654-cd85498f1555",
  "createdAt": "2021-01-02T10:55:00Z",
  "organizations": [
    {
      "id": "c0dc4e79-ec52-4811-8cf5-addb2527915c",
      "owner": {
        "id": "50af5191-05a3-42a5-802a-6b59091157af",
        "name": "FinTech Solutions Inc."
      },
      "members": [
        {
          "id": "e309e948-088e-4d77-b654-cd85498f1555",
          "name": "Fintech Payment Processing"
        },
        {
          "id": "50af5191-05a3-42a5-802a-6b59091157af",
          "name": "Fintech Lending Services"
        }
      ]
    }
  ],
  "legalName": "Fintech Payment Processing",
  "address": {
    "line1": "7500 Bluewater Rd NW",
    "town": "Albuquerque",
    "state": "NY",
    "postcode": "87121",
    "country": "US"
  },
  "url": "https://example.com/",
  "domain": "example.com",
  "label": "Example customer",
  "integrationIds": [
    {
      "service": "Xero",
      "id": "2aaff66f-ef30-4599-b192-c168fd4cd226",
      "lastSynced": "2024-03-28T16:47:00Z",
      "isPending": false
    },
    {
      "service": "Stripe",
      "id": "cus_OCtCxqQDgu1uX9",
      "lastSynced": "2024-03-28T16:47:00Z",
      "isPending": false
    }
  ],
  "taxStatus": "TAXED",
  "contacts": [
    {
      "id": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
      "name": "John Smith",
      "email": "john.smith@example.com",
      "billingPreference": "NONE",
      "createdAt": "2022-06-28T16:47:00Z",
      "updatedAt": "2022-06-28T16:47:00Z",
      "archivedAt": "2023-06-28T16:47:00Z"
    }
  ],
  "status": "ACTIVE"
}

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

Example:

"John Doe"

​
address
object
required

Address

Example:
{
  "line1": "7500 Bluewater Rd NW",
  "town": "Albuquerque",
  "state": "NY",
  "postcode": "87121",
  "country": "US"
}
​
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. Needs atleast one Contact with a billing preference of 'PRIMARY'

Example:
[
  {
    "name": "John Smith",
    "email": "john.smith@example.com",
    "billingPreference": "PRIMARY"
  },
  {
    "name": "Anna Smith",
    "email": "anna.smith@example.com",
    "billingPreference": "STANDARD"
  },
  {
    "name": "Penny Smith",
    "email": "penny.smith@example.com",
    "billingPreference": "NONE"
  }
]
​
url
string

URL

Example:

"https://example.com/"

​
label
string

Label

Example:

"Example customer"

​
customerAliases
string[]

Customer aliases

Example:
["b1c87177-088a-40ec-8917-9809343f3f9c"]
​
integrationIds
object[]

IDs in external integrations

Example:
[
  { "service": "Xero", "id": "123456789" },
  {
    "service": "Stripe",
    "id": "cus_OCtCxqQDgu1uX9"
  },
  { "service": "HubSpot", "id": "123456789" }
]
​
parentId
string

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>[]

Automatically create customer in these linked integrations

Available options:
Xero
Example:
["Xero"]
​
status
enum<string>

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"

Response

201
application/json
Created
​
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:
[
  {
    "id": "c0dc4e79-ec52-4811-8cf5-addb2527915c",
    "owner": {
      "id": "50af5191-05a3-42a5-802a-6b59091157af",
      "name": "FinTech Solutions Inc."
    },
    "members": [
      {
        "id": "e309e948-088e-4d77-b654-cd85498f1555",
        "name": "Fintech Payment Processing"
      },
      {
        "id": "50af5191-05a3-42a5-802a-6b59091157af",
        "name": "Fintech Lending Services"
      }
    ]
  }
]
​
legalName
string
required

Legal name

Example:

"Fintech Payment Processing"

​
address
object
required

Address

Example:
{
  "line1": "7500 Bluewater Rd NW",
  "town": "Albuquerque",
  "state": "NY",
  "postcode": "87121",
  "country": "US"
}
​
integrationIds
object[]
required

External services which are linked to this customer

Example:
[
  {
    "service": "Xero",
    "id": "2aaff66f-ef30-4599-b192-c168fd4cd226",
    "lastSynced": "2024-03-28T16:47:00Z",
    "isPending": false
  },
  {
    "service": "Stripe",
    "id": "cus_OCtCxqQDgu1uX9",
    "lastSynced": "2024-03-28T16:47:00Z",
    "isPending": false
  }
]
​
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:
[
  {
    "id": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
    "name": "John Smith",
    "email": "john.smith@example.com",
    "billingPreference": "NONE",
    "createdAt": "2022-06-28T16:47:00Z",
    "updatedAt": "2022-06-28T16:47:00Z",
    "archivedAt": "2023-06-28T16:47:00Z"
  }
]
​
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"

​
url
string

URL

Example:

"https://example.com/"

​
domain
string

Customer's primary domain name

Example:

"example.com"

​
label
string

Label

Example:

"Example customer"