orb-billing 5.4.0 → 5.5.1
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.
- package/CHANGELOG.md +16 -0
- package/index.d.mts +2 -2
- package/index.d.ts +2 -2
- package/index.d.ts.map +1 -1
- package/index.js.map +1 -1
- package/index.mjs.map +1 -1
- package/package.json +1 -5
- package/resources/customers/customers.d.ts +556 -400
- package/resources/customers/customers.d.ts.map +1 -1
- package/resources/customers/customers.js.map +1 -1
- package/resources/customers/customers.mjs.map +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.d.ts +26 -3
- package/resources/dimensional-price-groups/dimensional-price-groups.d.ts.map +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.js +8 -0
- package/resources/dimensional-price-groups/dimensional-price-groups.js.map +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.mjs +9 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.mjs.map +1 -1
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.ts +26 -0
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.ts.map +1 -1
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.js +8 -0
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.js.map +1 -1
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.mjs +8 -0
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.mjs.map +1 -1
- package/resources/dimensional-price-groups/index.d.ts +2 -2
- package/resources/dimensional-price-groups/index.d.ts.map +1 -1
- package/resources/dimensional-price-groups/index.js.map +1 -1
- package/resources/dimensional-price-groups/index.mjs +1 -1
- package/resources/dimensional-price-groups/index.mjs.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/invoices.d.ts +139 -100
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs.map +1 -1
- package/resources/shared.d.ts +338 -203
- package/resources/shared.d.ts.map +1 -1
- package/resources/shared.js.map +1 -1
- package/resources/shared.mjs.map +1 -1
- package/src/index.ts +2 -0
- package/src/resources/customers/customers.ts +556 -400
- package/src/resources/dimensional-price-groups/dimensional-price-groups.ts +39 -2
- package/src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts +37 -0
- package/src/resources/dimensional-price-groups/index.ts +5 -1
- package/src/resources/index.ts +1 -0
- package/src/resources/invoices.ts +139 -100
- package/src/resources/shared.ts +436 -205
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/shared.d.ts
CHANGED
|
@@ -389,110 +389,149 @@ export interface CustomerMinified {
|
|
|
389
389
|
*
|
|
390
390
|
* ### Supported Tax ID Countries and Types
|
|
391
391
|
*
|
|
392
|
-
* | Country
|
|
393
|
-
* |
|
|
394
|
-
* |
|
|
395
|
-
* |
|
|
396
|
-
* |
|
|
397
|
-
* |
|
|
398
|
-
* |
|
|
399
|
-
* |
|
|
400
|
-
* |
|
|
401
|
-
* |
|
|
402
|
-
* |
|
|
403
|
-
* |
|
|
404
|
-
* |
|
|
405
|
-
* |
|
|
406
|
-
* |
|
|
407
|
-
* |
|
|
408
|
-
* |
|
|
409
|
-
* |
|
|
410
|
-
* |
|
|
411
|
-
* |
|
|
412
|
-
* |
|
|
413
|
-
* |
|
|
414
|
-
* |
|
|
415
|
-
* |
|
|
416
|
-
* |
|
|
417
|
-
* |
|
|
418
|
-
* |
|
|
419
|
-
* |
|
|
420
|
-
* |
|
|
421
|
-
* |
|
|
422
|
-
* |
|
|
423
|
-
* |
|
|
424
|
-
* |
|
|
425
|
-
* |
|
|
426
|
-
* |
|
|
427
|
-
* |
|
|
428
|
-
* |
|
|
429
|
-
* |
|
|
430
|
-
* |
|
|
431
|
-
* |
|
|
432
|
-
* |
|
|
433
|
-
* |
|
|
434
|
-
* |
|
|
435
|
-
* |
|
|
436
|
-
* |
|
|
437
|
-
* |
|
|
438
|
-
* |
|
|
439
|
-
* |
|
|
440
|
-
* |
|
|
441
|
-
* |
|
|
442
|
-
* |
|
|
443
|
-
* |
|
|
444
|
-
* |
|
|
445
|
-
* |
|
|
446
|
-
* |
|
|
447
|
-
* |
|
|
448
|
-
* |
|
|
449
|
-
* |
|
|
450
|
-
* |
|
|
451
|
-
* |
|
|
452
|
-
* |
|
|
453
|
-
* |
|
|
454
|
-
* |
|
|
455
|
-
* |
|
|
456
|
-
* |
|
|
457
|
-
* |
|
|
458
|
-
* |
|
|
459
|
-
* |
|
|
460
|
-
* |
|
|
461
|
-
* |
|
|
462
|
-
* |
|
|
463
|
-
* |
|
|
464
|
-
* |
|
|
465
|
-
* |
|
|
466
|
-
* |
|
|
467
|
-
* |
|
|
468
|
-
* |
|
|
469
|
-
* |
|
|
470
|
-
* |
|
|
471
|
-
* |
|
|
472
|
-
* |
|
|
473
|
-
* |
|
|
474
|
-
* |
|
|
475
|
-
* |
|
|
476
|
-
* |
|
|
477
|
-
* |
|
|
478
|
-
* |
|
|
479
|
-
* |
|
|
480
|
-
* |
|
|
481
|
-
* |
|
|
482
|
-
* |
|
|
483
|
-
* |
|
|
484
|
-
* |
|
|
485
|
-
* |
|
|
486
|
-
* |
|
|
487
|
-
* |
|
|
488
|
-
* |
|
|
489
|
-
* |
|
|
490
|
-
* |
|
|
491
|
-
* |
|
|
392
|
+
* | Country | Type | Description |
|
|
393
|
+
* | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
|
394
|
+
* | Albania | `al_tin` | Albania Tax Identification Number |
|
|
395
|
+
* | Andorra | `ad_nrt` | Andorran NRT Number |
|
|
396
|
+
* | Angola | `ao_tin` | Angola Tax Identification Number |
|
|
397
|
+
* | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
|
398
|
+
* | Armenia | `am_tin` | Armenia Tax Identification Number |
|
|
399
|
+
* | Aruba | `aw_tin` | Aruba Tax Identification Number |
|
|
400
|
+
* | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
|
401
|
+
* | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
|
402
|
+
* | Austria | `eu_vat` | European VAT Number |
|
|
403
|
+
* | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
|
|
404
|
+
* | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
|
|
405
|
+
* | Bahrain | `bh_vat` | Bahraini VAT Number |
|
|
406
|
+
* | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
|
|
407
|
+
* | Barbados | `bb_tin` | Barbados Tax Identification Number |
|
|
408
|
+
* | Belarus | `by_tin` | Belarus TIN Number |
|
|
409
|
+
* | Belgium | `eu_vat` | European VAT Number |
|
|
410
|
+
* | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
|
|
411
|
+
* | Bolivia | `bo_tin` | Bolivian Tax ID |
|
|
412
|
+
* | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
|
|
413
|
+
* | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
|
414
|
+
* | Brazil | `br_cpf` | Brazilian CPF Number |
|
|
415
|
+
* | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
|
416
|
+
* | Bulgaria | `eu_vat` | European VAT Number |
|
|
417
|
+
* | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
|
|
418
|
+
* | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
|
|
419
|
+
* | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
|
|
420
|
+
* | Canada | `ca_bn` | Canadian BN |
|
|
421
|
+
* | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
|
422
|
+
* | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
|
423
|
+
* | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
|
424
|
+
* | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
|
425
|
+
* | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
|
426
|
+
* | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
|
|
427
|
+
* | Chile | `cl_tin` | Chilean TIN |
|
|
428
|
+
* | China | `cn_tin` | Chinese Tax ID |
|
|
429
|
+
* | Colombia | `co_nit` | Colombian NIT Number |
|
|
430
|
+
* | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
|
|
431
|
+
* | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
|
432
|
+
* | Croatia | `eu_vat` | European VAT Number |
|
|
433
|
+
* | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
|
|
434
|
+
* | Cyprus | `eu_vat` | European VAT Number |
|
|
435
|
+
* | Czech Republic | `eu_vat` | European VAT Number |
|
|
436
|
+
* | Denmark | `eu_vat` | European VAT Number |
|
|
437
|
+
* | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
|
438
|
+
* | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
|
439
|
+
* | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
|
440
|
+
* | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
|
441
|
+
* | Estonia | `eu_vat` | European VAT Number |
|
|
442
|
+
* | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
|
|
443
|
+
* | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
444
|
+
* | Finland | `eu_vat` | European VAT Number |
|
|
445
|
+
* | France | `eu_vat` | European VAT Number |
|
|
446
|
+
* | Georgia | `ge_vat` | Georgian VAT |
|
|
447
|
+
* | Germany | `de_stn` | German Tax Number (Steuernummer) |
|
|
448
|
+
* | Germany | `eu_vat` | European VAT Number |
|
|
449
|
+
* | Greece | `eu_vat` | European VAT Number |
|
|
450
|
+
* | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
|
|
451
|
+
* | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
452
|
+
* | Hungary | `eu_vat` | European VAT Number |
|
|
453
|
+
* | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
|
454
|
+
* | Iceland | `is_vat` | Icelandic VAT |
|
|
455
|
+
* | India | `in_gst` | Indian GST Number |
|
|
456
|
+
* | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
|
457
|
+
* | Ireland | `eu_vat` | European VAT Number |
|
|
458
|
+
* | Israel | `il_vat` | Israel VAT |
|
|
459
|
+
* | Italy | `eu_vat` | European VAT Number |
|
|
460
|
+
* | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
461
|
+
* | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
462
|
+
* | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
463
|
+
* | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
|
464
|
+
* | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
|
465
|
+
* | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
|
|
466
|
+
* | Laos | `la_tin` | Laos Tax Identification Number |
|
|
467
|
+
* | Latvia | `eu_vat` | European VAT Number |
|
|
468
|
+
* | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
|
469
|
+
* | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
|
|
470
|
+
* | Lithuania | `eu_vat` | European VAT Number |
|
|
471
|
+
* | Luxembourg | `eu_vat` | European VAT Number |
|
|
472
|
+
* | Malaysia | `my_frp` | Malaysian FRP Number |
|
|
473
|
+
* | Malaysia | `my_itn` | Malaysian ITN |
|
|
474
|
+
* | Malaysia | `my_sst` | Malaysian SST Number |
|
|
475
|
+
* | Malta | `eu_vat` | European VAT Number |
|
|
476
|
+
* | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
|
|
477
|
+
* | Mexico | `mx_rfc` | Mexican RFC Number |
|
|
478
|
+
* | Moldova | `md_vat` | Moldova VAT Number |
|
|
479
|
+
* | Montenegro | `me_pib` | Montenegro PIB Number |
|
|
480
|
+
* | Morocco | `ma_vat` | Morocco VAT Number |
|
|
481
|
+
* | Nepal | `np_pan` | Nepal PAN Number |
|
|
482
|
+
* | Netherlands | `eu_vat` | European VAT Number |
|
|
483
|
+
* | New Zealand | `nz_gst` | New Zealand GST Number |
|
|
484
|
+
* | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
|
485
|
+
* | North Macedonia | `mk_vat` | North Macedonia VAT Number |
|
|
486
|
+
* | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
|
|
487
|
+
* | Norway | `no_vat` | Norwegian VAT Number |
|
|
488
|
+
* | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
489
|
+
* | Oman | `om_vat` | Omani VAT Number |
|
|
490
|
+
* | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
491
|
+
* | Philippines | `ph_tin` | Philippines Tax Identification Number |
|
|
492
|
+
* | Poland | `eu_vat` | European VAT Number |
|
|
493
|
+
* | Portugal | `eu_vat` | European VAT Number |
|
|
494
|
+
* | Romania | `eu_vat` | European VAT Number |
|
|
495
|
+
* | Romania | `ro_tin` | Romanian Tax ID Number |
|
|
496
|
+
* | Russia | `ru_inn` | Russian INN |
|
|
497
|
+
* | Russia | `ru_kpp` | Russian KPP |
|
|
498
|
+
* | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
|
499
|
+
* | Senegal | `sn_ninea` | Senegal NINEA Number |
|
|
500
|
+
* | Serbia | `rs_pib` | Serbian PIB Number |
|
|
501
|
+
* | Singapore | `sg_gst` | Singaporean GST |
|
|
502
|
+
* | Singapore | `sg_uen` | Singaporean UEN |
|
|
503
|
+
* | Slovakia | `eu_vat` | European VAT Number |
|
|
504
|
+
* | Slovenia | `eu_vat` | European VAT Number |
|
|
505
|
+
* | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
|
506
|
+
* | South Africa | `za_vat` | South African VAT Number |
|
|
507
|
+
* | South Korea | `kr_brn` | Korean BRN |
|
|
508
|
+
* | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
509
|
+
* | Spain | `eu_vat` | European VAT Number |
|
|
510
|
+
* | Suriname | `sr_fin` | Suriname FIN Number |
|
|
511
|
+
* | Sweden | `eu_vat` | European VAT Number |
|
|
512
|
+
* | Switzerland | `ch_uid` | Switzerland UID Number |
|
|
513
|
+
* | Switzerland | `ch_vat` | Switzerland VAT Number |
|
|
514
|
+
* | Taiwan | `tw_vat` | Taiwanese VAT |
|
|
515
|
+
* | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
|
|
516
|
+
* | Tanzania | `tz_vat` | Tanzania VAT Number |
|
|
517
|
+
* | Thailand | `th_vat` | Thai VAT |
|
|
518
|
+
* | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
|
519
|
+
* | Uganda | `ug_tin` | Uganda Tax Identification Number |
|
|
520
|
+
* | Ukraine | `ua_vat` | Ukrainian VAT |
|
|
521
|
+
* | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
|
522
|
+
* | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
|
523
|
+
* | United States | `us_ein` | United States EIN |
|
|
524
|
+
* | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
|
525
|
+
* | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
|
|
526
|
+
* | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
|
|
527
|
+
* | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
528
|
+
* | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
529
|
+
* | Zambia | `zm_tin` | Zambia Tax Identification Number |
|
|
530
|
+
* | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
|
|
492
531
|
*/
|
|
493
532
|
export interface CustomerTaxID {
|
|
494
|
-
country: 'AD' | 'AE' | 'AR' | 'AT' | 'AU' | 'BE' | 'BG' | 'BH' | 'BO' | 'BR' | 'CA' | 'CH' | 'CL' | 'CN' | 'CO' | 'CR' | '
|
|
495
|
-
type: 'ad_nrt' | 'ae_trn' | 'ar_cuit' | 'eu_vat' | 'au_abn' | 'au_arn' | 'bg_uic' | 'bh_vat' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'ch_vat' | 'cl_tin' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'eu_oss_vat' | 'gb_vat' | 'ge_vat' | 'hk_br' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kr_brn' | 'kz_bin' | 'li_uid' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sv_nit' | 'th_vat' | 'tr_tin' | 'tw_vat' | 'ua_vat' | 'us_ein' | 'uy_ruc' | 've_rif' | 'vn_tin' | 'za_vat';
|
|
533
|
+
country: 'AD' | 'AE' | 'AL' | 'AM' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BJ' | 'BO' | 'BR' | 'BS' | 'BY' | 'CA' | 'CD' | 'CH' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'DE' | 'CY' | 'CZ' | 'DK' | 'DO' | 'EC' | 'EE' | 'EG' | 'ES' | 'ET' | 'EU' | 'FI' | 'FR' | 'GB' | 'GE' | 'GN' | 'GR' | 'HK' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IS' | 'IT' | 'JP' | 'KE' | 'KG' | 'KH' | 'KR' | 'KZ' | 'LA' | 'LI' | 'LT' | 'LU' | 'LV' | 'MA' | 'MD' | 'ME' | 'MK' | 'MR' | 'MT' | 'MX' | 'MY' | 'NG' | 'NL' | 'NO' | 'NP' | 'NZ' | 'OM' | 'PE' | 'PH' | 'PL' | 'PT' | 'RO' | 'RS' | 'RU' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'SN' | 'SR' | 'SV' | 'TH' | 'TJ' | 'TR' | 'TW' | 'TZ' | 'UA' | 'UG' | 'US' | 'UY' | 'UZ' | 'VE' | 'VN' | 'ZA' | 'ZM' | 'ZW';
|
|
534
|
+
type: 'ad_nrt' | 'ae_trn' | 'al_tin' | 'am_tin' | 'ao_tin' | 'ar_cuit' | 'eu_vat' | 'au_abn' | 'au_arn' | 'aw_tin' | 'az_tin' | 'ba_tin' | 'bb_tin' | 'bd_bin' | 'bf_ifu' | 'bg_uic' | 'bh_vat' | 'bj_ifu' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'bs_tin' | 'by_tin' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'cd_nif' | 'ch_uid' | 'ch_vat' | 'cl_tin' | 'cm_niu' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'cv_nif' | 'de_stn' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'et_tin' | 'eu_oss_vat' | 'gb_vat' | 'ge_vat' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'ma_vat' | 'md_vat' | 'me_pib' | 'mk_vat' | 'mr_nif' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'np_pan' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sn_ninea' | 'sr_fin' | 'sv_nit' | 'th_vat' | 'tj_tin' | 'tr_tin' | 'tw_vat' | 'tz_vat' | 'ua_vat' | 'ug_tin' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin';
|
|
496
535
|
value: string;
|
|
497
536
|
}
|
|
498
537
|
export interface DimensionalPriceConfiguration {
|
|
@@ -547,106 +586,145 @@ export interface Invoice {
|
|
|
547
586
|
*
|
|
548
587
|
* ### Supported Tax ID Countries and Types
|
|
549
588
|
*
|
|
550
|
-
* | Country
|
|
551
|
-
* |
|
|
552
|
-
* |
|
|
553
|
-
* |
|
|
554
|
-
* |
|
|
555
|
-
* |
|
|
556
|
-
* |
|
|
557
|
-
* |
|
|
558
|
-
* |
|
|
559
|
-
* |
|
|
560
|
-
* |
|
|
561
|
-
* |
|
|
562
|
-
* |
|
|
563
|
-
* |
|
|
564
|
-
* |
|
|
565
|
-
* |
|
|
566
|
-
* |
|
|
567
|
-
* |
|
|
568
|
-
* |
|
|
569
|
-
* |
|
|
570
|
-
* |
|
|
571
|
-
* |
|
|
572
|
-
* |
|
|
573
|
-
* |
|
|
574
|
-
* |
|
|
575
|
-
* |
|
|
576
|
-
* |
|
|
577
|
-
* |
|
|
578
|
-
* |
|
|
579
|
-
* |
|
|
580
|
-
* |
|
|
581
|
-
* |
|
|
582
|
-
* |
|
|
583
|
-
* |
|
|
584
|
-
* |
|
|
585
|
-
* |
|
|
586
|
-
* |
|
|
587
|
-
* |
|
|
588
|
-
* |
|
|
589
|
-
* |
|
|
590
|
-
* |
|
|
591
|
-
* |
|
|
592
|
-
* |
|
|
593
|
-
* |
|
|
594
|
-
* |
|
|
595
|
-
* |
|
|
596
|
-
* |
|
|
597
|
-
* |
|
|
598
|
-
* |
|
|
599
|
-
* |
|
|
600
|
-
* |
|
|
601
|
-
* |
|
|
602
|
-
* |
|
|
603
|
-
* |
|
|
604
|
-
* |
|
|
605
|
-
* |
|
|
606
|
-
* |
|
|
607
|
-
* |
|
|
608
|
-
* |
|
|
609
|
-
* |
|
|
610
|
-
* |
|
|
611
|
-
* |
|
|
612
|
-
* |
|
|
613
|
-
* |
|
|
614
|
-
* |
|
|
615
|
-
* |
|
|
616
|
-
* |
|
|
617
|
-
* |
|
|
618
|
-
* |
|
|
619
|
-
* |
|
|
620
|
-
* |
|
|
621
|
-
* |
|
|
622
|
-
* |
|
|
623
|
-
* |
|
|
624
|
-
* |
|
|
625
|
-
* |
|
|
626
|
-
* |
|
|
627
|
-
* |
|
|
628
|
-
* |
|
|
629
|
-
* |
|
|
630
|
-
* |
|
|
631
|
-
* |
|
|
632
|
-
* |
|
|
633
|
-
* |
|
|
634
|
-
* |
|
|
635
|
-
* |
|
|
636
|
-
* |
|
|
637
|
-
* |
|
|
638
|
-
* |
|
|
639
|
-
* |
|
|
640
|
-
* |
|
|
641
|
-
* |
|
|
642
|
-
* |
|
|
643
|
-
* |
|
|
644
|
-
* |
|
|
645
|
-
* |
|
|
646
|
-
* |
|
|
647
|
-
* |
|
|
648
|
-
* |
|
|
649
|
-
* |
|
|
589
|
+
* | Country | Type | Description |
|
|
590
|
+
* | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
|
591
|
+
* | Albania | `al_tin` | Albania Tax Identification Number |
|
|
592
|
+
* | Andorra | `ad_nrt` | Andorran NRT Number |
|
|
593
|
+
* | Angola | `ao_tin` | Angola Tax Identification Number |
|
|
594
|
+
* | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
|
595
|
+
* | Armenia | `am_tin` | Armenia Tax Identification Number |
|
|
596
|
+
* | Aruba | `aw_tin` | Aruba Tax Identification Number |
|
|
597
|
+
* | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
|
598
|
+
* | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
|
599
|
+
* | Austria | `eu_vat` | European VAT Number |
|
|
600
|
+
* | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
|
|
601
|
+
* | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
|
|
602
|
+
* | Bahrain | `bh_vat` | Bahraini VAT Number |
|
|
603
|
+
* | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
|
|
604
|
+
* | Barbados | `bb_tin` | Barbados Tax Identification Number |
|
|
605
|
+
* | Belarus | `by_tin` | Belarus TIN Number |
|
|
606
|
+
* | Belgium | `eu_vat` | European VAT Number |
|
|
607
|
+
* | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
|
|
608
|
+
* | Bolivia | `bo_tin` | Bolivian Tax ID |
|
|
609
|
+
* | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
|
|
610
|
+
* | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
|
611
|
+
* | Brazil | `br_cpf` | Brazilian CPF Number |
|
|
612
|
+
* | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
|
613
|
+
* | Bulgaria | `eu_vat` | European VAT Number |
|
|
614
|
+
* | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
|
|
615
|
+
* | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
|
|
616
|
+
* | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
|
|
617
|
+
* | Canada | `ca_bn` | Canadian BN |
|
|
618
|
+
* | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
|
619
|
+
* | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
|
620
|
+
* | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
|
621
|
+
* | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
|
622
|
+
* | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
|
623
|
+
* | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
|
|
624
|
+
* | Chile | `cl_tin` | Chilean TIN |
|
|
625
|
+
* | China | `cn_tin` | Chinese Tax ID |
|
|
626
|
+
* | Colombia | `co_nit` | Colombian NIT Number |
|
|
627
|
+
* | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
|
|
628
|
+
* | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
|
629
|
+
* | Croatia | `eu_vat` | European VAT Number |
|
|
630
|
+
* | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
|
|
631
|
+
* | Cyprus | `eu_vat` | European VAT Number |
|
|
632
|
+
* | Czech Republic | `eu_vat` | European VAT Number |
|
|
633
|
+
* | Denmark | `eu_vat` | European VAT Number |
|
|
634
|
+
* | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
|
635
|
+
* | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
|
636
|
+
* | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
|
637
|
+
* | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
|
638
|
+
* | Estonia | `eu_vat` | European VAT Number |
|
|
639
|
+
* | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
|
|
640
|
+
* | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
641
|
+
* | Finland | `eu_vat` | European VAT Number |
|
|
642
|
+
* | France | `eu_vat` | European VAT Number |
|
|
643
|
+
* | Georgia | `ge_vat` | Georgian VAT |
|
|
644
|
+
* | Germany | `de_stn` | German Tax Number (Steuernummer) |
|
|
645
|
+
* | Germany | `eu_vat` | European VAT Number |
|
|
646
|
+
* | Greece | `eu_vat` | European VAT Number |
|
|
647
|
+
* | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
|
|
648
|
+
* | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
649
|
+
* | Hungary | `eu_vat` | European VAT Number |
|
|
650
|
+
* | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
|
651
|
+
* | Iceland | `is_vat` | Icelandic VAT |
|
|
652
|
+
* | India | `in_gst` | Indian GST Number |
|
|
653
|
+
* | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
|
654
|
+
* | Ireland | `eu_vat` | European VAT Number |
|
|
655
|
+
* | Israel | `il_vat` | Israel VAT |
|
|
656
|
+
* | Italy | `eu_vat` | European VAT Number |
|
|
657
|
+
* | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
658
|
+
* | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
659
|
+
* | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
660
|
+
* | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
|
661
|
+
* | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
|
662
|
+
* | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
|
|
663
|
+
* | Laos | `la_tin` | Laos Tax Identification Number |
|
|
664
|
+
* | Latvia | `eu_vat` | European VAT Number |
|
|
665
|
+
* | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
|
666
|
+
* | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
|
|
667
|
+
* | Lithuania | `eu_vat` | European VAT Number |
|
|
668
|
+
* | Luxembourg | `eu_vat` | European VAT Number |
|
|
669
|
+
* | Malaysia | `my_frp` | Malaysian FRP Number |
|
|
670
|
+
* | Malaysia | `my_itn` | Malaysian ITN |
|
|
671
|
+
* | Malaysia | `my_sst` | Malaysian SST Number |
|
|
672
|
+
* | Malta | `eu_vat` | European VAT Number |
|
|
673
|
+
* | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
|
|
674
|
+
* | Mexico | `mx_rfc` | Mexican RFC Number |
|
|
675
|
+
* | Moldova | `md_vat` | Moldova VAT Number |
|
|
676
|
+
* | Montenegro | `me_pib` | Montenegro PIB Number |
|
|
677
|
+
* | Morocco | `ma_vat` | Morocco VAT Number |
|
|
678
|
+
* | Nepal | `np_pan` | Nepal PAN Number |
|
|
679
|
+
* | Netherlands | `eu_vat` | European VAT Number |
|
|
680
|
+
* | New Zealand | `nz_gst` | New Zealand GST Number |
|
|
681
|
+
* | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
|
682
|
+
* | North Macedonia | `mk_vat` | North Macedonia VAT Number |
|
|
683
|
+
* | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
|
|
684
|
+
* | Norway | `no_vat` | Norwegian VAT Number |
|
|
685
|
+
* | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
686
|
+
* | Oman | `om_vat` | Omani VAT Number |
|
|
687
|
+
* | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
688
|
+
* | Philippines | `ph_tin` | Philippines Tax Identification Number |
|
|
689
|
+
* | Poland | `eu_vat` | European VAT Number |
|
|
690
|
+
* | Portugal | `eu_vat` | European VAT Number |
|
|
691
|
+
* | Romania | `eu_vat` | European VAT Number |
|
|
692
|
+
* | Romania | `ro_tin` | Romanian Tax ID Number |
|
|
693
|
+
* | Russia | `ru_inn` | Russian INN |
|
|
694
|
+
* | Russia | `ru_kpp` | Russian KPP |
|
|
695
|
+
* | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
|
696
|
+
* | Senegal | `sn_ninea` | Senegal NINEA Number |
|
|
697
|
+
* | Serbia | `rs_pib` | Serbian PIB Number |
|
|
698
|
+
* | Singapore | `sg_gst` | Singaporean GST |
|
|
699
|
+
* | Singapore | `sg_uen` | Singaporean UEN |
|
|
700
|
+
* | Slovakia | `eu_vat` | European VAT Number |
|
|
701
|
+
* | Slovenia | `eu_vat` | European VAT Number |
|
|
702
|
+
* | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
|
703
|
+
* | South Africa | `za_vat` | South African VAT Number |
|
|
704
|
+
* | South Korea | `kr_brn` | Korean BRN |
|
|
705
|
+
* | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
706
|
+
* | Spain | `eu_vat` | European VAT Number |
|
|
707
|
+
* | Suriname | `sr_fin` | Suriname FIN Number |
|
|
708
|
+
* | Sweden | `eu_vat` | European VAT Number |
|
|
709
|
+
* | Switzerland | `ch_uid` | Switzerland UID Number |
|
|
710
|
+
* | Switzerland | `ch_vat` | Switzerland VAT Number |
|
|
711
|
+
* | Taiwan | `tw_vat` | Taiwanese VAT |
|
|
712
|
+
* | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
|
|
713
|
+
* | Tanzania | `tz_vat` | Tanzania VAT Number |
|
|
714
|
+
* | Thailand | `th_vat` | Thai VAT |
|
|
715
|
+
* | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
|
716
|
+
* | Uganda | `ug_tin` | Uganda Tax Identification Number |
|
|
717
|
+
* | Ukraine | `ua_vat` | Ukrainian VAT |
|
|
718
|
+
* | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
|
719
|
+
* | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
|
720
|
+
* | United States | `us_ein` | United States EIN |
|
|
721
|
+
* | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
|
722
|
+
* | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
|
|
723
|
+
* | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
|
|
724
|
+
* | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
725
|
+
* | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
726
|
+
* | Zambia | `zm_tin` | Zambia Tax Identification Number |
|
|
727
|
+
* | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
|
|
650
728
|
*/
|
|
651
729
|
customer_tax_id: CustomerTaxID | null;
|
|
652
730
|
/**
|
|
@@ -6130,7 +6208,7 @@ export interface PlanPhaseUsageDiscountAdjustment {
|
|
|
6130
6208
|
* For more on the types of prices, see
|
|
6131
6209
|
* [the core concepts documentation](/core-concepts#plan-and-price)
|
|
6132
6210
|
*/
|
|
6133
|
-
export type Price = Price.UnitPrice | Price.PackagePrice | Price.MatrixPrice | Price.TieredPrice | Price.TieredBPSPrice | Price.BPSPrice | Price.BulkBPSPrice | Price.BulkPrice | Price.ThresholdTotalAmountPrice | Price.TieredPackagePrice | Price.GroupedTieredPrice | Price.TieredWithMinimumPrice | Price.TieredPackageWithMinimumPrice | Price.PackageWithAllocationPrice | Price.UnitWithPercentPrice | Price.MatrixWithAllocationPrice | Price.TieredWithProrationPrice | Price.UnitWithProrationPrice | Price.GroupedAllocationPrice | Price.GroupedWithProratedMinimumPrice | Price.GroupedWithMeteredMinimumPrice | Price.MatrixWithDisplayNamePrice | Price.BulkWithProrationPrice | Price.GroupedTieredPackagePrice | Price.MaxGroupTieredPackagePrice | Price.ScalableMatrixWithUnitPricingPrice | Price.ScalableMatrixWithTieredPricingPrice | Price.CumulativeGroupedBulkPrice;
|
|
6211
|
+
export type Price = Price.UnitPrice | Price.PackagePrice | Price.MatrixPrice | Price.TieredPrice | Price.TieredBPSPrice | Price.BPSPrice | Price.BulkBPSPrice | Price.BulkPrice | Price.ThresholdTotalAmountPrice | Price.TieredPackagePrice | Price.GroupedTieredPrice | Price.TieredWithMinimumPrice | Price.TieredPackageWithMinimumPrice | Price.PackageWithAllocationPrice | Price.UnitWithPercentPrice | Price.MatrixWithAllocationPrice | Price.TieredWithProrationPrice | Price.UnitWithProrationPrice | Price.GroupedAllocationPrice | Price.GroupedWithProratedMinimumPrice | Price.GroupedWithMeteredMinimumPrice | Price.MatrixWithDisplayNamePrice | Price.BulkWithProrationPrice | Price.GroupedTieredPackagePrice | Price.MaxGroupTieredPackagePrice | Price.ScalableMatrixWithUnitPricingPrice | Price.ScalableMatrixWithTieredPricingPrice | Price.CumulativeGroupedBulkPrice | Price.GroupedWithMinMaxThresholdsPrice;
|
|
6134
6212
|
export declare namespace Price {
|
|
6135
6213
|
interface UnitPrice {
|
|
6136
6214
|
id: string;
|
|
@@ -7710,6 +7788,63 @@ export declare namespace Price {
|
|
|
7710
7788
|
replaces_price_id: string | null;
|
|
7711
7789
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
7712
7790
|
}
|
|
7791
|
+
interface GroupedWithMinMaxThresholdsPrice {
|
|
7792
|
+
id: string;
|
|
7793
|
+
billable_metric: Shared.BillableMetricTiny | null;
|
|
7794
|
+
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7795
|
+
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7796
|
+
conversion_rate: number | null;
|
|
7797
|
+
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7798
|
+
created_at: string;
|
|
7799
|
+
credit_allocation: Shared.Allocation | null;
|
|
7800
|
+
currency: string;
|
|
7801
|
+
/**
|
|
7802
|
+
* @deprecated
|
|
7803
|
+
*/
|
|
7804
|
+
discount: Shared.Discount | null;
|
|
7805
|
+
external_price_id: string | null;
|
|
7806
|
+
fixed_price_quantity: number | null;
|
|
7807
|
+
grouped_with_min_max_thresholds_config: {
|
|
7808
|
+
[key: string]: unknown;
|
|
7809
|
+
};
|
|
7810
|
+
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
7811
|
+
item: Shared.ItemSlim;
|
|
7812
|
+
/**
|
|
7813
|
+
* @deprecated
|
|
7814
|
+
*/
|
|
7815
|
+
maximum: Shared.Maximum | null;
|
|
7816
|
+
/**
|
|
7817
|
+
* @deprecated
|
|
7818
|
+
*/
|
|
7819
|
+
maximum_amount: string | null;
|
|
7820
|
+
/**
|
|
7821
|
+
* User specified key-value pairs for the resource. If not present, this defaults
|
|
7822
|
+
* to an empty dictionary. Individual keys can be removed by setting the value to
|
|
7823
|
+
* `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
|
7824
|
+
* `null`.
|
|
7825
|
+
*/
|
|
7826
|
+
metadata: {
|
|
7827
|
+
[key: string]: string;
|
|
7828
|
+
};
|
|
7829
|
+
/**
|
|
7830
|
+
* @deprecated
|
|
7831
|
+
*/
|
|
7832
|
+
minimum: Shared.Minimum | null;
|
|
7833
|
+
/**
|
|
7834
|
+
* @deprecated
|
|
7835
|
+
*/
|
|
7836
|
+
minimum_amount: string | null;
|
|
7837
|
+
model_type: 'grouped_with_min_max_thresholds';
|
|
7838
|
+
name: string;
|
|
7839
|
+
plan_phase_order: number | null;
|
|
7840
|
+
price_type: 'usage_price' | 'fixed_price';
|
|
7841
|
+
/**
|
|
7842
|
+
* The price id this price replaces. This price will take the place of the replaced
|
|
7843
|
+
* price in plan version migrations.
|
|
7844
|
+
*/
|
|
7845
|
+
replaces_price_id: string | null;
|
|
7846
|
+
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
7847
|
+
}
|
|
7713
7848
|
}
|
|
7714
7849
|
/**
|
|
7715
7850
|
* The Price Interval resource represents a period of time for which a price will
|