Update customer by external ID

curl --request PUT \
  --url https://api.withorb.com/v1/customers/external_customer_id/{external_customer_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {},
  "name": "<string>",
  "email": "jsmith@example.com",
  "payment_provider_id": "<string>",
  "shipping_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "currency": "<string>",
  "tax_id": {
    "value": "<string>"
  },
  "auto_collection": true,
  "auto_issuance": true,
  "additional_emails": [
    "<string>"
  ],
  "email_delivery": true,
  "tax_configuration": {
    "tax_exempt": true,
    "tax_provider": "avalara",
    "automatic_tax_enabled": true,
    "tax_exemption_code": "<string>"
  },
  "reporting_configuration": {
    "exempt": true
  },
  "accounting_sync_configuration": {
    "excluded": true,
    "accounting_providers": [
      {
        "external_provider_id": "<string>"
      }
    ]
  },
  "external_customer_id": "<string>",
  "hierarchy": {
    "parent_customer_id": "<string>",
    "child_customer_ids": [
      "<string>"
    ]
  },
  "payment_configuration": {
    "payment_providers": []
  },
  "default_payment_method_id": "<string>"
}
'

import requests

url = "https://api.withorb.com/v1/customers/external_customer_id/{external_customer_id}"

payload = {
    "metadata": {},
    "name": "<string>",
    "email": "jsmith@example.com",
    "payment_provider_id": "<string>",
    "shipping_address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
    },
    "billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
    },
    "currency": "<string>",
    "tax_id": { "value": "<string>" },
    "auto_collection": True,
    "auto_issuance": True,
    "additional_emails": ["<string>"],
    "email_delivery": True,
    "tax_configuration": {
        "tax_exempt": True,
        "tax_provider": "avalara",
        "automatic_tax_enabled": True,
        "tax_exemption_code": "<string>"
    },
    "reporting_configuration": { "exempt": True },
    "accounting_sync_configuration": {
        "excluded": True,
        "accounting_providers": [{ "external_provider_id": "<string>" }]
    },
    "external_customer_id": "<string>",
    "hierarchy": {
        "parent_customer_id": "<string>",
        "child_customer_ids": ["<string>"]
    },
    "payment_configuration": { "payment_providers": [] },
    "default_payment_method_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metadata: {},
    name: '<string>',
    email: 'jsmith@example.com',
    payment_provider_id: '<string>',
    shipping_address: {
      line1: '<string>',
      line2: '<string>',
      city: '<string>',
      state: '<string>',
      postal_code: '<string>',
      country: '<string>'
    },
    billing_address: {
      line1: '<string>',
      line2: '<string>',
      city: '<string>',
      state: '<string>',
      postal_code: '<string>',
      country: '<string>'
    },
    currency: '<string>',
    tax_id: {value: '<string>'},
    auto_collection: true,
    auto_issuance: true,
    additional_emails: ['<string>'],
    email_delivery: true,
    tax_configuration: {
      tax_exempt: true,
      tax_provider: 'avalara',
      automatic_tax_enabled: true,
      tax_exemption_code: '<string>'
    },
    reporting_configuration: {exempt: true},
    accounting_sync_configuration: {excluded: true, accounting_providers: [{external_provider_id: '<string>'}]},
    external_customer_id: '<string>',
    hierarchy: {parent_customer_id: '<string>', child_customer_ids: ['<string>']},
    payment_configuration: {payment_providers: []},
    default_payment_method_id: '<string>'
  })
};

