orb-billing 1.23.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 (89) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/index.d.mts +2 -2
  3. package/index.d.ts +2 -2
  4. package/index.d.ts.map +1 -1
  5. package/index.js +4 -0
  6. package/index.js.map +1 -1
  7. package/index.mjs +4 -0
  8. package/index.mjs.map +1 -1
  9. package/package.json +3 -1
  10. package/resources/coupons/coupons.d.ts +60 -2
  11. package/resources/coupons/coupons.d.ts.map +1 -1
  12. package/resources/coupons/coupons.js.map +1 -1
  13. package/resources/coupons/coupons.mjs.map +1 -1
  14. package/resources/credit-notes.d.ts +57 -5
  15. package/resources/credit-notes.d.ts.map +1 -1
  16. package/resources/credit-notes.js.map +1 -1
  17. package/resources/credit-notes.mjs.map +1 -1
  18. package/resources/customers/balance-transactions.d.ts +2 -2
  19. package/resources/customers/balance-transactions.d.ts.map +1 -1
  20. package/resources/customers/balance-transactions.js.map +1 -1
  21. package/resources/customers/balance-transactions.mjs.map +1 -1
  22. package/resources/customers/customers.d.ts +696 -8
  23. package/resources/customers/customers.d.ts.map +1 -1
  24. package/resources/customers/customers.js.map +1 -1
  25. package/resources/customers/customers.mjs.map +1 -1
  26. package/resources/customers/usage.d.ts +74 -58
  27. package/resources/customers/usage.d.ts.map +1 -1
  28. package/resources/customers/usage.js +14 -14
  29. package/resources/customers/usage.js.map +1 -1
  30. package/resources/customers/usage.mjs +14 -14
  31. package/resources/customers/usage.mjs.map +1 -1
  32. package/resources/events/events.d.ts +40 -40
  33. package/resources/events/events.js +40 -40
  34. package/resources/events/events.mjs +40 -40
  35. package/resources/index.d.ts +4 -3
  36. package/resources/index.d.ts.map +1 -1
  37. package/resources/index.js +19 -4
  38. package/resources/index.js.map +1 -1
  39. package/resources/index.mjs +2 -1
  40. package/resources/index.mjs.map +1 -1
  41. package/resources/invoice-line-items.d.ts +2 -2
  42. package/resources/invoice-line-items.d.ts.map +1 -1
  43. package/resources/invoices.d.ts +358 -71
  44. package/resources/invoices.d.ts.map +1 -1
  45. package/resources/invoices.js.map +1 -1
  46. package/resources/invoices.mjs.map +1 -1
  47. package/resources/plans/plans.d.ts +648 -4
  48. package/resources/plans/plans.d.ts.map +1 -1
  49. package/resources/plans/plans.js.map +1 -1
  50. package/resources/plans/plans.mjs.map +1 -1
  51. package/resources/prices/index.d.ts +1 -1
  52. package/resources/prices/index.d.ts.map +1 -1
  53. package/resources/prices/index.js +3 -3
  54. package/resources/prices/index.js.map +1 -1
  55. package/resources/prices/index.mjs +1 -1
  56. package/resources/prices/index.mjs.map +1 -1
  57. package/resources/prices/prices.d.ts +56 -83
  58. package/resources/prices/prices.d.ts.map +1 -1
  59. package/resources/prices/prices.js.map +1 -1
  60. package/resources/prices/prices.mjs.map +1 -1
  61. package/resources/shared.d.ts +62 -0
  62. package/resources/shared.d.ts.map +1 -0
  63. package/resources/shared.js +4 -0
  64. package/resources/shared.js.map +1 -0
  65. package/resources/shared.mjs +3 -0
  66. package/resources/shared.mjs.map +1 -0
  67. package/resources/subscriptions.d.ts +1084 -241
  68. package/resources/subscriptions.d.ts.map +1 -1
  69. package/resources/subscriptions.js.map +1 -1
  70. package/resources/subscriptions.mjs.map +1 -1
  71. package/src/index.ts +7 -2
  72. package/src/resources/coupons/coupons.ts +76 -2
  73. package/src/resources/credit-notes.ts +81 -5
  74. package/src/resources/customers/balance-transactions.ts +18 -2
  75. package/src/resources/customers/customers.ts +1144 -12
  76. package/src/resources/customers/usage.ts +80 -62
  77. package/src/resources/events/events.ts +40 -40
  78. package/src/resources/index.ts +3 -3
  79. package/src/resources/invoice-line-items.ts +2 -2
  80. package/src/resources/invoices.ts +598 -91
  81. package/src/resources/plans/plans.ts +810 -4
  82. package/src/resources/prices/index.ts +1 -1
  83. package/src/resources/prices/prices.ts +67 -100
  84. package/src/resources/shared.ts +84 -0
  85. package/src/resources/subscriptions.ts +1291 -279
  86. package/src/version.ts +1 -1
  87. package/version.d.ts +1 -1
  88. package/version.js +1 -1
  89. package/version.mjs +1 -1
