Skip to content

Update a customer. Fields left out keep their current value.

PATCH
/customers/{id}
id
required
string

Customer ID

Update a customer. A field that is absent is left as it is; there is deliberately no way to clear one back to empty in v1, because null and “not supplied” are indistinguishable once deserialized and guessing between them would make an omitted field destructive.

object
default_payment_method_id
One of:
null
email
string | null
metadata
object | null
name
string | null
phone
string | null

Customer updated

A customer as returned. Timestamps are Unix milliseconds, matching every other resource on this API.

object
created
required
integer format: int64
default_payment_method_id
One of:
null
email
string | null
id
required

Identifier for a customer (cus_…).

string
livemode
required
boolean
metadata
required
object
key
additional properties
string
name
string | null
phone
string | null
updated
required
integer format: int64

No such customer

object
error
required
object
code
required
string
message
required
string
param
string | null
retryable

When present and true, the caller may retry the same request.

boolean | null
type
required
string