Skip to content

Create a customer

POST
/customers
curl --request POST \
--url https://api.bizzle.my/v1/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "email": "hello@example.com", "name": "example", "phone": "example", "metadata": {} }'
Idempotency-Key
string
<= 255 characters

Unique identifier used to replay requests safely.

Media typeapplication/json
object
email
string format: email
name
string
phone
string
metadata
object

Example generated

{
"email": "hello@example.com",
"name": "example",
"phone": "example",
"metadata": {}
}

Customer created.

Media typeapplication/json
object
id
string
object
string
Allowed values: customer
merchantId
string
email
string format: email
nullable
name
string
nullable
phone
string
nullable
metadata
object
created
integer format: int64

Example

{
"id": "cus_5nq1Kdab2pXueN5y8Z",
"object": "customer"
}

Error response.

Media typeapplication/json
object
error
required
string
message
string
code
string
details
object

Example generated

{
"error": "example",
"message": "example",
"code": "example",
"details": {}
}

Too many requests.

Media typeapplication/json
object
error
required
string
message
string
code
string
details
object

Example generated

{
"error": "example",
"message": "example",
"code": "example",
"details": {}
}
RateLimit-Limit
integer

Maximum requests per window.

RateLimit-Remaining
integer

Requests remaining in the current window.

RateLimit-Reset
integer

Unix seconds when the window resets.

Retry-After
integer

Seconds to wait before retrying (on 429/handled outages).