orb-billing 1.22.0 → 1.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/core.d.ts.map +1 -1
  3. package/core.js +8 -10
  4. package/core.js.map +1 -1
  5. package/core.mjs +8 -10
  6. package/core.mjs.map +1 -1
  7. package/index.d.mts +2 -2
  8. package/index.d.ts +2 -2
  9. package/index.d.ts.map +1 -1
  10. package/index.js +4 -0
  11. package/index.js.map +1 -1
  12. package/index.mjs +4 -0
  13. package/index.mjs.map +1 -1
  14. package/package.json +3 -1
  15. package/resources/coupons/coupons.d.ts +60 -2
  16. package/resources/coupons/coupons.d.ts.map +1 -1
  17. package/resources/coupons/coupons.js.map +1 -1
  18. package/resources/coupons/coupons.mjs.map +1 -1
  19. package/resources/credit-notes.d.ts +57 -5
  20. package/resources/credit-notes.d.ts.map +1 -1
  21. package/resources/credit-notes.js.map +1 -1
  22. package/resources/credit-notes.mjs.map +1 -1
  23. package/resources/customers/balance-transactions.d.ts +2 -2
  24. package/resources/customers/balance-transactions.d.ts.map +1 -1
  25. package/resources/customers/balance-transactions.js.map +1 -1
  26. package/resources/customers/balance-transactions.mjs.map +1 -1
  27. package/resources/customers/customers.d.ts +696 -8
  28. package/resources/customers/customers.d.ts.map +1 -1
  29. package/resources/customers/customers.js.map +1 -1
  30. package/resources/customers/customers.mjs.map +1 -1
  31. package/resources/customers/usage.d.ts +74 -58
  32. package/resources/customers/usage.d.ts.map +1 -1
  33. package/resources/customers/usage.js +14 -14
  34. package/resources/customers/usage.js.map +1 -1
  35. package/resources/customers/usage.mjs +14 -14
  36. package/resources/customers/usage.mjs.map +1 -1
  37. package/resources/events/events.d.ts +40 -40
  38. package/resources/events/events.js +40 -40
  39. package/resources/events/events.mjs +40 -40
  40. package/resources/index.d.ts +4 -3
  41. package/resources/index.d.ts.map +1 -1
  42. package/resources/index.js +19 -4
  43. package/resources/index.js.map +1 -1
  44. package/resources/index.mjs +2 -1
  45. package/resources/index.mjs.map +1 -1
  46. package/resources/invoice-line-items.d.ts +2 -2
  47. package/resources/invoice-line-items.d.ts.map +1 -1
  48. package/resources/invoices.d.ts +358 -71
  49. package/resources/invoices.d.ts.map +1 -1
  50. package/resources/invoices.js.map +1 -1
  51. package/resources/invoices.mjs.map +1 -1
  52. package/resources/plans/plans.d.ts +648 -4
  53. package/resources/plans/plans.d.ts.map +1 -1
  54. package/resources/plans/plans.js.map +1 -1
  55. package/resources/plans/plans.mjs.map +1 -1
  56. package/resources/prices/index.d.ts +1 -1
  57. package/resources/prices/index.d.ts.map +1 -1
  58. package/resources/prices/index.js +3 -3
  59. package/resources/prices/index.js.map +1 -1
  60. package/resources/prices/index.mjs +1 -1
  61. package/resources/prices/index.mjs.map +1 -1
  62. package/resources/prices/prices.d.ts +56 -83
  63. package/resources/prices/prices.d.ts.map +1 -1
  64. package/resources/prices/prices.js.map +1 -1
  65. package/resources/prices/prices.mjs.map +1 -1
  66. package/resources/shared.d.ts +62 -0
  67. package/resources/shared.d.ts.map +1 -0
  68. package/resources/shared.js +4 -0
  69. package/resources/shared.js.map +1 -0
  70. package/resources/shared.mjs +3 -0
  71. package/resources/shared.mjs.map +1 -0
  72. package/resources/subscriptions.d.ts +1084 -241
  73. package/resources/subscriptions.d.ts.map +1 -1
  74. package/resources/subscriptions.js.map +1 -1
  75. package/resources/subscriptions.mjs.map +1 -1
  76. package/src/_shims/index.d.ts +1 -1
  77. package/src/_shims/index.mjs +1 -1
  78. package/src/core.ts +8 -12
  79. package/src/index.ts +8 -3
  80. package/src/resources/coupons/coupons.ts +82 -8
  81. package/src/resources/coupons/subscriptions.ts +7 -7
  82. package/src/resources/credit-notes.ts +86 -10
  83. package/src/resources/customers/balance-transactions.ts +23 -7
  84. package/src/resources/customers/costs.ts +5 -5
  85. package/src/resources/customers/credits/credits.ts +6 -6
  86. package/src/resources/customers/credits/ledger.ts +5 -5
  87. package/src/resources/customers/customers.ts +1153 -21
  88. package/src/resources/customers/usage.ts +83 -65
  89. package/src/resources/events/backfills.ts +5 -5
  90. package/src/resources/events/events.ts +45 -45
  91. package/src/resources/index.ts +3 -3
  92. package/src/resources/invoice-line-items.ts +6 -6
  93. package/src/resources/invoices.ts +604 -97
  94. package/src/resources/items.ts +5 -5
  95. package/src/resources/metrics.ts +5 -5
  96. package/src/resources/plans/external-plan-id.ts +5 -5
  97. package/src/resources/plans/plans.ts +817 -11
  98. package/src/resources/prices/external-price-id.ts +3 -3
  99. package/src/resources/prices/index.ts +1 -1
  100. package/src/resources/prices/prices.ts +73 -106
  101. package/src/resources/shared.ts +84 -0
  102. package/src/resources/subscriptions.ts +1299 -287
  103. package/src/resources/top-level.ts +3 -3
  104. package/src/version.ts +1 -1
  105. package/version.d.ts +1 -1
  106. package/version.js +1 -1
  107. package/version.mjs +1 -1
