stripe 17.1.0 → 17.2.0-beta.2

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 (175) hide show
  1. package/CHANGELOG.md +901 -109
  2. package/README.md +4 -4
  3. package/VERSION +1 -1
  4. package/cjs/resources/AccountNotices.js +21 -0
  5. package/cjs/resources/Capital/FinancingOffers.js +21 -0
  6. package/cjs/resources/Capital/FinancingSummary.js +12 -0
  7. package/cjs/resources/Capital/FinancingTransactions.js +17 -0
  8. package/cjs/resources/FinancialConnections/Accounts.js +5 -0
  9. package/cjs/resources/FinancialConnections/Institutions.js +17 -0
  10. package/cjs/resources/GiftCards/Cards.js +23 -0
  11. package/cjs/resources/GiftCards/Transactions.js +33 -0
  12. package/cjs/resources/Invoices.js +17 -0
  13. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
  14. package/cjs/resources/Issuing/DisputeSettlementDetails.js +17 -0
  15. package/cjs/resources/Margins.js +22 -0
  16. package/cjs/resources/Orders.js +24 -0
  17. package/cjs/resources/PaymentIntents.js +4 -0
  18. package/cjs/resources/Quotes.js +32 -0
  19. package/cjs/resources/SubscriptionSchedules.js +4 -0
  20. package/cjs/resources/Tax/Associations.js +9 -0
  21. package/cjs/resources/Tax/Forms.js +20 -0
  22. package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
  23. package/cjs/resources/Terminal/Readers.js +12 -0
  24. package/cjs/resources/TestHelpers/Issuing/Cards.js +4 -0
  25. package/cjs/resources.js +42 -10
  26. package/cjs/stripe.core.js +1 -1
  27. package/esm/resources/AccountNotices.js +18 -0
  28. package/esm/resources/Capital/FinancingOffers.js +18 -0
  29. package/esm/resources/Capital/FinancingSummary.js +9 -0
  30. package/esm/resources/Capital/FinancingTransactions.js +14 -0
  31. package/esm/resources/FinancialConnections/Accounts.js +5 -0
  32. package/esm/resources/FinancialConnections/Institutions.js +14 -0
  33. package/esm/resources/GiftCards/Cards.js +20 -0
  34. package/esm/resources/GiftCards/Transactions.js +30 -0
  35. package/esm/resources/Invoices.js +17 -0
  36. package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
  37. package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
  38. package/esm/resources/Margins.js +19 -0
  39. package/esm/resources/Orders.js +21 -0
  40. package/esm/resources/PaymentIntents.js +4 -0
  41. package/esm/resources/Quotes.js +32 -0
  42. package/esm/resources/SubscriptionSchedules.js +4 -0
  43. package/esm/resources/Tax/Associations.js +6 -0
  44. package/esm/resources/Tax/Forms.js +17 -0
  45. package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
  46. package/esm/resources/Terminal/Readers.js +12 -0
  47. package/esm/resources/TestHelpers/Issuing/Cards.js +4 -0
  48. package/esm/resources.js +29 -0
  49. package/esm/stripe.core.js +1 -1
  50. package/package.json +1 -1
  51. package/types/AccountLinksResource.d.ts +5 -1
  52. package/types/AccountNotices.d.ts +113 -0
  53. package/types/AccountNoticesResource.d.ts +98 -0
  54. package/types/AccountSessions.d.ts +75 -5
  55. package/types/AccountSessionsResource.d.ts +354 -5
  56. package/types/Accounts.d.ts +127 -3
  57. package/types/AccountsResource.d.ts +296 -2
  58. package/types/Billing/CreditGrants.d.ts +2 -2
  59. package/types/Billing/CreditGrantsResource.d.ts +2 -2
  60. package/types/Billing/MeterErrorReports.d.ts +106 -0
  61. package/types/Billing/Meters.d.ts +2 -0
  62. package/types/Capital/FinancingOffers.d.ts +188 -0
  63. package/types/Capital/FinancingOffersResource.d.ts +97 -0
  64. package/types/Capital/FinancingSummary.d.ts +106 -0
  65. package/types/Capital/FinancingSummaryResource.d.ts +27 -0
  66. package/types/Capital/FinancingTransactions.d.ts +135 -0
  67. package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
  68. package/types/Charges.d.ts +152 -0
  69. package/types/ChargesResource.d.ts +1294 -0
  70. package/types/Checkout/Sessions.d.ts +309 -5
  71. package/types/Checkout/SessionsResource.d.ts +356 -5
  72. package/types/ConfirmationTokens.d.ts +137 -0
  73. package/types/Coupons.d.ts +1 -1
  74. package/types/CouponsResource.d.ts +1 -1
  75. package/types/CreditNotes.d.ts +21 -0
  76. package/types/CreditNotesResource.d.ts +51 -0
  77. package/types/CustomersResource.d.ts +22 -2
  78. package/types/Disputes.d.ts +152 -0
  79. package/types/DisputesResource.d.ts +120 -0
  80. package/types/EventTypes.d.ts +564 -2
  81. package/types/Events.d.ts +91 -0
  82. package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
  83. package/types/FinancialConnections/Accounts.d.ts +29 -1
  84. package/types/FinancialConnections/AccountsResource.d.ts +35 -3
  85. package/types/FinancialConnections/Institutions.d.ts +93 -0
  86. package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
  87. package/types/FinancialConnections/Sessions.d.ts +49 -1
  88. package/types/FinancialConnections/SessionsResource.d.ts +38 -1
  89. package/types/Forwarding/Requests.d.ts +5 -0
  90. package/types/GiftCards/Cards.d.ts +118 -0
  91. package/types/GiftCards/CardsResource.d.ts +159 -0
  92. package/types/GiftCards/Transactions.d.ts +129 -0
  93. package/types/GiftCards/TransactionsResource.d.ts +201 -0
  94. package/types/InvoiceItems.d.ts +5 -0
  95. package/types/InvoiceItemsResource.d.ts +98 -0
  96. package/types/InvoiceLineItems.d.ts +31 -1
  97. package/types/InvoicePayments.d.ts +138 -0
  98. package/types/Invoices.d.ts +134 -3
  99. package/types/InvoicesResource.d.ts +5478 -1799
  100. package/types/Issuing/Authorizations.d.ts +1 -1
  101. package/types/Issuing/AuthorizationsResource.d.ts +1 -1
  102. package/types/Issuing/CardholdersResource.d.ts +2 -1
  103. package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
  104. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
  105. package/types/Issuing/DisputeSettlementDetails.d.ts +73 -0
  106. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
  107. package/types/Issuing/Settlements.d.ts +103 -0
  108. package/types/Issuing/Transactions.d.ts +2 -0
  109. package/types/Issuing/TransactionsResource.d.ts +5 -0
  110. package/types/LineItems.d.ts +7 -0
  111. package/types/Mandates.d.ts +85 -0
  112. package/types/Margins.d.ts +56 -0
  113. package/types/MarginsResource.d.ts +114 -0
  114. package/types/Orders.d.ts +1154 -0
  115. package/types/OrdersResource.d.ts +2911 -0
  116. package/types/PaymentIntents.d.ts +643 -1
  117. package/types/PaymentIntentsResource.d.ts +7790 -3514
  118. package/types/PaymentLinks.d.ts +3 -0
  119. package/types/PaymentLinksResource.d.ts +6 -0
  120. package/types/PaymentMethodConfigurations.d.ts +36 -0
  121. package/types/PaymentMethodConfigurationsResource.d.ts +52 -2
  122. package/types/PaymentMethods.d.ts +137 -0
  123. package/types/PaymentMethodsResource.d.ts +158 -0
  124. package/types/Persons.d.ts +1 -1
  125. package/types/Prices.d.ts +22 -0
  126. package/types/PricesResource.d.ts +22 -0
  127. package/types/Products.d.ts +39 -0
  128. package/types/ProductsResource.d.ts +36 -0
  129. package/types/QuoteLines.d.ts +634 -0
  130. package/types/QuotePreviewInvoices.d.ts +1596 -0
  131. package/types/QuotePreviewSubscriptionSchedules.d.ts +814 -0
  132. package/types/Quotes.d.ts +591 -1
  133. package/types/QuotesResource.d.ts +2526 -194
  134. package/types/SetupAttempts.d.ts +19 -0
  135. package/types/SetupIntents.d.ts +112 -1
  136. package/types/SetupIntentsResource.d.ts +669 -3
  137. package/types/Sources.d.ts +23 -0
  138. package/types/SubscriptionItems.d.ts +21 -0
  139. package/types/SubscriptionItemsResource.d.ts +109 -0
  140. package/types/SubscriptionSchedules.d.ts +200 -0
  141. package/types/SubscriptionSchedulesResource.d.ts +1234 -16
  142. package/types/Subscriptions.d.ts +82 -1
  143. package/types/SubscriptionsResource.d.ts +348 -3
  144. package/types/Tax/Associations.d.ts +126 -0
  145. package/types/Tax/AssociationsResource.d.ts +29 -0
  146. package/types/Tax/CalculationLineItems.d.ts +1 -0
  147. package/types/Tax/Calculations.d.ts +33 -1
  148. package/types/Tax/CalculationsResource.d.ts +7 -1
  149. package/types/Tax/Forms.d.ts +133 -0
  150. package/types/Tax/FormsResource.d.ts +90 -0
  151. package/types/Tax/Registrations.d.ts +82 -0
  152. package/types/Tax/RegistrationsResource.d.ts +109 -0
  153. package/types/Tax/Transactions.d.ts +8 -1
  154. package/types/TaxIds.d.ts +7 -1
  155. package/types/TaxIdsResource.d.ts +7 -1
  156. package/types/TaxRates.d.ts +25 -0
  157. package/types/TaxRatesResource.d.ts +2 -0
  158. package/types/Terminal/ReaderCollectedData.d.ts +51 -0
  159. package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
  160. package/types/Terminal/Readers.d.ts +278 -0
  161. package/types/Terminal/ReadersResource.d.ts +215 -0
  162. package/types/TestHelpers/ConfirmationTokensResource.d.ts +112 -0
  163. package/types/TestHelpers/Issuing/CardsResource.d.ts +22 -0
  164. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
  165. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
  166. package/types/TokensResource.d.ts +1 -1
  167. package/types/Treasury/FinancialAccounts.d.ts +6 -1
  168. package/types/Treasury/FinancialAccountsResource.d.ts +10 -0
  169. package/types/Treasury/OutboundTransfers.d.ts +26 -0
  170. package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
  171. package/types/Treasury/ReceivedCredits.d.ts +26 -0
  172. package/types/Treasury/ReceivedDebits.d.ts +31 -0
  173. package/types/UsageRecordSummaries.d.ts +1 -1
  174. package/types/WebhookEndpointsResource.d.ts +66 -0
  175. package/types/index.d.ts +53 -0
