diff --git a/.release-please-manifest.json b/.release-please-manifest.json
index 448d10af..9bf38528 100644
--- a/.release-please-manifest.json
+++ b/.release-please-manifest.json
@@ -1,3 +1,3 @@
{
- ".": "5.4.0"
+ ".": "5.5.0"
}
diff --git a/.stats.yml b/.stats.yml
index 82cec55f..c03739d1 100644
--- a/.stats.yml
+++ b/.stats.yml
@@ -1,4 +1,4 @@
-configured_endpoints: 116
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-1aabbd8715a871e993abf67f0bf9c1d6793b4f197c4b2f11fc7a76453590cd6c.yml
-openapi_spec_hash: 3e5878f87e74881d882a69e1ccdc25a3
-config_hash: 1f535c1fa222aacf28b636eed21bec72
+configured_endpoints: 118
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-4f31d46f5ba187fc4d702c9f9f1573dacb891edbd086f935707578d7c4f5fed8.yml
+openapi_spec_hash: 25b1019f20a47b8af665aae5f8fd0025
+config_hash: 5135e9237207028f293049a77428c775
diff --git a/CHANGELOG.md b/CHANGELOG.md
index dd9ac6b4..f95aedf4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,13 @@
# Changelog
+## 5.5.0 (2025-07-26)
+
+Full Changelog: [v5.4.0...v5.5.0](https://github.com/orbcorp/orb-node/compare/v5.4.0...v5.5.0)
+
+### Features
+
+* **api:** api update ([56034ca](https://github.com/orbcorp/orb-node/commit/56034cab5a3cfbe778cb18a5bbb2d90eaa88b307))
+
## 5.4.0 (2025-07-24)
Full Changelog: [v5.3.0...v5.4.0](https://github.com/orbcorp/orb-node/compare/v5.3.0...v5.4.0)
diff --git a/api.md b/api.md
index e293b0dc..6ae6edfa 100644
--- a/api.md
+++ b/api.md
@@ -541,6 +541,7 @@ Methods:
- client.dimensionalPriceGroups.create({ ...params }) -> DimensionalPriceGroup
- client.dimensionalPriceGroups.retrieve(dimensionalPriceGroupId) -> DimensionalPriceGroup
+- client.dimensionalPriceGroups.update(dimensionalPriceGroupId, { ...params }) -> DimensionalPriceGroup
- client.dimensionalPriceGroups.list({ ...params }) -> DimensionalPriceGroupsPage
## ExternalDimensionalPriceGroupID
@@ -548,6 +549,7 @@ Methods:
Methods:
- client.dimensionalPriceGroups.externalDimensionalPriceGroupId.retrieve(externalDimensionalPriceGroupId) -> DimensionalPriceGroup
+- client.dimensionalPriceGroups.externalDimensionalPriceGroupId.update(externalDimensionalPriceGroupId, { ...params }) -> DimensionalPriceGroup
# SubscriptionChanges
diff --git a/package.json b/package.json
index 095c4ebd..f80d5122 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "orb-billing",
- "version": "5.4.0",
+ "version": "5.5.0",
"description": "The official TypeScript library for the Orb API",
"author": "Orb ",
"types": "dist/index.d.ts",
diff --git a/src/index.ts b/src/index.ts
index 36cbde95..d9c5b5b4 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -149,6 +149,7 @@ import {
DimensionalPriceGroup,
DimensionalPriceGroupCreateParams,
DimensionalPriceGroupListParams,
+ DimensionalPriceGroupUpdateParams,
DimensionalPriceGroups,
DimensionalPriceGroupsPage,
} from './resources/dimensional-price-groups/dimensional-price-groups';
@@ -600,6 +601,7 @@ export declare namespace Orb {
type DimensionalPriceGroup as DimensionalPriceGroup,
DimensionalPriceGroupsPage as DimensionalPriceGroupsPage,
type DimensionalPriceGroupCreateParams as DimensionalPriceGroupCreateParams,
+ type DimensionalPriceGroupUpdateParams as DimensionalPriceGroupUpdateParams,
type DimensionalPriceGroupListParams as DimensionalPriceGroupListParams,
};
diff --git a/src/resources/customers/customers.ts b/src/resources/customers/customers.ts
index 67ac22c9..297fd941 100644
--- a/src/resources/customers/customers.ts
+++ b/src/resources/customers/customers.ts
@@ -303,106 +303,145 @@ export interface Customer {
*
* ### 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 |
+ * | Country | Type | Description |
+ * | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+ * | Albania | `al_tin` | Albania Tax Identification Number |
+ * | Andorra | `ad_nrt` | Andorran NRT Number |
+ * | Angola | `ao_tin` | Angola Tax Identification Number |
+ * | Argentina | `ar_cuit` | Argentinian Tax ID Number |
+ * | Armenia | `am_tin` | Armenia Tax Identification Number |
+ * | Aruba | `aw_tin` | Aruba Tax Identification Number |
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
+ * | Austria | `eu_vat` | European VAT Number |
+ * | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
+ * | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
+ * | Bahrain | `bh_vat` | Bahraini VAT Number |
+ * | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
+ * | Barbados | `bb_tin` | Barbados Tax Identification Number |
+ * | Belarus | `by_tin` | Belarus TIN Number |
+ * | Belgium | `eu_vat` | European VAT Number |
+ * | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
+ * | Bolivia | `bo_tin` | Bolivian Tax ID |
+ * | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
+ * | Brazil | `br_cnpj` | Brazilian CNPJ Number |
+ * | Brazil | `br_cpf` | Brazilian CPF Number |
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
+ * | Bulgaria | `eu_vat` | European VAT Number |
+ * | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
+ * | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
+ * | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
+ * | Canada | `ca_bn` | Canadian BN |
+ * | Canada | `ca_gst_hst` | Canadian GST/HST Number |
+ * | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
+ * | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
+ * | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
+ * | Canada | `ca_qst` | Canadian QST Number (Québec) |
+ * | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
+ * | Chile | `cl_tin` | Chilean TIN |
+ * | China | `cn_tin` | Chinese Tax ID |
+ * | Colombia | `co_nit` | Colombian NIT Number |
+ * | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
+ * | Costa Rica | `cr_tin` | Costa Rican Tax ID |
+ * | Croatia | `eu_vat` | European VAT Number |
+ * | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
+ * | Cyprus | `eu_vat` | European VAT Number |
+ * | Czech Republic | `eu_vat` | European VAT Number |
+ * | Denmark | `eu_vat` | European VAT Number |
+ * | Dominican Republic | `do_rcn` | Dominican RCN Number |
+ * | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
+ * | El Salvador | `sv_nit` | El Salvadorian NIT Number |
+ * | Estonia | `eu_vat` | European VAT Number |
+ * | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
+ * | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
+ * | Finland | `eu_vat` | European VAT Number |
+ * | France | `eu_vat` | European VAT Number |
+ * | Georgia | `ge_vat` | Georgian VAT |
+ * | Germany | `de_stn` | German Tax Number (Steuernummer) |
+ * | Germany | `eu_vat` | European VAT Number |
+ * | Greece | `eu_vat` | European VAT Number |
+ * | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
+ * | Hong Kong | `hk_br` | Hong Kong BR Number |
+ * | Hungary | `eu_vat` | European VAT Number |
+ * | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
+ * | Iceland | `is_vat` | Icelandic VAT |
+ * | India | `in_gst` | Indian GST Number |
+ * | Indonesia | `id_npwp` | Indonesian NPWP Number |
+ * | Ireland | `eu_vat` | European VAT Number |
+ * | Israel | `il_vat` | Israel VAT |
+ * | Italy | `eu_vat` | European VAT Number |
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
+ * | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
+ * | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
+ * | Laos | `la_tin` | Laos Tax Identification Number |
+ * | Latvia | `eu_vat` | European VAT Number |
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
+ * | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
+ * | Lithuania | `eu_vat` | European VAT Number |
+ * | Luxembourg | `eu_vat` | European VAT Number |
+ * | Malaysia | `my_frp` | Malaysian FRP Number |
+ * | Malaysia | `my_itn` | Malaysian ITN |
+ * | Malaysia | `my_sst` | Malaysian SST Number |
+ * | Malta | `eu_vat` | European VAT Number |
+ * | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
+ * | Mexico | `mx_rfc` | Mexican RFC Number |
+ * | Moldova | `md_vat` | Moldova VAT Number |
+ * | Montenegro | `me_pib` | Montenegro PIB Number |
+ * | Morocco | `ma_vat` | Morocco VAT Number |
+ * | Nepal | `np_pan` | Nepal PAN Number |
+ * | Netherlands | `eu_vat` | European VAT Number |
+ * | New Zealand | `nz_gst` | New Zealand GST Number |
+ * | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
+ * | North Macedonia | `mk_vat` | North Macedonia VAT Number |
+ * | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
+ * | Norway | `no_vat` | Norwegian VAT Number |
+ * | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
+ * | Oman | `om_vat` | Omani VAT Number |
+ * | 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 |
+ * | Senegal | `sn_ninea` | Senegal NINEA Number |
+ * | Serbia | `rs_pib` | Serbian PIB Number |
+ * | Singapore | `sg_gst` | Singaporean GST |
+ * | Singapore | `sg_uen` | Singaporean UEN |
+ * | Slovakia | `eu_vat` | European VAT Number |
+ * | Slovenia | `eu_vat` | European VAT Number |
+ * | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
+ * | South Africa | `za_vat` | South African VAT Number |
+ * | South Korea | `kr_brn` | Korean BRN |
+ * | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
+ * | Spain | `eu_vat` | European VAT Number |
+ * | Suriname | `sr_fin` | Suriname FIN Number |
+ * | Sweden | `eu_vat` | European VAT Number |
+ * | Switzerland | `ch_uid` | Switzerland UID Number |
+ * | Switzerland | `ch_vat` | Switzerland VAT Number |
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
+ * | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
+ * | Tanzania | `tz_vat` | Tanzania VAT Number |
+ * | Thailand | `th_vat` | Thai VAT |
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
+ * | Uganda | `ug_tin` | Uganda Tax Identification Number |
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
+ * | United Kingdom | `gb_vat` | United Kingdom VAT Number |
+ * | United States | `us_ein` | United States EIN |
+ * | Uruguay | `uy_ruc` | Uruguayan RUC Number |
+ * | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
+ * | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
+ * | Venezuela | `ve_rif` | Venezuelan RIF Number |
+ * | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
+ * | Zambia | `zm_tin` | Zambia Tax Identification Number |
+ * | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
*/
tax_id: Shared.CustomerTaxID | null;
@@ -573,106 +612,145 @@ export interface CustomerCreateParams {
*
* ### 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 |
+ * | Country | Type | Description |
+ * | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+ * | Albania | `al_tin` | Albania Tax Identification Number |
+ * | Andorra | `ad_nrt` | Andorran NRT Number |
+ * | Angola | `ao_tin` | Angola Tax Identification Number |
+ * | Argentina | `ar_cuit` | Argentinian Tax ID Number |
+ * | Armenia | `am_tin` | Armenia Tax Identification Number |
+ * | Aruba | `aw_tin` | Aruba Tax Identification Number |
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
+ * | Austria | `eu_vat` | European VAT Number |
+ * | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
+ * | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
+ * | Bahrain | `bh_vat` | Bahraini VAT Number |
+ * | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
+ * | Barbados | `bb_tin` | Barbados Tax Identification Number |
+ * | Belarus | `by_tin` | Belarus TIN Number |
+ * | Belgium | `eu_vat` | European VAT Number |
+ * | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
+ * | Bolivia | `bo_tin` | Bolivian Tax ID |
+ * | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
+ * | Brazil | `br_cnpj` | Brazilian CNPJ Number |
+ * | Brazil | `br_cpf` | Brazilian CPF Number |
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
+ * | Bulgaria | `eu_vat` | European VAT Number |
+ * | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
+ * | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
+ * | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
+ * | Canada | `ca_bn` | Canadian BN |
+ * | Canada | `ca_gst_hst` | Canadian GST/HST Number |
+ * | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
+ * | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
+ * | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
+ * | Canada | `ca_qst` | Canadian QST Number (Québec) |
+ * | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
+ * | Chile | `cl_tin` | Chilean TIN |
+ * | China | `cn_tin` | Chinese Tax ID |
+ * | Colombia | `co_nit` | Colombian NIT Number |
+ * | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
+ * | Costa Rica | `cr_tin` | Costa Rican Tax ID |
+ * | Croatia | `eu_vat` | European VAT Number |
+ * | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
+ * | Cyprus | `eu_vat` | European VAT Number |
+ * | Czech Republic | `eu_vat` | European VAT Number |
+ * | Denmark | `eu_vat` | European VAT Number |
+ * | Dominican Republic | `do_rcn` | Dominican RCN Number |
+ * | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
+ * | El Salvador | `sv_nit` | El Salvadorian NIT Number |
+ * | Estonia | `eu_vat` | European VAT Number |
+ * | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
+ * | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
+ * | Finland | `eu_vat` | European VAT Number |
+ * | France | `eu_vat` | European VAT Number |
+ * | Georgia | `ge_vat` | Georgian VAT |
+ * | Germany | `de_stn` | German Tax Number (Steuernummer) |
+ * | Germany | `eu_vat` | European VAT Number |
+ * | Greece | `eu_vat` | European VAT Number |
+ * | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
+ * | Hong Kong | `hk_br` | Hong Kong BR Number |
+ * | Hungary | `eu_vat` | European VAT Number |
+ * | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
+ * | Iceland | `is_vat` | Icelandic VAT |
+ * | India | `in_gst` | Indian GST Number |
+ * | Indonesia | `id_npwp` | Indonesian NPWP Number |
+ * | Ireland | `eu_vat` | European VAT Number |
+ * | Israel | `il_vat` | Israel VAT |
+ * | Italy | `eu_vat` | European VAT Number |
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
+ * | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
+ * | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
+ * | Laos | `la_tin` | Laos Tax Identification Number |
+ * | Latvia | `eu_vat` | European VAT Number |
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
+ * | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
+ * | Lithuania | `eu_vat` | European VAT Number |
+ * | Luxembourg | `eu_vat` | European VAT Number |
+ * | Malaysia | `my_frp` | Malaysian FRP Number |
+ * | Malaysia | `my_itn` | Malaysian ITN |
+ * | Malaysia | `my_sst` | Malaysian SST Number |
+ * | Malta | `eu_vat` | European VAT Number |
+ * | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
+ * | Mexico | `mx_rfc` | Mexican RFC Number |
+ * | Moldova | `md_vat` | Moldova VAT Number |
+ * | Montenegro | `me_pib` | Montenegro PIB Number |
+ * | Morocco | `ma_vat` | Morocco VAT Number |
+ * | Nepal | `np_pan` | Nepal PAN Number |
+ * | Netherlands | `eu_vat` | European VAT Number |
+ * | New Zealand | `nz_gst` | New Zealand GST Number |
+ * | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
+ * | North Macedonia | `mk_vat` | North Macedonia VAT Number |
+ * | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
+ * | Norway | `no_vat` | Norwegian VAT Number |
+ * | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
+ * | Oman | `om_vat` | Omani VAT Number |
+ * | 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 |
+ * | Senegal | `sn_ninea` | Senegal NINEA Number |
+ * | Serbia | `rs_pib` | Serbian PIB Number |
+ * | Singapore | `sg_gst` | Singaporean GST |
+ * | Singapore | `sg_uen` | Singaporean UEN |
+ * | Slovakia | `eu_vat` | European VAT Number |
+ * | Slovenia | `eu_vat` | European VAT Number |
+ * | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
+ * | South Africa | `za_vat` | South African VAT Number |
+ * | South Korea | `kr_brn` | Korean BRN |
+ * | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
+ * | Spain | `eu_vat` | European VAT Number |
+ * | Suriname | `sr_fin` | Suriname FIN Number |
+ * | Sweden | `eu_vat` | European VAT Number |
+ * | Switzerland | `ch_uid` | Switzerland UID Number |
+ * | Switzerland | `ch_vat` | Switzerland VAT Number |
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
+ * | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
+ * | Tanzania | `tz_vat` | Tanzania VAT Number |
+ * | Thailand | `th_vat` | Thai VAT |
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
+ * | Uganda | `ug_tin` | Uganda Tax Identification Number |
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
+ * | United Kingdom | `gb_vat` | United Kingdom VAT Number |
+ * | United States | `us_ein` | United States EIN |
+ * | Uruguay | `uy_ruc` | Uruguayan RUC Number |
+ * | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
+ * | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
+ * | Venezuela | `ve_rif` | Venezuelan RIF Number |
+ * | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
+ * | Zambia | `zm_tin` | Zambia Tax Identification Number |
+ * | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
*/
tax_id?: Shared.CustomerTaxID | null;
@@ -770,106 +848,145 @@ export interface CustomerUpdateParams {
*
* ### 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 |
+ * | Country | Type | Description |
+ * | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+ * | Albania | `al_tin` | Albania Tax Identification Number |
+ * | Andorra | `ad_nrt` | Andorran NRT Number |
+ * | Angola | `ao_tin` | Angola Tax Identification Number |
+ * | Argentina | `ar_cuit` | Argentinian Tax ID Number |
+ * | Armenia | `am_tin` | Armenia Tax Identification Number |
+ * | Aruba | `aw_tin` | Aruba Tax Identification Number |
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
+ * | Austria | `eu_vat` | European VAT Number |
+ * | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
+ * | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
+ * | Bahrain | `bh_vat` | Bahraini VAT Number |
+ * | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
+ * | Barbados | `bb_tin` | Barbados Tax Identification Number |
+ * | Belarus | `by_tin` | Belarus TIN Number |
+ * | Belgium | `eu_vat` | European VAT Number |
+ * | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
+ * | Bolivia | `bo_tin` | Bolivian Tax ID |
+ * | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
+ * | Brazil | `br_cnpj` | Brazilian CNPJ Number |
+ * | Brazil | `br_cpf` | Brazilian CPF Number |
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
+ * | Bulgaria | `eu_vat` | European VAT Number |
+ * | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
+ * | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
+ * | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
+ * | Canada | `ca_bn` | Canadian BN |
+ * | Canada | `ca_gst_hst` | Canadian GST/HST Number |
+ * | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
+ * | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
+ * | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
+ * | Canada | `ca_qst` | Canadian QST Number (Québec) |
+ * | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
+ * | Chile | `cl_tin` | Chilean TIN |
+ * | China | `cn_tin` | Chinese Tax ID |
+ * | Colombia | `co_nit` | Colombian NIT Number |
+ * | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
+ * | Costa Rica | `cr_tin` | Costa Rican Tax ID |
+ * | Croatia | `eu_vat` | European VAT Number |
+ * | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
+ * | Cyprus | `eu_vat` | European VAT Number |
+ * | Czech Republic | `eu_vat` | European VAT Number |
+ * | Denmark | `eu_vat` | European VAT Number |
+ * | Dominican Republic | `do_rcn` | Dominican RCN Number |
+ * | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
+ * | El Salvador | `sv_nit` | El Salvadorian NIT Number |
+ * | Estonia | `eu_vat` | European VAT Number |
+ * | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
+ * | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
+ * | Finland | `eu_vat` | European VAT Number |
+ * | France | `eu_vat` | European VAT Number |
+ * | Georgia | `ge_vat` | Georgian VAT |
+ * | Germany | `de_stn` | German Tax Number (Steuernummer) |
+ * | Germany | `eu_vat` | European VAT Number |
+ * | Greece | `eu_vat` | European VAT Number |
+ * | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
+ * | Hong Kong | `hk_br` | Hong Kong BR Number |
+ * | Hungary | `eu_vat` | European VAT Number |
+ * | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
+ * | Iceland | `is_vat` | Icelandic VAT |
+ * | India | `in_gst` | Indian GST Number |
+ * | Indonesia | `id_npwp` | Indonesian NPWP Number |
+ * | Ireland | `eu_vat` | European VAT Number |
+ * | Israel | `il_vat` | Israel VAT |
+ * | Italy | `eu_vat` | European VAT Number |
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
+ * | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
+ * | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
+ * | Laos | `la_tin` | Laos Tax Identification Number |
+ * | Latvia | `eu_vat` | European VAT Number |
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
+ * | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
+ * | Lithuania | `eu_vat` | European VAT Number |
+ * | Luxembourg | `eu_vat` | European VAT Number |
+ * | Malaysia | `my_frp` | Malaysian FRP Number |
+ * | Malaysia | `my_itn` | Malaysian ITN |
+ * | Malaysia | `my_sst` | Malaysian SST Number |
+ * | Malta | `eu_vat` | European VAT Number |
+ * | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
+ * | Mexico | `mx_rfc` | Mexican RFC Number |
+ * | Moldova | `md_vat` | Moldova VAT Number |
+ * | Montenegro | `me_pib` | Montenegro PIB Number |
+ * | Morocco | `ma_vat` | Morocco VAT Number |
+ * | Nepal | `np_pan` | Nepal PAN Number |
+ * | Netherlands | `eu_vat` | European VAT Number |
+ * | New Zealand | `nz_gst` | New Zealand GST Number |
+ * | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
+ * | North Macedonia | `mk_vat` | North Macedonia VAT Number |
+ * | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
+ * | Norway | `no_vat` | Norwegian VAT Number |
+ * | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
+ * | Oman | `om_vat` | Omani VAT Number |
+ * | 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 |
+ * | Senegal | `sn_ninea` | Senegal NINEA Number |
+ * | Serbia | `rs_pib` | Serbian PIB Number |
+ * | Singapore | `sg_gst` | Singaporean GST |
+ * | Singapore | `sg_uen` | Singaporean UEN |
+ * | Slovakia | `eu_vat` | European VAT Number |
+ * | Slovenia | `eu_vat` | European VAT Number |
+ * | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
+ * | South Africa | `za_vat` | South African VAT Number |
+ * | South Korea | `kr_brn` | Korean BRN |
+ * | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
+ * | Spain | `eu_vat` | European VAT Number |
+ * | Suriname | `sr_fin` | Suriname FIN Number |
+ * | Sweden | `eu_vat` | European VAT Number |
+ * | Switzerland | `ch_uid` | Switzerland UID Number |
+ * | Switzerland | `ch_vat` | Switzerland VAT Number |
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
+ * | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
+ * | Tanzania | `tz_vat` | Tanzania VAT Number |
+ * | Thailand | `th_vat` | Thai VAT |
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
+ * | Uganda | `ug_tin` | Uganda Tax Identification Number |
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
+ * | United Kingdom | `gb_vat` | United Kingdom VAT Number |
+ * | United States | `us_ein` | United States EIN |
+ * | Uruguay | `uy_ruc` | Uruguayan RUC Number |
+ * | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
+ * | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
+ * | Venezuela | `ve_rif` | Venezuelan RIF Number |
+ * | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
+ * | Zambia | `zm_tin` | Zambia Tax Identification Number |
+ * | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
*/
tax_id?: Shared.CustomerTaxID | null;
}
@@ -970,106 +1087,145 @@ export interface CustomerUpdateByExternalIDParams {
*
* ### 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 |
+ * | Country | Type | Description |
+ * | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+ * | Albania | `al_tin` | Albania Tax Identification Number |
+ * | Andorra | `ad_nrt` | Andorran NRT Number |
+ * | Angola | `ao_tin` | Angola Tax Identification Number |
+ * | Argentina | `ar_cuit` | Argentinian Tax ID Number |
+ * | Armenia | `am_tin` | Armenia Tax Identification Number |
+ * | Aruba | `aw_tin` | Aruba Tax Identification Number |
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
+ * | Austria | `eu_vat` | European VAT Number |
+ * | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
+ * | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
+ * | Bahrain | `bh_vat` | Bahraini VAT Number |
+ * | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
+ * | Barbados | `bb_tin` | Barbados Tax Identification Number |
+ * | Belarus | `by_tin` | Belarus TIN Number |
+ * | Belgium | `eu_vat` | European VAT Number |
+ * | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
+ * | Bolivia | `bo_tin` | Bolivian Tax ID |
+ * | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
+ * | Brazil | `br_cnpj` | Brazilian CNPJ Number |
+ * | Brazil | `br_cpf` | Brazilian CPF Number |
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
+ * | Bulgaria | `eu_vat` | European VAT Number |
+ * | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
+ * | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
+ * | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
+ * | Canada | `ca_bn` | Canadian BN |
+ * | Canada | `ca_gst_hst` | Canadian GST/HST Number |
+ * | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
+ * | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
+ * | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
+ * | Canada | `ca_qst` | Canadian QST Number (Québec) |
+ * | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
+ * | Chile | `cl_tin` | Chilean TIN |
+ * | China | `cn_tin` | Chinese Tax ID |
+ * | Colombia | `co_nit` | Colombian NIT Number |
+ * | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
+ * | Costa Rica | `cr_tin` | Costa Rican Tax ID |
+ * | Croatia | `eu_vat` | European VAT Number |
+ * | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
+ * | Cyprus | `eu_vat` | European VAT Number |
+ * | Czech Republic | `eu_vat` | European VAT Number |
+ * | Denmark | `eu_vat` | European VAT Number |
+ * | Dominican Republic | `do_rcn` | Dominican RCN Number |
+ * | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
+ * | El Salvador | `sv_nit` | El Salvadorian NIT Number |
+ * | Estonia | `eu_vat` | European VAT Number |
+ * | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
+ * | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
+ * | Finland | `eu_vat` | European VAT Number |
+ * | France | `eu_vat` | European VAT Number |
+ * | Georgia | `ge_vat` | Georgian VAT |
+ * | Germany | `de_stn` | German Tax Number (Steuernummer) |
+ * | Germany | `eu_vat` | European VAT Number |
+ * | Greece | `eu_vat` | European VAT Number |
+ * | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
+ * | Hong Kong | `hk_br` | Hong Kong BR Number |
+ * | Hungary | `eu_vat` | European VAT Number |
+ * | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
+ * | Iceland | `is_vat` | Icelandic VAT |
+ * | India | `in_gst` | Indian GST Number |
+ * | Indonesia | `id_npwp` | Indonesian NPWP Number |
+ * | Ireland | `eu_vat` | European VAT Number |
+ * | Israel | `il_vat` | Israel VAT |
+ * | Italy | `eu_vat` | European VAT Number |
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
+ * | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
+ * | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
+ * | Laos | `la_tin` | Laos Tax Identification Number |
+ * | Latvia | `eu_vat` | European VAT Number |
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
+ * | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
+ * | Lithuania | `eu_vat` | European VAT Number |
+ * | Luxembourg | `eu_vat` | European VAT Number |
+ * | Malaysia | `my_frp` | Malaysian FRP Number |
+ * | Malaysia | `my_itn` | Malaysian ITN |
+ * | Malaysia | `my_sst` | Malaysian SST Number |
+ * | Malta | `eu_vat` | European VAT Number |
+ * | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
+ * | Mexico | `mx_rfc` | Mexican RFC Number |
+ * | Moldova | `md_vat` | Moldova VAT Number |
+ * | Montenegro | `me_pib` | Montenegro PIB Number |
+ * | Morocco | `ma_vat` | Morocco VAT Number |
+ * | Nepal | `np_pan` | Nepal PAN Number |
+ * | Netherlands | `eu_vat` | European VAT Number |
+ * | New Zealand | `nz_gst` | New Zealand GST Number |
+ * | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
+ * | North Macedonia | `mk_vat` | North Macedonia VAT Number |
+ * | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
+ * | Norway | `no_vat` | Norwegian VAT Number |
+ * | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
+ * | Oman | `om_vat` | Omani VAT Number |
+ * | 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 |
+ * | Senegal | `sn_ninea` | Senegal NINEA Number |
+ * | Serbia | `rs_pib` | Serbian PIB Number |
+ * | Singapore | `sg_gst` | Singaporean GST |
+ * | Singapore | `sg_uen` | Singaporean UEN |
+ * | Slovakia | `eu_vat` | European VAT Number |
+ * | Slovenia | `eu_vat` | European VAT Number |
+ * | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
+ * | South Africa | `za_vat` | South African VAT Number |
+ * | South Korea | `kr_brn` | Korean BRN |
+ * | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
+ * | Spain | `eu_vat` | European VAT Number |
+ * | Suriname | `sr_fin` | Suriname FIN Number |
+ * | Sweden | `eu_vat` | European VAT Number |
+ * | Switzerland | `ch_uid` | Switzerland UID Number |
+ * | Switzerland | `ch_vat` | Switzerland VAT Number |
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
+ * | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
+ * | Tanzania | `tz_vat` | Tanzania VAT Number |
+ * | Thailand | `th_vat` | Thai VAT |
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
+ * | Uganda | `ug_tin` | Uganda Tax Identification Number |
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
+ * | United Kingdom | `gb_vat` | United Kingdom VAT Number |
+ * | United States | `us_ein` | United States EIN |
+ * | Uruguay | `uy_ruc` | Uruguayan RUC Number |
+ * | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
+ * | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
+ * | Venezuela | `ve_rif` | Venezuelan RIF Number |
+ * | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
+ * | Zambia | `zm_tin` | Zambia Tax Identification Number |
+ * | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
*/
tax_id?: Shared.CustomerTaxID | null;
}
diff --git a/src/resources/dimensional-price-groups/dimensional-price-groups.ts b/src/resources/dimensional-price-groups/dimensional-price-groups.ts
index 189d7c2c..f54aa91f 100644
--- a/src/resources/dimensional-price-groups/dimensional-price-groups.ts
+++ b/src/resources/dimensional-price-groups/dimensional-price-groups.ts
@@ -5,7 +5,10 @@ import { isRequestOptions } from '../../core';
import * as Core from '../../core';
import * as Shared from '../shared';
import * as ExternalDimensionalPriceGroupIDAPI from './external-dimensional-price-group-id';
-import { ExternalDimensionalPriceGroupID } from './external-dimensional-price-group-id';
+import {
+ ExternalDimensionalPriceGroupID,
+ ExternalDimensionalPriceGroupIDUpdateParams,
+} from './external-dimensional-price-group-id';
import { Page, type PageParams } from '../../pagination';
export class DimensionalPriceGroups extends APIResource {
@@ -39,6 +42,19 @@ export class DimensionalPriceGroups extends APIResource {
return this._client.get(`/dimensional_price_groups/${dimensionalPriceGroupId}`, options);
}
+ /**
+ * This endpoint can be used to update the `external_dimensional_price_group_id`
+ * and `metadata` of an existing dimensional price group. Other fields on a
+ * dimensional price group are currently immutable.
+ */
+ update(
+ dimensionalPriceGroupId: string,
+ body: DimensionalPriceGroupUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return this._client.put(`/dimensional_price_groups/${dimensionalPriceGroupId}`, { body, ...options });
+ }
+
/**
* List dimensional price groups
*/
@@ -128,6 +144,23 @@ export interface DimensionalPriceGroupCreateParams {
metadata?: { [key: string]: string | null } | null;
}
+export interface DimensionalPriceGroupUpdateParams {
+ /**
+ * An optional user-defined ID for this dimensional price group resource, used
+ * throughout the system as an alias for this dimensional price group. Use this
+ * field to identify a dimensional price group by an existing identifier in your
+ * system.
+ */
+ external_dimensional_price_group_id?: string | 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?: { [key: string]: string | null } | null;
+}
+
export interface DimensionalPriceGroupListParams extends PageParams {}
DimensionalPriceGroups.DimensionalPriceGroupsPage = DimensionalPriceGroupsPage;
@@ -139,8 +172,12 @@ export declare namespace DimensionalPriceGroups {
type DimensionalPriceGroups as DimensionalPriceGroups,
DimensionalPriceGroupsPage as DimensionalPriceGroupsPage,
type DimensionalPriceGroupCreateParams as DimensionalPriceGroupCreateParams,
+ type DimensionalPriceGroupUpdateParams as DimensionalPriceGroupUpdateParams,
type DimensionalPriceGroupListParams as DimensionalPriceGroupListParams,
};
- export { ExternalDimensionalPriceGroupID as ExternalDimensionalPriceGroupID };
+ export {
+ ExternalDimensionalPriceGroupID as ExternalDimensionalPriceGroupID,
+ type ExternalDimensionalPriceGroupIDUpdateParams as ExternalDimensionalPriceGroupIDUpdateParams,
+ };
}
diff --git a/src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts b/src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts
index 7cdda455..0250df26 100644
--- a/src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts
+++ b/src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts
@@ -17,4 +17,41 @@ export class ExternalDimensionalPriceGroupID extends APIResource {
options,
);
}
+
+ /**
+ * This endpoint can be used to update the `external_dimensional_price_group_id`
+ * and `metadata` of an existing dimensional price group. Other fields on a
+ * dimensional price group are currently immutable.
+ */
+ update(
+ externalDimensionalPriceGroupId: string,
+ body: ExternalDimensionalPriceGroupIDUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return this._client.put(
+ `/dimensional_price_groups/external_dimensional_price_group_id/${externalDimensionalPriceGroupId}`,
+ { body, ...options },
+ );
+ }
+}
+
+export interface ExternalDimensionalPriceGroupIDUpdateParams {
+ /**
+ * An optional user-defined ID for this dimensional price group resource, used
+ * throughout the system as an alias for this dimensional price group. Use this
+ * field to identify a dimensional price group by an existing identifier in your
+ * system.
+ */
+ body_external_dimensional_price_group_id?: string | 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?: { [key: string]: string | null } | null;
+}
+
+export declare namespace ExternalDimensionalPriceGroupID {
+ export { type ExternalDimensionalPriceGroupIDUpdateParams as ExternalDimensionalPriceGroupIDUpdateParams };
}
diff --git a/src/resources/dimensional-price-groups/index.ts b/src/resources/dimensional-price-groups/index.ts
index f98b3839..cec643e0 100644
--- a/src/resources/dimensional-price-groups/index.ts
+++ b/src/resources/dimensional-price-groups/index.ts
@@ -5,6 +5,10 @@ export {
DimensionalPriceGroups,
type DimensionalPriceGroup,
type DimensionalPriceGroupCreateParams,
+ type DimensionalPriceGroupUpdateParams,
type DimensionalPriceGroupListParams,
} from './dimensional-price-groups';
-export { ExternalDimensionalPriceGroupID } from './external-dimensional-price-group-id';
+export {
+ ExternalDimensionalPriceGroupID,
+ type ExternalDimensionalPriceGroupIDUpdateParams,
+} from './external-dimensional-price-group-id';
diff --git a/src/resources/index.ts b/src/resources/index.ts
index 5b70dbee..46f47130 100644
--- a/src/resources/index.ts
+++ b/src/resources/index.ts
@@ -59,6 +59,7 @@ export {
DimensionalPriceGroups,
type DimensionalPriceGroup,
type DimensionalPriceGroupCreateParams,
+ type DimensionalPriceGroupUpdateParams,
type DimensionalPriceGroupListParams,
} from './dimensional-price-groups/dimensional-price-groups';
export {
diff --git a/src/resources/invoices.ts b/src/resources/invoices.ts
index e4abf435..3858d8a0 100644
--- a/src/resources/invoices.ts
+++ b/src/resources/invoices.ts
@@ -182,106 +182,145 @@ export interface InvoiceFetchUpcomingResponse {
*
* ### 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 |
+ * | Country | Type | Description |
+ * | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+ * | Albania | `al_tin` | Albania Tax Identification Number |
+ * | Andorra | `ad_nrt` | Andorran NRT Number |
+ * | Angola | `ao_tin` | Angola Tax Identification Number |
+ * | Argentina | `ar_cuit` | Argentinian Tax ID Number |
+ * | Armenia | `am_tin` | Armenia Tax Identification Number |
+ * | Aruba | `aw_tin` | Aruba Tax Identification Number |
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
+ * | Austria | `eu_vat` | European VAT Number |
+ * | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
+ * | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
+ * | Bahrain | `bh_vat` | Bahraini VAT Number |
+ * | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
+ * | Barbados | `bb_tin` | Barbados Tax Identification Number |
+ * | Belarus | `by_tin` | Belarus TIN Number |
+ * | Belgium | `eu_vat` | European VAT Number |
+ * | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
+ * | Bolivia | `bo_tin` | Bolivian Tax ID |
+ * | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
+ * | Brazil | `br_cnpj` | Brazilian CNPJ Number |
+ * | Brazil | `br_cpf` | Brazilian CPF Number |
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
+ * | Bulgaria | `eu_vat` | European VAT Number |
+ * | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
+ * | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
+ * | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
+ * | Canada | `ca_bn` | Canadian BN |
+ * | Canada | `ca_gst_hst` | Canadian GST/HST Number |
+ * | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
+ * | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
+ * | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
+ * | Canada | `ca_qst` | Canadian QST Number (Québec) |
+ * | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
+ * | Chile | `cl_tin` | Chilean TIN |
+ * | China | `cn_tin` | Chinese Tax ID |
+ * | Colombia | `co_nit` | Colombian NIT Number |
+ * | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
+ * | Costa Rica | `cr_tin` | Costa Rican Tax ID |
+ * | Croatia | `eu_vat` | European VAT Number |
+ * | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
+ * | Cyprus | `eu_vat` | European VAT Number |
+ * | Czech Republic | `eu_vat` | European VAT Number |
+ * | Denmark | `eu_vat` | European VAT Number |
+ * | Dominican Republic | `do_rcn` | Dominican RCN Number |
+ * | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
+ * | El Salvador | `sv_nit` | El Salvadorian NIT Number |
+ * | Estonia | `eu_vat` | European VAT Number |
+ * | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
+ * | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
+ * | Finland | `eu_vat` | European VAT Number |
+ * | France | `eu_vat` | European VAT Number |
+ * | Georgia | `ge_vat` | Georgian VAT |
+ * | Germany | `de_stn` | German Tax Number (Steuernummer) |
+ * | Germany | `eu_vat` | European VAT Number |
+ * | Greece | `eu_vat` | European VAT Number |
+ * | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
+ * | Hong Kong | `hk_br` | Hong Kong BR Number |
+ * | Hungary | `eu_vat` | European VAT Number |
+ * | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
+ * | Iceland | `is_vat` | Icelandic VAT |
+ * | India | `in_gst` | Indian GST Number |
+ * | Indonesia | `id_npwp` | Indonesian NPWP Number |
+ * | Ireland | `eu_vat` | European VAT Number |
+ * | Israel | `il_vat` | Israel VAT |
+ * | Italy | `eu_vat` | European VAT Number |
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
+ * | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
+ * | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
+ * | Laos | `la_tin` | Laos Tax Identification Number |
+ * | Latvia | `eu_vat` | European VAT Number |
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
+ * | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
+ * | Lithuania | `eu_vat` | European VAT Number |
+ * | Luxembourg | `eu_vat` | European VAT Number |
+ * | Malaysia | `my_frp` | Malaysian FRP Number |
+ * | Malaysia | `my_itn` | Malaysian ITN |
+ * | Malaysia | `my_sst` | Malaysian SST Number |
+ * | Malta | `eu_vat` | European VAT Number |
+ * | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
+ * | Mexico | `mx_rfc` | Mexican RFC Number |
+ * | Moldova | `md_vat` | Moldova VAT Number |
+ * | Montenegro | `me_pib` | Montenegro PIB Number |
+ * | Morocco | `ma_vat` | Morocco VAT Number |
+ * | Nepal | `np_pan` | Nepal PAN Number |
+ * | Netherlands | `eu_vat` | European VAT Number |
+ * | New Zealand | `nz_gst` | New Zealand GST Number |
+ * | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
+ * | North Macedonia | `mk_vat` | North Macedonia VAT Number |
+ * | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
+ * | Norway | `no_vat` | Norwegian VAT Number |
+ * | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
+ * | Oman | `om_vat` | Omani VAT Number |
+ * | 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 |
+ * | Senegal | `sn_ninea` | Senegal NINEA Number |
+ * | Serbia | `rs_pib` | Serbian PIB Number |
+ * | Singapore | `sg_gst` | Singaporean GST |
+ * | Singapore | `sg_uen` | Singaporean UEN |
+ * | Slovakia | `eu_vat` | European VAT Number |
+ * | Slovenia | `eu_vat` | European VAT Number |
+ * | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
+ * | South Africa | `za_vat` | South African VAT Number |
+ * | South Korea | `kr_brn` | Korean BRN |
+ * | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
+ * | Spain | `eu_vat` | European VAT Number |
+ * | Suriname | `sr_fin` | Suriname FIN Number |
+ * | Sweden | `eu_vat` | European VAT Number |
+ * | Switzerland | `ch_uid` | Switzerland UID Number |
+ * | Switzerland | `ch_vat` | Switzerland VAT Number |
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
+ * | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
+ * | Tanzania | `tz_vat` | Tanzania VAT Number |
+ * | Thailand | `th_vat` | Thai VAT |
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
+ * | Uganda | `ug_tin` | Uganda Tax Identification Number |
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
+ * | United Kingdom | `gb_vat` | United Kingdom VAT Number |
+ * | United States | `us_ein` | United States EIN |
+ * | Uruguay | `uy_ruc` | Uruguayan RUC Number |
+ * | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
+ * | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
+ * | Venezuela | `ve_rif` | Venezuelan RIF Number |
+ * | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
+ * | Zambia | `zm_tin` | Zambia Tax Identification Number |
+ * | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
*/
customer_tax_id: Shared.CustomerTaxID | null;
diff --git a/src/resources/shared.ts b/src/resources/shared.ts
index 75c28477..185dd3b8 100644
--- a/src/resources/shared.ts
+++ b/src/resources/shared.ts
@@ -511,139 +511,195 @@ export interface CustomerMinified {
*
* ### 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 |
+ * | Country | Type | Description |
+ * | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+ * | Albania | `al_tin` | Albania Tax Identification Number |
+ * | Andorra | `ad_nrt` | Andorran NRT Number |
+ * | Angola | `ao_tin` | Angola Tax Identification Number |
+ * | Argentina | `ar_cuit` | Argentinian Tax ID Number |
+ * | Armenia | `am_tin` | Armenia Tax Identification Number |
+ * | Aruba | `aw_tin` | Aruba Tax Identification Number |
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
+ * | Austria | `eu_vat` | European VAT Number |
+ * | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
+ * | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
+ * | Bahrain | `bh_vat` | Bahraini VAT Number |
+ * | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
+ * | Barbados | `bb_tin` | Barbados Tax Identification Number |
+ * | Belarus | `by_tin` | Belarus TIN Number |
+ * | Belgium | `eu_vat` | European VAT Number |
+ * | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
+ * | Bolivia | `bo_tin` | Bolivian Tax ID |
+ * | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
+ * | Brazil | `br_cnpj` | Brazilian CNPJ Number |
+ * | Brazil | `br_cpf` | Brazilian CPF Number |
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
+ * | Bulgaria | `eu_vat` | European VAT Number |
+ * | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
+ * | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
+ * | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
+ * | Canada | `ca_bn` | Canadian BN |
+ * | Canada | `ca_gst_hst` | Canadian GST/HST Number |
+ * | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
+ * | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
+ * | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
+ * | Canada | `ca_qst` | Canadian QST Number (Québec) |
+ * | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
+ * | Chile | `cl_tin` | Chilean TIN |
+ * | China | `cn_tin` | Chinese Tax ID |
+ * | Colombia | `co_nit` | Colombian NIT Number |
+ * | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
+ * | Costa Rica | `cr_tin` | Costa Rican Tax ID |
+ * | Croatia | `eu_vat` | European VAT Number |
+ * | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
+ * | Cyprus | `eu_vat` | European VAT Number |
+ * | Czech Republic | `eu_vat` | European VAT Number |
+ * | Denmark | `eu_vat` | European VAT Number |
+ * | Dominican Republic | `do_rcn` | Dominican RCN Number |
+ * | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
+ * | El Salvador | `sv_nit` | El Salvadorian NIT Number |
+ * | Estonia | `eu_vat` | European VAT Number |
+ * | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
+ * | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
+ * | Finland | `eu_vat` | European VAT Number |
+ * | France | `eu_vat` | European VAT Number |
+ * | Georgia | `ge_vat` | Georgian VAT |
+ * | Germany | `de_stn` | German Tax Number (Steuernummer) |
+ * | Germany | `eu_vat` | European VAT Number |
+ * | Greece | `eu_vat` | European VAT Number |
+ * | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
+ * | Hong Kong | `hk_br` | Hong Kong BR Number |
+ * | Hungary | `eu_vat` | European VAT Number |
+ * | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
+ * | Iceland | `is_vat` | Icelandic VAT |
+ * | India | `in_gst` | Indian GST Number |
+ * | Indonesia | `id_npwp` | Indonesian NPWP Number |
+ * | Ireland | `eu_vat` | European VAT Number |
+ * | Israel | `il_vat` | Israel VAT |
+ * | Italy | `eu_vat` | European VAT Number |
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
+ * | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
+ * | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
+ * | Laos | `la_tin` | Laos Tax Identification Number |
+ * | Latvia | `eu_vat` | European VAT Number |
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
+ * | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
+ * | Lithuania | `eu_vat` | European VAT Number |
+ * | Luxembourg | `eu_vat` | European VAT Number |
+ * | Malaysia | `my_frp` | Malaysian FRP Number |
+ * | Malaysia | `my_itn` | Malaysian ITN |
+ * | Malaysia | `my_sst` | Malaysian SST Number |
+ * | Malta | `eu_vat` | European VAT Number |
+ * | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
+ * | Mexico | `mx_rfc` | Mexican RFC Number |
+ * | Moldova | `md_vat` | Moldova VAT Number |
+ * | Montenegro | `me_pib` | Montenegro PIB Number |
+ * | Morocco | `ma_vat` | Morocco VAT Number |
+ * | Nepal | `np_pan` | Nepal PAN Number |
+ * | Netherlands | `eu_vat` | European VAT Number |
+ * | New Zealand | `nz_gst` | New Zealand GST Number |
+ * | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
+ * | North Macedonia | `mk_vat` | North Macedonia VAT Number |
+ * | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
+ * | Norway | `no_vat` | Norwegian VAT Number |
+ * | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
+ * | Oman | `om_vat` | Omani VAT Number |
+ * | 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 |
+ * | Senegal | `sn_ninea` | Senegal NINEA Number |
+ * | Serbia | `rs_pib` | Serbian PIB Number |
+ * | Singapore | `sg_gst` | Singaporean GST |
+ * | Singapore | `sg_uen` | Singaporean UEN |
+ * | Slovakia | `eu_vat` | European VAT Number |
+ * | Slovenia | `eu_vat` | European VAT Number |
+ * | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
+ * | South Africa | `za_vat` | South African VAT Number |
+ * | South Korea | `kr_brn` | Korean BRN |
+ * | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
+ * | Spain | `eu_vat` | European VAT Number |
+ * | Suriname | `sr_fin` | Suriname FIN Number |
+ * | Sweden | `eu_vat` | European VAT Number |
+ * | Switzerland | `ch_uid` | Switzerland UID Number |
+ * | Switzerland | `ch_vat` | Switzerland VAT Number |
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
+ * | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
+ * | Tanzania | `tz_vat` | Tanzania VAT Number |
+ * | Thailand | `th_vat` | Thai VAT |
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
+ * | Uganda | `ug_tin` | Uganda Tax Identification Number |
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
+ * | United Kingdom | `gb_vat` | United Kingdom VAT Number |
+ * | United States | `us_ein` | United States EIN |
+ * | Uruguay | `uy_ruc` | Uruguayan RUC Number |
+ * | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
+ * | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
+ * | Venezuela | `ve_rif` | Venezuelan RIF Number |
+ * | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
+ * | Zambia | `zm_tin` | Zambia Tax Identification Number |
+ * | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
*/
export interface CustomerTaxID {
country:
| 'AD'
| 'AE'
+ | 'AL'
+ | 'AM'
+ | 'AO'
| 'AR'
| 'AT'
| 'AU'
+ | 'AW'
+ | 'AZ'
+ | 'BA'
+ | 'BB'
+ | 'BD'
| 'BE'
+ | 'BF'
| 'BG'
| 'BH'
+ | 'BJ'
| 'BO'
| 'BR'
+ | 'BS'
+ | 'BY'
| 'CA'
+ | 'CD'
| 'CH'
| 'CL'
+ | 'CM'
| 'CN'
| 'CO'
| 'CR'
+ | 'CV'
+ | 'DE'
| 'CY'
| 'CZ'
- | 'DE'
| 'DK'
- | 'EE'
| 'DO'
| 'EC'
+ | 'EE'
| 'EG'
| 'ES'
+ | 'ET'
| 'EU'
| 'FI'
| 'FR'
| 'GB'
| 'GE'
+ | 'GN'
| 'GR'
| 'HK'
| 'HR'
@@ -656,18 +712,27 @@ export interface CustomerTaxID {
| 'IT'
| 'JP'
| 'KE'
+ | 'KG'
+ | 'KH'
| 'KR'
| 'KZ'
+ | 'LA'
| 'LI'
| 'LT'
| 'LU'
| 'LV'
+ | 'MA'
+ | 'MD'
+ | 'ME'
+ | 'MK'
+ | 'MR'
| 'MT'
| 'MX'
| 'MY'
| 'NG'
| 'NL'
| 'NO'
+ | 'NP'
| 'NZ'
| 'OM'
| 'PE'
@@ -682,48 +747,76 @@ export interface CustomerTaxID {
| 'SG'
| 'SI'
| 'SK'
+ | 'SN'
+ | 'SR'
| 'SV'
| 'TH'
+ | 'TJ'
| 'TR'
| 'TW'
+ | 'TZ'
| 'UA'
+ | 'UG'
| 'US'
| 'UY'
+ | 'UZ'
| 'VE'
| 'VN'
- | 'ZA';
+ | 'ZA'
+ | 'ZM'
+ | 'ZW';
type:
| 'ad_nrt'
| 'ae_trn'
+ | 'al_tin'
+ | 'am_tin'
+ | 'ao_tin'
| 'ar_cuit'
| 'eu_vat'
| 'au_abn'
| 'au_arn'
+ | 'aw_tin'
+ | 'az_tin'
+ | 'ba_tin'
+ | 'bb_tin'
+ | 'bd_bin'
+ | 'bf_ifu'
| 'bg_uic'
| 'bh_vat'
+ | 'bj_ifu'
| 'bo_tin'
| 'br_cnpj'
| 'br_cpf'
+ | 'bs_tin'
+ | 'by_tin'
| 'ca_bn'
| 'ca_gst_hst'
| 'ca_pst_bc'
| 'ca_pst_mb'
| 'ca_pst_sk'
| 'ca_qst'
+ | 'cd_nif'
+ | 'ch_uid'
| 'ch_vat'
| 'cl_tin'
+ | 'cm_niu'
| 'cn_tin'
| 'co_nit'
| 'cr_tin'
+ | 'cv_nif'
+ | 'de_stn'
| 'do_rcn'
| 'ec_ruc'
| 'eg_tin'
| 'es_cif'
+ | 'et_tin'
| 'eu_oss_vat'
| 'gb_vat'
| 'ge_vat'
+ | 'gn_nif'
| 'hk_br'
+ | 'hr_oib'
| 'hu_tin'
| 'id_npwp'
| 'il_vat'
@@ -733,9 +826,18 @@ export interface CustomerTaxID {
| 'jp_rn'
| 'jp_trn'
| 'ke_pin'
+ | 'kg_tin'
+ | 'kh_tin'
| 'kr_brn'
| 'kz_bin'
+ | 'la_tin'
| 'li_uid'
+ | 'li_vat'
+ | 'ma_vat'
+ | 'md_vat'
+ | 'me_pib'
+ | 'mk_vat'
+ | 'mr_nif'
| 'mx_rfc'
| 'my_frp'
| 'my_itn'
@@ -743,6 +845,7 @@ export interface CustomerTaxID {
| 'ng_tin'
| 'no_vat'
| 'no_voec'
+ | 'np_pan'
| 'nz_gst'
| 'om_vat'
| 'pe_ruc'
@@ -755,16 +858,25 @@ export interface CustomerTaxID {
| 'sg_gst'
| 'sg_uen'
| 'si_tin'
+ | 'sn_ninea'
+ | 'sr_fin'
| 'sv_nit'
| 'th_vat'
+ | 'tj_tin'
| 'tr_tin'
| 'tw_vat'
+ | 'tz_vat'
| 'ua_vat'
+ | 'ug_tin'
| 'us_ein'
| 'uy_ruc'
+ | 'uz_tin'
+ | 'uz_vat'
| 've_rif'
| 'vn_tin'
- | 'za_vat';
+ | 'za_vat'
+ | 'zm_tin'
+ | 'zw_tin';
value: string;
}
@@ -840,106 +952,145 @@ export interface Invoice {
*
* ### 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 |
+ * | Country | Type | Description |
+ * | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+ * | Albania | `al_tin` | Albania Tax Identification Number |
+ * | Andorra | `ad_nrt` | Andorran NRT Number |
+ * | Angola | `ao_tin` | Angola Tax Identification Number |
+ * | Argentina | `ar_cuit` | Argentinian Tax ID Number |
+ * | Armenia | `am_tin` | Armenia Tax Identification Number |
+ * | Aruba | `aw_tin` | Aruba Tax Identification Number |
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
+ * | Austria | `eu_vat` | European VAT Number |
+ * | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
+ * | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
+ * | Bahrain | `bh_vat` | Bahraini VAT Number |
+ * | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
+ * | Barbados | `bb_tin` | Barbados Tax Identification Number |
+ * | Belarus | `by_tin` | Belarus TIN Number |
+ * | Belgium | `eu_vat` | European VAT Number |
+ * | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
+ * | Bolivia | `bo_tin` | Bolivian Tax ID |
+ * | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
+ * | Brazil | `br_cnpj` | Brazilian CNPJ Number |
+ * | Brazil | `br_cpf` | Brazilian CPF Number |
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
+ * | Bulgaria | `eu_vat` | European VAT Number |
+ * | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
+ * | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
+ * | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
+ * | Canada | `ca_bn` | Canadian BN |
+ * | Canada | `ca_gst_hst` | Canadian GST/HST Number |
+ * | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
+ * | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
+ * | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
+ * | Canada | `ca_qst` | Canadian QST Number (Québec) |
+ * | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
+ * | Chile | `cl_tin` | Chilean TIN |
+ * | China | `cn_tin` | Chinese Tax ID |
+ * | Colombia | `co_nit` | Colombian NIT Number |
+ * | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
+ * | Costa Rica | `cr_tin` | Costa Rican Tax ID |
+ * | Croatia | `eu_vat` | European VAT Number |
+ * | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
+ * | Cyprus | `eu_vat` | European VAT Number |
+ * | Czech Republic | `eu_vat` | European VAT Number |
+ * | Denmark | `eu_vat` | European VAT Number |
+ * | Dominican Republic | `do_rcn` | Dominican RCN Number |
+ * | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
+ * | El Salvador | `sv_nit` | El Salvadorian NIT Number |
+ * | Estonia | `eu_vat` | European VAT Number |
+ * | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
+ * | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
+ * | Finland | `eu_vat` | European VAT Number |
+ * | France | `eu_vat` | European VAT Number |
+ * | Georgia | `ge_vat` | Georgian VAT |
+ * | Germany | `de_stn` | German Tax Number (Steuernummer) |
+ * | Germany | `eu_vat` | European VAT Number |
+ * | Greece | `eu_vat` | European VAT Number |
+ * | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
+ * | Hong Kong | `hk_br` | Hong Kong BR Number |
+ * | Hungary | `eu_vat` | European VAT Number |
+ * | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
+ * | Iceland | `is_vat` | Icelandic VAT |
+ * | India | `in_gst` | Indian GST Number |
+ * | Indonesia | `id_npwp` | Indonesian NPWP Number |
+ * | Ireland | `eu_vat` | European VAT Number |
+ * | Israel | `il_vat` | Israel VAT |
+ * | Italy | `eu_vat` | European VAT Number |
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
+ * | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
+ * | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
+ * | Laos | `la_tin` | Laos Tax Identification Number |
+ * | Latvia | `eu_vat` | European VAT Number |
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
+ * | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
+ * | Lithuania | `eu_vat` | European VAT Number |
+ * | Luxembourg | `eu_vat` | European VAT Number |
+ * | Malaysia | `my_frp` | Malaysian FRP Number |
+ * | Malaysia | `my_itn` | Malaysian ITN |
+ * | Malaysia | `my_sst` | Malaysian SST Number |
+ * | Malta | `eu_vat` | European VAT Number |
+ * | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
+ * | Mexico | `mx_rfc` | Mexican RFC Number |
+ * | Moldova | `md_vat` | Moldova VAT Number |
+ * | Montenegro | `me_pib` | Montenegro PIB Number |
+ * | Morocco | `ma_vat` | Morocco VAT Number |
+ * | Nepal | `np_pan` | Nepal PAN Number |
+ * | Netherlands | `eu_vat` | European VAT Number |
+ * | New Zealand | `nz_gst` | New Zealand GST Number |
+ * | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
+ * | North Macedonia | `mk_vat` | North Macedonia VAT Number |
+ * | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
+ * | Norway | `no_vat` | Norwegian VAT Number |
+ * | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
+ * | Oman | `om_vat` | Omani VAT Number |
+ * | 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 |
+ * | Senegal | `sn_ninea` | Senegal NINEA Number |
+ * | Serbia | `rs_pib` | Serbian PIB Number |
+ * | Singapore | `sg_gst` | Singaporean GST |
+ * | Singapore | `sg_uen` | Singaporean UEN |
+ * | Slovakia | `eu_vat` | European VAT Number |
+ * | Slovenia | `eu_vat` | European VAT Number |
+ * | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
+ * | South Africa | `za_vat` | South African VAT Number |
+ * | South Korea | `kr_brn` | Korean BRN |
+ * | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
+ * | Spain | `eu_vat` | European VAT Number |
+ * | Suriname | `sr_fin` | Suriname FIN Number |
+ * | Sweden | `eu_vat` | European VAT Number |
+ * | Switzerland | `ch_uid` | Switzerland UID Number |
+ * | Switzerland | `ch_vat` | Switzerland VAT Number |
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
+ * | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
+ * | Tanzania | `tz_vat` | Tanzania VAT Number |
+ * | Thailand | `th_vat` | Thai VAT |
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
+ * | Uganda | `ug_tin` | Uganda Tax Identification Number |
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
+ * | United Kingdom | `gb_vat` | United Kingdom VAT Number |
+ * | United States | `us_ein` | United States EIN |
+ * | Uruguay | `uy_ruc` | Uruguayan RUC Number |
+ * | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
+ * | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
+ * | Venezuela | `ve_rif` | Venezuelan RIF Number |
+ * | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
+ * | Zambia | `zm_tin` | Zambia Tax Identification Number |
+ * | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
*/
customer_tax_id: CustomerTaxID | null;
@@ -7545,7 +7696,8 @@ export type Price =
| Price.MaxGroupTieredPackagePrice
| Price.ScalableMatrixWithUnitPricingPrice
| Price.ScalableMatrixWithTieredPricingPrice
- | Price.CumulativeGroupedBulkPrice;
+ | Price.CumulativeGroupedBulkPrice
+ | Price.GroupedWithMinMaxThresholdsPrice;
export namespace Price {
export interface UnitPrice {
@@ -9759,6 +9911,85 @@ export namespace Price {
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
}
+
+ export interface GroupedWithMinMaxThresholdsPrice {
+ id: string;
+
+ billable_metric: Shared.BillableMetricTiny | null;
+
+ billing_cycle_configuration: Shared.BillingCycleConfiguration;
+
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
+
+ conversion_rate: number | null;
+
+ conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+
+ created_at: string;
+
+ credit_allocation: Shared.Allocation | null;
+
+ currency: string;
+
+ /**
+ * @deprecated
+ */
+ discount: Shared.Discount | null;
+
+ external_price_id: string | null;
+
+ fixed_price_quantity: number | null;
+
+ grouped_with_min_max_thresholds_config: { [key: string]: unknown };
+
+ invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+
+ item: Shared.ItemSlim;
+
+ /**
+ * @deprecated
+ */
+ maximum: Shared.Maximum | null;
+
+ /**
+ * @deprecated
+ */
+ maximum_amount: string | null;
+
+ /**
+ * User specified key-value pairs for the resource. If not present, this defaults
+ * to an empty dictionary. Individual keys can be removed by setting the value to
+ * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+ * `null`.
+ */
+ metadata: { [key: string]: string };
+
+ /**
+ * @deprecated
+ */
+ minimum: Shared.Minimum | null;
+
+ /**
+ * @deprecated
+ */
+ minimum_amount: string | null;
+
+ model_type: 'grouped_with_min_max_thresholds';
+
+ name: string;
+
+ plan_phase_order: number | null;
+
+ price_type: 'usage_price' | 'fixed_price';
+
+ /**
+ * The price id this price replaces. This price will take the place of the replaced
+ * price in plan version migrations.
+ */
+ replaces_price_id: string | null;
+
+ dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
+ }
}
/**
diff --git a/src/version.ts b/src/version.ts
index 0e5f6f83..6e85b993 100644
--- a/src/version.ts
+++ b/src/version.ts
@@ -1 +1 @@
-export const VERSION = '5.4.0'; // x-release-please-version
+export const VERSION = '5.5.0'; // x-release-please-version
diff --git a/tests/api-resources/dimensional-price-groups/dimensional-price-groups.test.ts b/tests/api-resources/dimensional-price-groups/dimensional-price-groups.test.ts
index a58259fc..b0ff4451 100644
--- a/tests/api-resources/dimensional-price-groups/dimensional-price-groups.test.ts
+++ b/tests/api-resources/dimensional-price-groups/dimensional-price-groups.test.ts
@@ -54,6 +54,17 @@ describe('resource dimensionalPriceGroups', () => {
).rejects.toThrow(Orb.NotFoundError);
});
+ test('update', async () => {
+ const responsePromise = client.dimensionalPriceGroups.update('dimensional_price_group_id', {});
+ const rawResponse = await responsePromise.asResponse();
+ expect(rawResponse).toBeInstanceOf(Response);
+ const response = await responsePromise;
+ expect(response).not.toBeInstanceOf(Response);
+ const dataAndResponse = await responsePromise.withResponse();
+ expect(dataAndResponse.data).toBe(response);
+ expect(dataAndResponse.response).toBe(rawResponse);
+ });
+
test('list', async () => {
const responsePromise = client.dimensionalPriceGroups.list();
const rawResponse = await responsePromise.asResponse();
diff --git a/tests/api-resources/dimensional-price-groups/external-dimensional-price-group-id.test.ts b/tests/api-resources/dimensional-price-groups/external-dimensional-price-group-id.test.ts
index 396867ef..6e0e742d 100644
--- a/tests/api-resources/dimensional-price-groups/external-dimensional-price-group-id.test.ts
+++ b/tests/api-resources/dimensional-price-groups/external-dimensional-price-group-id.test.ts
@@ -31,4 +31,18 @@ describe('resource externalDimensionalPriceGroupId', () => {
),
).rejects.toThrow(Orb.NotFoundError);
});
+
+ test('update', async () => {
+ const responsePromise = client.dimensionalPriceGroups.externalDimensionalPriceGroupId.update(
+ 'external_dimensional_price_group_id',
+ {},
+ );
+ const rawResponse = await responsePromise.asResponse();
+ expect(rawResponse).toBeInstanceOf(Response);
+ const response = await responsePromise;
+ expect(response).not.toBeInstanceOf(Response);
+ const dataAndResponse = await responsePromise.withResponse();
+ expect(dataAndResponse.data).toBe(response);
+ expect(dataAndResponse.response).toBe(rawResponse);
+ });
});