API Reference · Customers

Update a customer

Updates any subset of the customer fields.

PATCH/v1/customers/:id

Accepts a partial object — only provided fields are modified. Changing the email is allowed but must not collide with another customer in the same livemode.

Returnscustomer object

Path parameters

idstringRequired

Customer id (`cus_…`).

Body parameters

emailstring

New email address.

first_namestring

New given name.

last_namestring

New family name.

phonestring

New phone number.

company_namestring

New business name.

notesstring

Replaces existing notes.

metadataobject

Merges into existing metadata; pass `null` on a key to delete it.

Errors

404

resource_missing

No customer exists with that id.

409

resource_already_exists

New email collides with an existing customer.

Request

curl -X PATCH https://lunipay.io/api/v1/customers/cus_01JRZK2Q4T9ZS0VCNA3HX7W9EY \
  -H "Authorization: Bearer sk_test_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "phone": "+18765559999" }'

Response

{
  "id": "cus_01JRZK2Q4T9ZS0VCNA3HX7W9EY",
  "object": "customer",
  "livemode": false,
  "email": "ada@example.com",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "phone": "+18765559999",
  "company_name": "Analytical Engines Ltd.",
  "notes": "VIP — priority support",
  "metadata": {
    "internal_id": "ACCT-42"
  },
  "stripe_customer_id": "cus_Pxxxxxxxxxxxx",
  "created": 1713100800,
  "updated": 1713100900
}