Find a Customer - Numeral API

cURL

curl --request GET \
  --url https://api.numeralhq.com/tax/customers/{customer_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.numeralhq.com/tax/customers/{customer_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.numeralhq.com/tax/customers/{customer_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.numeralhq.com/tax/customers/{customer_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.numeralhq.com/tax/customers/{customer_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

{
  "error": {
    "error_code": "missing_field",
    "error_message": "Field is required",
    "error_meta": {
      "field": "path.to.fieldname",
      "expected": "string",
      "received": "undefined"
    }
  }
}

GET

/

tax

/

customers

/

{customer_id}

cURL

curl --request GET \
  --url https://api.numeralhq.com/tax/customers/{customer_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.numeralhq.com/tax/customers/{customer_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.numeralhq.com/tax/customers/{customer_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.numeralhq.com/tax/customers/{customer_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.numeralhq.com/tax/customers/{customer_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

{
  "error": {
    "error_code": "missing_field",
    "error_message": "Field is required",
    "error_meta": {
      "field": "path.to.fieldname",
      "expected": "string",
      "received": "undefined"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customer_id

string

required

The ID of the customer to retrieve

Query Parameters

id_type

enum<string>

default: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.

Available options:

id,

reference_customer_id

Response

Customer details

id

string

The ID of the customer

Example:

"cus_123456789"

object

string

The type of object: tax.customer

Example:

"tax.customer"

reference_customer_id

string

The ID of the customer in your system

Example:

"20506"

name

string

The name of the created customer

Example:

"Customer Name"

email

string

The email of the created customer

Example:

"customer@example.com"

is_tax_exempt

boolean

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

Example:

true