v10

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-122928103.7 KB
Customers

Update a customer

Update one or more fields of an existing customer.

patch/v1/customers/{customerId}

Path parameters

customerIdstring required

The customer's prefixed identifier (e.g., cus_ab12cd34ef). This is the merchant-facing slug, not the internal UUID.

Request body

namestring
emailstring email
documentstring
documentType'CPF' | 'CNPJ'
phonestring
isActiveboolean
metadataobject

Response

Customer updated.

messagestring