Skip to main content
POST
Create (or get) a customer

Authorizations

X-Suby-Api-Key
string
header
required

Secret API key. sk_live_… (production) or sk_sandbox_… (sandbox).

Body

application/json
email
string<email>
required
Maximum string length: 320
firstName
string
Maximum string length: 100
lastName
string
Maximum string length: 100
billingAddress
object
metadata
object

Key-value pairs. ≤50 keys, keys ≤40 chars, values are strings ≤500 chars (or null to clear). Nested structures must be JSON-stringified into a single string value.

Response

Existing customer returned

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload.

message
string