Skip to main content
POST
Create Customer

Authorizations

Authorization
string
header
required

Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.

Headers

Idempotency-Key
string

Deduplicates retried requests with the same key and parameters instead of creating a second resource. Recommended: an opaque, randomly-generated value such as a UUID.

Body

application/json
email
string
required

The upsert match key. Normalized to lowercase and trimmed server-side.

name
string

Customer name (non-empty when present).

phone
string

Customer phone (non-empty when present).

provider_default_invoice_payment_method_id
string

Provider payment-method ID to set as the default for future invoices.

address
object

Customer address. Optional fields: line1, line2, city, state, postal_code, country.

shipping
object

Shipping details. Requires name and address.line1; optional phone and the other address fields.

metadata
object

String key/value pairs.

Response

Success.

data
object
required