fetch('https://api.withorb.com/v1/customers/external_customer_id/{external_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.withorb.com/v1/customers/external_customer_id/{external_customer_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'metadata' => [
        
    ],
    'name' => '<string>',
    'email' => 'jsmith@example.com',
    'payment_provider_id' => '<string>',
    'shipping_address' => [
        'line1' => '<string>',
        'line2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'postal_code' => '<string>',
        'country' => '<string>'
    ],
    'billing_address' => [
        'line1' => '<string>',
        'line2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'postal_code' => '<string>',
        'country' => '<string>'
    ],
    'currency' => '<string>',
    'tax_id' => [
        'value' => '<string>'
    ],
    'auto_collection' => true,
    'auto_issuance' => true,
    'additional_emails' => [
        '<string>'
    ],
    'email_delivery' => true,
    'tax_configuration' => [
        'tax_exempt' => true,
        'tax_provider' => 'avalara',
        'automatic_tax_enabled' => true,
        'tax_exemption_code' => '<string>'
    ],
    'reporting_configuration' => [
        'exempt' => true
    ],
    'accounting_sync_configuration' => [
        'excluded' => true,
        'accounting_providers' => [
                [
                                'external_provider_id' => '<string>'
                ]
        ]
    ],
    'external_customer_id' => '<string>',
    'hierarchy' => [
        'parent_customer_id' => '<string>',
        'child_customer_ids' => [
                '<string>'
        ]
    ],
    'payment_configuration' => [
        'payment_providers' => [
                
        ]
    ],
    'default_payment_method_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.withorb.com/v1/customers/external_customer_id/{external_customer_id}"

	payload := strings.NewReader("{\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"payment_provider_id\": \"<string>\",\n  \"shipping_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"billing_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"currency\": \"<string>\",\n  \"tax_id\": {\n    \"value\": \"<string>\"\n  },\n  \"auto_collection\": true,\n  \"auto_issuance\": true,\n  \"additional_emails\": [\n    \"<string>\"\n  ],\n  \"email_delivery\": true,\n  \"tax_configuration\": {\n    \"tax_exempt\": true,\n    \"tax_provider\": \"avalara\",\n    \"automatic_tax_enabled\": true,\n    \"tax_exemption_code\": \"<string>\"\n  },\n  \"reporting_configuration\": {\n    \"exempt\": true\n  },\n  \"accounting_sync_configuration\": {\n    \"excluded\": true,\n    \"accounting_providers\": [\n      {\n        \"external_provider_id\": \"<string>\"\n      }\n    ]\n  },\n  \"external_customer_id\": \"<string>\",\n  \"hierarchy\": {\n    \"parent_customer_id\": \"<string>\",\n    \"child_customer_ids\": [\n      \"<string>\"\n    ]\n  },\n  \"payment_configuration\": {\n    \"payment_providers\": []\n  },\n  \"default_payment_method_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.withorb.com/v1/customers/external_customer_id/{external_customer_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"payment_provider_id\": \"<string>\",\n  \"shipping_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"billing_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"currency\": \"<string>\",\n  \"tax_id\": {\n    \"value\": \"<string>\"\n  },\n  \"auto_collection\": true,\n  \"auto_issuance\": true,\n  \"additional_emails\": [\n    \"<string>\"\n  ],\n  \"email_delivery\": true,\n  \"tax_configuration\": {\n    \"tax_exempt\": true,\n    \"tax_provider\": \"avalara\",\n    \"automatic_tax_enabled\": true,\n    \"tax_exemption_code\": \"<string>\"\n  },\n  \"reporting_configuration\": {\n    \"exempt\": true\n  },\n  \"accounting_sync_configuration\": {\n    \"excluded\": true,\n    \"accounting_providers\": [\n      {\n        \"external_provider_id\": \"<string>\"\n      }\n    ]\n  },\n  \"external_customer_id\": \"<string>\",\n  \"hierarchy\": {\n    \"parent_customer_id\": \"<string>\",\n    \"child_customer_ids\": [\n      \"<string>\"\n    ]\n  },\n  \"payment_configuration\": {\n    \"payment_providers\": []\n  },\n  \"default_payment_method_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withorb.com/v1/customers/external_customer_id/{external_customer_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"payment_provider_id\": \"<string>\",\n  \"shipping_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"billing_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"currency\": \"<string>\",\n  \"tax_id\": {\n    \"value\": \"<string>\"\n  },\n  \"auto_collection\": true,\n  \"auto_issuance\": true,\n  \"additional_emails\": [\n    \"<string>\"\n  ],\n  \"email_delivery\": true,\n  \"tax_configuration\": {\n    \"tax_exempt\": true,\n    \"tax_provider\": \"avalara\",\n    \"automatic_tax_enabled\": true,\n    \"tax_exemption_code\": \"<string>\"\n  },\n  \"reporting_configuration\": {\n    \"exempt\": true\n  },\n  \"accounting_sync_configuration\": {\n    \"excluded\": true,\n    \"accounting_providers\": [\n      {\n        \"external_provider_id\": \"<string>\"\n      }\n    ]\n  },\n  \"external_customer_id\": \"<string>\",\n  \"hierarchy\": {\n    \"parent_customer_id\": \"<string>\",\n    \"child_customer_ids\": [\n      \"<string>\"\n    ]\n  },\n  \"payment_configuration\": {\n    \"payment_providers\": []\n  },\n  \"default_payment_method_id\": \"<string>\"\n}"

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

{
  "metadata": {},
  "id": "<string>",
  "external_customer_id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "timezone": "<string>",
  "payment_provider_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "shipping_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "balance": "<string>",
  "currency": "<string>",
  "tax_id": {
    "value": "<string>"
  },
  "auto_collection": true,
  "exempt_from_automated_tax": true,
  "email_delivery": true,
  "auto_issuance": true,
  "additional_emails": [
    "<string>"
  ],
  "portal_url": "<string>",
  "hierarchy": {
    "parent": {
      "id": "<string>",
      "external_customer_id": "<string>"
    },
    "children": [
      {
        "id": "<string>",
        "external_customer_id": "<string>"
      }
    ]
  },
  "accounting_sync_configuration": {
    "excluded": true,
    "accounting_providers": [
      {
        "external_provider_id": "<string>"
      }
    ]
  },
  "reporting_configuration": {
    "exempt": true
  },
  "payment_configuration": {
    "payment_providers": []
  },
  "default_payment_method": {
    "id": "<string>",
    "provider_type": "<string>",
    "external_payment_method_id": "<string>",
    "customer_id": "<string>",
    "default": true,
    "created_at": "2023-11-07T05:31:56Z"
  },
  "automatic_tax_enabled": true
}

{
  "type": "https://docs.withorb.com/reference/error-responses#400-constraint-violation",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#401-authentication-error",
  "status": 401,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#404-feature-not-available",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#409-resource-conflict",
  "status": 409,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#413-request-too-large",
  "status": 413,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#429-too-many-requests",
  "status": 429,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#500-internal-server-error",
  "status": 123,
  "detail": "<string>",
  "title": "<string>"
}

PUT

customers

external_customer_id

{external_customer_id}

Update customer by external ID

curl --request PUT \
  --url https://api.withorb.com/v1/customers/external_customer_id/{external_customer_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {},
  "name": "<string>",
  "email": "jsmith@example.com",
  "payment_provider_id": "<string>",
  "shipping_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "currency": "<string>",
  "tax_id": {
    "value": "<string>"
  },
  "auto_collection": true,
  "auto_issuance": true,
  "additional_emails": [
    "<string>"
  ],
  "email_delivery": true,
  "tax_configuration": {
    "tax_exempt": true,
    "tax_provider": "avalara",
    "automatic_tax_enabled": true,
    "tax_exemption_code": "<string>"
  },
  "reporting_configuration": {
    "exempt": true
  },
  "accounting_sync_configuration": {
    "excluded": true,
    "accounting_providers": [
      {
        "external_provider_id": "<string>"
      }
    ]
  },
  "external_customer_id": "<string>",
  "hierarchy": {
    "parent_customer_id": "<string>",
    "child_customer_ids": [
      "<string>"
    ]
  },
  "payment_configuration": {
    "payment_providers": []
  },
  "default_payment_method_id": "<string>"
}
'

