CHcheckout
Customers

Update customer details

Update the details of a customer and link payment instruments to them.

patch/customers/{identifier}

Request

Path parameters

identifierstring required

The customer's ID

Request body

emailstring email

The email address of the customer

namestring

The name of the customer

metadataobject

Allows you to store additional information about a customer. You can include a maximum of 20 key-value pairs. Each key and value can be up to 100 characters long. Providing metadata in this request will replace any existing stored for this customer.

defaultstring

The ID of this customer's default instrument

Example request

{
  "email": "brucewayne@gmail.com",
  "name": "Bruce Wayne",
  "phone": {
    "country_code": "+1",
    "number": "415 555 2671"
  },
  "metadata": {
    "coupon_code": "NY2018",
    "partner_id": 123989
  },
  "default": "src_wmlfc3zyhqzehihu7giusaaawu"
}

Response

Customer updated successfully

Changes

No recorded changes to this operation across all 1 revision of this API.