Skip to main content
POST
Create a customer

Authorizations

Authorization
string
header
required

Secret key, kc_sk_test_... or kc_sk_live_.... Server-side only.

Headers

Idempotency-Key
string
required

Unique key per logical request, reused on retries. 1 to 255 characters.

Required string length: 1 - 255

Body

application/json
reference
string
Maximum string length: 100
email
string<email>
name
string
Maximum string length: 200
metadata
object

Up to 50 keys. Keys up to 40 characters, values up to 500 characters. Echoed back unchanged.

Response

Customer created.

id
string
required
Example:

"cus_01JABCDEF"

object
string
required
Allowed value: "customer"
metadata
object
required

Up to 50 keys. Keys up to 40 characters, values up to 500 characters. Echoed back unchanged.

created_at
string<date-time>
required
reference
string | null

The partner's own customer ID.

email
string | null
name
string | null