Skip to main content
PUT
/
customers
/
{customer_id}
Update customer
curl --request PUT \
  --url https://api.withorb.com/v1/customers/{customer_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata": {},
  "name": "<string>",
  "email": "[email protected]",
  "payment_provider_id": "<string>",
  "payment_provider": "quickbooks",
  "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": {
    "country": "AD",
    "type": "ad_nrt",
    "value": "<string>"
  },
  "auto_collection": true,
  "auto_issuance": true,
  "additional_emails": [
    "<string>"
  ],
  "email_delivery": true,
  "tax_configuration": {
    "tax_exempt": true,
    "automatic_tax_enabled": true,
    "tax_provider": "avalara",
    "tax_exemption_code": "<string>"
  },
  "reporting_configuration": {
    "exempt": true
  },
  "accounting_sync_configuration": {
    "excluded": true,
    "accounting_providers": [
      {
        "provider_type": "<string>",
        "external_provider_id": "<string>"
      }
    ]
  },
  "external_customer_id": "<string>",
  "hierarchy": {
    "parent_customer_id": "<string>",
    "child_customer_ids": [
      "<string>"
    ]
  }
}'
{
  "metadata": {},
  "id": "<string>",
  "external_customer_id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "timezone": "<string>",
  "payment_provider_id": "<string>",
  "payment_provider": "quickbooks",
  "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": {
    "country": "AD",
    "type": "ad_nrt",
    "value": "<string>"
  },
  "auto_collection": true,
  "exempt_from_automated_tax": true,
  "email_delivery": true,
  "auto_issuance": true,
  "additional_emails": [
    "<string>"
  ],
  "portal_url": "<string>",
  "accounting_sync_configuration": {
    "excluded": true,
    "accounting_providers": [
      {
        "provider_type": "quickbooks",
        "external_provider_id": "<string>"
      }
    ]
  },
  "reporting_configuration": {
    "exempt": true
  },
  "hierarchy": {
    "parent": {
      "id": "<string>",
      "external_customer_id": "<string>"
    },
    "children": [
      {
        "id": "<string>",
        "external_customer_id": "<string>"
      }
    ]
  },
  "automatic_tax_enabled": true
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
customer_id
string
required

Body

application/json
​
metadata
object | null
​
name
string | null
​
email
string<email> | null
​
payment_provider_id
string | null
​
payment_provider
enum<string> | null
Available options:
quickbooks,
bill.com,
stripe_charge,
stripe_invoice,
netsuite
​
shipping_address
object | null
​
billing_address
object | null
​
currency
string | null
​
tax_id
object | null
​
auto_collection
boolean | null
​
auto_issuance
boolean | null
​
additional_emails
string[] | null
​
email_delivery
boolean | null
​
tax_configuration
object | null
  • NewAvalaraTaxConfiguration
  • NewTaxJarConfiguration
  • NewSphereConfiguration
  • NewNumeralConfiguration
  • NewAnrokConfiguration
  • NewStripeTaxConfiguration
​
reporting_configuration
object | null
​
accounting_sync_configuration
object | null
​
external_customer_id
string | null
​
hierarchy
object | null

Response

​
metadata
object
required
​
id
string
required
​
external_customer_id
string | null
required
​
name
string
required
​
email
string
required
​
timezone
string
required
​
payment_provider_id
string | null
required
​
payment_provider
enum<string> | null
required
Available options:
quickbooks,
bill.com,
stripe_charge,
stripe_invoice,
netsuite
​
created_at
string<date-time>
required
​
shipping_address
object | null
required
​
billing_address
object | null
required
​
balance
string
required
​
currency
string | null
required
​
tax_id
object | null
required
​
auto_collection
boolean
required
​
exempt_from_automated_tax
boolean | null
required
​
email_delivery
boolean
required
​
auto_issuance
boolean | null
required
​
additional_emails
string[]
required
​
portal_url
string | null
required
​
hierarchy
object
required
​
accounting_sync_configuration
object | null
​
reporting_configuration
object | null
​
automatic_tax_enabled
boolean | null