NUnumeral-com

Get Customer

Changed on

Retrieve the details of a specific customer

get/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

Query parameters

id_type'id' | 'reference_customer_id'

The type of identifier provided in the path. Use id (the default) to look up by the Numeral customer ID, or reference_customer_id to look up by your own reference customer ID.

Response

Customer details

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

  • f4650eaed11fRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id getCustomer_v20260301 was added

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status