import requests

url = "https://api.withorb.com/v1/customers/external_customer_id/{external_customer_id}"

payload = {
    "metadata": {},
    "name": "<string>",
    "email": "jsmith@example.com",
    "payment_provider_id": "<string>",
    "shipping_address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
    },
    "billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
    },
    "currency": "<string>",
    "tax_id": { "value": "<string>" },
    "auto_collection": True,
    "auto_issuance": True,
    "additional_emails": ["<string>"],
    "email_delivery": True,
    "tax_configuration": {
        "tax_exempt": True,
        "tax_provider": "avalara",
        "automatic_tax_enabled": True,
        "tax_exemption_code": "<string>"
    },
    "reporting_configuration": { "exempt": True },
    "accounting_sync_configuration": {
        "excluded": True,
        "accounting_providers": [{ "external_provider_id": "<string>" }]
    },
    "external_customer_id": "<string>",
    "hierarchy": {
        "parent_customer_id": "<string>",
        "child_customer_ids": ["<string>"]
    },
    "payment_configuration": { "payment_providers": [] },
    "default_payment_method_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metadata: {},
    name: '<string>',
    email: 'jsmith@example.com',
    payment_provider_id: '<string>',
    shipping_address: {
      line1: '<string>',
      line2: '<string>',
      city: '<string>',
      state: '<string>',
      postal_code: '<string>',
      country: '<string>'
    },
    billing_address: {
      line1: '<string>',
      line2: '<string>',
      city: '<string>',
      state: '<string>',
      postal_code: '<string>',
      country: '<string>'
    },
    currency: '<string>',
    tax_id: {value: '<string>'},
    auto_collection: true,
    auto_issuance: true,
    additional_emails: ['<string>'],
    email_delivery: true,
    tax_configuration: {
      tax_exempt: true,
      tax_provider: 'avalara',
      automatic_tax_enabled: true,
      tax_exemption_code: '<string>'
    },
    reporting_configuration: {exempt: true},
    accounting_sync_configuration: {excluded: true, accounting_providers: [{external_provider_id: '<string>'}]},
    external_customer_id: '<string>',
    hierarchy: {parent_customer_id: '<string>', child_customer_ids: ['<string>']},
    payment_configuration: {payment_providers: []},
    default_payment_method_id: '<string>'
  })
};

