Skip to main content
POST
Create a customer

Authorizations

Authorization
string
header
required

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

Body

application/json

Create a new customer. ACH enable/disable is not set at creation — new customers inherit the org default (achEnabled is null) and can be changed afterwards via PUT /customer/{customerId}.

name
string
required
emails
string[]
required
syncToQbo
boolean

When true and your account has QuickBooks Online connected, the customer is also created in QuickBooks. Defaults to false (the customer exists only in Nickel).

Response

Successful operation

id
string
Example:

"clkqzo2y1000cx9tfohoiodq1"

name
string
Example:

"Claudio Wilson"

emails
string[]
achEnabled
boolean | null

Per-customer override for whether ACH/bank payments are allowed. null means no customer-level override (inherits the organization default). A payment link can further override this at checkout, so a customer-level true may still be disabled for a specific link.

Example:

false

feePassthroughPercent
integer | null

Effective percent (0-100) of the card processing fee passed through to this customer: the per-customer override if one is set, otherwise the organization default. A per-payment-link feePassthroughPercent takes precedence over this value.

Example:

100