Update Customer

Updates an existing customer’s properties.

Mutation

Mutation

mutation UpdateCustomer($input: UpdateCustomerInput!) {
  updateOneCustomer(input: $input) {
    customerId
    name
    email
    billingId
    additionalMetaData
    updatedAt
  }
}

{
  "input": {
    "customerId": "customer-123",
    "name": "Acme Corporation",
    "email": "[e-mail]",
    "additionalMetaData": {
      "industry": "Technology",
      "employeeCount": 150
    }
  }
}

{
  "data": {
    "updateOneCustomer": {
      "customerId": "customer-123",
      "name": "Acme Corporation",
      "email": "[e-mail]",
      "billingId": "cus_ABC123",
      "additionalMetaData": {
        "industry": "Technology",
        "employeeCount": 150
      },
      "updatedAt": "2024-01-20T15:45:00Z"
    }
  }
}

Parameters

input · UpdateCustomerInput · required

Input for updating a customer

Show properties

customerId · String · required

The customer’s reference ID to update

name · String

New display name

email · String

New email address

billingId · String

Update billing provider ID

billingInformation · CustomerBillingInfo

Updated billing details

additionalMetaData · JSON

Updated custom metadata (replaces existing)

crmId · String

CRM integration ID

salesforceId · String

Salesforce ID

environmentId · UUID

Environment ID

Return Type

Returns the updated Customer object.

Common Use Cases

Update billing email

Change the email address used for billing communications.

Link to billing provider

Update billingId after creating customer in Stripe.

Sync CRM data

Update metadata with data from your CRM.

Related Operations

• Get Customer - Retrieve customer
• Archive Customer - Archive customer