fetch('https://api.withorb.com/v1/customers/external_customer_id/{external_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.withorb.com/v1/customers/external_customer_id/{external_customer_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'metadata' => [
        
    ],
    'name' => '<string>',
    'email' => 'jsmith@example.com',
    'payment_provider_id' => '<string>',
    'shipping_address' => [
        'line1' => '<string>',
        'line2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'postal_code' => '<string>',
        'country' => '<string>'
    ],
    'billing_address' => [
        'line1' => '<string>',
        'line2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'postal_code' => '<string>',
        'country' => '<string>'
    ],
    'currency' => '<string>',
    'tax_id' => [
        'value' => '<string>'
    ],
    'auto_collection' => true,
    'auto_issuance' => true,
    'additional_emails' => [
        '<string>'
    ],
    'email_delivery' => true,
    'tax_configuration' => [
        'tax_exempt' => true,
        'tax_provider' => 'avalara',
        'automatic_tax_enabled' => true,
        'tax_exemption_code' => '<string>'
    ],
    'reporting_configuration' => [
        'exempt' => true
    ],
    'accounting_sync_configuration' => [
        'excluded' => true,
        'accounting_providers' => [
                [
                                'external_provider_id' => '<string>'
                ]
        ]
    ],
    'external_customer_id' => '<string>',
    'hierarchy' => [
        'parent_customer_id' => '<string>',
        'child_customer_ids' => [
                '<string>'
        ]
    ],
    'payment_configuration' => [
        'payment_providers' => [
                
        ]
    ],
    'default_payment_method_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.withorb.com/v1/customers/external_customer_id/{external_customer_id}"

	payload := strings.NewReader("{\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"payment_provider_id\": \"<string>\",\n  \"shipping_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"billing_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"currency\": \"<string>\",\n  \"tax_id\": {\n    \"value\": \"<string>\"\n  },\n  \"auto_collection\": true,\n  \"auto_issuance\": true,\n  \"additional_emails\": [\n    \"<string>\"\n  ],\n  \"email_delivery\": true,\n  \"tax_configuration\": {\n    \"tax_exempt\": true,\n    \"tax_provider\": \"avalara\",\n    \"automatic_tax_enabled\": true,\n    \"tax_exemption_code\": \"<string>\"\n  },\n  \"reporting_configuration\": {\n    \"exempt\": true\n  },\n  \"accounting_sync_configuration\": {\n    \"excluded\": true,\n    \"accounting_providers\": [\n      {\n        \"external_provider_id\": \"<string>\"\n      }\n    ]\n  },\n  \"external_customer_id\": \"<string>\",\n  \"hierarchy\": {\n    \"parent_customer_id\": \"<string>\",\n    \"child_customer_ids\": [\n      \"<string>\"\n    ]\n  },\n  \"payment_configuration\": {\n    \"payment_providers\": []\n  },\n  \"default_payment_method_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.withorb.com/v1/customers/external_customer_id/{external_customer_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"payment_provider_id\": \"<string>\",\n  \"shipping_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"billing_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"currency\": \"<string>\",\n  \"tax_id\": {\n    \"value\": \"<string>\"\n  },\n  \"auto_collection\": true,\n  \"auto_issuance\": true,\n  \"additional_emails\": [\n    \"<string>\"\n  ],\n  \"email_delivery\": true,\n  \"tax_configuration\": {\n    \"tax_exempt\": true,\n    \"tax_provider\": \"avalara\",\n    \"automatic_tax_enabled\": true,\n    \"tax_exemption_code\": \"<string>\"\n  },\n  \"reporting_configuration\": {\n    \"exempt\": true\n  },\n  \"accounting_sync_configuration\": {\n    \"excluded\": true,\n    \"accounting_providers\": [\n      {\n        \"external_provider_id\": \"<string>\"\n      }\n    ]\n  },\n  \"external_customer_id\": \"<string>\",\n  \"hierarchy\": {\n    \"parent_customer_id\": \"<string>\",\n    \"child_customer_ids\": [\n      \"<string>\"\n    ]\n  },\n  \"payment_configuration\": {\n    \"payment_providers\": []\n  },\n  \"default_payment_method_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withorb.com/v1/customers/external_customer_id/{external_customer_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"payment_provider_id\": \"<string>\",\n  \"shipping_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"billing_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"currency\": \"<string>\",\n  \"tax_id\": {\n    \"value\": \"<string>\"\n  },\n  \"auto_collection\": true,\n  \"auto_issuance\": true,\n  \"additional_emails\": [\n    \"<string>\"\n  ],\n  \"email_delivery\": true,\n  \"tax_configuration\": {\n    \"tax_exempt\": true,\n    \"tax_provider\": \"avalara\",\n    \"automatic_tax_enabled\": true,\n    \"tax_exemption_code\": \"<string>\"\n  },\n  \"reporting_configuration\": {\n    \"exempt\": true\n  },\n  \"accounting_sync_configuration\": {\n    \"excluded\": true,\n    \"accounting_providers\": [\n      {\n        \"external_provider_id\": \"<string>\"\n      }\n    ]\n  },\n  \"external_customer_id\": \"<string>\",\n  \"hierarchy\": {\n    \"parent_customer_id\": \"<string>\",\n    \"child_customer_ids\": [\n      \"<string>\"\n    ]\n  },\n  \"payment_configuration\": {\n    \"payment_providers\": []\n  },\n  \"default_payment_method_id\": \"<string>\"\n}"

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

{
  "metadata": {},
  "id": "<string>",
  "external_customer_id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "timezone": "<string>",
  "payment_provider_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "shipping_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "balance": "<string>",
  "currency": "<string>",
  "tax_id": {
    "value": "<string>"
  },
  "auto_collection": true,
  "exempt_from_automated_tax": true,
  "email_delivery": true,
  "auto_issuance": true,
  "additional_emails": [
    "<string>"
  ],
  "portal_url": "<string>",
  "hierarchy": {
    "parent": {
      "id": "<string>",
      "external_customer_id": "<string>"
    },
    "children": [
      {
        "id": "<string>",
        "external_customer_id": "<string>"
      }
    ]
  },
  "accounting_sync_configuration": {
    "excluded": true,
    "accounting_providers": [
      {
        "external_provider_id": "<string>"
      }
    ]
  },
  "reporting_configuration": {
    "exempt": true
  },
  "payment_configuration": {
    "payment_providers": []
  },
  "default_payment_method": {
    "id": "<string>",
    "provider_type": "<string>",
    "external_payment_method_id": "<string>",
    "customer_id": "<string>",
    "default": true,
    "created_at": "2023-11-07T05:31:56Z"
  },
  "automatic_tax_enabled": true
}

{
  "type": "https://docs.withorb.com/reference/error-responses#400-constraint-violation",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#401-authentication-error",
  "status": 401,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#404-feature-not-available",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#409-resource-conflict",
  "status": 409,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#413-request-too-large",
  "status": 413,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#429-too-many-requests",
  "status": 429,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#500-internal-server-error",
  "status": 123,
  "detail": "<string>",
  "title": "<string>"
}

Authorizations

Authorization

string

header

required

API Keys can be issued in the Orb's web application.

Path Parameters

external_customer_id

string

required

Body

application/json

metadata

Metadata · object | null

User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

Show child attributes

name

string | null

The full name of the customer

string<email> | null

A valid customer email, to be used for invoicing and notifications.

payment_provider_id

string | null

The ID of this customer in an external payments solution, such as Stripe. This is used for creating charges or invoices in the external system via Orb.

payment_provider

enum<string> | null

This is used for creating charges or invoices in an external system via Orb. When not in test mode:

the connection must first be configured in the Orb webapp.
if the provider is an invoicing provider (stripe_invoice, quickbooks, bill.com, netsuite), any product mappings must first be configured with the Orb team.

Available options:

quickbooks,

bill.com,

stripe_charge,

stripe_invoice,

netsuite,

adyen

shipping_address

AddressInput · object | null

Show child attributes

billing_address

AddressInput · object | null

Show child attributes

currency

string | null

An ISO 4217 currency string used for the customer's invoices and balance. This can only be set if the customer does not already have a currency configured. If not set at creation or update time, it will be set at subscription creation time.

tax_id

CustomerTaxId · object | null

Tax IDs are commonly required to be displayed on customer invoices, which are added to the headers of invoices.

Supported Tax ID Countries and Types

Country	Type	Description
Albania	`al_tin`	Albania Tax Identification Number
Andorra	`ad_nrt`	Andorran NRT Number
Angola	`ao_tin`	Angola Tax Identification Number
Argentina	`ar_cuit`	Argentinian Tax ID Number
Armenia	`am_tin`	Armenia Tax Identification Number
Aruba	`aw_tin`	Aruba Tax Identification Number
Australia	`au_abn`	Australian Business Number (AU ABN)
Australia	`au_arn`	Australian Taxation Office Reference Number
Austria	`eu_vat`	European VAT Number
Azerbaijan	`az_tin`	Azerbaijan Tax Identification Number
Bahamas	`bs_tin`	Bahamas Tax Identification Number
Bahrain	`bh_vat`	Bahraini VAT Number
Bangladesh	`bd_bin`	Bangladesh Business Identification Number
Barbados	`bb_tin`	Barbados Tax Identification Number
Belarus	`by_tin`	Belarus TIN Number
Belgium	`eu_vat`	European VAT Number
Benin	`bj_ifu`	Benin Tax Identification Number (Identifiant Fiscal Unique)
Bolivia	`bo_tin`	Bolivian Tax ID
Bosnia and Herzegovina	`ba_tin`	Bosnia and Herzegovina Tax Identification Number
Brazil	`br_cnpj`	Brazilian CNPJ Number
Brazil	`br_cpf`	Brazilian CPF Number
Bulgaria	`bg_uic`	Bulgaria Unified Identification Code
Bulgaria	`eu_vat`	European VAT Number
Burkina Faso	`bf_ifu`	Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique)
Cambodia	`kh_tin`	Cambodia Tax Identification Number
Cameroon	`cm_niu`	Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique)
Canada	`ca_bn`	Canadian BN
Canada	`ca_gst_hst`	Canadian GST/HST Number
Canada	`ca_pst_bc`	Canadian PST Number (British Columbia)
Canada	`ca_pst_mb`	Canadian PST Number (Manitoba)
Canada	`ca_pst_sk`	Canadian PST Number (Saskatchewan)
Canada	`ca_qst`	Canadian QST Number (Québec)
Cape Verde	`cv_nif`	Cape Verde Tax Identification Number (Número de Identificação Fiscal)
Chile	`cl_tin`	Chilean TIN
China	`cn_tin`	Chinese Tax ID
Colombia	`co_nit`	Colombian NIT Number
Congo-Kinshasa	`cd_nif`	Congo (DR) Tax Identification Number (Número de Identificação Fiscal)
Costa Rica	`cr_tin`	Costa Rican Tax ID
Croatia	`eu_vat`	European VAT Number
Croatia	`hr_oib`	Croatian Personal Identification Number (OIB)
Cyprus	`eu_vat`	European VAT Number
Czech Republic	`eu_vat`	European VAT Number
Denmark	`eu_vat`	European VAT Number
Dominican Republic	`do_rcn`	Dominican RCN Number
Ecuador	`ec_ruc`	Ecuadorian RUC Number
Egypt	`eg_tin`	Egyptian Tax Identification Number
El Salvador	`sv_nit`	El Salvadorian NIT Number
Estonia	`eu_vat`	European VAT Number
Ethiopia	`et_tin`	Ethiopia Tax Identification Number
European Union	`eu_oss_vat`	European One Stop Shop VAT Number for non-Union scheme
Faroe Islands	`fo_vat`	Faroe Islands VAT Number
Finland	`eu_vat`	European VAT Number
France	`eu_vat`	European VAT Number
Georgia	`ge_vat`	Georgian VAT
Germany	`de_stn`	German Tax Number (Steuernummer)
Germany	`eu_vat`	European VAT Number
Gibraltar	`gi_tin`	Gibraltar Tax Identification Number
Greece	`eu_vat`	European VAT Number
Guinea	`gn_nif`	Guinea Tax Identification Number (Número de Identificação Fiscal)
Hong Kong	`hk_br`	Hong Kong BR Number
Hungary	`eu_vat`	European VAT Number
Hungary	`hu_tin`	Hungary Tax Number (adószám)
Iceland	`is_vat`	Icelandic VAT
India	`in_gst`	Indian GST Number
Indonesia	`id_npwp`	Indonesian NPWP Number
Ireland	`eu_vat`	European VAT Number
Israel	`il_vat`	Israel VAT
Italy	`eu_vat`	European VAT Number
Italy	`it_cf`	Italian Codice Fiscale Number
Japan	`jp_cn`	Japanese Corporate Number (Hōjin Bangō)
Japan	`jp_rn`	Japanese Registered Foreign Businesses' Registration Number (Tōroku Kokugai Jigyōsha no Tōroku Bangō)
Japan	`jp_trn`	Japanese Tax Registration Number (Tōroku Bangō)
Kazakhstan	`kz_bin`	Kazakhstani Business Identification Number
Kenya	`ke_pin`	Kenya Revenue Authority Personal Identification Number
Kyrgyzstan	`kg_tin`	Kyrgyzstan Tax Identification Number
Laos	`la_tin`	Laos Tax Identification Number
Latvia	`eu_vat`	European VAT Number
Liechtenstein	`li_uid`	Liechtensteinian UID Number
Liechtenstein	`li_vat`	Liechtenstein VAT Number
Lithuania	`eu_vat`	European VAT Number
Luxembourg	`eu_vat`	European VAT Number
Malaysia	`my_frp`	Malaysian FRP Number
Malaysia	`my_itn`	Malaysian ITN
Malaysia	`my_sst`	Malaysian SST Number
Malta	`eu_vat`	European VAT Number
Mauritania	`mr_nif`	Mauritania Tax Identification Number (Número de Identificação Fiscal)
Mexico	`mx_rfc`	Mexican RFC Number
Moldova	`md_vat`	Moldova VAT Number
Montenegro	`me_pib`	Montenegro PIB Number
Morocco	`ma_vat`	Morocco VAT Number
Nepal	`np_pan`	Nepal PAN Number
Netherlands	`eu_vat`	European VAT Number
New Zealand	`nz_gst`	New Zealand GST Number
Nigeria	`ng_tin`	Nigerian Tax Identification Number
North Macedonia	`mk_vat`	North Macedonia VAT Number
Northern Ireland	`eu_vat`	Northern Ireland VAT Number
Norway	`no_vat`	Norwegian VAT Number
Norway	`no_voec`	Norwegian VAT on e-commerce Number
Oman	`om_vat`	Omani VAT Number
Paraguay	`py_ruc`	Paraguayan RUC Number
Peru	`pe_ruc`	Peruvian RUC Number
Philippines	`ph_tin`	Philippines Tax Identification Number
Poland	`eu_vat`	European VAT Number
Poland	`pl_nip`	Polish Tax ID Number
Portugal	`eu_vat`	European VAT Number
Romania	`eu_vat`	European VAT Number
Romania	`ro_tin`	Romanian Tax ID Number
Russia	`ru_inn`	Russian INN
Russia	`ru_kpp`	Russian KPP
Saudi Arabia	`sa_vat`	Saudi Arabia VAT
Senegal	`sn_ninea`	Senegal NINEA Number
Serbia	`rs_pib`	Serbian PIB Number
Singapore	`sg_gst`	Singaporean GST
Singapore	`sg_uen`	Singaporean UEN
Slovakia	`eu_vat`	European VAT Number
Slovenia	`eu_vat`	European VAT Number
Slovenia	`si_tin`	Slovenia Tax Number (davčna številka)
South Africa	`za_vat`	South African VAT Number
South Korea	`kr_brn`	Korean BRN
Spain	`es_cif`	Spanish NIF Number (previously Spanish CIF Number)
Spain	`eu_vat`	European VAT Number
Sri Lanka	`lk_vat`	Sri Lanka VAT Number
Suriname	`sr_fin`	Suriname FIN Number
Sweden	`eu_vat`	European VAT Number
Switzerland	`ch_uid`	Switzerland UID Number
Switzerland	`ch_vat`	Switzerland VAT Number
Taiwan	`tw_vat`	Taiwanese VAT
Tajikistan	`tj_tin`	Tajikistan Tax Identification Number
Tanzania	`tz_vat`	Tanzania VAT Number
Thailand	`th_vat`	Thai VAT
Turkey	`tr_tin`	Turkish Tax Identification Number
Uganda	`ug_tin`	Uganda Tax Identification Number
Ukraine	`ua_vat`	Ukrainian VAT
United Arab Emirates	`ae_trn`	United Arab Emirates TRN
United Kingdom	`gb_vat`	United Kingdom VAT Number
United States	`us_ein`	United States EIN
Uruguay	`uy_ruc`	Uruguayan RUC Number
Uzbekistan	`uz_tin`	Uzbekistan TIN Number
Uzbekistan	`uz_vat`	Uzbekistan VAT Number
Venezuela	`ve_rif`	Venezuelan RIF Number
Vietnam	`vn_tin`	Vietnamese Tax ID Number
Zambia	`zm_tin`	Zambia Tax Identification Number
Zimbabwe	`zw_tin`	Zimbabwe Tax Identification Number