@@ -0,0 +1,126 @@
1
+ // File generated from our OpenAPI spec
2
+
3
+ declare module 'stripe' {
4
+ namespace Stripe {
5
+ namespace Tax {
6
+ /**
7
+ * A Tax Association exposes the Tax Transactions that Stripe attempted to create on your behalf based on the PaymentIntent input
8
+ */
9
+ interface Association {
10
+ /**
11
+ * Unique identifier for the object.
12
+ */
13
+ id: string;
14
+
15
+ /**
16
+ * String representing the object's type. Objects of the same type share the same value.
17
+ */
18
+ object: 'tax.association';
19
+
20
+ /**
21
+ * The [Tax Calculation](https://stripe.com/docs/api/tax/calculations/object) that was included in PaymentIntent.
22
+ */
23
+ calculation: string;
24
+
25
+ /**
26
+ * The [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) that this Tax Association is tracking.
27
+ */
28
+ payment_intent: string;
29
+
30
+ /**
31
+ * Status of the Tax Association.
32
+ */
33
+ status: Association.Status;
34
+
35
+ status_details: Association.StatusDetails;
36
+ }
37
+
38
+ namespace Association {
39
+ type Status = 'committed' | 'errored';
40
+
41
+ interface StatusDetails {
42
+ committed?: StatusDetails.Committed;
43
+
44
+ errored?: StatusDetails.Errored;
45
+ }
46
+
47
+ namespace StatusDetails {
48
+ interface Committed {
49
+ /**
50
+ * Attempts to create Tax Transaction reversals
51
+ */
52
+ reversals: Array<Committed.Reversal>;
53
+
54
+ /**
55
+ * The [Tax Transaction](https://stripe.com/docs/api/tax/transaction/object)
56
+ */
57
+ transaction: string;
58
+ }
59
+
60
+ namespace Committed {
61
+ interface Reversal {
62
+ /**
63
+ * Status of the attempted Tax Transaction reversal.
64
+ */
65
+ status: Reversal.Status;
66
+
67
+ status_details: Reversal.StatusDetails;
68
+ }
69
+
70
+ namespace Reversal {
71
+ type Status = 'committed' | 'errored';
72
+
73
+ interface StatusDetails {
74
+ committed?: StatusDetails.Committed;
75
+
76
+ errored?: StatusDetails.Errored;
77
+ }
78
+
79
+ namespace StatusDetails {
80
+ interface Committed {
81
+ /**
82
+ * The [Tax Transaction](https://stripe.com/docs/api/tax/transaction/object)
83
+ */
84
+ transaction: string;
85
+ }
86
+
87
+ interface Errored {
88
+ /**
89
+ * Details on why we could not commit the reversal Tax Transaction
90
+ */
91
+ reason: Errored.Reason;
92
+
93
+ /**
94
+ * The [Refund](https://stripe.com/docs/api/refunds/object) ID that should have created a tax reversal.
95
+ */
96
+ refund_id: string;
97
+ }
98
+
99
+ namespace Errored {
100
+ type Reason =
101
+ | 'original_transaction_voided'
102
+ | 'unique_reference_violation';
103
+ }
104
+ }
105
+ }
106
+ }
107
+
108
+ interface Errored {
109
+ /**
110
+ * Details on why we could not commit the Tax Transaction
111
+ */
112
+ reason: Errored.Reason;
113
+ }
114
+
115
+ namespace Errored {
116
+ type Reason =
117
+ | 'another_payment_associated_with_calculation'
118
+ | 'calculation_expired'
119
+ | 'currency_mismatch'
120
+ | 'unique_reference_violation';
121
+ }
122
+ }
123
+ }
124
+ }
125
+ }
126
+ }
@@ -0,0 +1,29 @@
1
+ // File generated from our OpenAPI spec
2
+
3
+ declare module 'stripe' {
4
+ namespace Stripe {
5
+ namespace Tax {
6
+ interface AssociationFindParams {
7
+ /**
8
+ * Valid [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) id
9
+ */
10
+ payment_intent: string;
11
+
12
+ /**
13
+ * Specifies which fields in the response should be expanded.
14
+ */
15
+ expand?: Array<string>;
16
+ }
17
+
18
+ class AssociationsResource {
19
+ /**
20
+ * Finds a tax association object by PaymentIntent id.
21
+ */
22
+ find(
23
+ params: AssociationFindParams,
24
+ options?: RequestOptions
25
+ ): Promise<Stripe.Response<Stripe.Tax.Association>>;
26
+ }
27
+ }
28
+ }
29
+ }
@@ -169,6 +169,7 @@ declare module 'stripe' {
169
169
  | 'lease_tax'
170
170
  | 'pst'
171
171
  | 'qst'
172
+ | 'retail_delivery_fee'
172
173
  | 'rst'
173
174
  | 'sales_tax'
174
175
  | 'vat';
@@ -120,7 +120,7 @@ declare module 'stripe' {
120
120
 
121
121
  interface TaxId {
122
122
  /**
123
- * The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`
123
+ * The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown`
124
124
  */
125
125
  type: TaxId.Type;
126
126
 
@@ -142,6 +142,7 @@ declare module 'stripe' {
142
142
  | 'bo_tin'
143
143
  | 'br_cnpj'
144
144
  | 'br_cpf'
145
+ | 'by_tin'
145
146
  | 'ca_bn'
146
147
  | 'ca_gst_hst'
147
148
  | 'ca_pst_bc'
@@ -177,6 +178,8 @@ declare module 'stripe' {
177
178
  | 'kr_brn'
178
179
  | 'kz_bin'
179
180
  | 'li_uid'
181
+ | 'ma_vat'
182
+ | 'md_vat'
180
183
  | 'mx_rfc'
181
184
  | 'my_frp'
182
185
  | 'my_itn'
@@ -200,10 +203,13 @@ declare module 'stripe' {
200
203
  | 'th_vat'
201
204
  | 'tr_tin'
202
205
  | 'tw_vat'
206
+ | 'tz_vat'
203
207
  | 'ua_vat'
204
208
  | 'unknown'
205
209
  | 'us_ein'
206
210
  | 'uy_ruc'
211
+ | 'uz_tin'
212
+ | 'uz_vat'
207
213
  | 've_rif'
208
214
  | 'vn_tin'
209
215
  | 'za_vat';
@@ -352,6 +358,7 @@ declare module 'stripe' {
352
358
  | 'lease_tax'
353
359
  | 'pst'
354
360
  | 'qst'
361
+ | 'retail_delivery_fee'
355
362
  | 'rst'
356
363
  | 'sales_tax'
357
364
  | 'vat';
@@ -407,11 +414,21 @@ declare module 'stripe' {
407
414
  */
408
415
  country: string | null;
409
416
 
417
+ /**
418
+ * The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.
419
+ */
420
+ flat_amount?: TaxRateDetails.FlatAmount | null;
421
+
410
422
  /**
411
423
  * The tax rate percentage as a string. For example, 8.5% is represented as `"8.5"`.
412
424
  */
413
425
  percentage_decimal: string;
414
426
 
427
+ /**
428
+ * Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location.
429
+ */
430
+ rate_type?: TaxRateDetails.RateType | null;
431
+
415
432
  /**
416
433
  * State, county, province, or region.
417
434
  */
@@ -424,6 +441,20 @@ declare module 'stripe' {
424
441
  }
425
442
 
426
443
  namespace TaxRateDetails {
444
+ interface FlatAmount {
445
+ /**
446
+ * Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
447
+ */
448
+ amount: number;
449
+
450
+ /**
451
+ * Three-letter ISO currency code, in lowercase.
452
+ */
453
+ currency: string;
454
+ }
455
+
456
+ type RateType = 'flat_amount' | 'percentage';
457
+
427
458
  type TaxType =
428
459
  | 'amusement_tax'
429
460
  | 'communications_tax'
@@ -434,6 +465,7 @@ declare module 'stripe' {
434
465
  | 'lease_tax'
435
466
  | 'pst'
436
467
  | 'qst'
468
+ | 'retail_delivery_fee'
437
469
  | 'rst'
438
470
  | 'sales_tax'
439
471
  | 'vat';
@@ -115,7 +115,7 @@ declare module 'stripe' {
115
115
 
116
116
  interface TaxId {
117
117
  /**
118
- * Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `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_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `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`, or `za_vat`
118
+ * Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `ma_vat`, `md_vat`, `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`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`
119
119
  */
120
120
  type: TaxId.Type;
121
121
 
@@ -137,6 +137,7 @@ declare module 'stripe' {
137
137
  | 'bo_tin'
138
138
  | 'br_cnpj'
139
139
  | 'br_cpf'
140
+ | 'by_tin'
140
141
  | 'ca_bn'
141
142
  | 'ca_gst_hst'
142
143
  | 'ca_pst_bc'
@@ -172,6 +173,8 @@ declare module 'stripe' {
172
173
  | 'kr_brn'
173
174
  | 'kz_bin'
174
175
  | 'li_uid'
176
+ | 'ma_vat'
177
+ | 'md_vat'
175
178
  | 'mx_rfc'
176
179
  | 'my_frp'
177
180
  | 'my_itn'
@@ -195,9 +198,12 @@ declare module 'stripe' {
195
198
  | 'th_vat'
196
199
  | 'tr_tin'
197
200
  | 'tw_vat'
201
+ | 'tz_vat'
198
202
  | 'ua_vat'
199
203
  | 'us_ein'
200
204
  | 'uy_ruc'
205
+ | 'uz_tin'
206
+ | 'uz_vat'
201
207
  | 've_rif'
202
208
  | 'vn_tin'
203
209
  | 'za_vat';
@@ -0,0 +1,133 @@
1
+ // File generated from our OpenAPI spec
2
+
3
+ declare module 'stripe' {
4
+ namespace Stripe {
5
+ namespace Tax {
6
+ /**
7
+ * Tax forms are legal documents which are delivered to one or more tax authorities for information reporting purposes.
8
+ *
9
+ * Related guide: [US tax reporting for Connect platforms](https://stripe.com/docs/connect/tax-reporting)
10
+ */
11
+ interface Form {
12
+ /**
13
+ * Unique identifier for the object.
14
+ */
15
+ id: string;
16
+
17
+ /**
18
+ * String representing the object's type. Objects of the same type share the same value.
19
+ */
20
+ object: 'tax.form';
21
+
22
+ /**
23
+ * The form that corrects this form, if any.
24
+ */
25
+ corrected_by: string | Stripe.Tax.Form | null;
26
+
27
+ /**
28
+ * Time at which the object was created. Measured in seconds since the Unix epoch.
29
+ */
30
+ created: number;
31
+
32
+ /**
33
+ * A list of tax filing statuses. Note that a filing status will only be included if the form has been filed directly with the jurisdiction's tax authority.
34
+ */
35
+ filing_statuses: Array<Form.FilingStatus>;
36
+
37
+ /**
38
+ * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
39
+ */
40
+ livemode: boolean;
41
+
42
+ payee: Form.Payee;
43
+
44
+ /**
45
+ * The type of the tax form. An additional hash is included on the tax form with a name matching this value. It contains additional information specific to the tax form type.
46
+ */
47
+ type: Form.Type;
48
+
49
+ us_1099_k?: Form.Us1099K;
50
+
51
+ us_1099_misc?: Form.Us1099Misc;
52
+
53
+ us_1099_nec?: Form.Us1099Nec;
54
+ }
55
+
56
+ namespace Form {
57
+ interface FilingStatus {
58
+ /**
59
+ * Time when the filing status was updated.
60
+ */
61
+ effective_at: number;
62
+
63
+ jurisdiction: FilingStatus.Jurisdiction;
64
+
65
+ /**
66
+ * The current status of the filed form.
67
+ */
68
+ value: FilingStatus.Value;
69
+ }
70
+
71
+ namespace FilingStatus {
72
+ interface Jurisdiction {
73
+ /**
74
+ * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Always `US`.
75
+ */
76
+ country: string;
77
+
78
+ /**
79
+ * Indicates the level of the jurisdiction where the form was filed.
80
+ */
81
+ level: Jurisdiction.Level;
82
+
83
+ /**
84
+ * [ISO 3166-2 U.S. state code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix, if any. For example, "NY" for New York, United States.
85
+ */
86
+ state: string | null;
87
+ }
88
+
89
+ namespace Jurisdiction {
90
+ type Level = 'country' | 'state';
91
+ }
92
+
93
+ type Value = 'accepted' | 'filed' | 'rejected';
94
+ }
95
+
96
+ interface Payee {
97
+ /**
98
+ * The ID of the payee's Stripe account.
99
+ */
100
+ account: string | Stripe.Account | null;
101
+
102
+ /**
103
+ * Always `account`.
104
+ */
105
+ type: 'account';
106
+ }
107
+
108
+ type Type = 'us_1099_k' | 'us_1099_misc' | 'us_1099_nec';
109
+
110
+ interface Us1099K {
111
+ /**
112
+ * Year represented by the information reported on the tax form.
113
+ */
114
+ reporting_year: number;
115
+ }
116
+
117
+ interface Us1099Misc {
118
+ /**
119
+ * Year represented by the information reported on the tax form.
120
+ */
121
+ reporting_year: number;
122
+ }
123
+
124
+ interface Us1099Nec {
125
+ /**
126
+ * Year represented by the information reported on the tax form.
127
+ */
128
+ reporting_year: number;
129
+ }
130
+ }
131
+ }
132
+ }
133
+ }
@@ -0,0 +1,90 @@
1
+ // File generated from our OpenAPI spec
2
+
3
+ declare module 'stripe' {
4
+ namespace Stripe {
5
+ namespace Tax {
6
+ interface FormRetrieveParams {
7
+ /**
8
+ * Specifies which fields in the response should be expanded.
9
+ */
10
+ expand?: Array<string>;
11
+ }
12
+
13
+ interface FormListParams extends PaginationParams {
14
+ /**
15
+ * The payee whose volume is represented on the tax form.
16
+ */
17
+ payee: FormListParams.Payee;
18
+
19
+ /**
20
+ * Specifies which fields in the response should be expanded.
21
+ */
22
+ expand?: Array<string>;
23
+
24
+ /**
25
+ * An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future tax form types. If your integration expects only one type of tax form in the response, make sure to provide a type value in the request.
26
+ */
27
+ type?: FormListParams.Type;
28
+ }
29
+
30
+ namespace FormListParams {
31
+ interface Payee {
32
+ /**
33
+ * The ID of the Stripe account whose forms will be retrieved.
34
+ */
35
+ account?: string;
36
+
37
+ /**
38
+ * Specifies the payee type. Always `account`.
39
+ */
40
+ type?: 'account';
41
+ }
42
+
43
+ type Type = 'us_1099_k' | 'us_1099_misc' | 'us_1099_nec';
44
+ }
45
+
46
+ interface FormPdfParams {
47
+ /**
48
+ * Specifies which fields in the response should be expanded.
49
+ */
50
+ expand?: Array<string>;
51
+ }
52
+
53
+ class FormsResource {
54
+ /**
55
+ * Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.
56
+ */
57
+ retrieve(
58
+ id: string,
59
+ params?: FormRetrieveParams,
60
+ options?: RequestOptions
61
+ ): Promise<Stripe.Response<Stripe.Tax.Form>>;
62
+ retrieve(
63
+ id: string,
64
+ options?: RequestOptions
65
+ ): Promise<Stripe.Response<Stripe.Tax.Form>>;
66
+
67
+ /**
68
+ * Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
69
+ */
70
+ list(
71
+ params: FormListParams,
72
+ options?: RequestOptions
73
+ ): ApiListPromise<Stripe.Tax.Form>;
74
+
75
+ /**
76
+ * Download the PDF for a tax form.
77
+ */
78
+ pdf(
79
+ id: string,
80
+ params?: FormPdfParams,
81
+ options?: RequestOptions
82
+ ): Promise<StripeStreamResponse>;
83
+ pdf(
84
+ id: string,
85
+ options?: RequestOptions
86
+ ): Promise<StripeStreamResponse>;
87
+ }
88
+ }
89
+ }
90
+ }
@@ -68,6 +68,8 @@ declare module 'stripe' {
68
68
 
69
69
  bh?: CountryOptions.Bh;
70
70
 
71
+ by?: CountryOptions.By;
72
+
71
73
  ca?: CountryOptions.Ca;
72
74
 
73
75
  ch?: CountryOptions.Ch;
@@ -76,6 +78,8 @@ declare module 'stripe' {
76
78
 
77
79
  co?: CountryOptions.Co;
78
80
 
81
+ cr?: CountryOptions.Cr;
82
+
79
83
  cy?: CountryOptions.Cy;
80
84
 
81
85
  cz?: CountryOptions.Cz;
@@ -84,6 +88,8 @@ declare module 'stripe' {
84
88
 
85
89
  dk?: CountryOptions.Dk;
86
90
 
91
+ ec?: CountryOptions.Ec;
92
+
87
93
  ee?: CountryOptions.Ee;
88
94
 
89
95
  eg?: CountryOptions.Eg;
@@ -126,6 +132,10 @@ declare module 'stripe' {
126
132
 
127
133
  lv?: CountryOptions.Lv;
128
134
 
135
+ ma?: CountryOptions.Ma;
136
+
137
+ md?: CountryOptions.Md;
138
+
129
139
  mt?: CountryOptions.Mt;
130
140
 
131
141
  mx?: CountryOptions.Mx;
@@ -148,6 +158,10 @@ declare module 'stripe' {
148
158
 
149
159
  ro?: CountryOptions.Ro;
150
160
 
161
+ rs?: CountryOptions.Rs;
162
+
163
+ ru?: CountryOptions.Ru;
164
+
151
165
  sa?: CountryOptions.Sa;
152
166
 
153
167
  se?: CountryOptions.Se;
@@ -162,8 +176,12 @@ declare module 'stripe' {
162
176
 
163
177
  tr?: CountryOptions.Tr;
164
178
 
179
+ tz?: CountryOptions.Tz;
180
+
165
181
  us?: CountryOptions.Us;
166
182
 
183
+ uz?: CountryOptions.Uz;
184
+
167
185
  vn?: CountryOptions.Vn;
168
186
 
169
187
  za?: CountryOptions.Za;
@@ -263,6 +281,13 @@ declare module 'stripe' {
263
281
  type: 'standard';
264
282
  }
265
283
 
284
+ interface By {
285
+ /**
286
+ * Type of registration in `country`.
287
+ */
288
+ type: 'simplified';
289
+ }
290
+
266
291
  interface Ca {
267
292
  province_standard?: Ca.ProvinceStandard;
268
293
 
@@ -304,6 +329,13 @@ declare module 'stripe' {
304
329
  type: 'simplified';
305
330
  }
306
331
 
332
+ interface Cr {
333
+ /**
334
+ * Type of registration in `country`.
335
+ */
336
+ type: 'simplified';
337
+ }
338
+
307
339
  interface Cy {
308
340
  standard?: Cy.Standard;
309
341
 
@@ -400,6 +432,13 @@ declare module 'stripe' {
400
432
  type Type = 'ioss' | 'oss_non_union' | 'oss_union' | 'standard';
401
433
  }
402
434
 
435
+ interface Ec {
436
+ /**
437
+ * Type of registration in `country`.
438
+ */
439
+ type: 'simplified';
440
+ }
441
+
403
442
  interface Ee {
404
443
  standard?: Ee.Standard;
405
444
 
@@ -751,6 +790,20 @@ declare module 'stripe' {
751
790
  type Type = 'ioss' | 'oss_non_union' | 'oss_union' | 'standard';
752
791
  }
753
792
 
793
+ interface Ma {
794
+ /**
795
+ * Type of registration in `country`.
796
+ */
797
+ type: 'simplified';
798
+ }
799
+
800
+ interface Md {
801
+ /**
802
+ * Type of registration in `country`.
803
+ */
804
+ type: 'simplified';
805
+ }
806
+
754
807
  interface Mt {
755
808
  standard?: Mt.Standard;
756
809
 
@@ -913,6 +966,20 @@ declare module 'stripe' {
913
966
  type Type = 'ioss' | 'oss_non_union' | 'oss_union' | 'standard';
914
967
  }
915
968
 
969
+ interface Rs {
970
+ /**
971
+ * Type of registration in `country`.
972
+ */
973
+ type: 'standard';
974
+ }
975
+
976
+ interface Ru {
977
+ /**
978
+ * Type of registration in `country`.
979
+ */
980
+ type: 'simplified';
981
+ }
982
+
916
983
  interface Sa {
917
984
  /**
918
985
  * Type of registration in `country`.
@@ -1013,6 +1080,13 @@ declare module 'stripe' {
1013
1080
  type: 'simplified';
1014
1081
  }
1015
1082
 
1083
+ interface Tz {
1084
+ /**
1085
+ * Type of registration in `country`.
1086
+ */
1087
+ type: 'simplified';
1088
+ }
1089
+
1016
1090
  interface Us {
1017
1091
  local_amusement_tax?: Us.LocalAmusementTax;
1018
1092
 
@@ -1078,9 +1152,17 @@ declare module 'stripe' {
1078
1152
  | 'local_amusement_tax'
1079
1153
  | 'local_lease_tax'
1080
1154
  | 'state_communications_tax'
1155
+ | 'state_retail_delivery_fee'
1081
1156
  | 'state_sales_tax';
1082
1157
  }
1083
1158
 
1159
+ interface Uz {
1160
+ /**
1161
+ * Type of registration in `country`.
1162
+ */
1163
+ type: 'simplified';
1164
+ }
1165
+
1084
1166
  interface Vn {
1085
1167
  /**
1086
1168
  * Type of registration in `country`.