Update Customer

Changed on

Update an existing customer's information. All fields are optional, but at least one must be provided. Only the fields you include are changed.

post/tax/customers/{customer_id}

Request

  • Base URL
    https://api.numeralhq.com
  • URL
    https://api.numeralhq.com/tax/customers/{customer_id}
  • Auth
    HTTP bearer

Path parameters

customer_idstring required

The Numeral customer ID (cust_xxx) or your reference_customer_id. Either identifier is accepted; no id_type query parameter is needed.

Request body

namestring

The customer's name

emailstring

The customer's email. Must be unique across your customers.

is_tax_exemptboolean

If true, all POST /tax/calculations sold to this customer will return $0 in tax owed.

reference_customer_idstring

The ID of the customer in your system. Must be unique across your customers.

Example request

{
  "name": "New Customer Name",
  "email": "new.email@example.com",
  "is_tax_exempt": true,
  "reference_customer_id": "20507"
}

Response

The updated customer

idstring

The ID of the customer

objectstring

The type of object: tax.customer

reference_customer_idstring

The ID of the customer in your system

namestring

The name of the created customer

emailstring

The email of the created customer

is_tax_exemptboolean

If true, all POST /tax/calculations sold to this customer will return $0 in tax owed. The default value is false.

Example response

{
  "id": "cust_123456789",
  "object": "tax.customer",
  "reference_customer_id": "20506",
  "name": "Customer Name",
  "email": "customer@example.com",
  "is_tax_exempt": true
}

Changes