Skip to main content
POST
/
customers
Create customer
curl --request POST \
  --url https://api.kohortpay.com/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "emailAddress": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+1 555 555 5555",
  "address": {
    "street": "123 Main St",
    "city": "Springfield",
    "state": "IL",
    "postalCode": "62701",
    "country": "US"
  },
  "shippingAddress": {
    "addressLine1": "Avenue des Champs-Élysées",
    "addressLine2": "Appartement 4B",
    "city": "Paris",
    "postalCode": "75014",
    "country": "France",
    "state": "Île-de-France",
    "companyName": "Google LLC",
    "vatNumber": "FR123456789",
    "registrationNumber": "123456789"
  },
  "metadata": {
    "order_id": "ord_1JYLo8KerLxWZaQtys6ZQ1xS"
  },
  "locale": "fr_FR",
  "clientReferenceId": "myclientid-1234"
}'
{
  "id": "cus_1234567890",
  "emailAddress": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+1 555 555 5555",
  "livemode": true,
  "isBlocked": true,
  "organizationId": "org_1234567890",
  "addressId": "adr_1234567890",
  "shippingAddressId": "adr_1234567890",
  "metadata": {
    "my_system_id": "1JYLo8KerLxWZaQtys6ZQ1xS"
  },
  "createdAt": "2021-07-22T00:00:00.000Z",
  "createdBy": "usr_1234567890",
  "updatedAt": "2021-07-22T00:00:00.000Z",
  "blockedAt": "2021-07-22T00:00:00.000Z",
  "blockedBy": "usr_1234567890",
  "updatedBy": "usr_1234567890",
  "deletedAt": "2021-07-22T00:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
emailAddress
string<email>
required
Example:
​
firstName
string | null
Example:
​
lastName
string | null
Example:
​
phoneNumber
string<phone> | null
Example:
​
address
object
Example:
​
shippingAddress
object
​
metadata
object
Example:
​
locale
enum<string>
Available options:
en_US,
fr_FR
Example:
​
clientReferenceId
string
Example:

Response

201 - application/json
​
id
string
required
Example:
​
emailAddress
string<email>
required
Example:
​
firstName
string | null
required
Example:
​
lastName
string | null
required
Example:
​
phoneNumber
string<phone> | null
required
Example:
​
livemode
boolean
required
Example:
​
isBlocked
boolean
required
Example:
​
organizationId
string
required
Example:
​
addressId
string | null
required
Example:
​
shippingAddressId
string | null
required
Example:
​
metadata
object | null
required
Example:
​
createdAt
string<date-time>
required
Example:
​
createdBy
string | null
required
Example:
​
updatedAt
string<date-time>
required
Example:
​
blockedAt
string<date-time> | null
required
Example:
​
blockedBy
string | null
required
Example:
​
updatedBy
string | null
required
Example:
​
deletedAt
string<date-time> | null
required
Example: