StripeKit - Update Customer

`kit.customers.update()`

Updates an existing customer. Only the fields you pass are changed; omitted fields are left untouched in Stripe.

Signature

Parameters

Field	Type	Description
`email`	`string`	Replaces the customer's email. Validated and lowercased the same way as on `create()`.
`name`	`string`	Replaces the customer's name.
`phone`	`string`	Replaces the phone number.
`description`	`string`	Replaces the internal description.
`address`	`object`	Replaces the full address object; you cannot patch a single sub-field, send the complete address.
`defaultPaymentMethodId`	`string`	Sets the customer's default payment method for future invoices and off-session charges.
`metadata`	`Record<string,string>`	Replaces the customer's metadata. Unlike `create()`, this does not merge with a `source` key, whatever you pass here becomes the full metadata object in Stripe.

Example request

Example response

Errors

Exception	When
`StripeOperationError`	The customer ID does not exist, or Stripe rejects a field, for example an invalid `email`.

Notes

If a storage adapter is configured, the updated record is persisted via saveCustomer() automatically.

To change the default payment method independently of any other customer field, use kit.paymentMethods.setDefault() instead, it is a more direct call for that one purpose.

Update

kit.customers.update()#

Signature#

Parameters#

Example request#

Example response#

Errors#