Update customer information

📘
API Refs

Staging: Update customer information

Path parameters

Name	Type	Description	Required
id	string	Stripe customer ID (starting with "cus_")	yes

Request body

All fields are optional - only include fields you want to update.

Name	Type	Description	Required
email	string	Updated email address	no
firstName	string	Updated first name	no
lastName	string	Updated last name	no
phone	string	Updated phone number	no
address	object	Updated address	no

Address Object

Field	Type	Description	Required
street	string	Street address	no
city	string	City	no
state	string	State or province	no
postalCode	string	Postal/ZIP code	no

Response

Success Response (200 OK)

Field	Type	Description
id	string	Customer ID
email	string	Updated email
stripeCustomerId	string	Stripe customer ID (read-only)
firstName	string	Updated first name
lastName	string	Updated last name
phone	string	Updated phone
address	object	Updated address
createdAt	string	Customer creation date (ISO 8601)
updatedAt	string	Update timestamp (ISO 8601)

Example Request

{
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe-Smith",
  "phone": "+19876543210",
  "address": {
    "street": "456 Business Ave",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001"
  }
}

Example Response

{
  "id": "123",
  "email": "[email protected]",
  "stripeCustomerId": "cus_ExampleCustomerID123",
  "firstName": "John",
  "lastName": "Doe-Smith",
  "phone": "+19876543210",
  "address": {
    "street": "456 Business Ave",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001"
  },
  "createdAt": "2023-12-01T00:00:00.000Z",
  "updatedAt": "2024-01-20T14:30:00.000Z"
}

Description

This endpoint updates customer information such as contact details and address. Only include the fields you want to update in the request body - any fields not included will remain unchanged. Changes are synchronized with Stripe automatically.

Note: You cannot update payment methods through this endpoint. Customers should use the billing portal for payment method management.

Error Responses

400 Bad Request: Invalid update data or email format
401 Unauthorized: Invalid or missing authorization token
403 Forbidden: Insufficient permissions
404 Not Found: Customer not found