Skip to main content
PATCH
/
customers
/
{id}
Update a customer
curl --request PATCH \
  --url https://api.corebill.io/v1/customers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe Jr.",
  "email": "[email protected]",
  "notes": "Updated contact information"
}
'
{
  "data": {
    "id": "cus_a1b2c3d4e5f6",
    "name": "John Doe",
    "slug": "john-doe",
    "currency": "USD",
    "status": "active",
    "created_at": "2025-03-01T09:00:00.000Z",
    "contact_email": "[email protected]",
    "contact_phone": "+1-555-0100",
    "country": "US",
    "city": "San Francisco",
    "legal_name": "John Doe LLC",
    "legal_address": "123 Market St, San Francisco, CA 94105",
    "legal_vat": "US123456789",
    "zipcode": "94105",
    "updated_at": "2025-03-15T11:30:00.000Z",
    "notes": "Preferred payment method: wire transfer"
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Generate keys from the Corebill dashboard under the Developers section.

Example: Authorization: Bearer sk_live_abc123def456

Path Parameters

​
id
string
required

The customer ID

Query Parameters

​
company_id
string
required

The company ID to scope the request to

Body

application/json

All fields are optional. Shorthand fields email and phone map to contact_email and contact_phone respectively.

​
name
string

Customer display name

Example:

"John Doe Jr."

​
contact_email
string<email>

Contact email

Example:

"[email protected]"

​
email
string<email>

Shorthand for contact_email

Example:

"[email protected]"

​
contact_phone
string

Contact phone

Example:

"+1-555-0300"

​
phone
string

Shorthand for contact_phone

Example:

"+1-555-0300"

​
country
string

Country code or name

Example:

"US"

​
city
string

City name

Example:

"Los Angeles"

​
currency
string

Preferred currency code (ISO 4217)

Example:

"EUR"

​
status
enum<string>

Customer status

Available options:
active,
inactive
Example:

"active"

​
legal_name
string

Legal business name

Example:

"Doe Enterprises LLC"

​
legal_address
string

Legal business address

Example:

"789 Sunset Blvd, Los Angeles, CA 90028"

​
legal_vat
string

VAT or tax identification number

Example:

"US111222333"

​
zipcode
string

ZIP or postal code

Example:

"90028"

​
notes
string

Internal notes about the customer

Example:

"VIP client, priority support"

Response

Customer updated successfully

​
data
object
required

Full customer object including notes (returned by GET /customers/{id})