package/resources/customers/customers.d.ts CHANGED
@@ -152,6 +152,92 @@ export interface Customer {
152
152
  payment_provider_id: string | null;
153
153
  portal_url: string | null;
154
154
  shipping_address: Customer.ShippingAddress | null;
155
+ /**
156
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
157
+ * added to the headers of invoices.
158
+ *
159
+ * ### Supported Tax ID Countries and Types
160
+ *
161
+ * | Country | Type | Description |
162
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
163
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
164
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
165
+ * | Austria | `eu_vat` | European VAT number |
166
+ * | Belgium | `eu_vat` | European VAT number |
167
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
168
+ * | Brazil | `br_cpf` | Brazilian CPF number |
169
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
170
+ * | Bulgaria | `eu_vat` | European VAT number |
171
+ * | Canada | `ca_bn` | Canadian BN |
172
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
173
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
174
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
175
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
176
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
177
+ * | Chile | `cl_tin` | Chilean TIN |
178
+ * | Croatia | `eu_vat` | European VAT number |
179
+ * | Cyprus | `eu_vat` | European VAT number |
180
+ * | Czech Republic | `eu_vat` | European VAT number |
181
+ * | Denmark | `eu_vat` | European VAT number |
182
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
183
+ * | Estonia | `eu_vat` | European VAT number |
184
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
185
+ * | Finland | `eu_vat` | European VAT number |
186
+ * | France | `eu_vat` | European VAT number |
187
+ * | Georgia | `ge_vat` | Georgian VAT |
188
+ * | Germany | `eu_vat` | European VAT number |
189
+ * | Greece | `eu_vat` | European VAT number |
190
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
191
+ * | Hungary | `eu_vat` | European VAT number |
192
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
193
+ * | Iceland | `is_vat` | Icelandic VAT |
194
+ * | India | `in_gst` | Indian GST number |
195
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
196
+ * | Ireland | `eu_vat` | European VAT number |
197
+ * | Israel | `il_vat` | Israel VAT |
198
+ * | Italy | `eu_vat` | European VAT number |
199
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
200
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
201
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
202
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
203
+ * | Latvia | `eu_vat` | European VAT number |
204
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
205
+ * | Lithuania | `eu_vat` | European VAT number |
206
+ * | Luxembourg | `eu_vat` | European VAT number |
207
+ * | Malaysia | `my_frp` | Malaysian FRP number |
208
+ * | Malaysia | `my_itn` | Malaysian ITN |
209
+ * | Malaysia | `my_sst` | Malaysian SST number |
210
+ * | Malta | `eu_vat ` | European VAT number |
211
+ * | Mexico | `mx_rfc` | Mexican RFC number |
212
+ * | Netherlands | `eu_vat` | European VAT number |
213
+ * | New Zealand | `nz_gst` | New Zealand GST number |
214
+ * | Norway | `no_vat` | Norwegian VAT number |
215
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
216
+ * | Poland | `eu_vat` | European VAT number |
217
+ * | Portugal | `eu_vat` | European VAT number |
218
+ * | Romania | `eu_vat` | European VAT number |
219
+ * | Russia | `ru_inn` | Russian INN |
220
+ * | Russia | `ru_kpp` | Russian KPP |
221
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
222
+ * | Singapore | `sg_uen` | Singaporean UEN |
223
+ * | Slovakia | `eu_vat` | European VAT number |
224
+ * | Slovenia | `eu_vat` | European VAT number |
225
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
226
+ * | South Africa | `za_vat` | South African VAT number |
227
+ * | South Korea | `kr_brn` | Korean BRN |
228
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
229
+ * | Spain | `eu_vat` | European VAT number |
230
+ * | Sweden | `eu_vat` | European VAT number |
231
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
232
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
233
+ * | Thailand | `th_vat` | Thai VAT |
234
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
235
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
236
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
237
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
238
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
239
+ * | United States | `us_ein` | United States EIN |
240
+ */
155
241
  tax_id: Customer.TaxID | null;
156
242
  /**
157
243
  * A timezone identifier from the IANA timezone database, such as
@@ -179,9 +265,95 @@ export declare namespace Customer {
179
265
  postal_code: string | null;
180
266
  state: string | null;
181
267
  }
268
+ /**
269
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
270
+ * added to the headers of invoices.
271
+ *
272
+ * ### Supported Tax ID Countries and Types
273
+ *
274
+ * | Country | Type | Description |
275
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
276
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
277
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
278
+ * | Austria | `eu_vat` | European VAT number |
279
+ * | Belgium | `eu_vat` | European VAT number |
280
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
281
+ * | Brazil | `br_cpf` | Brazilian CPF number |
282
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
283
+ * | Bulgaria | `eu_vat` | European VAT number |
284
+ * | Canada | `ca_bn` | Canadian BN |
285
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
286
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
287
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
288
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
289
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
290
+ * | Chile | `cl_tin` | Chilean TIN |
291
+ * | Croatia | `eu_vat` | European VAT number |
292
+ * | Cyprus | `eu_vat` | European VAT number |
293
+ * | Czech Republic | `eu_vat` | European VAT number |
294
+ * | Denmark | `eu_vat` | European VAT number |
295
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
296
+ * | Estonia | `eu_vat` | European VAT number |
297
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
298
+ * | Finland | `eu_vat` | European VAT number |
299
+ * | France | `eu_vat` | European VAT number |
300
+ * | Georgia | `ge_vat` | Georgian VAT |
301
+ * | Germany | `eu_vat` | European VAT number |
302
+ * | Greece | `eu_vat` | European VAT number |
303
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
304
+ * | Hungary | `eu_vat` | European VAT number |
305
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
306
+ * | Iceland | `is_vat` | Icelandic VAT |
307
+ * | India | `in_gst` | Indian GST number |
308
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
309
+ * | Ireland | `eu_vat` | European VAT number |
310
+ * | Israel | `il_vat` | Israel VAT |
311
+ * | Italy | `eu_vat` | European VAT number |
312
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
313
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
314
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
315
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
316
+ * | Latvia | `eu_vat` | European VAT number |
317
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
318
+ * | Lithuania | `eu_vat` | European VAT number |
319
+ * | Luxembourg | `eu_vat` | European VAT number |
320
+ * | Malaysia | `my_frp` | Malaysian FRP number |
321
+ * | Malaysia | `my_itn` | Malaysian ITN |
322
+ * | Malaysia | `my_sst` | Malaysian SST number |
323
+ * | Malta | `eu_vat ` | European VAT number |
324
+ * | Mexico | `mx_rfc` | Mexican RFC number |
325
+ * | Netherlands | `eu_vat` | European VAT number |
326
+ * | New Zealand | `nz_gst` | New Zealand GST number |
327
+ * | Norway | `no_vat` | Norwegian VAT number |
328
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
329
+ * | Poland | `eu_vat` | European VAT number |
330
+ * | Portugal | `eu_vat` | European VAT number |
331
+ * | Romania | `eu_vat` | European VAT number |
332
+ * | Russia | `ru_inn` | Russian INN |
333
+ * | Russia | `ru_kpp` | Russian KPP |
334
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
335
+ * | Singapore | `sg_uen` | Singaporean UEN |
336
+ * | Slovakia | `eu_vat` | European VAT number |
337
+ * | Slovenia | `eu_vat` | European VAT number |
338
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
339
+ * | South Africa | `za_vat` | South African VAT number |
340
+ * | South Korea | `kr_brn` | Korean BRN |
341
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
342
+ * | Spain | `eu_vat` | European VAT number |
343
+ * | Sweden | `eu_vat` | European VAT number |
344
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
345
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
346
+ * | Thailand | `th_vat` | Thai VAT |
347
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
348
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
349
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
350
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
351
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
352
+ * | United States | `us_ein` | United States EIN |
353
+ */
182
354
  interface TaxID {
183
- country: string;
184
- type: string;
355
+ country: 'AE' | 'AT' | 'AU' | 'BE' | 'BG' | 'BR' | 'CA' | 'CH' | 'CL' | 'CY' | 'CZ' | 'DE' | 'DK' | 'EE' | 'EG' | 'ES' | 'EU' | 'FI' | 'FR' | 'GB' | 'GE' | 'GR' | 'HK' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IS' | 'IT' | 'JP' | 'KE' | 'KR' | 'LI' | 'LT' | 'LU' | 'LV' | 'MT' | 'MX' | 'MY' | 'NL' | 'NO' | 'NZ' | 'PH' | 'PL' | 'PT' | 'RO' | 'RU' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'TH' | 'TR' | 'TW' | 'UA' | 'US' | 'ZA';
356
+ type: 'ae_trn' | 'eu_vat' | 'au_abn' | 'au_arn' | 'bg_uic' | 'br_cnpj' | 'br_cpf' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'ch_vat' | 'cl_tin' | 'eg_tin' | 'es_cif' | 'eu_oss_vat' | 'gb_vat' | 'ge_vat' | 'hk_br' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kr_brn' | 'li_uid' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'no_vat' | 'nz_gst' | 'ph_tin' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'th_vat' | 'tr_tin' | 'tw_vat' | 'ua_vat' | 'us_ein' | 'za_vat';
185
357
  value: string;
186
358
  }
187
359
  interface AccountingSyncConfiguration {
@@ -252,6 +424,92 @@ export interface CustomerCreateParams {
252
424
  payment_provider_id?: string | null;
253
425
  reporting_configuration?: CustomerCreateParams.ReportingConfiguration | null;
254
426
  shipping_address?: CustomerCreateParams.ShippingAddress | null;
427
+ /**
428
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
429
+ * added to the headers of invoices.
430
+ *
431
+ * ### Supported Tax ID Countries and Types
432
+ *
433
+ * | Country | Type | Description |
434
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
435
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
436
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
437
+ * | Austria | `eu_vat` | European VAT number |
438
+ * | Belgium | `eu_vat` | European VAT number |
439
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
440
+ * | Brazil | `br_cpf` | Brazilian CPF number |
441
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
442
+ * | Bulgaria | `eu_vat` | European VAT number |
443
+ * | Canada | `ca_bn` | Canadian BN |
444
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
445
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
446
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
447
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
448
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
449
+ * | Chile | `cl_tin` | Chilean TIN |
450
+ * | Croatia | `eu_vat` | European VAT number |
451
+ * | Cyprus | `eu_vat` | European VAT number |
452
+ * | Czech Republic | `eu_vat` | European VAT number |
453
+ * | Denmark | `eu_vat` | European VAT number |
454
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
455
+ * | Estonia | `eu_vat` | European VAT number |
456
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
457
+ * | Finland | `eu_vat` | European VAT number |
458
+ * | France | `eu_vat` | European VAT number |
459
+ * | Georgia | `ge_vat` | Georgian VAT |
460
+ * | Germany | `eu_vat` | European VAT number |
461
+ * | Greece | `eu_vat` | European VAT number |
462
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
463
+ * | Hungary | `eu_vat` | European VAT number |
464
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
465
+ * | Iceland | `is_vat` | Icelandic VAT |
466
+ * | India | `in_gst` | Indian GST number |
467
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
468
+ * | Ireland | `eu_vat` | European VAT number |
469
+ * | Israel | `il_vat` | Israel VAT |
470
+ * | Italy | `eu_vat` | European VAT number |
471
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
472
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
473
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
474
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
475
+ * | Latvia | `eu_vat` | European VAT number |
476
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
477
+ * | Lithuania | `eu_vat` | European VAT number |
478
+ * | Luxembourg | `eu_vat` | European VAT number |
479
+ * | Malaysia | `my_frp` | Malaysian FRP number |
480
+ * | Malaysia | `my_itn` | Malaysian ITN |
481
+ * | Malaysia | `my_sst` | Malaysian SST number |
482
+ * | Malta | `eu_vat ` | European VAT number |
483
+ * | Mexico | `mx_rfc` | Mexican RFC number |
484
+ * | Netherlands | `eu_vat` | European VAT number |
485
+ * | New Zealand | `nz_gst` | New Zealand GST number |
486
+ * | Norway | `no_vat` | Norwegian VAT number |
487
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
488
+ * | Poland | `eu_vat` | European VAT number |
489
+ * | Portugal | `eu_vat` | European VAT number |
490
+ * | Romania | `eu_vat` | European VAT number |
491
+ * | Russia | `ru_inn` | Russian INN |
492
+ * | Russia | `ru_kpp` | Russian KPP |
493
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
494
+ * | Singapore | `sg_uen` | Singaporean UEN |
495
+ * | Slovakia | `eu_vat` | European VAT number |
496
+ * | Slovenia | `eu_vat` | European VAT number |
497
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
498
+ * | South Africa | `za_vat` | South African VAT number |
499
+ * | South Korea | `kr_brn` | Korean BRN |
500
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
501
+ * | Spain | `eu_vat` | European VAT number |
502
+ * | Sweden | `eu_vat` | European VAT number |
503
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
504
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
505
+ * | Thailand | `th_vat` | Thai VAT |
506
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
507
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
508
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
509
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
510
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
511
+ * | United States | `us_ein` | United States EIN |
512
+ */
255
513
  tax_id?: CustomerCreateParams.TaxID | null;
256
514
  /**
257
515
  * A timezone identifier from the IANA timezone database, such as
@@ -290,9 +548,95 @@ export declare namespace CustomerCreateParams {
290
548
  postal_code?: string | null;
291
549
  state?: string | null;
292
550
  }
551
+ /**
552
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
553
+ * added to the headers of invoices.
554
+ *
555
+ * ### Supported Tax ID Countries and Types
556
+ *
557
+ * | Country | Type | Description |
558
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
559
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
560
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
561
+ * | Austria | `eu_vat` | European VAT number |
562
+ * | Belgium | `eu_vat` | European VAT number |
563
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
564
+ * | Brazil | `br_cpf` | Brazilian CPF number |
565
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
566
+ * | Bulgaria | `eu_vat` | European VAT number |
567
+ * | Canada | `ca_bn` | Canadian BN |
568
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
569
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
570
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
571
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
572
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
573
+ * | Chile | `cl_tin` | Chilean TIN |
574
+ * | Croatia | `eu_vat` | European VAT number |
575
+ * | Cyprus | `eu_vat` | European VAT number |
576
+ * | Czech Republic | `eu_vat` | European VAT number |
577
+ * | Denmark | `eu_vat` | European VAT number |
578
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
579
+ * | Estonia | `eu_vat` | European VAT number |
580
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
581
+ * | Finland | `eu_vat` | European VAT number |
582
+ * | France | `eu_vat` | European VAT number |
583
+ * | Georgia | `ge_vat` | Georgian VAT |
584
+ * | Germany | `eu_vat` | European VAT number |
585
+ * | Greece | `eu_vat` | European VAT number |
586
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
587
+ * | Hungary | `eu_vat` | European VAT number |
588
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
589
+ * | Iceland | `is_vat` | Icelandic VAT |
590
+ * | India | `in_gst` | Indian GST number |
591
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
592
+ * | Ireland | `eu_vat` | European VAT number |
593
+ * | Israel | `il_vat` | Israel VAT |
594
+ * | Italy | `eu_vat` | European VAT number |
595
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
596
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
597
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
598
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
599
+ * | Latvia | `eu_vat` | European VAT number |
600
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
601
+ * | Lithuania | `eu_vat` | European VAT number |
602
+ * | Luxembourg | `eu_vat` | European VAT number |
603
+ * | Malaysia | `my_frp` | Malaysian FRP number |
604
+ * | Malaysia | `my_itn` | Malaysian ITN |
605
+ * | Malaysia | `my_sst` | Malaysian SST number |
606
+ * | Malta | `eu_vat ` | European VAT number |
607
+ * | Mexico | `mx_rfc` | Mexican RFC number |
608
+ * | Netherlands | `eu_vat` | European VAT number |
609
+ * | New Zealand | `nz_gst` | New Zealand GST number |
610
+ * | Norway | `no_vat` | Norwegian VAT number |
611
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
612
+ * | Poland | `eu_vat` | European VAT number |
613
+ * | Portugal | `eu_vat` | European VAT number |
614
+ * | Romania | `eu_vat` | European VAT number |
615
+ * | Russia | `ru_inn` | Russian INN |
616
+ * | Russia | `ru_kpp` | Russian KPP |
617
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
618
+ * | Singapore | `sg_uen` | Singaporean UEN |
619
+ * | Slovakia | `eu_vat` | European VAT number |
620
+ * | Slovenia | `eu_vat` | European VAT number |
621
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
622
+ * | South Africa | `za_vat` | South African VAT number |
623
+ * | South Korea | `kr_brn` | Korean BRN |
624
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
625
+ * | Spain | `eu_vat` | European VAT number |
626
+ * | Sweden | `eu_vat` | European VAT number |
627
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
628
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
629
+ * | Thailand | `th_vat` | Thai VAT |
630
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
631
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
632
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
633
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
634
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
635
+ * | United States | `us_ein` | United States EIN |
636
+ */
293
637
  interface TaxID {
294
- country: string;
295
- type: string;
638
+ country: 'AE' | 'AT' | 'AU' | 'BE' | 'BG' | 'BR' | 'CA' | 'CH' | 'CL' | 'CY' | 'CZ' | 'DE' | 'DK' | 'EE' | 'EG' | 'ES' | 'EU' | 'FI' | 'FR' | 'GB' | 'GE' | 'GR' | 'HK' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IS' | 'IT' | 'JP' | 'KE' | 'KR' | 'LI' | 'LT' | 'LU' | 'LV' | 'MT' | 'MX' | 'MY' | 'NL' | 'NO' | 'NZ' | 'PH' | 'PL' | 'PT' | 'RO' | 'RU' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'TH' | 'TR' | 'TW' | 'UA' | 'US' | 'ZA';
639
+ type: 'ae_trn' | 'eu_vat' | 'au_abn' | 'au_arn' | 'bg_uic' | 'br_cnpj' | 'br_cpf' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'ch_vat' | 'cl_tin' | 'eg_tin' | 'es_cif' | 'eu_oss_vat' | 'gb_vat' | 'ge_vat' | 'hk_br' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kr_brn' | 'li_uid' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'no_vat' | 'nz_gst' | 'ph_tin' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'th_vat' | 'tr_tin' | 'tw_vat' | 'ua_vat' | 'us_ein' | 'za_vat';
296
640
  value: string;
297
641
  }
298
642
  }
@@ -352,6 +696,92 @@ export interface CustomerUpdateParams {
352
696
  payment_provider_id?: string | null;
353
697
  reporting_configuration?: CustomerUpdateParams.ReportingConfiguration | null;
354
698
  shipping_address?: CustomerUpdateParams.ShippingAddress | null;
699
+ /**
700
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
701
+ * added to the headers of invoices.
702
+ *
703
+ * ### Supported Tax ID Countries and Types
704
+ *
705
+ * | Country | Type | Description |
706
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
707
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
708
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
709
+ * | Austria | `eu_vat` | European VAT number |
710
+ * | Belgium | `eu_vat` | European VAT number |
711
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
712
+ * | Brazil | `br_cpf` | Brazilian CPF number |
713
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
714
+ * | Bulgaria | `eu_vat` | European VAT number |
715
+ * | Canada | `ca_bn` | Canadian BN |
716
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
717
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
718
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
719
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
720
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
721
+ * | Chile | `cl_tin` | Chilean TIN |
722
+ * | Croatia | `eu_vat` | European VAT number |
723
+ * | Cyprus | `eu_vat` | European VAT number |
724
+ * | Czech Republic | `eu_vat` | European VAT number |
725
+ * | Denmark | `eu_vat` | European VAT number |
726
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
727
+ * | Estonia | `eu_vat` | European VAT number |
728
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
729
+ * | Finland | `eu_vat` | European VAT number |
730
+ * | France | `eu_vat` | European VAT number |
731
+ * | Georgia | `ge_vat` | Georgian VAT |
732
+ * | Germany | `eu_vat` | European VAT number |
733
+ * | Greece | `eu_vat` | European VAT number |
734
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
735
+ * | Hungary | `eu_vat` | European VAT number |
736
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
737
+ * | Iceland | `is_vat` | Icelandic VAT |
738
+ * | India | `in_gst` | Indian GST number |
739
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
740
+ * | Ireland | `eu_vat` | European VAT number |
741
+ * | Israel | `il_vat` | Israel VAT |
742
+ * | Italy | `eu_vat` | European VAT number |
743
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
744
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
745
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
746
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
747
+ * | Latvia | `eu_vat` | European VAT number |
748
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
749
+ * | Lithuania | `eu_vat` | European VAT number |
750
+ * | Luxembourg | `eu_vat` | European VAT number |
751
+ * | Malaysia | `my_frp` | Malaysian FRP number |
752
+ * | Malaysia | `my_itn` | Malaysian ITN |
753
+ * | Malaysia | `my_sst` | Malaysian SST number |
754
+ * | Malta | `eu_vat ` | European VAT number |
755
+ * | Mexico | `mx_rfc` | Mexican RFC number |
756
+ * | Netherlands | `eu_vat` | European VAT number |
757
+ * | New Zealand | `nz_gst` | New Zealand GST number |
758
+ * | Norway | `no_vat` | Norwegian VAT number |
759
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
760
+ * | Poland | `eu_vat` | European VAT number |
761
+ * | Portugal | `eu_vat` | European VAT number |
762
+ * | Romania | `eu_vat` | European VAT number |
763
+ * | Russia | `ru_inn` | Russian INN |
764
+ * | Russia | `ru_kpp` | Russian KPP |
765
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
766
+ * | Singapore | `sg_uen` | Singaporean UEN |
767
+ * | Slovakia | `eu_vat` | European VAT number |
768
+ * | Slovenia | `eu_vat` | European VAT number |
769
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
770
+ * | South Africa | `za_vat` | South African VAT number |
771
+ * | South Korea | `kr_brn` | Korean BRN |
772
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
773
+ * | Spain | `eu_vat` | European VAT number |
774
+ * | Sweden | `eu_vat` | European VAT number |
775
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
776
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
777
+ * | Thailand | `th_vat` | Thai VAT |
778
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
779
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
780
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
781
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
782
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
783
+ * | United States | `us_ein` | United States EIN |
784
+ */
355
785
  tax_id?: CustomerUpdateParams.TaxID | null;
356
786
  }
357
787
  export declare namespace CustomerUpdateParams {
@@ -384,9 +814,95 @@ export declare namespace CustomerUpdateParams {
384
814
  postal_code?: string | null;
385
815
  state?: string | null;
386
816
  }
817
+ /**
818
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
819
+ * added to the headers of invoices.
820
+ *
821
+ * ### Supported Tax ID Countries and Types
822
+ *
823
+ * | Country | Type | Description |
824
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
825
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
826
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
827
+ * | Austria | `eu_vat` | European VAT number |
828
+ * | Belgium | `eu_vat` | European VAT number |
829
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
830
+ * | Brazil | `br_cpf` | Brazilian CPF number |
831
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
832
+ * | Bulgaria | `eu_vat` | European VAT number |
833
+ * | Canada | `ca_bn` | Canadian BN |
834
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
835
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
836
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
837
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
838
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
839
+ * | Chile | `cl_tin` | Chilean TIN |
840
+ * | Croatia | `eu_vat` | European VAT number |
841
+ * | Cyprus | `eu_vat` | European VAT number |
842
+ * | Czech Republic | `eu_vat` | European VAT number |
843
+ * | Denmark | `eu_vat` | European VAT number |
844
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
845
+ * | Estonia | `eu_vat` | European VAT number |
846
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
847
+ * | Finland | `eu_vat` | European VAT number |
848
+ * | France | `eu_vat` | European VAT number |
849
+ * | Georgia | `ge_vat` | Georgian VAT |
850
+ * | Germany | `eu_vat` | European VAT number |
851
+ * | Greece | `eu_vat` | European VAT number |
852
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
853
+ * | Hungary | `eu_vat` | European VAT number |
854
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
855
+ * | Iceland | `is_vat` | Icelandic VAT |
856
+ * | India | `in_gst` | Indian GST number |
857
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
858
+ * | Ireland | `eu_vat` | European VAT number |
859
+ * | Israel | `il_vat` | Israel VAT |
860
+ * | Italy | `eu_vat` | European VAT number |
861
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
862
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
863
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
864
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
865
+ * | Latvia | `eu_vat` | European VAT number |
866
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
867
+ * | Lithuania | `eu_vat` | European VAT number |
868
+ * | Luxembourg | `eu_vat` | European VAT number |
869
+ * | Malaysia | `my_frp` | Malaysian FRP number |
870
+ * | Malaysia | `my_itn` | Malaysian ITN |
871
+ * | Malaysia | `my_sst` | Malaysian SST number |
872
+ * | Malta | `eu_vat ` | European VAT number |
873
+ * | Mexico | `mx_rfc` | Mexican RFC number |
874
+ * | Netherlands | `eu_vat` | European VAT number |
875
+ * | New Zealand | `nz_gst` | New Zealand GST number |
876
+ * | Norway | `no_vat` | Norwegian VAT number |
877
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
878
+ * | Poland | `eu_vat` | European VAT number |
879
+ * | Portugal | `eu_vat` | European VAT number |
880
+ * | Romania | `eu_vat` | European VAT number |
881
+ * | Russia | `ru_inn` | Russian INN |
882
+ * | Russia | `ru_kpp` | Russian KPP |
883
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
884
+ * | Singapore | `sg_uen` | Singaporean UEN |
885
+ * | Slovakia | `eu_vat` | European VAT number |
886
+ * | Slovenia | `eu_vat` | European VAT number |
887
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
888
+ * | South Africa | `za_vat` | South African VAT number |
889
+ * | South Korea | `kr_brn` | Korean BRN |
890
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
891
+ * | Spain | `eu_vat` | European VAT number |
892
+ * | Sweden | `eu_vat` | European VAT number |
893
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
894
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
895
+ * | Thailand | `th_vat` | Thai VAT |
896
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
897
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
898
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
899
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
900
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
901
+ * | United States | `us_ein` | United States EIN |
902
+ */
387
903
  interface TaxID {
388
- country: string;
389
- type: string;
904
+ country: 'AE' | 'AT' | 'AU' | 'BE' | 'BG' | 'BR' | 'CA' | 'CH' | 'CL' | 'CY' | 'CZ' | 'DE' | 'DK' | 'EE' | 'EG' | 'ES' | 'EU' | 'FI' | 'FR' | 'GB' | 'GE' | 'GR' | 'HK' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IS' | 'IT' | 'JP' | 'KE' | 'KR' | 'LI' | 'LT' | 'LU' | 'LV' | 'MT' | 'MX' | 'MY' | 'NL' | 'NO' | 'NZ' | 'PH' | 'PL' | 'PT' | 'RO' | 'RU' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'TH' | 'TR' | 'TW' | 'UA' | 'US' | 'ZA';
905
+ type: 'ae_trn' | 'eu_vat' | 'au_abn' | 'au_arn' | 'bg_uic' | 'br_cnpj' | 'br_cpf' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'ch_vat' | 'cl_tin' | 'eg_tin' | 'es_cif' | 'eu_oss_vat' | 'gb_vat' | 'ge_vat' | 'hk_br' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kr_brn' | 'li_uid' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'no_vat' | 'nz_gst' | 'ph_tin' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'th_vat' | 'tr_tin' | 'tw_vat' | 'ua_vat' | 'us_ein' | 'za_vat';
390
906
  value: string;
391
907
  }
392
908
  }
@@ -452,6 +968,92 @@ export interface CustomerUpdateByExternalIDParams {
452
968
  payment_provider_id?: string | null;
453
969
  reporting_configuration?: CustomerUpdateByExternalIDParams.ReportingConfiguration | null;
454
970
  shipping_address?: CustomerUpdateByExternalIDParams.ShippingAddress | null;
971
+ /**
972
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
973
+ * added to the headers of invoices.
974
+ *
975
+ * ### Supported Tax ID Countries and Types
976
+ *
977
+ * | Country | Type | Description |
978
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
979
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
980
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
981
+ * | Austria | `eu_vat` | European VAT number |
982
+ * | Belgium | `eu_vat` | European VAT number |
983
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
984
+ * | Brazil | `br_cpf` | Brazilian CPF number |
985
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
986
+ * | Bulgaria | `eu_vat` | European VAT number |
987
+ * | Canada | `ca_bn` | Canadian BN |
988
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
989
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
990
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
991
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
992
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
993
+ * | Chile | `cl_tin` | Chilean TIN |
994
+ * | Croatia | `eu_vat` | European VAT number |
995
+ * | Cyprus | `eu_vat` | European VAT number |
996
+ * | Czech Republic | `eu_vat` | European VAT number |
997
+ * | Denmark | `eu_vat` | European VAT number |
998
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
999
+ * | Estonia | `eu_vat` | European VAT number |
1000
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
1001
+ * | Finland | `eu_vat` | European VAT number |
1002
+ * | France | `eu_vat` | European VAT number |
1003
+ * | Georgia | `ge_vat` | Georgian VAT |
1004
+ * | Germany | `eu_vat` | European VAT number |
1005
+ * | Greece | `eu_vat` | European VAT number |
1006
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
1007
+ * | Hungary | `eu_vat` | European VAT number |
1008
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
1009
+ * | Iceland | `is_vat` | Icelandic VAT |
1010
+ * | India | `in_gst` | Indian GST number |
1011
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
1012
+ * | Ireland | `eu_vat` | European VAT number |
1013
+ * | Israel | `il_vat` | Israel VAT |
1014
+ * | Italy | `eu_vat` | European VAT number |
1015
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
1016
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
1017
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
1018
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
1019
+ * | Latvia | `eu_vat` | European VAT number |
1020
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
1021
+ * | Lithuania | `eu_vat` | European VAT number |
1022
+ * | Luxembourg | `eu_vat` | European VAT number |
1023
+ * | Malaysia | `my_frp` | Malaysian FRP number |
1024
+ * | Malaysia | `my_itn` | Malaysian ITN |
1025
+ * | Malaysia | `my_sst` | Malaysian SST number |
1026
+ * | Malta | `eu_vat ` | European VAT number |
1027
+ * | Mexico | `mx_rfc` | Mexican RFC number |
1028
+ * | Netherlands | `eu_vat` | European VAT number |
1029
+ * | New Zealand | `nz_gst` | New Zealand GST number |
1030
+ * | Norway | `no_vat` | Norwegian VAT number |
1031
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
1032
+ * | Poland | `eu_vat` | European VAT number |
1033
+ * | Portugal | `eu_vat` | European VAT number |
1034
+ * | Romania | `eu_vat` | European VAT number |
1035
+ * | Russia | `ru_inn` | Russian INN |
1036
+ * | Russia | `ru_kpp` | Russian KPP |
1037
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
1038
+ * | Singapore | `sg_uen` | Singaporean UEN |
1039
+ * | Slovakia | `eu_vat` | European VAT number |
1040
+ * | Slovenia | `eu_vat` | European VAT number |
1041
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
1042
+ * | South Africa | `za_vat` | South African VAT number |
1043
+ * | South Korea | `kr_brn` | Korean BRN |
1044
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
1045
+ * | Spain | `eu_vat` | European VAT number |
1046
+ * | Sweden | `eu_vat` | European VAT number |
1047
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
1048
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
1049
+ * | Thailand | `th_vat` | Thai VAT |
1050
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
1051
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
1052
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
1053
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
1054
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
1055
+ * | United States | `us_ein` | United States EIN |
1056
+ */
455
1057
  tax_id?: CustomerUpdateByExternalIDParams.TaxID | null;
456
1058
  }
457
1059
  export declare namespace CustomerUpdateByExternalIDParams {
@@ -484,9 +1086,95 @@ export declare namespace CustomerUpdateByExternalIDParams {
484
1086
  postal_code?: string | null;
485
1087
  state?: string | null;
486
1088
  }
1089
+ /**
1090
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
1091
+ * added to the headers of invoices.
1092
+ *
1093
+ * ### Supported Tax ID Countries and Types
1094
+ *
1095
+ * | Country | Type | Description |
1096
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
1097
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
1098
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
1099
+ * | Austria | `eu_vat` | European VAT number |
1100
+ * | Belgium | `eu_vat` | European VAT number |
1101
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
1102
+ * | Brazil | `br_cpf` | Brazilian CPF number |
1103
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
1104
+ * | Bulgaria | `eu_vat` | European VAT number |
1105
+ * | Canada | `ca_bn` | Canadian BN |
1106
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
1107
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
1108
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
1109
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
1110
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
1111
+ * | Chile | `cl_tin` | Chilean TIN |
1112
+ * | Croatia | `eu_vat` | European VAT number |
1113
+ * | Cyprus | `eu_vat` | European VAT number |
1114
+ * | Czech Republic | `eu_vat` | European VAT number |
1115
+ * | Denmark | `eu_vat` | European VAT number |
1116
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
1117
+ * | Estonia | `eu_vat` | European VAT number |
1118
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
1119
+ * | Finland | `eu_vat` | European VAT number |
1120
+ * | France | `eu_vat` | European VAT number |
1121
+ * | Georgia | `ge_vat` | Georgian VAT |
1122
+ * | Germany | `eu_vat` | European VAT number |
1123
+ * | Greece | `eu_vat` | European VAT number |
1124
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
1125
+ * | Hungary | `eu_vat` | European VAT number |
1126
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
1127
+ * | Iceland | `is_vat` | Icelandic VAT |
1128
+ * | India | `in_gst` | Indian GST number |
1129
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
1130
+ * | Ireland | `eu_vat` | European VAT number |
1131
+ * | Israel | `il_vat` | Israel VAT |
1132
+ * | Italy | `eu_vat` | European VAT number |
1133
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
1134
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
1135
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
1136
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
1137
+ * | Latvia | `eu_vat` | European VAT number |
1138
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
1139
+ * | Lithuania | `eu_vat` | European VAT number |
1140
+ * | Luxembourg | `eu_vat` | European VAT number |
1141
+ * | Malaysia | `my_frp` | Malaysian FRP number |
1142
+ * | Malaysia | `my_itn` | Malaysian ITN |
1143
+ * | Malaysia | `my_sst` | Malaysian SST number |
1144
+ * | Malta | `eu_vat ` | European VAT number |
1145
+ * | Mexico | `mx_rfc` | Mexican RFC number |
1146
+ * | Netherlands | `eu_vat` | European VAT number |
1147
+ * | New Zealand | `nz_gst` | New Zealand GST number |
1148
+ * | Norway | `no_vat` | Norwegian VAT number |
1149
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
1150
+ * | Poland | `eu_vat` | European VAT number |
1151
+ * | Portugal | `eu_vat` | European VAT number |
1152
+ * | Romania | `eu_vat` | European VAT number |
1153
+ * | Russia | `ru_inn` | Russian INN |
1154
+ * | Russia | `ru_kpp` | Russian KPP |
1155
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
1156
+ * | Singapore | `sg_uen` | Singaporean UEN |
1157
+ * | Slovakia | `eu_vat` | European VAT number |
1158
+ * | Slovenia | `eu_vat` | European VAT number |
1159
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
1160
+ * | South Africa | `za_vat` | South African VAT number |
1161
+ * | South Korea | `kr_brn` | Korean BRN |
1162
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
1163
+ * | Spain | `eu_vat` | European VAT number |
1164
+ * | Sweden | `eu_vat` | European VAT number |
1165
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
1166
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
1167
+ * | Thailand | `th_vat` | Thai VAT |
1168
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
1169
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
1170
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
1171
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
1172
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
1173
+ * | United States | `us_ein` | United States EIN |
1174
+ */
487
1175
  interface TaxID {
488
- country: string;
489
- type: string;
1176
+ country: 'AE' | 'AT' | 'AU' | 'BE' | 'BG' | 'BR' | 'CA' | 'CH' | 'CL' | 'CY' | 'CZ' | 'DE' | 'DK' | 'EE' | 'EG' | 'ES' | 'EU' | 'FI' | 'FR' | 'GB' | 'GE' | 'GR' | 'HK' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IS' | 'IT' | 'JP' | 'KE' | 'KR' | 'LI' | 'LT' | 'LU' | 'LV' | 'MT' | 'MX' | 'MY' | 'NL' | 'NO' | 'NZ' | 'PH' | 'PL' | 'PT' | 'RO' | 'RU' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'TH' | 'TR' | 'TW' | 'UA' | 'US' | 'ZA';
1177
+ type: 'ae_trn' | 'eu_vat' | 'au_abn' | 'au_arn' | 'bg_uic' | 'br_cnpj' | 'br_cpf' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'ch_vat' | 'cl_tin' | 'eg_tin' | 'es_cif' | 'eu_oss_vat' | 'gb_vat' | 'ge_vat' | 'hk_br' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kr_brn' | 'li_uid' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'no_vat' | 'nz_gst' | 'ph_tin' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'th_vat' | 'tr_tin' | 'tw_vat' | 'ua_vat' | 'us_ein' | 'za_vat';
490
1178
  value: string;
491
1179
  }
492
1180
  }