Show child attributes

auto_collection

boolean | null

Used to determine if invoices for this customer will automatically attempt to charge a saved payment method, if available. This parameter defaults to True when a payment provider is provided on customer creation.

auto_issuance

boolean | null

Used to determine if invoices for this customer will be automatically issued. If true, invoices will be automatically issued. If false, invoices will require manual approval.If null is specified, the customer's auto issuance setting will be inherited from the account-level setting.

additional_emails

string[] | null

Additional email addresses for this customer. If populated, these email addresses will be CC'd for customer communications. The total number of email addresses (including the primary email) cannot exceed 50.

email_delivery

boolean | null

tax_configuration

NewAvalaraTaxConfiguration · object

Show child attributes

reporting_configuration

NewReportingConfiguration · object | null

Show child attributes

accounting_sync_configuration

NewAccountingSyncConfiguration · object | null

Show child attributes

external_customer_id

string | null

The external customer ID. This can only be set if the customer has no existing external customer ID. Since this action may change usage quantities for all existing subscriptions, it is disallowed if the customer has issued invoices with usage line items and subject to the same restrictions as backdated subscription creation.

hierarchy

CustomerHierarchyConfig · object | null

The hierarchical relationships for this customer.

Show child attributes

payment_configuration

PaymentConfiguration · object | null

