v1

latestOpenAPI 3.0.3MIT-LICENSE2026-07-2469127278.1 KB
Customers

Update customer

You can update customer-related data

put/customers/{id}

Path parameters

idstring required

Identifier of the resource

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

X-Child-Company-Idstring

In the case of a holding company, the company id of the child company to which will process the request.

Request body

namestring

Customer's name.

emailstring email

Customer email address.

phonestring

Customer phone number.

corporateboolean

True if the customer represents a company.

custom_referencestring

Merchant-defined reference used to identify the customer in your system.

metadataobject

Arbitrary metadata associated with the customer.

default_payment_source_idstring

Sets the default payment source for the customer (must be an existing payment source on the customer).

default_fiscal_entity_idstring

Sets the default fiscal entity for the customer (must be an existing fiscal entity on the customer).

default_shipping_contact_idstring

Sets the default shipping contact for the customer (must be an existing shipping contact on the customer).

Example request

{
  "name": "Miguel",
  "email": "miguel@gmail.com",
  "phone": "5215555555555",
  "custom_reference": "customer_123",
  "payment_sources": [
    {
      "type": "cash",
      "expires_at": 1553273553
    }
  ]
}

Response

successful operation