Skip to main content

UpdateCustomerInput

Input for updateCustomer. Only provided fields are updated. billingDetails, shippingDetails and metadata replace the stored value as a whole; they are not merged. Only email, name and phone accept null, which clears them.

input UpdateCustomerInput {
  id: ID!
  email: String
  name: String
  phone: String
  billingDetails: ContactDetailsInput
  shippingDetails: ContactDetailsInput
  metadata: [KeyValueInput!]
  defaultTokenId: ID
}

Fields​

UpdateCustomerInput.id ● ID! non-null scalar​

ID of the customer to update.

UpdateCustomerInput.email ● String scalar​

The customer's email address. Must be a valid email address. null clears it.

UpdateCustomerInput.name ● String scalar​

The customer's full name or business name. null clears it.

UpdateCustomerInput.phone ● String scalar​

The customer's phone number. Use E.164 format (for example +34600000000). The format is not validated. null clears it.

UpdateCustomerInput.billingDetails ● ContactDetailsInput input​

Billing contact details and address. Replaces the stored billing details as a whole.

UpdateCustomerInput.shippingDetails ● ContactDetailsInput input​

Shipping contact details and address. Replaces the stored shipping details as a whole.

UpdateCustomerInput.metadata ● [KeyValueInput!] list input​

Key/value metadata. Each key holds up to 50 characters and each value up to 500. Replaces the stored metadata as a whole: to remove a key, send the list without it. A null value fails validation.

UpdateCustomerInput.defaultTokenId ● ID scalar​

ID of the payment method charged when a payment asks for the customer's default. Must be a CustomerPaymentMethod.id of this customer with sequence: false; any other ID is refused. It cannot be cleared with null. When the customer has no default, the first payment method with sequence: false that a payment saves for the customer becomes the default.

Member Of​

updateCustomer mutation

Last updated on