Skip to main content
PATCH
Update a customer

Autorizaciones

Authorization
string
header
requerido

Parámetros de ruta

id
string
requerido

Unique identifier of the customer to update.

Cuerpo

application/json
metadata
object
requerido

Set of key-value pairs that replaces the customer's current metadata. Up to 50 keys, each with a non-empty name of up to 40 characters. Each value is a string of up to 500 characters, a number, a boolean, or null. Send {} to remove all keys.

Ejemplo:

Respuesta

The customer with updated metadata.

id
string
requerido

Unique identifier of the customer.

Ejemplo:

"cus_0ujsswThIGTUYm2K8FjOOfXtY1K"

object
any
requerido

Type of the object. Always customer.

address
object | null
requerido

Customer's address. Only the fields with a value are returned. null when the customer has no address information.

created_at
string<date-time>
requerido

ISO 8601 datetime, in UTC, of when the customer was created.

Ejemplo:

"2026-01-15T14:30:00Z"

email
string | null
requerido

Customer's email, stored in lowercase. null if not provided.

Ejemplo:

"jared@piedpiper.com"

metadata
object
requerido

Set of key-value pairs that you can attach to an object. Useful for storing additional information about the object in a structured format.

Ejemplo:
mode
enum<string>
requerido

Mode of the customer, matching the mode of the API key used to create it. One of live or test.

Opciones disponibles:
live,
test
Ejemplo:

"live"

name
string | null
requerido

Customer's full name or business name. null if not provided.

Ejemplo:

"Test Customer 1"

phone
string | null
requerido

Customer's phone number in E.164 format, including the country code (for example +56911111111). null if not provided.

Ejemplo:

"+56911111111"

tax_id
object | null
requerido

Tax identifier of the customer: a Chilean tax ID (RUT), a Mexican tax ID (RFC), or a custom identifier. null if not provided.