orb-billing 4.74.0 → 5.0.0

package/src/resources/customers/customers.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../../resource';
 import { isRequestOptions } from '../../core';
 import * as Core from '../../core';
+import * as Shared from '../shared';
 import * as BalanceTransactionsAPI from './balance-transactions';
 import {
   BalanceTransactionCreateParams,
@@ -185,6 +186,26 @@ export class Customers extends APIResource {
 
 export class CustomersPage extends Page<Customer> {}
 
+export interface AccountingProviderConfig {
+  external_provider_id: string;
+
+  provider_type: string;
+}
+
+export interface AddressInput {
+  city?: string | null;
+
+  country?: string | null;
+
+  line1?: string | null;
+
+  line2?: string | null;
+
+  postal_code?: string | null;
+
+  state?: string | null;
+}
+
 /**
  * A customer is a buyer of your products, and the other party to the billing
  * relationship.
@@ -217,7 +238,7 @@ export interface Customer {
    */
   balance: string;
 
-  billing_address: Customer.BillingAddress | null;
+  billing_address: Shared.Address | null;
 
   created_at: string;
 
@@ -274,7 +295,7 @@ export interface Customer {
 
   portal_url: string | null;
 
-  shipping_address: Customer.ShippingAddress | null;
+  shipping_address: Shared.Address | null;
 
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
@@ -383,7 +404,7 @@ export interface Customer {
    * | Venezuela            | `ve_rif`     | Venezuelan RIF Number                                                                                   |
    * | Vietnam              | `vn_tin`     | Vietnamese Tax ID Number                                                                                |
    */
-  tax_id: Customer.TaxID | null;
+  tax_id: Shared.CustomerTaxID | null;
 
   /**
    * A timezone identifier from the IANA timezone database, such as
@@ -398,319 +419,13 @@ export interface Customer {
 }
 
 export namespace Customer {
-  export interface BillingAddress {
-    city: string | null;
-
-    country: string | null;
-
-    line1: string | null;
-
-    line2: string | null;
-
-    postal_code: string | null;
-
-    state: string | null;
-  }
-
   /**
    * The hierarchical relationships for this customer.
    */
   export interface Hierarchy {
-    children: Array<Hierarchy.Child>;
-
-    parent: Hierarchy.Parent | null;
-  }
-
-  export namespace Hierarchy {
-    export interface Child {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-
-    export interface Parent {
-      id: string;
-
-      external_customer_id: string | null;
-    }
-  }
-
-  export interface ShippingAddress {
-    city: string | null;
-
-    country: string | null;
-
-    line1: string | null;
-
-    line2: string | null;
-
-    postal_code: string | null;
-
-    state: string | null;
-  }
+    children: Array<Shared.CustomerMinified>;
 
-  /**
-   * 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                                                                                             |
-   * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
-   * | Andorra              | `ad_nrt`     | Andorran NRT Number                                                                                     |
-   * | Argentina            | `ar_cuit`    | Argentinian Tax ID Number                                                                               |
-   * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
-   * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
-   * | Austria              | `eu_vat`     | European VAT Number                                                                                     |
-   * | Bahrain              | `bh_vat`     | Bahraini VAT Number                                                                                     |
-   * | Belgium              | `eu_vat`     | European VAT Number                                                                                     |
-   * | Bolivia              | `bo_tin`     | Bolivian Tax ID                                                                                         |
-   * | 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                                                                                     |
-   * | 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)                                                                            |
-   * | Chile                | `cl_tin`     | Chilean TIN                                                                                             |
-   * | China                | `cn_tin`     | Chinese Tax ID                                                                                          |
-   * | Colombia             | `co_nit`     | Colombian NIT Number                                                                                    |
-   * | Costa Rica           | `cr_tin`     | Costa Rican Tax ID                                                                                      |
-   * | Croatia              | `eu_vat`     | European VAT Number                                                                                     |
-   * | 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                                                                                     |
-   * | EU                   | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
-   * | Finland              | `eu_vat`     | European VAT Number                                                                                     |
-   * | France               | `eu_vat`     | European VAT Number                                                                                     |
-   * | Georgia              | `ge_vat`     | Georgian VAT                                                                                            |
-   * | Germany              | `eu_vat`     | European VAT Number                                                                                     |
-   * | Greece               | `eu_vat`     | European VAT Number                                                                                     |
-   * | 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                                                                                     |
-   * | 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                                                  |
-   * | Latvia               | `eu_vat`     | European VAT Number                                                                                     |
-   * | Liechtenstein        | `li_uid`     | Liechtensteinian UID 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                                                                                     |
-   * | Mexico               | `mx_rfc`     | Mexican RFC Number                                                                                      |
-   * | Netherlands          | `eu_vat`     | European VAT Number                                                                                     |
-   * | New Zealand          | `nz_gst`     | New Zealand GST Number                                                                                  |
-   * | Nigeria              | `ng_tin`     | Nigerian Tax Identification Number                                                                      |
-   * | Norway               | `no_vat`     | Norwegian VAT Number                                                                                    |
-   * | Norway               | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
-   * | Oman                 | `om_vat`     | Omani VAT Number                                                                                        |
-   * | Peru                 | `pe_ruc`     | Peruvian RUC Number                                                                                     |
-   * | Philippines          | `ph_tin `    | Philippines Tax Identification Number                                                                   |
-   * | Poland               | `eu_vat`     | European VAT 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                                                                                        |
-   * | 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                                                                                     |
-   * | Sweden               | `eu_vat`     | European VAT Number                                                                                     |
-   * | Switzerland          | `ch_vat`     | Switzerland VAT Number                                                                                  |
-   * | Taiwan               | `tw_vat`     | Taiwanese VAT                                                                                           |
-   * | Thailand             | `th_vat`     | Thai VAT                                                                                                |
-   * | Turkey               | `tr_tin`     | Turkish Tax Identification Number                                                                       |
-   * | Ukraine              | `ua_vat`     | Ukrainian VAT                                                                                           |
-   * | United Arab Emirates | `ae_trn`     | United Arab Emirates TRN                                                                                |
-   * | United Kingdom       | `eu_vat`     | Northern Ireland VAT Number                                                                             |
-   * | United Kingdom       | `gb_vat`     | United Kingdom VAT Number                                                                               |
-   * | United States        | `us_ein`     | United States EIN                                                                                       |
-   * | Uruguay              | `uy_ruc`     | Uruguayan RUC Number                                                                                    |
-   * | Venezuela            | `ve_rif`     | Venezuelan RIF Number                                                                                   |
-   * | Vietnam              | `vn_tin`     | Vietnamese Tax ID Number                                                                                |
-   */
-  export interface TaxID {
-    country:
-      | 'AD'
-      | 'AE'
-      | 'AR'
-      | 'AT'
-      | 'AU'
-      | 'BE'
-      | 'BG'
-      | 'BH'
-      | 'BO'
-      | 'BR'
-      | 'CA'
-      | 'CH'
-      | 'CL'
-      | 'CN'
-      | 'CO'
-      | 'CR'
-      | 'CY'
-      | 'CZ'
-      | 'DE'
-      | 'DK'
-      | 'EE'
-      | 'DO'
-      | 'EC'
-      | 'EG'
-      | 'ES'
-      | 'EU'
-      | 'FI'
-      | 'FR'
-      | 'GB'
-      | 'GE'
-      | 'GR'
-      | 'HK'
-      | 'HR'
-      | 'HU'
-      | 'ID'
-      | 'IE'
-      | 'IL'
-      | 'IN'
-      | 'IS'
-      | 'IT'
-      | 'JP'
-      | 'KE'
-      | 'KR'
-      | 'KZ'
-      | 'LI'
-      | 'LT'
-      | 'LU'
-      | 'LV'
-      | 'MT'
-      | 'MX'
-      | 'MY'
-      | 'NG'
-      | 'NL'
-      | 'NO'
-      | 'NZ'
-      | 'OM'
-      | 'PE'
-      | 'PH'
-      | 'PL'
-      | 'PT'
-      | 'RO'
-      | 'RS'
-      | 'RU'
-      | 'SA'
-      | 'SE'
-      | 'SG'
-      | 'SI'
-      | 'SK'
-      | 'SV'
-      | 'TH'
-      | 'TR'
-      | 'TW'
-      | 'UA'
-      | 'US'
-      | 'UY'
-      | 'VE'
-      | 'VN'
-      | 'ZA';
-
-    type:
-      | 'ad_nrt'
-      | 'ae_trn'
-      | 'ar_cuit'
-      | 'eu_vat'
-      | 'au_abn'
-      | 'au_arn'
-      | 'bg_uic'
-      | 'bh_vat'
-      | 'bo_tin'
-      | 'br_cnpj'
-      | 'br_cpf'
-      | 'ca_bn'
-      | 'ca_gst_hst'
-      | 'ca_pst_bc'
-      | 'ca_pst_mb'
-      | 'ca_pst_sk'
-      | 'ca_qst'
-      | 'ch_vat'
-      | 'cl_tin'
-      | 'cn_tin'
-      | 'co_nit'
-      | 'cr_tin'
-      | 'do_rcn'
-      | 'ec_ruc'
-      | 'eg_tin'
-      | 'es_cif'
-      | 'eu_oss_vat'
-      | 'gb_vat'
-      | 'ge_vat'
-      | 'hk_br'
-      | 'hu_tin'
-      | 'id_npwp'
-      | 'il_vat'
-      | 'in_gst'
-      | 'is_vat'
-      | 'jp_cn'
-      | 'jp_rn'
-      | 'jp_trn'
-      | 'ke_pin'
-      | 'kr_brn'
-      | 'kz_bin'
-      | 'li_uid'
-      | 'mx_rfc'
-      | 'my_frp'
-      | 'my_itn'
-      | 'my_sst'
-      | 'ng_tin'
-      | 'no_vat'
-      | 'no_voec'
-      | 'nz_gst'
-      | 'om_vat'
-      | 'pe_ruc'
-      | 'ph_tin'
-      | 'ro_tin'
-      | 'rs_pib'
-      | 'ru_inn'
-      | 'ru_kpp'
-      | 'sa_vat'
-      | 'sg_gst'
-      | 'sg_uen'
-      | 'si_tin'
-      | 'sv_nit'
-      | 'th_vat'
-      | 'tr_tin'
-      | 'tw_vat'
-      | 'ua_vat'
-      | 'us_ein'
-      | 'uy_ruc'
-      | 've_rif'
-      | 'vn_tin'
-      | 'za_vat';
-
-    value: string;
+    parent: Shared.CustomerMinified | null;
   }
 
   export interface AccountingSyncConfiguration {
@@ -732,6 +447,50 @@ export namespace Customer {
   }
 }
 
+export interface CustomerHierarchyConfig {
+  /**
+   * A list of child customer IDs to add to the hierarchy. The desired child
+   * customers must not already be part of another hierarchy.
+   */
+  child_customer_ids?: Array<string>;
+
+  /**
+   * The ID of the parent customer in the hierarchy. The desired parent customer must
+   * not be a child of another customer.
+   */
+  parent_customer_id?: string | null;
+}
+
+export interface NewAccountingSyncConfiguration {
+  accounting_providers?: Array<AccountingProviderConfig> | null;
+
+  excluded?: boolean | null;
+}
+
+export interface NewAvalaraTaxConfiguration {
+  tax_exempt: boolean;
+
+  tax_provider: 'avalara';
+
+  tax_exemption_code?: string | null;
+}
+
+export interface NewReportingConfiguration {
+  exempt: boolean;
+}
+
+export interface NewSphereConfiguration {
+  tax_exempt: boolean;
+
+  tax_provider: 'sphere';
+}
+
+export interface NewTaxJarConfiguration {
+  tax_exempt: boolean;
+
+  tax_provider: 'taxjar';
+}
+
 export interface CustomerCreateParams {
   /**
    * A valid customer email, to be used for notifications. When Orb triggers payment
@@ -745,7 +504,7 @@ export interface CustomerCreateParams {
    */
   name: string;
 
-  accounting_sync_configuration?: CustomerCreateParams.AccountingSyncConfiguration | null;
+  accounting_sync_configuration?: NewAccountingSyncConfiguration | null;
 
   /**
    * Additional email addresses for this customer. If populated, these email
@@ -760,7 +519,7 @@ export interface CustomerCreateParams {
    */
   auto_collection?: boolean | null;
 
-  billing_address?: CustomerCreateParams.BillingAddress | null;
+  billing_address?: AddressInput | null;
 
   /**
    * An ISO 4217 currency string used for the customer's invoices and balance. If not
@@ -780,7 +539,7 @@ export interface CustomerCreateParams {
   /**
    * The hierarchical relationships for this customer.
    */
-  hierarchy?: CustomerCreateParams.Hierarchy | null;
+  hierarchy?: CustomerHierarchyConfig | null;
 
   /**
    * User-specified key/value pairs for the resource. Individual keys can be removed
@@ -802,15 +561,11 @@ export interface CustomerCreateParams {
    */
   payment_provider_id?: string | null;
 
-  reporting_configuration?: CustomerCreateParams.ReportingConfiguration | null;
+  reporting_configuration?: NewReportingConfiguration | null;
 
-  shipping_address?: CustomerCreateParams.ShippingAddress | null;
+  shipping_address?: AddressInput | null;
 
-  tax_configuration?:
-    | CustomerCreateParams.NewAvalaraTaxConfiguration
-    | CustomerCreateParams.NewTaxJarConfiguration
-    | CustomerCreateParams.NewSphereConfiguration
-    | null;
+  tax_configuration?: NewAvalaraTaxConfiguration | NewTaxJarConfiguration | NewSphereConfiguration | null;
 
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
@@ -919,7 +674,7 @@ export interface CustomerCreateParams {
    * | Venezuela            | `ve_rif`     | Venezuelan RIF Number                                                                                   |
    * | Vietnam              | `vn_tin`     | Vietnamese Tax ID Number                                                                                |
    */
-  tax_id?: CustomerCreateParams.TaxID | null;
+  tax_id?: Shared.CustomerTaxID | null;
 
   /**
    * A timezone identifier from the IANA timezone database, such as
@@ -929,89 +684,82 @@ export interface CustomerCreateParams {
   timezone?: string | null;
 }
 
-export namespace CustomerCreateParams {
-  export interface AccountingSyncConfiguration {
-    accounting_providers?: Array<AccountingSyncConfiguration.AccountingProvider> | null;
-
-    excluded?: boolean | null;
-  }
-
-  export namespace AccountingSyncConfiguration {
-    export interface AccountingProvider {
-      external_provider_id: string;
+export interface CustomerUpdateParams {
+  accounting_sync_configuration?: NewAccountingSyncConfiguration | null;
 
-      provider_type: string;
-    }
-  }
+  /**
+   * Additional email addresses for this customer. If populated, these email
+   * addresses will be CC'd for customer communications.
+   */
+  additional_emails?: Array<string> | null;
 
-  export interface BillingAddress {
-    city?: string | 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_collection?: boolean | null;
 
-    country?: string | null;
+  billing_address?: AddressInput | null;
 
-    line1?: string | null;
+  /**
+   * An ISO 4217 currency string used for the customer's invoices and balance. If not
+   * set at creation time, will be set at subscription creation time.
+   */
+  currency?: string | null;
 
-    line2?: string | null;
+  /**
+   * A valid customer email, to be used for invoicing and notifications.
+   */
+  email?: string | null;
 
-    postal_code?: string | null;
+  email_delivery?: boolean | null;
 
-    state?: string | null;
-  }
+  /**
+   * The external customer ID. This can only be set if empty and the customer has no
+   * past or current subscriptions.
+   */
+  external_customer_id?: string | null;
 
   /**
    * The hierarchical relationships for this customer.
    */
-  export interface Hierarchy {
-    /**
-     * A list of child customer IDs to add to the hierarchy. The desired child
-     * customers must not already be part of another hierarchy.
-     */
-    child_customer_ids?: Array<string>;
-
-    /**
-     * The ID of the parent customer in the hierarchy. The desired parent customer must
-     * not be a child of another customer.
-     */
-    parent_customer_id?: string | null;
-  }
-
-  export interface ReportingConfiguration {
-    exempt: boolean;
-  }
-
-  export interface ShippingAddress {
-    city?: string | null;
-
-    country?: string | null;
-
-    line1?: string | null;
-
-    line2?: string | null;
+  hierarchy?: CustomerHierarchyConfig | null;
 
-    postal_code?: string | null;
-
-    state?: string | null;
-  }
-
-  export interface NewAvalaraTaxConfiguration {
-    tax_exempt: boolean;
+  /**
+   * 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`.
+   */
+  metadata?: Record<string, string | null> | null;
 
-    tax_provider: 'avalara';
+  /**
+   * The full name of the customer
+   */
+  name?: string | null;
 
-    tax_exemption_code?: 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.
+   */
+  payment_provider?: 'quickbooks' | 'bill.com' | 'stripe_charge' | 'stripe_invoice' | 'netsuite' | null;
 
-  export interface NewTaxJarConfiguration {
-    tax_exempt: boolean;
+  /**
+   * 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_id?: string | null;
 
-    tax_provider: 'taxjar';
-  }
+  reporting_configuration?: NewReportingConfiguration | null;
 
-  export interface NewSphereConfiguration {
-    tax_exempt: boolean;
+  shipping_address?: AddressInput | null;
 
-    tax_provider: 'sphere';
-  }
+  tax_configuration?: NewAvalaraTaxConfiguration | NewTaxJarConfiguration | NewSphereConfiguration | null;
 
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
@@ -1120,166 +868,21 @@ export namespace CustomerCreateParams {
    * | Venezuela            | `ve_rif`     | Venezuelan RIF Number                                                                                   |
    * | Vietnam              | `vn_tin`     | Vietnamese Tax ID Number                                                                                |
    */
-  export interface TaxID {
-    country:
-      | 'AD'
-      | 'AE'
-      | 'AR'
-      | 'AT'
-      | 'AU'
-      | 'BE'
-      | 'BG'
-      | 'BH'
-      | 'BO'
-      | 'BR'
-      | 'CA'
-      | 'CH'
-      | 'CL'
-      | 'CN'
-      | 'CO'
-      | 'CR'
-      | 'CY'
-      | 'CZ'
-      | 'DE'
-      | 'DK'
-      | 'EE'
-      | 'DO'
-      | 'EC'
-      | 'EG'
-      | 'ES'
-      | 'EU'
-      | 'FI'
-      | 'FR'
-      | 'GB'
-      | 'GE'
-      | 'GR'
-      | 'HK'
-      | 'HR'
-      | 'HU'
-      | 'ID'
-      | 'IE'
-      | 'IL'
-      | 'IN'
-      | 'IS'
-      | 'IT'
-      | 'JP'
-      | 'KE'
-      | 'KR'
-      | 'KZ'
-      | 'LI'
-      | 'LT'
-      | 'LU'
-      | 'LV'
-      | 'MT'
-      | 'MX'
-      | 'MY'
-      | 'NG'
-      | 'NL'
-      | 'NO'
-      | 'NZ'
-      | 'OM'
-      | 'PE'
-      | 'PH'
-      | 'PL'
-      | 'PT'
-      | 'RO'
-      | 'RS'
-      | 'RU'
-      | 'SA'
-      | 'SE'
-      | 'SG'
-      | 'SI'
-      | 'SK'
-      | 'SV'
-      | 'TH'
-      | 'TR'
-      | 'TW'
-      | 'UA'
-      | 'US'
-      | 'UY'
-      | 'VE'
-      | 'VN'
-      | 'ZA';
-
-    type:
-      | 'ad_nrt'
-      | 'ae_trn'
-      | 'ar_cuit'
-      | 'eu_vat'
-      | 'au_abn'
-      | 'au_arn'
-      | 'bg_uic'
-      | 'bh_vat'
-      | 'bo_tin'
-      | 'br_cnpj'
-      | 'br_cpf'
-      | 'ca_bn'
-      | 'ca_gst_hst'
-      | 'ca_pst_bc'
-      | 'ca_pst_mb'
-      | 'ca_pst_sk'
-      | 'ca_qst'
-      | 'ch_vat'
-      | 'cl_tin'
-      | 'cn_tin'
-      | 'co_nit'
-      | 'cr_tin'
-      | 'do_rcn'
-      | 'ec_ruc'
-      | 'eg_tin'
-      | 'es_cif'
-      | 'eu_oss_vat'
-      | 'gb_vat'
-      | 'ge_vat'
-      | 'hk_br'
-      | 'hu_tin'
-      | 'id_npwp'
-      | 'il_vat'
-      | 'in_gst'
-      | 'is_vat'
-      | 'jp_cn'
-      | 'jp_rn'
-      | 'jp_trn'
-      | 'ke_pin'
-      | 'kr_brn'
-      | 'kz_bin'
-      | 'li_uid'
-      | 'mx_rfc'
-      | 'my_frp'
-      | 'my_itn'
-      | 'my_sst'
-      | 'ng_tin'
-      | 'no_vat'
-      | 'no_voec'
-      | 'nz_gst'
-      | 'om_vat'
-      | 'pe_ruc'
-      | 'ph_tin'
-      | 'ro_tin'
-      | 'rs_pib'
-      | 'ru_inn'
-      | 'ru_kpp'
-      | 'sa_vat'
-      | 'sg_gst'
-      | 'sg_uen'
-      | 'si_tin'
-      | 'sv_nit'
-      | 'th_vat'
-      | 'tr_tin'
-      | 'tw_vat'
-      | 'ua_vat'
-      | 'us_ein'
-      | 'uy_ruc'
-      | 've_rif'
-      | 'vn_tin'
-      | 'za_vat';
-
-    value: string;
-  }
+  tax_id?: Shared.CustomerTaxID | null;
 }
 
-export interface CustomerUpdateParams {
-  accounting_sync_configuration?: CustomerUpdateParams.AccountingSyncConfiguration | null;
+export interface CustomerListParams extends PageParams {
+  'created_at[gt]'?: string | null;
+
+  'created_at[gte]'?: string | null;
+
+  'created_at[lt]'?: string | null;
+
+  'created_at[lte]'?: string | null;
+}
+
+export interface CustomerUpdateByExternalIDParams {
+  accounting_sync_configuration?: NewAccountingSyncConfiguration | null;
 
   /**
    * Additional email addresses for this customer. If populated, these email
@@ -1294,7 +897,7 @@ export interface CustomerUpdateParams {
    */
   auto_collection?: boolean | null;
 
-  billing_address?: CustomerUpdateParams.BillingAddress | null;
+  billing_address?: AddressInput | null;
 
   /**
    * An ISO 4217 currency string used for the customer's invoices and balance. If not
@@ -1318,7 +921,7 @@ export interface CustomerUpdateParams {
   /**
    * The hierarchical relationships for this customer.
    */
-  hierarchy?: CustomerUpdateParams.Hierarchy | null;
+  hierarchy?: CustomerHierarchyConfig | null;
 
   /**
    * User-specified key/value pairs for the resource. Individual keys can be removed
@@ -1349,15 +952,11 @@ export interface CustomerUpdateParams {
    */
   payment_provider_id?: string | null;
 
-  reporting_configuration?: CustomerUpdateParams.ReportingConfiguration | null;
+  reporting_configuration?: NewReportingConfiguration | null;
 
-  shipping_address?: CustomerUpdateParams.ShippingAddress | null;
+  shipping_address?: AddressInput | null;
 
-  tax_configuration?:
-    | CustomerUpdateParams.NewAvalaraTaxConfiguration
-    | CustomerUpdateParams.NewTaxJarConfiguration
-    | CustomerUpdateParams.NewSphereConfiguration
-    | null;
+  tax_configuration?: NewAvalaraTaxConfiguration | NewTaxJarConfiguration | NewSphereConfiguration | null;
 
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
@@ -1466,906 +1065,7 @@ export interface CustomerUpdateParams {
    * | Venezuela            | `ve_rif`     | Venezuelan RIF Number                                                                                   |
    * | Vietnam              | `vn_tin`     | Vietnamese Tax ID Number                                                                                |
    */
-  tax_id?: CustomerUpdateParams.TaxID | null;
-}
-
-export namespace CustomerUpdateParams {
-  export interface AccountingSyncConfiguration {
-    accounting_providers?: Array<AccountingSyncConfiguration.AccountingProvider> | null;
-
-    excluded?: boolean | null;
-  }
-
-  export namespace AccountingSyncConfiguration {
-    export interface AccountingProvider {
-      external_provider_id: string;
-
-      provider_type: string;
-    }
-  }
-
-  export interface BillingAddress {
-    city?: string | null;
-
-    country?: string | null;
-
-    line1?: string | null;
-
-    line2?: string | null;
-
-    postal_code?: string | null;
-
-    state?: string | null;
-  }
-
-  /**
-   * The hierarchical relationships for this customer.
-   */
-  export interface Hierarchy {
-    /**
-     * A list of child customer IDs to add to the hierarchy. The desired child
-     * customers must not already be part of another hierarchy.
-     */
-    child_customer_ids?: Array<string>;
-
-    /**
-     * The ID of the parent customer in the hierarchy. The desired parent customer must
-     * not be a child of another customer.
-     */
-    parent_customer_id?: string | null;
-  }
-
-  export interface ReportingConfiguration {
-    exempt: boolean;
-  }
-
-  export interface ShippingAddress {
-    city?: string | null;
-
-    country?: string | null;
-
-    line1?: string | null;
-
-    line2?: string | null;
-
-    postal_code?: string | null;
-
-    state?: string | null;
-  }
-
-  export interface NewAvalaraTaxConfiguration {
-    tax_exempt: boolean;
-
-    tax_provider: 'avalara';
-
-    tax_exemption_code?: string | null;
-  }
-
-  export interface NewTaxJarConfiguration {
-    tax_exempt: boolean;
-
-    tax_provider: 'taxjar';
-  }
-
-  export interface NewSphereConfiguration {
-    tax_exempt: boolean;
-
-    tax_provider: 'sphere';
-  }
-
-  /**
-   * 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                                                                                             |
-   * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
-   * | Andorra              | `ad_nrt`     | Andorran NRT Number                                                                                     |
-   * | Argentina            | `ar_cuit`    | Argentinian Tax ID Number                                                                               |
-   * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
-   * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
-   * | Austria              | `eu_vat`     | European VAT Number                                                                                     |
-   * | Bahrain              | `bh_vat`     | Bahraini VAT Number                                                                                     |
-   * | Belgium              | `eu_vat`     | European VAT Number                                                                                     |
-   * | Bolivia              | `bo_tin`     | Bolivian Tax ID                                                                                         |
-   * | 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                                                                                     |
-   * | 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)                                                                            |
-   * | Chile                | `cl_tin`     | Chilean TIN                                                                                             |
-   * | China                | `cn_tin`     | Chinese Tax ID                                                                                          |
-   * | Colombia             | `co_nit`     | Colombian NIT Number                                                                                    |
-   * | Costa Rica           | `cr_tin`     | Costa Rican Tax ID                                                                                      |
-   * | Croatia              | `eu_vat`     | European VAT Number                                                                                     |
-   * | 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                                                                                     |
-   * | EU                   | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
-   * | Finland              | `eu_vat`     | European VAT Number                                                                                     |
-   * | France               | `eu_vat`     | European VAT Number                                                                                     |
-   * | Georgia              | `ge_vat`     | Georgian VAT                                                                                            |
-   * | Germany              | `eu_vat`     | European VAT Number                                                                                     |
-   * | Greece               | `eu_vat`     | European VAT Number                                                                                     |
-   * | 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                                                                                     |
-   * | 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                                                  |
-   * | Latvia               | `eu_vat`     | European VAT Number                                                                                     |
-   * | Liechtenstein        | `li_uid`     | Liechtensteinian UID 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                                                                                     |
-   * | Mexico               | `mx_rfc`     | Mexican RFC Number                                                                                      |
-   * | Netherlands          | `eu_vat`     | European VAT Number                                                                                     |
-   * | New Zealand          | `nz_gst`     | New Zealand GST Number                                                                                  |
-   * | Nigeria              | `ng_tin`     | Nigerian Tax Identification Number                                                                      |
-   * | Norway               | `no_vat`     | Norwegian VAT Number                                                                                    |
-   * | Norway               | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
-   * | Oman                 | `om_vat`     | Omani VAT Number                                                                                        |
-   * | Peru                 | `pe_ruc`     | Peruvian RUC Number                                                                                     |
-   * | Philippines          | `ph_tin `    | Philippines Tax Identification Number                                                                   |
-   * | Poland               | `eu_vat`     | European VAT 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                                                                                        |
-   * | 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                                                                                     |
-   * | Sweden               | `eu_vat`     | European VAT Number                                                                                     |
-   * | Switzerland          | `ch_vat`     | Switzerland VAT Number                                                                                  |
-   * | Taiwan               | `tw_vat`     | Taiwanese VAT                                                                                           |
-   * | Thailand             | `th_vat`     | Thai VAT                                                                                                |
-   * | Turkey               | `tr_tin`     | Turkish Tax Identification Number                                                                       |
-   * | Ukraine              | `ua_vat`     | Ukrainian VAT                                                                                           |
-   * | United Arab Emirates | `ae_trn`     | United Arab Emirates TRN                                                                                |
-   * | United Kingdom       | `eu_vat`     | Northern Ireland VAT Number                                                                             |
-   * | United Kingdom       | `gb_vat`     | United Kingdom VAT Number                                                                               |
-   * | United States        | `us_ein`     | United States EIN                                                                                       |
-   * | Uruguay              | `uy_ruc`     | Uruguayan RUC Number                                                                                    |
-   * | Venezuela            | `ve_rif`     | Venezuelan RIF Number                                                                                   |
-   * | Vietnam              | `vn_tin`     | Vietnamese Tax ID Number                                                                                |
-   */
-  export interface TaxID {
-    country:
-      | 'AD'
-      | 'AE'
-      | 'AR'
-      | 'AT'
-      | 'AU'
-      | 'BE'
-      | 'BG'
-      | 'BH'
-      | 'BO'
-      | 'BR'
-      | 'CA'
-      | 'CH'
-      | 'CL'
-      | 'CN'
-      | 'CO'
-      | 'CR'
-      | 'CY'
-      | 'CZ'
-      | 'DE'
-      | 'DK'
-      | 'EE'
-      | 'DO'
-      | 'EC'
-      | 'EG'
-      | 'ES'
-      | 'EU'
-      | 'FI'
-      | 'FR'
-      | 'GB'
-      | 'GE'
-      | 'GR'
-      | 'HK'
-      | 'HR'
-      | 'HU'
-      | 'ID'
-      | 'IE'
-      | 'IL'
-      | 'IN'
-      | 'IS'
-      | 'IT'
-      | 'JP'
-      | 'KE'
-      | 'KR'
-      | 'KZ'
-      | 'LI'
-      | 'LT'
-      | 'LU'
-      | 'LV'
-      | 'MT'
-      | 'MX'
-      | 'MY'
-      | 'NG'
-      | 'NL'
-      | 'NO'
-      | 'NZ'
-      | 'OM'
-      | 'PE'
-      | 'PH'
-      | 'PL'
-      | 'PT'
-      | 'RO'
-      | 'RS'
-      | 'RU'
-      | 'SA'
-      | 'SE'
-      | 'SG'
-      | 'SI'
-      | 'SK'
-      | 'SV'
-      | 'TH'
-      | 'TR'
-      | 'TW'
-      | 'UA'
-      | 'US'
-      | 'UY'
-      | 'VE'
-      | 'VN'
-      | 'ZA';
-
-    type:
-      | 'ad_nrt'
-      | 'ae_trn'
-      | 'ar_cuit'
-      | 'eu_vat'
-      | 'au_abn'
-      | 'au_arn'
-      | 'bg_uic'
-      | 'bh_vat'
-      | 'bo_tin'
-      | 'br_cnpj'
-      | 'br_cpf'
-      | 'ca_bn'
-      | 'ca_gst_hst'
-      | 'ca_pst_bc'
-      | 'ca_pst_mb'
-      | 'ca_pst_sk'
-      | 'ca_qst'
-      | 'ch_vat'
-      | 'cl_tin'
-      | 'cn_tin'
-      | 'co_nit'
-      | 'cr_tin'
-      | 'do_rcn'
-      | 'ec_ruc'
-      | 'eg_tin'
-      | 'es_cif'
-      | 'eu_oss_vat'
-      | 'gb_vat'
-      | 'ge_vat'
-      | 'hk_br'
-      | 'hu_tin'
-      | 'id_npwp'
-      | 'il_vat'
-      | 'in_gst'
-      | 'is_vat'
-      | 'jp_cn'
-      | 'jp_rn'
-      | 'jp_trn'
-      | 'ke_pin'
-      | 'kr_brn'
-      | 'kz_bin'
-      | 'li_uid'
-      | 'mx_rfc'
-      | 'my_frp'
-      | 'my_itn'
-      | 'my_sst'
-      | 'ng_tin'
-      | 'no_vat'
-      | 'no_voec'
-      | 'nz_gst'
-      | 'om_vat'
-      | 'pe_ruc'
-      | 'ph_tin'
-      | 'ro_tin'
-      | 'rs_pib'
-      | 'ru_inn'
-      | 'ru_kpp'
-      | 'sa_vat'
-      | 'sg_gst'
-      | 'sg_uen'
-      | 'si_tin'
-      | 'sv_nit'
-      | 'th_vat'
-      | 'tr_tin'
-      | 'tw_vat'
-      | 'ua_vat'
-      | 'us_ein'
-      | 'uy_ruc'
-      | 've_rif'
-      | 'vn_tin'
-      | 'za_vat';
-
-    value: string;
-  }
-}
-
-export interface CustomerListParams extends PageParams {
-  'created_at[gt]'?: string | null;
-
-  'created_at[gte]'?: string | null;
-
-  'created_at[lt]'?: string | null;
-
-  'created_at[lte]'?: string | null;
-}
-
-export interface CustomerUpdateByExternalIDParams {
-  accounting_sync_configuration?: CustomerUpdateByExternalIDParams.AccountingSyncConfiguration | null;
-
-  /**
-   * Additional email addresses for this customer. If populated, these email
-   * addresses will be CC'd for customer communications.
-   */
-  additional_emails?: Array<string> | 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_collection?: boolean | null;
-
-  billing_address?: CustomerUpdateByExternalIDParams.BillingAddress | null;
-
-  /**
-   * An ISO 4217 currency string used for the customer's invoices and balance. If not
-   * set at creation time, will be set at subscription creation time.
-   */
-  currency?: string | null;
-
-  /**
-   * A valid customer email, to be used for invoicing and notifications.
-   */
-  email?: string | null;
-
-  email_delivery?: boolean | null;
-
-  /**
-   * The external customer ID. This can only be set if empty and the customer has no
-   * past or current subscriptions.
-   */
-  external_customer_id?: string | null;
-
-  /**
-   * The hierarchical relationships for this customer.
-   */
-  hierarchy?: CustomerUpdateByExternalIDParams.Hierarchy | 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`.
-   */
-  metadata?: Record<string, string | null> | null;
-
-  /**
-   * The full name of the customer
-   */
-  name?: 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.
-   */
-  payment_provider?: 'quickbooks' | 'bill.com' | 'stripe_charge' | 'stripe_invoice' | 'netsuite' | 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_id?: string | null;
-
-  reporting_configuration?: CustomerUpdateByExternalIDParams.ReportingConfiguration | null;
-
-  shipping_address?: CustomerUpdateByExternalIDParams.ShippingAddress | null;
-
-  tax_configuration?:
-    | CustomerUpdateByExternalIDParams.NewAvalaraTaxConfiguration
-    | CustomerUpdateByExternalIDParams.NewTaxJarConfiguration
-    | CustomerUpdateByExternalIDParams.NewSphereConfiguration
-    | 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                                                                                             |
-   * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
-   * | Andorra              | `ad_nrt`     | Andorran NRT Number                                                                                     |
-   * | Argentina            | `ar_cuit`    | Argentinian Tax ID Number                                                                               |
-   * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
-   * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
-   * | Austria              | `eu_vat`     | European VAT Number                                                                                     |
-   * | Bahrain              | `bh_vat`     | Bahraini VAT Number                                                                                     |
-   * | Belgium              | `eu_vat`     | European VAT Number                                                                                     |
-   * | Bolivia              | `bo_tin`     | Bolivian Tax ID                                                                                         |
-   * | 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                                                                                     |
-   * | 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)                                                                            |
-   * | Chile                | `cl_tin`     | Chilean TIN                                                                                             |
-   * | China                | `cn_tin`     | Chinese Tax ID                                                                                          |
-   * | Colombia             | `co_nit`     | Colombian NIT Number                                                                                    |
-   * | Costa Rica           | `cr_tin`     | Costa Rican Tax ID                                                                                      |
-   * | Croatia              | `eu_vat`     | European VAT Number                                                                                     |
-   * | 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                                                                                     |
-   * | EU                   | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
-   * | Finland              | `eu_vat`     | European VAT Number                                                                                     |
-   * | France               | `eu_vat`     | European VAT Number                                                                                     |
-   * | Georgia              | `ge_vat`     | Georgian VAT                                                                                            |
-   * | Germany              | `eu_vat`     | European VAT Number                                                                                     |
-   * | Greece               | `eu_vat`     | European VAT Number                                                                                     |
-   * | 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                                                                                     |
-   * | 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                                                  |
-   * | Latvia               | `eu_vat`     | European VAT Number                                                                                     |
-   * | Liechtenstein        | `li_uid`     | Liechtensteinian UID 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                                                                                     |
-   * | Mexico               | `mx_rfc`     | Mexican RFC Number                                                                                      |
-   * | Netherlands          | `eu_vat`     | European VAT Number                                                                                     |
-   * | New Zealand          | `nz_gst`     | New Zealand GST Number                                                                                  |
-   * | Nigeria              | `ng_tin`     | Nigerian Tax Identification Number                                                                      |
-   * | Norway               | `no_vat`     | Norwegian VAT Number                                                                                    |
-   * | Norway               | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
-   * | Oman                 | `om_vat`     | Omani VAT Number                                                                                        |
-   * | Peru                 | `pe_ruc`     | Peruvian RUC Number                                                                                     |
-   * | Philippines          | `ph_tin `    | Philippines Tax Identification Number                                                                   |
-   * | Poland               | `eu_vat`     | European VAT 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                                                                                        |
-   * | 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                                                                                     |
-   * | Sweden               | `eu_vat`     | European VAT Number                                                                                     |
-   * | Switzerland          | `ch_vat`     | Switzerland VAT Number                                                                                  |
-   * | Taiwan               | `tw_vat`     | Taiwanese VAT                                                                                           |
-   * | Thailand             | `th_vat`     | Thai VAT                                                                                                |
-   * | Turkey               | `tr_tin`     | Turkish Tax Identification Number                                                                       |
-   * | Ukraine              | `ua_vat`     | Ukrainian VAT                                                                                           |
-   * | United Arab Emirates | `ae_trn`     | United Arab Emirates TRN                                                                                |
-   * | United Kingdom       | `eu_vat`     | Northern Ireland VAT Number                                                                             |
-   * | United Kingdom       | `gb_vat`     | United Kingdom VAT Number                                                                               |
-   * | United States        | `us_ein`     | United States EIN                                                                                       |
-   * | Uruguay              | `uy_ruc`     | Uruguayan RUC Number                                                                                    |
-   * | Venezuela            | `ve_rif`     | Venezuelan RIF Number                                                                                   |
-   * | Vietnam              | `vn_tin`     | Vietnamese Tax ID Number                                                                                |
-   */
-  tax_id?: CustomerUpdateByExternalIDParams.TaxID | null;
-}
-
-export namespace CustomerUpdateByExternalIDParams {
-  export interface AccountingSyncConfiguration {
-    accounting_providers?: Array<AccountingSyncConfiguration.AccountingProvider> | null;
-
-    excluded?: boolean | null;
-  }
-
-  export namespace AccountingSyncConfiguration {
-    export interface AccountingProvider {
-      external_provider_id: string;
-
-      provider_type: string;
-    }
-  }
-
-  export interface BillingAddress {
-    city?: string | null;
-
-    country?: string | null;
-
-    line1?: string | null;
-
-    line2?: string | null;
-
-    postal_code?: string | null;
-
-    state?: string | null;
-  }
-
-  /**
-   * The hierarchical relationships for this customer.
-   */
-  export interface Hierarchy {
-    /**
-     * A list of child customer IDs to add to the hierarchy. The desired child
-     * customers must not already be part of another hierarchy.
-     */
-    child_customer_ids?: Array<string>;
-
-    /**
-     * The ID of the parent customer in the hierarchy. The desired parent customer must
-     * not be a child of another customer.
-     */
-    parent_customer_id?: string | null;
-  }
-
-  export interface ReportingConfiguration {
-    exempt: boolean;
-  }
-
-  export interface ShippingAddress {
-    city?: string | null;
-
-    country?: string | null;
-
-    line1?: string | null;
-
-    line2?: string | null;
-
-    postal_code?: string | null;
-
-    state?: string | null;
-  }
-
-  export interface NewAvalaraTaxConfiguration {
-    tax_exempt: boolean;
-
-    tax_provider: 'avalara';
-
-    tax_exemption_code?: string | null;
-  }
-
-  export interface NewTaxJarConfiguration {
-    tax_exempt: boolean;
-
-    tax_provider: 'taxjar';
-  }
-
-  export interface NewSphereConfiguration {
-    tax_exempt: boolean;
-
-    tax_provider: 'sphere';
-  }
-
-  /**
-   * 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                                                                                             |
-   * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
-   * | Andorra              | `ad_nrt`     | Andorran NRT Number                                                                                     |
-   * | Argentina            | `ar_cuit`    | Argentinian Tax ID Number                                                                               |
-   * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
-   * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
-   * | Austria              | `eu_vat`     | European VAT Number                                                                                     |
-   * | Bahrain              | `bh_vat`     | Bahraini VAT Number                                                                                     |
-   * | Belgium              | `eu_vat`     | European VAT Number                                                                                     |
-   * | Bolivia              | `bo_tin`     | Bolivian Tax ID                                                                                         |
-   * | 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                                                                                     |
-   * | 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)                                                                            |
-   * | Chile                | `cl_tin`     | Chilean TIN                                                                                             |
-   * | China                | `cn_tin`     | Chinese Tax ID                                                                                          |
-   * | Colombia             | `co_nit`     | Colombian NIT Number                                                                                    |
-   * | Costa Rica           | `cr_tin`     | Costa Rican Tax ID                                                                                      |
-   * | Croatia              | `eu_vat`     | European VAT Number                                                                                     |
-   * | 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                                                                                     |
-   * | EU                   | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
-   * | Finland              | `eu_vat`     | European VAT Number                                                                                     |
-   * | France               | `eu_vat`     | European VAT Number                                                                                     |
-   * | Georgia              | `ge_vat`     | Georgian VAT                                                                                            |
-   * | Germany              | `eu_vat`     | European VAT Number                                                                                     |
-   * | Greece               | `eu_vat`     | European VAT Number                                                                                     |
-   * | 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                                                                                     |
-   * | 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                                                  |
-   * | Latvia               | `eu_vat`     | European VAT Number                                                                                     |
-   * | Liechtenstein        | `li_uid`     | Liechtensteinian UID 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                                                                                     |
-   * | Mexico               | `mx_rfc`     | Mexican RFC Number                                                                                      |
-   * | Netherlands          | `eu_vat`     | European VAT Number                                                                                     |
-   * | New Zealand          | `nz_gst`     | New Zealand GST Number                                                                                  |
-   * | Nigeria              | `ng_tin`     | Nigerian Tax Identification Number                                                                      |
-   * | Norway               | `no_vat`     | Norwegian VAT Number                                                                                    |
-   * | Norway               | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
-   * | Oman                 | `om_vat`     | Omani VAT Number                                                                                        |
-   * | Peru                 | `pe_ruc`     | Peruvian RUC Number                                                                                     |
-   * | Philippines          | `ph_tin `    | Philippines Tax Identification Number                                                                   |
-   * | Poland               | `eu_vat`     | European VAT 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                                                                                        |
-   * | 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                                                                                     |
-   * | Sweden               | `eu_vat`     | European VAT Number                                                                                     |
-   * | Switzerland          | `ch_vat`     | Switzerland VAT Number                                                                                  |
-   * | Taiwan               | `tw_vat`     | Taiwanese VAT                                                                                           |
-   * | Thailand             | `th_vat`     | Thai VAT                                                                                                |
-   * | Turkey               | `tr_tin`     | Turkish Tax Identification Number                                                                       |
-   * | Ukraine              | `ua_vat`     | Ukrainian VAT                                                                                           |
-   * | United Arab Emirates | `ae_trn`     | United Arab Emirates TRN                                                                                |
-   * | United Kingdom       | `eu_vat`     | Northern Ireland VAT Number                                                                             |
-   * | United Kingdom       | `gb_vat`     | United Kingdom VAT Number                                                                               |
-   * | United States        | `us_ein`     | United States EIN                                                                                       |
-   * | Uruguay              | `uy_ruc`     | Uruguayan RUC Number                                                                                    |
-   * | Venezuela            | `ve_rif`     | Venezuelan RIF Number                                                                                   |
-   * | Vietnam              | `vn_tin`     | Vietnamese Tax ID Number                                                                                |
-   */
-  export interface TaxID {
-    country:
-      | 'AD'
-      | 'AE'
-      | 'AR'
-      | 'AT'
-      | 'AU'
-      | 'BE'
-      | 'BG'
-      | 'BH'
-      | 'BO'
-      | 'BR'
-      | 'CA'
-      | 'CH'
-      | 'CL'
-      | 'CN'
-      | 'CO'
-      | 'CR'
-      | 'CY'
-      | 'CZ'
-      | 'DE'
-      | 'DK'
-      | 'EE'
-      | 'DO'
-      | 'EC'
-      | 'EG'
-      | 'ES'
-      | 'EU'
-      | 'FI'
-      | 'FR'
-      | 'GB'
-      | 'GE'
-      | 'GR'
-      | 'HK'
-      | 'HR'
-      | 'HU'
-      | 'ID'
-      | 'IE'
-      | 'IL'
-      | 'IN'
-      | 'IS'
-      | 'IT'
-      | 'JP'
-      | 'KE'
-      | 'KR'
-      | 'KZ'
-      | 'LI'
-      | 'LT'
-      | 'LU'
-      | 'LV'
-      | 'MT'
-      | 'MX'
-      | 'MY'
-      | 'NG'
-      | 'NL'
-      | 'NO'
-      | 'NZ'
-      | 'OM'
-      | 'PE'
-      | 'PH'
-      | 'PL'
-      | 'PT'
-      | 'RO'
-      | 'RS'
-      | 'RU'
-      | 'SA'
-      | 'SE'
-      | 'SG'
-      | 'SI'
-      | 'SK'
-      | 'SV'
-      | 'TH'
-      | 'TR'
-      | 'TW'
-      | 'UA'
-      | 'US'
-      | 'UY'
-      | 'VE'
-      | 'VN'
-      | 'ZA';
-
-    type:
-      | 'ad_nrt'
-      | 'ae_trn'
-      | 'ar_cuit'
-      | 'eu_vat'
-      | 'au_abn'
-      | 'au_arn'
-      | 'bg_uic'
-      | 'bh_vat'
-      | 'bo_tin'
-      | 'br_cnpj'
-      | 'br_cpf'
-      | 'ca_bn'
-      | 'ca_gst_hst'
-      | 'ca_pst_bc'
-      | 'ca_pst_mb'
-      | 'ca_pst_sk'
-      | 'ca_qst'
-      | 'ch_vat'
-      | 'cl_tin'
-      | 'cn_tin'
-      | 'co_nit'
-      | 'cr_tin'
-      | 'do_rcn'
-      | 'ec_ruc'
-      | 'eg_tin'
-      | 'es_cif'
-      | 'eu_oss_vat'
-      | 'gb_vat'
-      | 'ge_vat'
-      | 'hk_br'
-      | 'hu_tin'
-      | 'id_npwp'
-      | 'il_vat'
-      | 'in_gst'
-      | 'is_vat'
-      | 'jp_cn'
-      | 'jp_rn'
-      | 'jp_trn'
-      | 'ke_pin'
-      | 'kr_brn'
-      | 'kz_bin'
-      | 'li_uid'
-      | 'mx_rfc'
-      | 'my_frp'
-      | 'my_itn'
-      | 'my_sst'
-      | 'ng_tin'
-      | 'no_vat'
-      | 'no_voec'
-      | 'nz_gst'
-      | 'om_vat'
-      | 'pe_ruc'
-      | 'ph_tin'
-      | 'ro_tin'
-      | 'rs_pib'
-      | 'ru_inn'
-      | 'ru_kpp'
-      | 'sa_vat'
-      | 'sg_gst'
-      | 'sg_uen'
-      | 'si_tin'
-      | 'sv_nit'
-      | 'th_vat'
-      | 'tr_tin'
-      | 'tw_vat'
-      | 'ua_vat'
-      | 'us_ein'
-      | 'uy_ruc'
-      | 've_rif'
-      | 'vn_tin'
-      | 'za_vat';
-
-    value: string;
-  }
+  tax_id?: Shared.CustomerTaxID | null;
 }
 
 Customers.CustomersPage = CustomersPage;
@@ -2378,7 +1078,15 @@ Customers.BalanceTransactionListResponsesPage = BalanceTransactionListResponsesP
 
 export declare namespace Customers {
   export {
+    type AccountingProviderConfig as AccountingProviderConfig,
+    type AddressInput as AddressInput,
     type Customer as Customer,
+    type CustomerHierarchyConfig as CustomerHierarchyConfig,
+    type NewAccountingSyncConfiguration as NewAccountingSyncConfiguration,
+    type NewAvalaraTaxConfiguration as NewAvalaraTaxConfiguration,
+    type NewReportingConfiguration as NewReportingConfiguration,
+    type NewSphereConfiguration as NewSphereConfiguration,
+    type NewTaxJarConfiguration as NewTaxJarConfiguration,
     CustomersPage as CustomersPage,
     type CustomerCreateParams as CustomerCreateParams,
     type CustomerUpdateParams as CustomerUpdateParams,