Skip to main content
PUT
/
customer
/
{customerId}
Update a customer
curl --request PUT \
  --url https://rest.staging.nickel.com/customer/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "emails": [
    "<string>"
  ],
  "achEnabled": false,
  "feePassthroughPercent": 50
}
'
{
  "id": "clkqzo2y1000cx9tfohoiodq1",
  "name": "Claudio Wilson",
  "emails": [
    "<string>"
  ],
  "achEnabled": false,
  "feePassthroughPercent": 100
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
customerId
string
required

ID of the customer to update

Body

application/json

Update an existing customer

Fields to update on a customer. All fields are optional; omit a field to leave it unchanged.

​
name
string
​
emails
string[]
​
achEnabled
boolean | null

Whether ACH/bank payments are allowed for this customer. Set to false to disable ACH (the customer must pay by card), true to (re-)enable, or null to clear the override so the customer inherits the org/payment-link setting. Omit to leave unchanged.

Example:

false

​
feePassthroughPercent
integer | null

Percent (0-100) of the card processing fee passed through to this customer's payments; the remainder is absorbed by your organization. Set to null to clear the per-customer override so the customer inherits the organization default. Omit to leave unchanged. A per-payment-link feePassthroughPercent takes precedence over this value.

Required range: 0 <= x <= 100
Example:

50

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