package/src/resources/customers/customers.ts CHANGED
@@ -229,6 +229,92 @@ export interface Customer {
229
229
 
230
230
  shipping_address: Customer.ShippingAddress | null;
231
231
 
232
+ /**
233
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
234
+ * added to the headers of invoices.
235
+ *
236
+ * ### Supported Tax ID Countries and Types
237
+ *
238
+ * | Country | Type | Description |
239
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
240
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
241
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
242
+ * | Austria | `eu_vat` | European VAT number |
243
+ * | Belgium | `eu_vat` | European VAT number |
244
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
245
+ * | Brazil | `br_cpf` | Brazilian CPF number |
246
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
247
+ * | Bulgaria | `eu_vat` | European VAT number |
248
+ * | Canada | `ca_bn` | Canadian BN |
249
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
250
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
251
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
252
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
253
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
254
+ * | Chile | `cl_tin` | Chilean TIN |
255
+ * | Croatia | `eu_vat` | European VAT number |
256
+ * | Cyprus | `eu_vat` | European VAT number |
257
+ * | Czech Republic | `eu_vat` | European VAT number |
258
+ * | Denmark | `eu_vat` | European VAT number |
259
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
260
+ * | Estonia | `eu_vat` | European VAT number |
261
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
262
+ * | Finland | `eu_vat` | European VAT number |
263
+ * | France | `eu_vat` | European VAT number |
264
+ * | Georgia | `ge_vat` | Georgian VAT |
265
+ * | Germany | `eu_vat` | European VAT number |
266
+ * | Greece | `eu_vat` | European VAT number |
267
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
268
+ * | Hungary | `eu_vat` | European VAT number |
269
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
270
+ * | Iceland | `is_vat` | Icelandic VAT |
271
+ * | India | `in_gst` | Indian GST number |
272
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
273
+ * | Ireland | `eu_vat` | European VAT number |
274
+ * | Israel | `il_vat` | Israel VAT |
275
+ * | Italy | `eu_vat` | European VAT number |
276
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
277
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
278
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
279
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
280
+ * | Latvia | `eu_vat` | European VAT number |
281
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
282
+ * | Lithuania | `eu_vat` | European VAT number |
283
+ * | Luxembourg | `eu_vat` | European VAT number |
284
+ * | Malaysia | `my_frp` | Malaysian FRP number |
285
+ * | Malaysia | `my_itn` | Malaysian ITN |
286
+ * | Malaysia | `my_sst` | Malaysian SST number |
287
+ * | Malta | `eu_vat ` | European VAT number |
288
+ * | Mexico | `mx_rfc` | Mexican RFC number |
289
+ * | Netherlands | `eu_vat` | European VAT number |
290
+ * | New Zealand | `nz_gst` | New Zealand GST number |
291
+ * | Norway | `no_vat` | Norwegian VAT number |
292
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
293
+ * | Poland | `eu_vat` | European VAT number |
294
+ * | Portugal | `eu_vat` | European VAT number |
295
+ * | Romania | `eu_vat` | European VAT number |
296
+ * | Russia | `ru_inn` | Russian INN |
297
+ * | Russia | `ru_kpp` | Russian KPP |
298
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
299
+ * | Singapore | `sg_uen` | Singaporean UEN |
300
+ * | Slovakia | `eu_vat` | European VAT number |
301
+ * | Slovenia | `eu_vat` | European VAT number |
302
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
303
+ * | South Africa | `za_vat` | South African VAT number |
304
+ * | South Korea | `kr_brn` | Korean BRN |
305
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
306
+ * | Spain | `eu_vat` | European VAT number |
307
+ * | Sweden | `eu_vat` | European VAT number |
308
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
309
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
310
+ * | Thailand | `th_vat` | Thai VAT |
311
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
312
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
313
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
314
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
315
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
316
+ * | United States | `us_ein` | United States EIN |
317
+ */
232
318
  tax_id: Customer.TaxID | null;
233
319
 
234
320
  /**
@@ -272,10 +358,207 @@ export namespace Customer {
272
358
  state: string | null;
273
359
  }
274
360
 
361
+ /**
362
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
363
+ * added to the headers of invoices.
364
+ *
365
+ * ### Supported Tax ID Countries and Types
366
+ *
367
+ * | Country | Type | Description |
368
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
369
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
370
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
371
+ * | Austria | `eu_vat` | European VAT number |
372
+ * | Belgium | `eu_vat` | European VAT number |
373
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
374
+ * | Brazil | `br_cpf` | Brazilian CPF number |
375
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
376
+ * | Bulgaria | `eu_vat` | European VAT number |
377
+ * | Canada | `ca_bn` | Canadian BN |
378
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
379
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
380
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
381
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
382
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
383
+ * | Chile | `cl_tin` | Chilean TIN |
384
+ * | Croatia | `eu_vat` | European VAT number |
385
+ * | Cyprus | `eu_vat` | European VAT number |
386
+ * | Czech Republic | `eu_vat` | European VAT number |
387
+ * | Denmark | `eu_vat` | European VAT number |
388
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
389
+ * | Estonia | `eu_vat` | European VAT number |
390
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
391
+ * | Finland | `eu_vat` | European VAT number |
392
+ * | France | `eu_vat` | European VAT number |
393
+ * | Georgia | `ge_vat` | Georgian VAT |
394
+ * | Germany | `eu_vat` | European VAT number |
395
+ * | Greece | `eu_vat` | European VAT number |
396
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
397
+ * | Hungary | `eu_vat` | European VAT number |
398
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
399
+ * | Iceland | `is_vat` | Icelandic VAT |
400
+ * | India | `in_gst` | Indian GST number |
401
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
402
+ * | Ireland | `eu_vat` | European VAT number |
403
+ * | Israel | `il_vat` | Israel VAT |
404
+ * | Italy | `eu_vat` | European VAT number |
405
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
406
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
407
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
408
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
409
+ * | Latvia | `eu_vat` | European VAT number |
410
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
411
+ * | Lithuania | `eu_vat` | European VAT number |
412
+ * | Luxembourg | `eu_vat` | European VAT number |
413
+ * | Malaysia | `my_frp` | Malaysian FRP number |
414
+ * | Malaysia | `my_itn` | Malaysian ITN |
415
+ * | Malaysia | `my_sst` | Malaysian SST number |
416
+ * | Malta | `eu_vat ` | European VAT number |
417
+ * | Mexico | `mx_rfc` | Mexican RFC number |
418
+ * | Netherlands | `eu_vat` | European VAT number |
419
+ * | New Zealand | `nz_gst` | New Zealand GST number |
420
+ * | Norway | `no_vat` | Norwegian VAT number |
421
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
422
+ * | Poland | `eu_vat` | European VAT number |
423
+ * | Portugal | `eu_vat` | European VAT number |
424
+ * | Romania | `eu_vat` | European VAT number |
425
+ * | Russia | `ru_inn` | Russian INN |
426
+ * | Russia | `ru_kpp` | Russian KPP |
427
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
428
+ * | Singapore | `sg_uen` | Singaporean UEN |
429
+ * | Slovakia | `eu_vat` | European VAT number |
430
+ * | Slovenia | `eu_vat` | European VAT number |
431
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
432
+ * | South Africa | `za_vat` | South African VAT number |
433
+ * | South Korea | `kr_brn` | Korean BRN |
434
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
435
+ * | Spain | `eu_vat` | European VAT number |
436
+ * | Sweden | `eu_vat` | European VAT number |
437
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
438
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
439
+ * | Thailand | `th_vat` | Thai VAT |
440
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
441
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
442
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
443
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
444
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
445
+ * | United States | `us_ein` | United States EIN |
446
+ */
275
447
  export interface TaxID {
276
- country: string;
277
-
278
- type: string;
448
+ country:
449
+ | 'AE'
450
+ | 'AT'
451
+ | 'AU'
452
+ | 'BE'
453
+ | 'BG'
454
+ | 'BR'
455
+ | 'CA'
456
+ | 'CH'
457
+ | 'CL'
458
+ | 'CY'
459
+ | 'CZ'
460
+ | 'DE'
461
+ | 'DK'
462
+ | 'EE'
463
+ | 'EG'
464
+ | 'ES'
465
+ | 'EU'
466
+ | 'FI'
467
+ | 'FR'
468
+ | 'GB'
469
+ | 'GE'
470
+ | 'GR'
471
+ | 'HK'
472
+ | 'HR'
473
+ | 'HU'
474
+ | 'ID'
475
+ | 'IE'
476
+ | 'IL'
477
+ | 'IN'
478
+ | 'IS'
479
+ | 'IT'
480
+ | 'JP'
481
+ | 'KE'
482
+ | 'KR'
483
+ | 'LI'
484
+ | 'LT'
485
+ | 'LU'
486
+ | 'LV'
487
+ | 'MT'
488
+ | 'MX'
489
+ | 'MY'
490
+ | 'NL'
491
+ | 'NO'
492
+ | 'NZ'
493
+ | 'PH'
494
+ | 'PL'
495
+ | 'PT'
496
+ | 'RO'
497
+ | 'RU'
498
+ | 'SA'
499
+ | 'SE'
500
+ | 'SG'
501
+ | 'SI'
502
+ | 'SK'
503
+ | 'TH'
504
+ | 'TR'
505
+ | 'TW'
506
+ | 'UA'
507
+ | 'US'
508
+ | 'ZA';
509
+
510
+ type:
511
+ | 'ae_trn'
512
+ | 'eu_vat'
513
+ | 'au_abn'
514
+ | 'au_arn'
515
+ | 'bg_uic'
516
+ | 'br_cnpj'
517
+ | 'br_cpf'
518
+ | 'ca_bn'
519
+ | 'ca_gst_hst'
520
+ | 'ca_pst_bc'
521
+ | 'ca_pst_mb'
522
+ | 'ca_pst_sk'
523
+ | 'ca_qst'
524
+ | 'ch_vat'
525
+ | 'cl_tin'
526
+ | 'eg_tin'
527
+ | 'es_cif'
528
+ | 'eu_oss_vat'
529
+ | 'gb_vat'
530
+ | 'ge_vat'
531
+ | 'hk_br'
532
+ | 'hu_tin'
533
+ | 'id_npwp'
534
+ | 'il_vat'
535
+ | 'in_gst'
536
+ | 'is_vat'
537
+ | 'jp_cn'
538
+ | 'jp_rn'
539
+ | 'jp_trn'
540
+ | 'ke_pin'
541
+ | 'kr_brn'
542
+ | 'li_uid'
543
+ | 'mx_rfc'
544
+ | 'my_frp'
545
+ | 'my_itn'
546
+ | 'my_sst'
547
+ | 'no_vat'
548
+ | 'nz_gst'
549
+ | 'ph_tin'
550
+ | 'ru_inn'
551
+ | 'ru_kpp'
552
+ | 'sa_vat'
553
+ | 'sg_gst'
554
+ | 'sg_uen'
555
+ | 'si_tin'
556
+ | 'th_vat'
557
+ | 'tr_tin'
558
+ | 'tw_vat'
559
+ | 'ua_vat'
560
+ | 'us_ein'
561
+ | 'za_vat';
279
562
 
280
563
  value: string;
281
564
  }
@@ -367,6 +650,92 @@ export interface CustomerCreateParams {
367
650
 
368
651
  shipping_address?: CustomerCreateParams.ShippingAddress | null;
369
652
 
653
+ /**
654
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
655
+ * added to the headers of invoices.
656
+ *
657
+ * ### Supported Tax ID Countries and Types
658
+ *
659
+ * | Country | Type | Description |
660
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
661
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
662
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
663
+ * | Austria | `eu_vat` | European VAT number |
664
+ * | Belgium | `eu_vat` | European VAT number |
665
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
666
+ * | Brazil | `br_cpf` | Brazilian CPF number |
667
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
668
+ * | Bulgaria | `eu_vat` | European VAT number |
669
+ * | Canada | `ca_bn` | Canadian BN |
670
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
671
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
672
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
673
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
674
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
675
+ * | Chile | `cl_tin` | Chilean TIN |
676
+ * | Croatia | `eu_vat` | European VAT number |
677
+ * | Cyprus | `eu_vat` | European VAT number |
678
+ * | Czech Republic | `eu_vat` | European VAT number |
679
+ * | Denmark | `eu_vat` | European VAT number |
680
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
681
+ * | Estonia | `eu_vat` | European VAT number |
682
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
683
+ * | Finland | `eu_vat` | European VAT number |
684
+ * | France | `eu_vat` | European VAT number |
685
+ * | Georgia | `ge_vat` | Georgian VAT |
686
+ * | Germany | `eu_vat` | European VAT number |
687
+ * | Greece | `eu_vat` | European VAT number |
688
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
689
+ * | Hungary | `eu_vat` | European VAT number |
690
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
691
+ * | Iceland | `is_vat` | Icelandic VAT |
692
+ * | India | `in_gst` | Indian GST number |
693
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
694
+ * | Ireland | `eu_vat` | European VAT number |
695
+ * | Israel | `il_vat` | Israel VAT |
696
+ * | Italy | `eu_vat` | European VAT number |
697
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
698
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
699
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
700
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
701
+ * | Latvia | `eu_vat` | European VAT number |
702
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
703
+ * | Lithuania | `eu_vat` | European VAT number |
704
+ * | Luxembourg | `eu_vat` | European VAT number |
705
+ * | Malaysia | `my_frp` | Malaysian FRP number |
706
+ * | Malaysia | `my_itn` | Malaysian ITN |
707
+ * | Malaysia | `my_sst` | Malaysian SST number |
708
+ * | Malta | `eu_vat ` | European VAT number |
709
+ * | Mexico | `mx_rfc` | Mexican RFC number |
710
+ * | Netherlands | `eu_vat` | European VAT number |
711
+ * | New Zealand | `nz_gst` | New Zealand GST number |
712
+ * | Norway | `no_vat` | Norwegian VAT number |
713
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
714
+ * | Poland | `eu_vat` | European VAT number |
715
+ * | Portugal | `eu_vat` | European VAT number |
716
+ * | Romania | `eu_vat` | European VAT number |
717
+ * | Russia | `ru_inn` | Russian INN |
718
+ * | Russia | `ru_kpp` | Russian KPP |
719
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
720
+ * | Singapore | `sg_uen` | Singaporean UEN |
721
+ * | Slovakia | `eu_vat` | European VAT number |
722
+ * | Slovenia | `eu_vat` | European VAT number |
723
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
724
+ * | South Africa | `za_vat` | South African VAT number |
725
+ * | South Korea | `kr_brn` | Korean BRN |
726
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
727
+ * | Spain | `eu_vat` | European VAT number |
728
+ * | Sweden | `eu_vat` | European VAT number |
729
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
730
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
731
+ * | Thailand | `th_vat` | Thai VAT |
732
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
733
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
734
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
735
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
736
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
737
+ * | United States | `us_ein` | United States EIN |
738
+ */
370
739
  tax_id?: CustomerCreateParams.TaxID | null;
371
740
 
372
741
  /**
@@ -424,10 +793,207 @@ export namespace CustomerCreateParams {
424
793
  state?: string | null;
425
794
  }
426
795
 
796
+ /**
797
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
798
+ * added to the headers of invoices.
799
+ *
800
+ * ### Supported Tax ID Countries and Types
801
+ *
802
+ * | Country | Type | Description |
803
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
804
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
805
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
806
+ * | Austria | `eu_vat` | European VAT number |
807
+ * | Belgium | `eu_vat` | European VAT number |
808
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
809
+ * | Brazil | `br_cpf` | Brazilian CPF number |
810
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
811
+ * | Bulgaria | `eu_vat` | European VAT number |
812
+ * | Canada | `ca_bn` | Canadian BN |
813
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
814
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
815
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
816
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
817
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
818
+ * | Chile | `cl_tin` | Chilean TIN |
819
+ * | Croatia | `eu_vat` | European VAT number |
820
+ * | Cyprus | `eu_vat` | European VAT number |
821
+ * | Czech Republic | `eu_vat` | European VAT number |
822
+ * | Denmark | `eu_vat` | European VAT number |
823
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
824
+ * | Estonia | `eu_vat` | European VAT number |
825
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
826
+ * | Finland | `eu_vat` | European VAT number |
827
+ * | France | `eu_vat` | European VAT number |
828
+ * | Georgia | `ge_vat` | Georgian VAT |
829
+ * | Germany | `eu_vat` | European VAT number |
830
+ * | Greece | `eu_vat` | European VAT number |
831
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
832
+ * | Hungary | `eu_vat` | European VAT number |
833
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
834
+ * | Iceland | `is_vat` | Icelandic VAT |
835
+ * | India | `in_gst` | Indian GST number |
836
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
837
+ * | Ireland | `eu_vat` | European VAT number |
838
+ * | Israel | `il_vat` | Israel VAT |
839
+ * | Italy | `eu_vat` | European VAT number |
840
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
841
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
842
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
843
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
844
+ * | Latvia | `eu_vat` | European VAT number |
845
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
846
+ * | Lithuania | `eu_vat` | European VAT number |
847
+ * | Luxembourg | `eu_vat` | European VAT number |
848
+ * | Malaysia | `my_frp` | Malaysian FRP number |
849
+ * | Malaysia | `my_itn` | Malaysian ITN |
850
+ * | Malaysia | `my_sst` | Malaysian SST number |
851
+ * | Malta | `eu_vat ` | European VAT number |
852
+ * | Mexico | `mx_rfc` | Mexican RFC number |
853
+ * | Netherlands | `eu_vat` | European VAT number |
854
+ * | New Zealand | `nz_gst` | New Zealand GST number |
855
+ * | Norway | `no_vat` | Norwegian VAT number |
856
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
857
+ * | Poland | `eu_vat` | European VAT number |
858
+ * | Portugal | `eu_vat` | European VAT number |
859
+ * | Romania | `eu_vat` | European VAT number |
860
+ * | Russia | `ru_inn` | Russian INN |
861
+ * | Russia | `ru_kpp` | Russian KPP |
862
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
863
+ * | Singapore | `sg_uen` | Singaporean UEN |
864
+ * | Slovakia | `eu_vat` | European VAT number |
865
+ * | Slovenia | `eu_vat` | European VAT number |
866
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
867
+ * | South Africa | `za_vat` | South African VAT number |
868
+ * | South Korea | `kr_brn` | Korean BRN |
869
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
870
+ * | Spain | `eu_vat` | European VAT number |
871
+ * | Sweden | `eu_vat` | European VAT number |
872
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
873
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
874
+ * | Thailand | `th_vat` | Thai VAT |
875
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
876
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
877
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
878
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
879
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
880
+ * | United States | `us_ein` | United States EIN |
881
+ */
427
882
  export interface TaxID {
428
- country: string;
429
-
430
- type: string;
883
+ country:
884
+ | 'AE'
885
+ | 'AT'
886
+ | 'AU'
887
+ | 'BE'
888
+ | 'BG'
889
+ | 'BR'
890
+ | 'CA'
891
+ | 'CH'
892
+ | 'CL'
893
+ | 'CY'
894
+ | 'CZ'
895
+ | 'DE'
896
+ | 'DK'
897
+ | 'EE'
898
+ | 'EG'
899
+ | 'ES'
900
+ | 'EU'
901
+ | 'FI'
902
+ | 'FR'
903
+ | 'GB'
904
+ | 'GE'
905
+ | 'GR'
906
+ | 'HK'
907
+ | 'HR'
908
+ | 'HU'
909
+ | 'ID'
910
+ | 'IE'
911
+ | 'IL'
912
+ | 'IN'
913
+ | 'IS'
914
+ | 'IT'
915
+ | 'JP'
916
+ | 'KE'
917
+ | 'KR'
918
+ | 'LI'
919
+ | 'LT'
920
+ | 'LU'
921
+ | 'LV'
922
+ | 'MT'
923
+ | 'MX'
924
+ | 'MY'
925
+ | 'NL'
926
+ | 'NO'
927
+ | 'NZ'
928
+ | 'PH'
929
+ | 'PL'
930
+ | 'PT'
931
+ | 'RO'
932
+ | 'RU'
933
+ | 'SA'
934
+ | 'SE'
935
+ | 'SG'
936
+ | 'SI'
937
+ | 'SK'
938
+ | 'TH'
939
+ | 'TR'
940
+ | 'TW'
941
+ | 'UA'
942
+ | 'US'
943
+ | 'ZA';
944
+
945
+ type:
946
+ | 'ae_trn'
947
+ | 'eu_vat'
948
+ | 'au_abn'
949
+ | 'au_arn'
950
+ | 'bg_uic'
951
+ | 'br_cnpj'
952
+ | 'br_cpf'
953
+ | 'ca_bn'
954
+ | 'ca_gst_hst'
955
+ | 'ca_pst_bc'
956
+ | 'ca_pst_mb'
957
+ | 'ca_pst_sk'
958
+ | 'ca_qst'
959
+ | 'ch_vat'
960
+ | 'cl_tin'
961
+ | 'eg_tin'
962
+ | 'es_cif'
963
+ | 'eu_oss_vat'
964
+ | 'gb_vat'
965
+ | 'ge_vat'
966
+ | 'hk_br'
967
+ | 'hu_tin'
968
+ | 'id_npwp'
969
+ | 'il_vat'
970
+ | 'in_gst'
971
+ | 'is_vat'
972
+ | 'jp_cn'
973
+ | 'jp_rn'
974
+ | 'jp_trn'
975
+ | 'ke_pin'
976
+ | 'kr_brn'
977
+ | 'li_uid'
978
+ | 'mx_rfc'
979
+ | 'my_frp'
980
+ | 'my_itn'
981
+ | 'my_sst'
982
+ | 'no_vat'
983
+ | 'nz_gst'
984
+ | 'ph_tin'
985
+ | 'ru_inn'
986
+ | 'ru_kpp'
987
+ | 'sa_vat'
988
+ | 'sg_gst'
989
+ | 'sg_uen'
990
+ | 'si_tin'
991
+ | 'th_vat'
992
+ | 'tr_tin'
993
+ | 'tw_vat'
994
+ | 'ua_vat'
995
+ | 'us_ein'
996
+ | 'za_vat';
431
997
 
432
998
  value: string;
433
999
  }
@@ -503,6 +1069,92 @@ export interface CustomerUpdateParams {
503
1069
 
504
1070
  shipping_address?: CustomerUpdateParams.ShippingAddress | null;
505
1071
 
1072
+ /**
1073
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
1074
+ * added to the headers of invoices.
1075
+ *
1076
+ * ### Supported Tax ID Countries and Types
1077
+ *
1078
+ * | Country | Type | Description |
1079
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
1080
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
1081
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
1082
+ * | Austria | `eu_vat` | European VAT number |
1083
+ * | Belgium | `eu_vat` | European VAT number |
1084
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
1085
+ * | Brazil | `br_cpf` | Brazilian CPF number |
1086
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
1087
+ * | Bulgaria | `eu_vat` | European VAT number |
1088
+ * | Canada | `ca_bn` | Canadian BN |
1089
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
1090
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
1091
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
1092
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
1093
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
1094
+ * | Chile | `cl_tin` | Chilean TIN |
1095
+ * | Croatia | `eu_vat` | European VAT number |
1096
+ * | Cyprus | `eu_vat` | European VAT number |
1097
+ * | Czech Republic | `eu_vat` | European VAT number |
1098
+ * | Denmark | `eu_vat` | European VAT number |
1099
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
1100
+ * | Estonia | `eu_vat` | European VAT number |
1101
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
1102
+ * | Finland | `eu_vat` | European VAT number |
1103
+ * | France | `eu_vat` | European VAT number |
1104
+ * | Georgia | `ge_vat` | Georgian VAT |
1105
+ * | Germany | `eu_vat` | European VAT number |
1106
+ * | Greece | `eu_vat` | European VAT number |
1107
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
1108
+ * | Hungary | `eu_vat` | European VAT number |
1109
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
1110
+ * | Iceland | `is_vat` | Icelandic VAT |
1111
+ * | India | `in_gst` | Indian GST number |
1112
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
1113
+ * | Ireland | `eu_vat` | European VAT number |
1114
+ * | Israel | `il_vat` | Israel VAT |
1115
+ * | Italy | `eu_vat` | European VAT number |
1116
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
1117
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
1118
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
1119
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
1120
+ * | Latvia | `eu_vat` | European VAT number |
1121
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
1122
+ * | Lithuania | `eu_vat` | European VAT number |
1123
+ * | Luxembourg | `eu_vat` | European VAT number |
1124
+ * | Malaysia | `my_frp` | Malaysian FRP number |
1125
+ * | Malaysia | `my_itn` | Malaysian ITN |
1126
+ * | Malaysia | `my_sst` | Malaysian SST number |
1127
+ * | Malta | `eu_vat ` | European VAT number |
1128
+ * | Mexico | `mx_rfc` | Mexican RFC number |
1129
+ * | Netherlands | `eu_vat` | European VAT number |
1130
+ * | New Zealand | `nz_gst` | New Zealand GST number |
1131
+ * | Norway | `no_vat` | Norwegian VAT number |
1132
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
1133
+ * | Poland | `eu_vat` | European VAT number |
1134
+ * | Portugal | `eu_vat` | European VAT number |
1135
+ * | Romania | `eu_vat` | European VAT number |
1136
+ * | Russia | `ru_inn` | Russian INN |
1137
+ * | Russia | `ru_kpp` | Russian KPP |
1138
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
1139
+ * | Singapore | `sg_uen` | Singaporean UEN |
1140
+ * | Slovakia | `eu_vat` | European VAT number |
1141
+ * | Slovenia | `eu_vat` | European VAT number |
1142
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
1143
+ * | South Africa | `za_vat` | South African VAT number |
1144
+ * | South Korea | `kr_brn` | Korean BRN |
1145
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
1146
+ * | Spain | `eu_vat` | European VAT number |
1147
+ * | Sweden | `eu_vat` | European VAT number |
1148
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
1149
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
1150
+ * | Thailand | `th_vat` | Thai VAT |
1151
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
1152
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
1153
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
1154
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
1155
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
1156
+ * | United States | `us_ein` | United States EIN |
1157
+ */
506
1158
  tax_id?: CustomerUpdateParams.TaxID | null;
507
1159
  }
508
1160
 
@@ -553,10 +1205,207 @@ export namespace CustomerUpdateParams {
553
1205
  state?: string | null;
554
1206
  }
555
1207
 
1208
+ /**
1209
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
1210
+ * added to the headers of invoices.
1211
+ *
1212
+ * ### Supported Tax ID Countries and Types
1213
+ *
1214
+ * | Country | Type | Description |
1215
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
1216
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
1217
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
1218
+ * | Austria | `eu_vat` | European VAT number |
1219
+ * | Belgium | `eu_vat` | European VAT number |
1220
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
1221
+ * | Brazil | `br_cpf` | Brazilian CPF number |
1222
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
1223
+ * | Bulgaria | `eu_vat` | European VAT number |
1224
+ * | Canada | `ca_bn` | Canadian BN |
1225
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
1226
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
1227
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
1228
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
1229
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
1230
+ * | Chile | `cl_tin` | Chilean TIN |
1231
+ * | Croatia | `eu_vat` | European VAT number |
1232
+ * | Cyprus | `eu_vat` | European VAT number |
1233
+ * | Czech Republic | `eu_vat` | European VAT number |
1234
+ * | Denmark | `eu_vat` | European VAT number |
1235
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
1236
+ * | Estonia | `eu_vat` | European VAT number |
1237
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
1238
+ * | Finland | `eu_vat` | European VAT number |
1239
+ * | France | `eu_vat` | European VAT number |
1240
+ * | Georgia | `ge_vat` | Georgian VAT |
1241
+ * | Germany | `eu_vat` | European VAT number |
1242
+ * | Greece | `eu_vat` | European VAT number |
1243
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
1244
+ * | Hungary | `eu_vat` | European VAT number |
1245
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
1246
+ * | Iceland | `is_vat` | Icelandic VAT |
1247
+ * | India | `in_gst` | Indian GST number |
1248
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
1249
+ * | Ireland | `eu_vat` | European VAT number |
1250
+ * | Israel | `il_vat` | Israel VAT |
1251
+ * | Italy | `eu_vat` | European VAT number |
1252
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
1253
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
1254
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
1255
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
1256
+ * | Latvia | `eu_vat` | European VAT number |
1257
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
1258
+ * | Lithuania | `eu_vat` | European VAT number |
1259
+ * | Luxembourg | `eu_vat` | European VAT number |
1260
+ * | Malaysia | `my_frp` | Malaysian FRP number |
1261
+ * | Malaysia | `my_itn` | Malaysian ITN |
1262
+ * | Malaysia | `my_sst` | Malaysian SST number |
1263
+ * | Malta | `eu_vat ` | European VAT number |
1264
+ * | Mexico | `mx_rfc` | Mexican RFC number |
1265
+ * | Netherlands | `eu_vat` | European VAT number |
1266
+ * | New Zealand | `nz_gst` | New Zealand GST number |
1267
+ * | Norway | `no_vat` | Norwegian VAT number |
1268
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
1269
+ * | Poland | `eu_vat` | European VAT number |
1270
+ * | Portugal | `eu_vat` | European VAT number |
1271
+ * | Romania | `eu_vat` | European VAT number |
1272
+ * | Russia | `ru_inn` | Russian INN |
1273
+ * | Russia | `ru_kpp` | Russian KPP |
1274
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
1275
+ * | Singapore | `sg_uen` | Singaporean UEN |
1276
+ * | Slovakia | `eu_vat` | European VAT number |
1277
+ * | Slovenia | `eu_vat` | European VAT number |
1278
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
1279
+ * | South Africa | `za_vat` | South African VAT number |
1280
+ * | South Korea | `kr_brn` | Korean BRN |
1281
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
1282
+ * | Spain | `eu_vat` | European VAT number |
1283
+ * | Sweden | `eu_vat` | European VAT number |
1284
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
1285
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
1286
+ * | Thailand | `th_vat` | Thai VAT |
1287
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
1288
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
1289
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
1290
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
1291
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
1292
+ * | United States | `us_ein` | United States EIN |
1293
+ */
556
1294
  export interface TaxID {
557
- country: string;
558
-
559
- type: string;
1295
+ country:
1296
+ | 'AE'
1297
+ | 'AT'
1298
+ | 'AU'
1299
+ | 'BE'
1300
+ | 'BG'
1301
+ | 'BR'
1302
+ | 'CA'
1303
+ | 'CH'
1304
+ | 'CL'
1305
+ | 'CY'
1306
+ | 'CZ'
1307
+ | 'DE'
1308
+ | 'DK'
1309
+ | 'EE'
1310
+ | 'EG'
1311
+ | 'ES'
1312
+ | 'EU'
1313
+ | 'FI'
1314
+ | 'FR'
1315
+ | 'GB'
1316
+ | 'GE'
1317
+ | 'GR'
1318
+ | 'HK'
1319
+ | 'HR'
1320
+ | 'HU'
1321
+ | 'ID'
1322
+ | 'IE'
1323
+ | 'IL'
1324
+ | 'IN'
1325
+ | 'IS'
1326
+ | 'IT'
1327
+ | 'JP'
1328
+ | 'KE'
1329
+ | 'KR'
1330
+ | 'LI'
1331
+ | 'LT'
1332
+ | 'LU'
1333
+ | 'LV'
1334
+ | 'MT'
1335
+ | 'MX'
1336
+ | 'MY'
1337
+ | 'NL'
1338
+ | 'NO'
1339
+ | 'NZ'
1340
+ | 'PH'
1341
+ | 'PL'
1342
+ | 'PT'
1343
+ | 'RO'
1344
+ | 'RU'
1345
+ | 'SA'
1346
+ | 'SE'
1347
+ | 'SG'
1348
+ | 'SI'
1349
+ | 'SK'
1350
+ | 'TH'
1351
+ | 'TR'
1352
+ | 'TW'
1353
+ | 'UA'
1354
+ | 'US'
1355
+ | 'ZA';
1356
+
1357
+ type:
1358
+ | 'ae_trn'
1359
+ | 'eu_vat'
1360
+ | 'au_abn'
1361
+ | 'au_arn'
1362
+ | 'bg_uic'
1363
+ | 'br_cnpj'
1364
+ | 'br_cpf'
1365
+ | 'ca_bn'
1366
+ | 'ca_gst_hst'
1367
+ | 'ca_pst_bc'
1368
+ | 'ca_pst_mb'
1369
+ | 'ca_pst_sk'
1370
+ | 'ca_qst'
1371
+ | 'ch_vat'
1372
+ | 'cl_tin'
1373
+ | 'eg_tin'
1374
+ | 'es_cif'
1375
+ | 'eu_oss_vat'
1376
+ | 'gb_vat'
1377
+ | 'ge_vat'
1378
+ | 'hk_br'
1379
+ | 'hu_tin'
1380
+ | 'id_npwp'
1381
+ | 'il_vat'
1382
+ | 'in_gst'
1383
+ | 'is_vat'
1384
+ | 'jp_cn'
1385
+ | 'jp_rn'
1386
+ | 'jp_trn'
1387
+ | 'ke_pin'
1388
+ | 'kr_brn'
1389
+ | 'li_uid'
1390
+ | 'mx_rfc'
1391
+ | 'my_frp'
1392
+ | 'my_itn'
1393
+ | 'my_sst'
1394
+ | 'no_vat'
1395
+ | 'nz_gst'
1396
+ | 'ph_tin'
1397
+ | 'ru_inn'
1398
+ | 'ru_kpp'
1399
+ | 'sa_vat'
1400
+ | 'sg_gst'
1401
+ | 'sg_uen'
1402
+ | 'si_tin'
1403
+ | 'th_vat'
1404
+ | 'tr_tin'
1405
+ | 'tw_vat'
1406
+ | 'ua_vat'
1407
+ | 'us_ein'
1408
+ | 'za_vat';
560
1409
 
561
1410
  value: string;
562
1411
  }
@@ -642,6 +1491,92 @@ export interface CustomerUpdateByExternalIDParams {
642
1491
 
643
1492
  shipping_address?: CustomerUpdateByExternalIDParams.ShippingAddress | null;
644
1493
 
1494
+ /**
1495
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
1496
+ * added to the headers of invoices.
1497
+ *
1498
+ * ### Supported Tax ID Countries and Types
1499
+ *
1500
+ * | Country | Type | Description |
1501
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
1502
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
1503
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
1504
+ * | Austria | `eu_vat` | European VAT number |
1505
+ * | Belgium | `eu_vat` | European VAT number |
1506
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
1507
+ * | Brazil | `br_cpf` | Brazilian CPF number |
1508
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
1509
+ * | Bulgaria | `eu_vat` | European VAT number |
1510
+ * | Canada | `ca_bn` | Canadian BN |
1511
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
1512
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
1513
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
1514
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
1515
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
1516
+ * | Chile | `cl_tin` | Chilean TIN |
1517
+ * | Croatia | `eu_vat` | European VAT number |
1518
+ * | Cyprus | `eu_vat` | European VAT number |
1519
+ * | Czech Republic | `eu_vat` | European VAT number |
1520
+ * | Denmark | `eu_vat` | European VAT number |
1521
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
1522
+ * | Estonia | `eu_vat` | European VAT number |
1523
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
1524
+ * | Finland | `eu_vat` | European VAT number |
1525
+ * | France | `eu_vat` | European VAT number |
1526
+ * | Georgia | `ge_vat` | Georgian VAT |
1527
+ * | Germany | `eu_vat` | European VAT number |
1528
+ * | Greece | `eu_vat` | European VAT number |
1529
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
1530
+ * | Hungary | `eu_vat` | European VAT number |
1531
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
1532
+ * | Iceland | `is_vat` | Icelandic VAT |
1533
+ * | India | `in_gst` | Indian GST number |
1534
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
1535
+ * | Ireland | `eu_vat` | European VAT number |
1536
+ * | Israel | `il_vat` | Israel VAT |
1537
+ * | Italy | `eu_vat` | European VAT number |
1538
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
1539
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
1540
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
1541
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
1542
+ * | Latvia | `eu_vat` | European VAT number |
1543
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
1544
+ * | Lithuania | `eu_vat` | European VAT number |
1545
+ * | Luxembourg | `eu_vat` | European VAT number |
1546
+ * | Malaysia | `my_frp` | Malaysian FRP number |
1547
+ * | Malaysia | `my_itn` | Malaysian ITN |
1548
+ * | Malaysia | `my_sst` | Malaysian SST number |
1549
+ * | Malta | `eu_vat ` | European VAT number |
1550
+ * | Mexico | `mx_rfc` | Mexican RFC number |
1551
+ * | Netherlands | `eu_vat` | European VAT number |
1552
+ * | New Zealand | `nz_gst` | New Zealand GST number |
1553
+ * | Norway | `no_vat` | Norwegian VAT number |
1554
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
1555
+ * | Poland | `eu_vat` | European VAT number |
1556
+ * | Portugal | `eu_vat` | European VAT number |
1557
+ * | Romania | `eu_vat` | European VAT number |
1558
+ * | Russia | `ru_inn` | Russian INN |
1559
+ * | Russia | `ru_kpp` | Russian KPP |
1560
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
1561
+ * | Singapore | `sg_uen` | Singaporean UEN |
1562
+ * | Slovakia | `eu_vat` | European VAT number |
1563
+ * | Slovenia | `eu_vat` | European VAT number |
1564
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
1565
+ * | South Africa | `za_vat` | South African VAT number |
1566
+ * | South Korea | `kr_brn` | Korean BRN |
1567
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
1568
+ * | Spain | `eu_vat` | European VAT number |
1569
+ * | Sweden | `eu_vat` | European VAT number |
1570
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
1571
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
1572
+ * | Thailand | `th_vat` | Thai VAT |
1573
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
1574
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
1575
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
1576
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
1577
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
1578
+ * | United States | `us_ein` | United States EIN |
1579
+ */
645
1580
  tax_id?: CustomerUpdateByExternalIDParams.TaxID | null;
646
1581
  }
647
1582
 
@@ -692,10 +1627,207 @@ export namespace CustomerUpdateByExternalIDParams {
692
1627
  state?: string | null;
693
1628
  }
694
1629
 
1630
+ /**
1631
+ * Tax IDs are commonly required to be displayed on customer invoices, which are
1632
+ * added to the headers of invoices.
1633
+ *
1634
+ * ### Supported Tax ID Countries and Types
1635
+ *
1636
+ * | Country | Type | Description |
1637
+ * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
1638
+ * | Australia | `au_abn` | Australian Business Number (AU ABN) |
1639
+ * | Australia | `au_arn` | Australian Taxation Office Reference Number |
1640
+ * | Austria | `eu_vat` | European VAT number |
1641
+ * | Belgium | `eu_vat` | European VAT number |
1642
+ * | Brazil | `br_cnpj` | Brazilian CNPJ number |
1643
+ * | Brazil | `br_cpf` | Brazilian CPF number |
1644
+ * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
1645
+ * | Bulgaria | `eu_vat` | European VAT number |
1646
+ * | Canada | `ca_bn` | Canadian BN |
1647
+ * | Canada | `ca_gst_hst` | Canadian GST/HST number |
1648
+ * | Canada | `ca_pst_bc` | Canadian PST number (British Columbia) |
1649
+ * | Canada | `ca_pst_mb` | Canadian PST number (Manitoba) |
1650
+ * | Canada | `ca_pst_sk` | Canadian PST number (Saskatchewan) |
1651
+ * | Canada | `ca_qst` | Canadian QST number (Québec) |
1652
+ * | Chile | `cl_tin` | Chilean TIN |
1653
+ * | Croatia | `eu_vat` | European VAT number |
1654
+ * | Cyprus | `eu_vat` | European VAT number |
1655
+ * | Czech Republic | `eu_vat` | European VAT number |
1656
+ * | Denmark | `eu_vat` | European VAT number |
1657
+ * | Egypt | `eg_tin` | Egyptian Tax Identification Number |
1658
+ * | Estonia | `eu_vat` | European VAT number |
1659
+ * | EU | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme |
1660
+ * | Finland | `eu_vat` | European VAT number |
1661
+ * | France | `eu_vat` | European VAT number |
1662
+ * | Georgia | `ge_vat` | Georgian VAT |
1663
+ * | Germany | `eu_vat` | European VAT number |
1664
+ * | Greece | `eu_vat` | European VAT number |
1665
+ * | Hong Kong | `hk_br` | Hong Kong BR number |
1666
+ * | Hungary | `eu_vat` | European VAT number |
1667
+ * | Hungary | `hu_tin` | Hungary tax number (adószám) |
1668
+ * | Iceland | `is_vat` | Icelandic VAT |
1669
+ * | India | `in_gst` | Indian GST number |
1670
+ * | Indonesia | `id_npwp` | Indonesian NPWP number |
1671
+ * | Ireland | `eu_vat` | European VAT number |
1672
+ * | Israel | `il_vat` | Israel VAT |
1673
+ * | Italy | `eu_vat` | European VAT number |
1674
+ * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
1675
+ * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
1676
+ * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
1677
+ * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
1678
+ * | Latvia | `eu_vat` | European VAT number |
1679
+ * | Liechtenstein | `li_uid` | Liechtensteinian UID number |
1680
+ * | Lithuania | `eu_vat` | European VAT number |
1681
+ * | Luxembourg | `eu_vat` | European VAT number |
1682
+ * | Malaysia | `my_frp` | Malaysian FRP number |
1683
+ * | Malaysia | `my_itn` | Malaysian ITN |
1684
+ * | Malaysia | `my_sst` | Malaysian SST number |
1685
+ * | Malta | `eu_vat ` | European VAT number |
1686
+ * | Mexico | `mx_rfc` | Mexican RFC number |
1687
+ * | Netherlands | `eu_vat` | European VAT number |
1688
+ * | New Zealand | `nz_gst` | New Zealand GST number |
1689
+ * | Norway | `no_vat` | Norwegian VAT number |
1690
+ * | Philippines | `ph_tin ` | Philippines Tax Identification Number |
1691
+ * | Poland | `eu_vat` | European VAT number |
1692
+ * | Portugal | `eu_vat` | European VAT number |
1693
+ * | Romania | `eu_vat` | European VAT number |
1694
+ * | Russia | `ru_inn` | Russian INN |
1695
+ * | Russia | `ru_kpp` | Russian KPP |
1696
+ * | Saudi Arabia | `sg_gst` | Singaporean GST |
1697
+ * | Singapore | `sg_uen` | Singaporean UEN |
1698
+ * | Slovakia | `eu_vat` | European VAT number |
1699
+ * | Slovenia | `eu_vat` | European VAT number |
1700
+ * | Slovenia | `si_tin` | Slovenia tax number (davčna številka) |
1701
+ * | South Africa | `za_vat` | South African VAT number |
1702
+ * | South Korea | `kr_brn` | Korean BRN |
1703
+ * | Spain | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
1704
+ * | Spain | `eu_vat` | European VAT number |
1705
+ * | Sweden | `eu_vat` | European VAT number |
1706
+ * | Switzerland | `ch_vat` | Switzerland VAT number |
1707
+ * | Taiwan | `tw_vat` | Taiwanese VAT |
1708
+ * | Thailand | `th_vat` | Thai VAT |
1709
+ * | Turkey | `tr_tin` | Turkish Tax Identification Number |
1710
+ * | Ukraine | `ua_vat` | Ukrainian VAT |
1711
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
1712
+ * | United Kingdom | `eu_vat` | Northern Ireland VAT number |
1713
+ * | United Kingdom | `gb_vat` | United Kingdom VAT number |
1714
+ * | United States | `us_ein` | United States EIN |
1715
+ */
695
1716
  export interface TaxID {
696
- country: string;
697
-
698
- type: string;
1717
+ country:
1718
+ | 'AE'
1719
+ | 'AT'
1720
+ | 'AU'
1721
+ | 'BE'
1722
+ | 'BG'
1723
+ | 'BR'
1724
+ | 'CA'
1725
+ | 'CH'
1726
+ | 'CL'
1727
+ | 'CY'
1728
+ | 'CZ'
1729
+ | 'DE'
1730
+ | 'DK'
1731
+ | 'EE'
1732
+ | 'EG'
1733
+ | 'ES'
1734
+ | 'EU'
1735
+ | 'FI'
1736
+ | 'FR'
1737
+ | 'GB'
1738
+ | 'GE'
1739
+ | 'GR'
1740
+ | 'HK'
1741
+ | 'HR'
1742
+ | 'HU'
1743
+ | 'ID'
1744
+ | 'IE'
1745
+ | 'IL'
1746
+ | 'IN'
1747
+ | 'IS'
1748
+ | 'IT'
1749
+ | 'JP'
1750
+ | 'KE'
1751
+ | 'KR'
1752
+ | 'LI'
1753
+ | 'LT'
1754
+ | 'LU'
1755
+ | 'LV'
1756
+ | 'MT'
1757
+ | 'MX'
1758
+ | 'MY'
1759
+ | 'NL'
1760
+ | 'NO'
1761
+ | 'NZ'
1762
+ | 'PH'
1763
+ | 'PL'
1764
+ | 'PT'
1765
+ | 'RO'
1766
+ | 'RU'
1767
+ | 'SA'
1768
+ | 'SE'
1769
+ | 'SG'
1770
+ | 'SI'
1771
+ | 'SK'
1772
+ | 'TH'
1773
+ | 'TR'
1774
+ | 'TW'
1775
+ | 'UA'
1776
+ | 'US'
1777
+ | 'ZA';
1778
+
1779
+ type:
1780
+ | 'ae_trn'
1781
+ | 'eu_vat'
1782
+ | 'au_abn'
1783
+ | 'au_arn'
1784
+ | 'bg_uic'
1785
+ | 'br_cnpj'
1786
+ | 'br_cpf'
1787
+ | 'ca_bn'
1788
+ | 'ca_gst_hst'
1789
+ | 'ca_pst_bc'
1790
+ | 'ca_pst_mb'
1791
+ | 'ca_pst_sk'
1792
+ | 'ca_qst'
1793
+ | 'ch_vat'
1794
+ | 'cl_tin'
1795
+ | 'eg_tin'
1796
+ | 'es_cif'
1797
+ | 'eu_oss_vat'
1798
+ | 'gb_vat'
1799
+ | 'ge_vat'
1800
+ | 'hk_br'
1801
+ | 'hu_tin'
1802
+ | 'id_npwp'
1803
+ | 'il_vat'
1804
+ | 'in_gst'
1805
+ | 'is_vat'
1806
+ | 'jp_cn'
1807
+ | 'jp_rn'
1808
+ | 'jp_trn'
1809
+ | 'ke_pin'
1810
+ | 'kr_brn'
1811
+ | 'li_uid'
1812
+ | 'mx_rfc'
1813
+ | 'my_frp'
1814
+ | 'my_itn'
1815
+ | 'my_sst'
1816
+ | 'no_vat'
1817
+ | 'nz_gst'
1818
+ | 'ph_tin'
1819
+ | 'ru_inn'
1820
+ | 'ru_kpp'
1821
+ | 'sa_vat'
1822
+ | 'sg_gst'
1823
+ | 'sg_uen'
1824
+ | 'si_tin'
1825
+ | 'th_vat'
1826
+ | 'tr_tin'
1827
+ | 'tw_vat'
1828
+ | 'ua_vat'
1829
+ | 'us_ein'
1830
+ | 'za_vat';
699
1831
 
700
1832
  value: string;
701
1833
  }