Skip to main content
POST
Create Customer
Scope: customers:write

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Display name

contacts
object[]
required

At least one contact is required. Each contact must have an email and at least one role.

Minimum array length: 1

Legal/registered business name

externalCustomerId
string

Your own external customer ID

paymentProviderId
string

Payment provider customer ID (e.g. Stripe cus_xxx). Requires provider.

provider
enum<string>

Payment provider. Requires paymentProviderId.

Available options:
stripe
tags
string[]
billingAddress
object

Billing address for tax calculation. Required when your organization has sales tax (Anrok) enabled.

paymentMethodId
string

Stripe Payment Method ID (pm_xxx). Sets the customer's default payment method. Requires paymentMethodType.

paymentMethodType
enum<string>

Type of payment method. Required when paymentMethodId is provided.

Available options:
card,
us_bank_account

Response

Customer created

data
object