Payment configuration for the customer, applicable when using Orb Invoicing with a supported payment provider such as Stripe.

Show child attributes

default_payment_method_id

string | null

The Orb ID of the payment method to set as this customer's default. Pass null to clear the customer's default payment method.

Response

A customer is a buyer of your products, and the other party to the billing relationship.

In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an external_customer_id with your own identifier. See Customer ID Aliases for further information about how these aliases work in Orb.

In addition to having an identifier in your system, a customer may exist in a payment provider solution like Stripe. Use the payment_provider_id and the payment_provider enum field to express this mapping.

A customer also has a timezone (from the standard IANA timezone database), which defaults to your account's timezone. See Timezone localization for information on what this timezone parameter influences within Orb.

metadata

Metadata · object

required

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

Show child attributes

string

required

external_customer_id

string | null

required

An optional user-defined ID for this customer resource, used throughout the system as an alias for this Customer. Use this field to identify a customer by an existing identifier in your system.

name

string

required

The full name of the customer

string

required

A valid customer email, to be used for notifications. When Orb triggers payment through a payment gateway, this email will be used for any automatically issued receipts.

timezone

string

required

A timezone identifier from the IANA timezone database, such as "America/Los_Angeles". This "defaults to your account's timezone if not set. This cannot be changed after customer creation.

payment_provider_id

string | null

required

The ID of this customer in an external payments solution, such as Stripe. This is used for creating charges or invoices in the external system via Orb.

payment_provider

enum<string> | null

required

