POST
/
customers
curl --request POST \
  --url https://api.flatpeak.com/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reference_id": "CUS1234567890"
}'
{
  "id": "cus_65e421d1daa4a24082b4f590",
  "object": "customer",
  "live_mode": true,
  "reference_id": "CUS1234567890",
  "locations": [
    "loc_641b90b758fb8e6293716e40"
  ],
  "time_created": "2021-05-05T05:37:27Z",
  "account_id": "acc_65e421bed29d88d9012e0662"
}

Authorizations

​
Authorization
string
header
required

Authenticate with bearer_token you obtained from /login endpoint.

Body

Create a customer
​
reference_id
string

A reference that is meaningful to you, for example, an ID from your system.

Example:

"CUS1234567890"

Response

201
application/json

This object represents a customer of your business.

​
id
string
required

FlatPeak unique object Id.

Example:

"cus_65e421d1daa4a24082b4f590"

​
object
string
required

Represents the object’s type.

Example:

"customer"

​
live_mode
boolean
required

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

​
time_created
string
required

Time when the object was created, in UTC.

Example:

"2021-05-05T05:37:27Z"

​
account_id
string
required

FlatPeak unique account id

Example:

"acc_65e421bed29d88d9012e0662"

​
reference_id
string

A reference that is meaningful to you, for example, an ID from your system.

Example:

"CUS1234567890"

​
locations
string[]

An array of FlatPeak location IDs that are associated with this object.

Was this page helpful?

Suggest editsRaise issue