This is used for creating charges or invoices in an external system via Orb. When not in test mode, the connection must first be configured in the Orb webapp.

Available options:

quickbooks,

bill.com,

stripe_charge,

stripe_invoice,

netsuite,

adyen

created_at

string<date-time>

required

shipping_address

Address · object | null

required

Show child attributes

billing_address

Address · object | null

required

Show child attributes

balance

string

required

The customer's current balance in their currency.

currency

string | null

required

tax_id

CustomerTaxId · object | null

required

Tax IDs are commonly required to be displayed on customer invoices, which are added to the headers of invoices.

Supported Tax ID Countries and Types

Country	Type	Description
Albania	`al_tin`	Albania Tax Identification Number
Andorra	`ad_nrt`	Andorran NRT Number
Angola	`ao_tin`	Angola Tax Identification Number
Argentina	`ar_cuit`	Argentinian Tax ID Number
Armenia	`am_tin`	Armenia Tax Identification Number
Aruba	`aw_tin`	Aruba Tax Identification Number
Australia	`au_abn`	Australian Business Number (AU ABN)
Australia	`au_arn`	Australian Taxation Office Reference Number
Austria	`eu_vat`	European VAT Number
Azerbaijan	`az_tin`	Azerbaijan Tax Identification Number
Bahamas	`bs_tin`	Bahamas Tax Identification Number
Bahrain	`bh_vat`	Bahraini VAT Number
Bangladesh	`bd_bin`	Bangladesh Business Identification Number
Barbados	`bb_tin`	Barbados Tax Identification Number
Belarus	`by_tin`	Belarus TIN Number
Belgium	`eu_vat`	European VAT Number
Benin	`bj_ifu`	Benin Tax Identification Number (Identifiant Fiscal Unique)
Bolivia	`bo_tin`	Bolivian Tax ID
Bosnia and Herzegovina	`ba_tin`	Bosnia and Herzegovina Tax Identification Number
Brazil	`br_cnpj`	Brazilian CNPJ Number
Brazil	`br_cpf`	Brazilian CPF Number
Bulgaria	`bg_uic`	Bulgaria Unified Identification Code
Bulgaria	`eu_vat`	European VAT Number
Burkina Faso	`bf_ifu`	Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique)
Cambodia	`kh_tin`	Cambodia Tax Identification Number
Cameroon	`cm_niu`	Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique)
Canada	`ca_bn`	Canadian BN
Canada	`ca_gst_hst`	Canadian GST/HST Number
Canada	`ca_pst_bc`	Canadian PST Number (British Columbia)
Canada	`ca_pst_mb`	Canadian PST Number (Manitoba)
Canada	`ca_pst_sk`	Canadian PST Number (Saskatchewan)
Canada	`ca_qst`	Canadian QST Number (Québec)
Cape Verde	`cv_nif`	Cape Verde Tax Identification Number (Número de Identificação Fiscal)
Chile	`cl_tin`	Chilean TIN
China	`cn_tin`	Chinese Tax ID
Colombia	`co_nit`	Colombian NIT Number
Congo-Kinshasa	`cd_nif`	Congo (DR) Tax Identification Number (Número de Identificação Fiscal)
Costa Rica	`cr_tin`	Costa Rican Tax ID
Croatia	`eu_vat`	European VAT Number
Croatia	`hr_oib`	Croatian Personal Identification Number (OIB)
Cyprus	`eu_vat`	European VAT Number
Czech Republic	`eu_vat`	European VAT Number
Denmark	`eu_vat`	European VAT Number
Dominican Republic	`do_rcn`	Dominican RCN Number
Ecuador	`ec_ruc`	Ecuadorian RUC Number
Egypt	`eg_tin`	Egyptian Tax Identification Number
El Salvador	`sv_nit`	El Salvadorian NIT Number
Estonia	`eu_vat`	European VAT Number
Ethiopia	`et_tin`	Ethiopia Tax Identification Number
European Union	`eu_oss_vat`	European One Stop Shop VAT Number for non-Union scheme
Faroe Islands	`fo_vat`	Faroe Islands VAT Number
Finland	`eu_vat`	European VAT Number
France	`eu_vat`	European VAT Number
Georgia	`ge_vat`	Georgian VAT
Germany	`de_stn`	German Tax Number (Steuernummer)
Germany	`eu_vat`	European VAT Number
Gibraltar	`gi_tin`	Gibraltar Tax Identification Number
Greece	`eu_vat`	European VAT Number
Guinea	`gn_nif`	Guinea Tax Identification Number (Número de Identificação Fiscal)
Hong Kong	`hk_br`	Hong Kong BR Number
Hungary	`eu_vat`	European VAT Number
Hungary	`hu_tin`	Hungary Tax Number (adószám)
Iceland	`is_vat`	Icelandic VAT
India	`in_gst`	Indian GST Number
Indonesia	`id_npwp`	Indonesian NPWP Number
Ireland	`eu_vat`	European VAT Number
Israel	`il_vat`	Israel VAT
Italy	`eu_vat`	European VAT Number
Italy	`it_cf`	Italian Codice Fiscale Number
Japan	`jp_cn`	Japanese Corporate Number (Hōjin Bangō)
Japan	`jp_rn`	Japanese Registered Foreign Businesses' Registration Number (Tōroku Kokugai Jigyōsha no Tōroku Bangō)
Japan	`jp_trn`	Japanese Tax Registration Number (Tōroku Bangō)
Kazakhstan	`kz_bin`	Kazakhstani Business Identification Number
Kenya	`ke_pin`	Kenya Revenue Authority Personal Identification Number
Kyrgyzstan	`kg_tin`	Kyrgyzstan Tax Identification Number
Laos	`la_tin`	Laos Tax Identification Number
Latvia	`eu_vat`	European VAT Number
Liechtenstein	`li_uid`	Liechtensteinian UID Number
Liechtenstein	`li_vat`	Liechtenstein VAT Number
Lithuania	`eu_vat`	European VAT Number
Luxembourg	`eu_vat`	European VAT Number
Malaysia	`my_frp`	Malaysian FRP Number
Malaysia	`my_itn`	Malaysian ITN
Malaysia	`my_sst`	Malaysian SST Number
Malta	`eu_vat`	European VAT Number
Mauritania	`mr_nif`	Mauritania Tax Identification Number (Número de Identificação Fiscal)
Mexico	`mx_rfc`	Mexican RFC Number
Moldova	`md_vat`	Moldova VAT Number
Montenegro	`me_pib`	Montenegro PIB Number
Morocco	`ma_vat`	Morocco VAT Number
Nepal	`np_pan`	Nepal PAN Number
Netherlands	`eu_vat`	European VAT Number
New Zealand	`nz_gst`	New Zealand GST Number
Nigeria	`ng_tin`	Nigerian Tax Identification Number
North Macedonia	`mk_vat`	North Macedonia VAT Number
Northern Ireland	`eu_vat`	Northern Ireland VAT Number
Norway	`no_vat`	Norwegian VAT Number
Norway	`no_voec`	Norwegian VAT on e-commerce Number
Oman	`om_vat`	Omani VAT Number
Paraguay	`py_ruc`	Paraguayan RUC Number
Peru	`pe_ruc`	Peruvian RUC Number
Philippines	`ph_tin`	Philippines Tax Identification Number
Poland	`eu_vat`	European VAT Number
Poland	`pl_nip`	Polish Tax ID Number
Portugal	`eu_vat`	European VAT Number
Romania	`eu_vat`	European VAT Number
Romania	`ro_tin`	Romanian Tax ID Number
Russia	`ru_inn`	Russian INN
Russia	`ru_kpp`	Russian KPP
Saudi Arabia	`sa_vat`	Saudi Arabia VAT
Senegal	`sn_ninea`	Senegal NINEA Number
Serbia	`rs_pib`	Serbian PIB Number
Singapore	`sg_gst`	Singaporean GST
Singapore	`sg_uen`	Singaporean UEN
Slovakia	`eu_vat`	European VAT Number
Slovenia	`eu_vat`	European VAT Number
Slovenia	`si_tin`	Slovenia Tax Number (davčna številka)
South Africa	`za_vat`	South African VAT Number
South Korea	`kr_brn`	Korean BRN
Spain	`es_cif`	Spanish NIF Number (previously Spanish CIF Number)
Spain	`eu_vat`	European VAT Number
Sri Lanka	`lk_vat`	Sri Lanka VAT Number
Suriname	`sr_fin`	Suriname FIN Number
Sweden	`eu_vat`	European VAT Number
Switzerland	`ch_uid`	Switzerland UID Number
Switzerland	`ch_vat`	Switzerland VAT Number
Taiwan	`tw_vat`	Taiwanese VAT
Tajikistan	`tj_tin`	Tajikistan Tax Identification Number
Tanzania	`tz_vat`	Tanzania VAT Number
Thailand	`th_vat`	Thai VAT
Turkey	`tr_tin`	Turkish Tax Identification Number
Uganda	`ug_tin`	Uganda Tax Identification Number
Ukraine	`ua_vat`	Ukrainian VAT
United Arab Emirates	`ae_trn`	United Arab Emirates TRN
United Kingdom	`gb_vat`	United Kingdom VAT Number
United States	`us_ein`	United States EIN
Uruguay	`uy_ruc`	Uruguayan RUC Number
Uzbekistan	`uz_tin`	Uzbekistan TIN Number
Uzbekistan	`uz_vat`	Uzbekistan VAT Number
Venezuela	`ve_rif`	Venezuelan RIF Number
Vietnam	`vn_tin`	Vietnamese Tax ID Number
Zambia	`zm_tin`	Zambia Tax Identification Number
Zimbabwe	`zw_tin`	Zimbabwe Tax Identification Number

Show child attributes

auto_collection

boolean

required

exempt_from_automated_tax

boolean | null

required

email_delivery

boolean

required

auto_issuance

boolean | null

required

Whether invoices for this customer should be automatically issued. If true, invoices will be automatically issued. If false, invoices will require manual approval. If null, inherits the account-level setting.

additional_emails

string[]

required

portal_url

string | null

required

Deprecated. Returns the URL of the most recent non-expired portal link, or null. When the account has opted into customer portal sessions, this field always returns null. Use POST /v1/customers/{id}/portal_sessions to mint short-lived portal session URLs.

hierarchy

CustomerHierarchy · object

required

The hierarchical relationships for this customer.

Show child attributes

accounting_sync_configuration

AccountingSyncConfiguration · object | null

Show child attributes

reporting_configuration

ReportingConfiguration · object | null

Show child attributes

payment_configuration

PaymentConfiguration · object | null

Payment configuration for the customer, applicable when using Orb Invoicing with a supported payment provider such as Stripe.

Show child attributes

default_payment_method

PaymentMethod · object | null

The customer's default payment method, or null if none is set.

Show child attributes

automatic_tax_enabled

boolean | null

Whether automatic tax calculation is enabled for this customer. This field is nullable for backwards compatibility but will always return a boolean value.

Fetch customer by external ID

Fetch customer costs by external ID

⌘I

API documentation

Alert

Coupon

Credit

Credit note

Customer

Dimensional Price Group

Event

Invoice

Item

LicenseType

License

Metric

Availability

Plan

Price

Subscription Change

Subscription

Price interval

Update customer by external ID

Authorizations

Path Parameters

Body

Supported Tax ID Countries and Types

Response

Supported Tax ID Countries and Types