stripe 17.8.0-beta.1 → 18.0.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 (208) hide show
  1. package/CHANGELOG.md +246 -1075
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +0 -1
  4. package/VERSION +1 -1
  5. package/cjs/apiVersion.js +1 -1
  6. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  7. package/cjs/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +4 -4
  8. package/cjs/resources/Invoices.js +0 -26
  9. package/cjs/resources/PaymentIntents.js +0 -8
  10. package/cjs/resources/Quotes.js +0 -32
  11. package/cjs/resources/SubscriptionItems.js +0 -9
  12. package/cjs/resources/SubscriptionSchedules.js +0 -4
  13. package/cjs/resources/Terminal/Readers.js +0 -12
  14. package/cjs/resources/TestHelpers/Terminal/Readers.js +0 -8
  15. package/cjs/resources.js +12 -48
  16. package/cjs/stripe.core.js +3 -14
  17. package/esm/apiVersion.js +1 -1
  18. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  19. package/esm/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +3 -3
  20. package/esm/resources/Invoices.js +0 -26
  21. package/esm/resources/PaymentIntents.js +0 -8
  22. package/esm/resources/Quotes.js +0 -32
  23. package/esm/resources/SubscriptionItems.js +0 -9
  24. package/esm/resources/SubscriptionSchedules.js +0 -4
  25. package/esm/resources/Terminal/Readers.js +0 -12
  26. package/esm/resources/TestHelpers/Terminal/Readers.js +0 -8
  27. package/esm/resources.js +1 -33
  28. package/esm/stripe.core.js +3 -14
  29. package/package.json +1 -1
  30. package/types/AccountLinksResource.d.ts +1 -5
  31. package/types/AccountSessions.d.ts +0 -45
  32. package/types/AccountSessionsResource.d.ts +0 -243
  33. package/types/Accounts.d.ts +48 -211
  34. package/types/AccountsResource.d.ts +86 -503
  35. package/types/ApplicationFees.d.ts +1 -1
  36. package/types/BalanceTransactions.d.ts +3 -1
  37. package/types/BalanceTransactionsResource.d.ts +1 -1
  38. package/types/BankAccounts.d.ts +9 -1
  39. package/types/Billing/CreditBalanceSummaryResource.d.ts +2 -2
  40. package/types/Billing/CreditGrants.d.ts +2 -2
  41. package/types/Billing/CreditGrantsResource.d.ts +2 -2
  42. package/types/Billing/Meters.d.ts +1 -1
  43. package/types/Billing/MetersResource.d.ts +2 -2
  44. package/types/Capabilities.d.ts +8 -0
  45. package/types/Cards.d.ts +1 -9
  46. package/types/Charges.d.ts +56 -153
  47. package/types/ChargesResource.d.ts +1 -1295
  48. package/types/Checkout/Sessions.d.ts +62 -336
  49. package/types/Checkout/SessionsResource.d.ts +69 -287
  50. package/types/ConfirmationTokens.d.ts +50 -99
  51. package/types/Coupons.d.ts +1 -1
  52. package/types/CouponsResource.d.ts +1 -1
  53. package/types/CreditNoteLineItems.d.ts +24 -22
  54. package/types/CreditNotes.d.ts +26 -23
  55. package/types/CreditNotesResource.d.ts +0 -15
  56. package/types/CustomerBalanceTransactions.d.ts +8 -1
  57. package/types/Customers.d.ts +3 -3
  58. package/types/CustomersResource.d.ts +3 -21
  59. package/types/EventTypes.d.ts +85 -545
  60. package/types/Events.d.ts +8 -93
  61. package/types/FinancialConnections/Accounts.d.ts +1 -29
  62. package/types/FinancialConnections/AccountsResource.d.ts +3 -35
  63. package/types/FinancialConnections/Sessions.d.ts +1 -49
  64. package/types/FinancialConnections/SessionsResource.d.ts +1 -38
  65. package/types/InvoiceItems.d.ts +60 -31
  66. package/types/InvoiceItemsResource.d.ts +26 -120
  67. package/types/InvoiceLineItems.d.ts +154 -91
  68. package/types/InvoicePayments.d.ts +2 -16
  69. package/types/InvoicePaymentsResource.d.ts +74 -0
  70. package/types/Invoices.d.ts +93 -214
  71. package/types/InvoicesResource.d.ts +307 -6599
  72. package/types/Issuing/Authorizations.d.ts +1 -1
  73. package/types/Issuing/AuthorizationsResource.d.ts +1 -1
  74. package/types/Issuing/CardholdersResource.d.ts +1 -2
  75. package/types/Issuing/Transactions.d.ts +0 -2
  76. package/types/Issuing/TransactionsResource.d.ts +0 -5
  77. package/types/LineItems.d.ts +0 -32
  78. package/types/Mandates.d.ts +8 -77
  79. package/types/PaymentIntents.d.ts +56 -648
  80. package/types/PaymentIntentsResource.d.ts +4120 -8122
  81. package/types/PaymentLinks.d.ts +49 -6
  82. package/types/PaymentLinksResource.d.ts +77 -12
  83. package/types/PaymentMethodConfigurations.d.ts +63 -135
  84. package/types/PaymentMethodConfigurationsResource.d.ts +116 -216
  85. package/types/PaymentMethodDomainsResource.d.ts +6 -6
  86. package/types/PaymentMethods.d.ts +50 -99
  87. package/types/PaymentMethodsResource.d.ts +53 -148
  88. package/types/Persons.d.ts +17 -9
  89. package/types/Plans.d.ts +0 -7
  90. package/types/PlansResource.d.ts +0 -7
  91. package/types/Prices.d.ts +0 -33
  92. package/types/PricesResource.d.ts +2 -35
  93. package/types/Products.d.ts +0 -39
  94. package/types/ProductsResource.d.ts +0 -36
  95. package/types/Quotes.d.ts +1 -591
  96. package/types/QuotesResource.d.ts +200 -2532
  97. package/types/Refunds.d.ts +18 -14
  98. package/types/Reviews.d.ts +3 -2
  99. package/types/SetupAttempts.d.ts +15 -38
  100. package/types/SetupIntents.d.ts +3 -111
  101. package/types/SetupIntentsResource.d.ts +155 -642
  102. package/types/Sources.d.ts +0 -29
  103. package/types/SubscriptionItems.d.ts +9 -34
  104. package/types/SubscriptionItemsResource.d.ts +2 -203
  105. package/types/SubscriptionSchedules.d.ts +0 -251
  106. package/types/SubscriptionSchedulesResource.d.ts +9 -1333
  107. package/types/Subscriptions.d.ts +4 -124
  108. package/types/SubscriptionsResource.d.ts +10 -455
  109. package/types/Tax/RegistrationsResource.d.ts +1 -1
  110. package/types/Terminal/Configurations.d.ts +86 -3
  111. package/types/Terminal/ConfigurationsResource.d.ts +192 -2
  112. package/types/Terminal/Readers.d.ts +0 -290
  113. package/types/Terminal/ReadersResource.d.ts +0 -215
  114. package/types/TestHelpers/ConfirmationTokensResource.d.ts +50 -103
  115. package/types/TestHelpers/Terminal/ReadersResource.d.ts +0 -53
  116. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  117. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  118. package/types/TokensResource.d.ts +6 -1
  119. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  120. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  121. package/types/Treasury/FinancialAccountsResource.d.ts +1 -38
  122. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  123. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  124. package/types/Treasury/ReceivedCredits.d.ts +0 -26
  125. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  126. package/types/V2/Core/EventDestinationsResource.d.ts +0 -5
  127. package/types/V2/Core/EventsResource.d.ts +0 -5
  128. package/types/V2/EventDestinations.d.ts +1 -1
  129. package/types/V2/Events.d.ts +1 -1
  130. package/types/WebhookEndpointsResource.d.ts +19 -71
  131. package/types/index.d.ts +2 -64
  132. package/types/lib.d.ts +1 -1
  133. package/types/test/typescriptTest.ts +3 -6
  134. package/cjs/resources/AccountNotices.js +0 -21
  135. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  136. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  137. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  138. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  139. package/cjs/resources/GiftCards/Cards.js +0 -23
  140. package/cjs/resources/GiftCards/Transactions.js +0 -33
  141. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  142. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  143. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  144. package/cjs/resources/Margins.js +0 -22
  145. package/cjs/resources/Orders.js +0 -24
  146. package/cjs/resources/PaymentRecords.js +0 -29
  147. package/cjs/resources/Tax/Associations.js +0 -9
  148. package/cjs/resources/Tax/Forms.js +0 -20
  149. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  150. package/esm/resources/AccountNotices.js +0 -18
  151. package/esm/resources/Capital/FinancingOffers.js +0 -18
  152. package/esm/resources/Capital/FinancingSummary.js +0 -9
  153. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  154. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  155. package/esm/resources/GiftCards/Cards.js +0 -20
  156. package/esm/resources/GiftCards/Transactions.js +0 -30
  157. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  158. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  159. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  160. package/esm/resources/Margins.js +0 -19
  161. package/esm/resources/Orders.js +0 -21
  162. package/esm/resources/PaymentRecords.js +0 -26
  163. package/esm/resources/Tax/Associations.js +0 -6
  164. package/esm/resources/Tax/Forms.js +0 -17
  165. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  166. package/types/AccountNotices.d.ts +0 -113
  167. package/types/AccountNoticesResource.d.ts +0 -98
  168. package/types/Billing/MeterErrorReports.d.ts +0 -106
  169. package/types/Capital/FinancingOffers.d.ts +0 -188
  170. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  171. package/types/Capital/FinancingSummary.d.ts +0 -106
  172. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  173. package/types/Capital/FinancingTransactions.d.ts +0 -135
  174. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  175. package/types/Deprecations.d.ts +0 -215
  176. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  177. package/types/FinancialConnections/Institutions.d.ts +0 -93
  178. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  179. package/types/GiftCards/Cards.d.ts +0 -118
  180. package/types/GiftCards/CardsResource.d.ts +0 -159
  181. package/types/GiftCards/Transactions.d.ts +0 -129
  182. package/types/GiftCards/TransactionsResource.d.ts +0 -201
  183. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  184. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  185. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -73
  186. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  187. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  188. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  189. package/types/Issuing/Settlements.d.ts +0 -103
  190. package/types/Margins.d.ts +0 -56
  191. package/types/MarginsResource.d.ts +0 -114
  192. package/types/Orders.d.ts +0 -1189
  193. package/types/OrdersResource.d.ts +0 -2981
  194. package/types/PaymentAttemptRecords.d.ts +0 -242
  195. package/types/PaymentAttemptRecordsResource.d.ts +0 -47
  196. package/types/PaymentRecords.d.ts +0 -242
  197. package/types/PaymentRecordsResource.d.ts +0 -455
  198. package/types/QuoteLines.d.ts +0 -634
  199. package/types/QuotePreviewInvoices.d.ts +0 -1658
  200. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -824
  201. package/types/Tax/Associations.d.ts +0 -126
  202. package/types/Tax/AssociationsResource.d.ts +0 -29
  203. package/types/Tax/Forms.d.ts +0 -220
  204. package/types/Tax/FormsResource.d.ts +0 -107
  205. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  206. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  207. package/types/UsageRecordSummaries.d.ts +0 -56
  208. package/types/UsageRecords.d.ts +0 -45
@@ -1,126 +0,0 @@
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
- }
@@ -1,29 +0,0 @@
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
- }
@@ -1,220 +0,0 @@
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
- au_serr?: Form.AuSerr;
23
-
24
- ca_mrdp?: Form.CaMrdp;
25
-
26
- /**
27
- * The form that corrects this form, if any.
28
- */
29
- corrected_by: string | Stripe.Tax.Form | null;
30
-
31
- /**
32
- * Time at which the object was created. Measured in seconds since the Unix epoch.
33
- */
34
- created: number;
35
-
36
- eu_dac7?: Form.EuDac7;
37
-
38
- /**
39
- * 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.
40
- */
41
- filing_statuses: Array<Form.FilingStatus>;
42
-
43
- gb_mrdp?: Form.GbMrdp;
44
-
45
- /**
46
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
47
- */
48
- livemode: boolean;
49
-
50
- nz_mrdp?: Form.NzMrdp;
51
-
52
- payee: Form.Payee;
53
-
54
- /**
55
- * 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.
56
- */
57
- type: Form.Type;
58
-
59
- us_1099_k?: Form.Us1099K;
60
-
61
- us_1099_misc?: Form.Us1099Misc;
62
-
63
- us_1099_nec?: Form.Us1099Nec;
64
- }
65
-
66
- namespace Form {
67
- interface AuSerr {
68
- /**
69
- * End date of the period represented by the information reported on the tax form.
70
- */
71
- reporting_period_end_date: string;
72
-
73
- /**
74
- * Start date of the period represented by the information reported on the tax form.
75
- */
76
- reporting_period_start_date: string;
77
- }
78
-
79
- interface CaMrdp {
80
- /**
81
- * End date of the period represented by the information reported on the tax form.
82
- */
83
- reporting_period_end_date: string;
84
-
85
- /**
86
- * Start date of the period represented by the information reported on the tax form.
87
- */
88
- reporting_period_start_date: string;
89
- }
90
-
91
- interface EuDac7 {
92
- /**
93
- * End date of the period represented by the information reported on the tax form.
94
- */
95
- reporting_period_end_date: string;
96
-
97
- /**
98
- * Start date of the period represented by the information reported on the tax form.
99
- */
100
- reporting_period_start_date: string;
101
- }
102
-
103
- interface FilingStatus {
104
- /**
105
- * Time when the filing status was updated.
106
- */
107
- effective_at: number;
108
-
109
- jurisdiction: FilingStatus.Jurisdiction;
110
-
111
- /**
112
- * The current status of the filed form.
113
- */
114
- value: FilingStatus.Value;
115
- }
116
-
117
- namespace FilingStatus {
118
- interface Jurisdiction {
119
- /**
120
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
121
- */
122
- country: string;
123
-
124
- /**
125
- * Indicates the level of the jurisdiction where the form was filed.
126
- */
127
- level: Jurisdiction.Level;
128
-
129
- /**
130
- * [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. Null for non-U.S. forms.
131
- */
132
- state: string | null;
133
- }
134
-
135
- namespace Jurisdiction {
136
- type Level = 'country' | 'state';
137
- }
138
-
139
- type Value = 'accepted' | 'filed' | 'rejected';
140
- }
141
-
142
- interface GbMrdp {
143
- /**
144
- * End date of the period represented by the information reported on the tax form.
145
- */
146
- reporting_period_end_date: string;
147
-
148
- /**
149
- * Start date of the period represented by the information reported on the tax form.
150
- */
151
- reporting_period_start_date: string;
152
- }
153
-
154
- interface NzMrdp {
155
- /**
156
- * End date of the period represented by the information reported on the tax form.
157
- */
158
- reporting_period_end_date: string;
159
-
160
- /**
161
- * Start date of the period represented by the information reported on the tax form.
162
- */
163
- reporting_period_start_date: string;
164
- }
165
-
166
- interface Payee {
167
- /**
168
- * The ID of the payee's Stripe account.
169
- */
170
- account: string | Stripe.Account | null;
171
-
172
- /**
173
- * The external reference to this payee.
174
- */
175
- external_reference: string | null;
176
-
177
- /**
178
- * Either `account` or `external_reference`.
179
- */
180
- type: Payee.Type;
181
- }
182
-
183
- namespace Payee {
184
- type Type = 'account' | 'external_reference';
185
- }
186
-
187
- type Type =
188
- | 'au_serr'
189
- | 'ca_mrdp'
190
- | 'eu_dac7'
191
- | 'gb_mrdp'
192
- | 'nz_mrdp'
193
- | 'us_1099_k'
194
- | 'us_1099_misc'
195
- | 'us_1099_nec';
196
-
197
- interface Us1099K {
198
- /**
199
- * Year represented by the information reported on the tax form.
200
- */
201
- reporting_year: number;
202
- }
203
-
204
- interface Us1099Misc {
205
- /**
206
- * Year represented by the information reported on the tax form.
207
- */
208
- reporting_year: number;
209
- }
210
-
211
- interface Us1099Nec {
212
- /**
213
- * Year represented by the information reported on the tax form.
214
- */
215
- reporting_year: number;
216
- }
217
- }
218
- }
219
- }
220
- }
@@ -1,107 +0,0 @@
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
- * The external reference to the payee whose forms will be retrieved.
39
- */
40
- external_reference?: string;
41
-
42
- /**
43
- * Specifies the payee type. Either `account` or `external_reference`.
44
- */
45
- type?: Payee.Type;
46
- }
47
-
48
- namespace Payee {
49
- type Type = 'account' | 'external_reference';
50
- }
51
-
52
- type Type =
53
- | 'au_serr'
54
- | 'ca_mrdp'
55
- | 'eu_dac7'
56
- | 'gb_mrdp'
57
- | 'nz_mrdp'
58
- | 'us_1099_k'
59
- | 'us_1099_misc'
60
- | 'us_1099_nec';
61
- }
62
-
63
- interface FormPdfParams {
64
- /**
65
- * Specifies which fields in the response should be expanded.
66
- */
67
- expand?: Array<string>;
68
- }
69
-
70
- class FormsResource {
71
- /**
72
- * 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.
73
- */
74
- retrieve(
75
- id: string,
76
- params?: FormRetrieveParams,
77
- options?: RequestOptions
78
- ): Promise<Stripe.Response<Stripe.Tax.Form>>;
79
- retrieve(
80
- id: string,
81
- options?: RequestOptions
82
- ): Promise<Stripe.Response<Stripe.Tax.Form>>;
83
-
84
- /**
85
- * 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.
86
- */
87
- list(
88
- params: FormListParams,
89
- options?: RequestOptions
90
- ): ApiListPromise<Stripe.Tax.Form>;
91
-
92
- /**
93
- * Download the PDF for a tax form.
94
- */
95
- pdf(
96
- id: string,
97
- params?: FormPdfParams,
98
- options?: RequestOptions
99
- ): Promise<StripeStreamResponse>;
100
- pdf(
101
- id: string,
102
- options?: RequestOptions
103
- ): Promise<StripeStreamResponse>;
104
- }
105
- }
106
- }
107
- }
@@ -1,51 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Terminal {
6
- /**
7
- * Returns data collected by Terminal readers. This data is only stored for 24 hours.
8
- */
9
- interface ReaderCollectedData {
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: 'terminal.reader_collected_data';
19
-
20
- /**
21
- * Time at which the object was created. Measured in seconds since the Unix epoch.
22
- */
23
- created: number;
24
-
25
- /**
26
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
27
- */
28
- livemode: boolean;
29
-
30
- /**
31
- * The magstripe data collected by the reader.
32
- */
33
- magstripe: ReaderCollectedData.Magstripe | null;
34
-
35
- /**
36
- * The type of data collected by the reader.
37
- */
38
- type: 'magstripe';
39
- }
40
-
41
- namespace ReaderCollectedData {
42
- interface Magstripe {
43
- /**
44
- * The raw magstripe data collected by the reader.
45
- */
46
- data: string | null;
47
- }
48
- }
49
- }
50
- }
51
- }
@@ -1,29 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Terminal {
6
- interface ReaderCollectedDataRetrieveParams {
7
- /**
8
- * Specifies which fields in the response should be expanded.
9
- */
10
- expand?: Array<string>;
11
- }
12
-
13
- class ReaderCollectedDataResource {
14
- /**
15
- * Retrieve data collected using Reader hardware.
16
- */
17
- retrieve(
18
- id: string,
19
- params?: ReaderCollectedDataRetrieveParams,
20
- options?: RequestOptions
21
- ): Promise<Stripe.Response<Stripe.Terminal.ReaderCollectedData>>;
22
- retrieve(
23
- id: string,
24
- options?: RequestOptions
25
- ): Promise<Stripe.Response<Stripe.Terminal.ReaderCollectedData>>;
26
- }
27
- }
28
- }
29
- }
@@ -1,56 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- /**
6
- * A usage record summary represents an aggregated view of how much usage was accrued for a subscription item within a subscription billing period.
7
- */
8
- interface UsageRecordSummary {
9
- /**
10
- * Unique identifier for the object.
11
- */
12
- id: string;
13
-
14
- /**
15
- * String representing the object's type. Objects of the same type share the same value.
16
- */
17
- object: 'usage_record_summary';
18
-
19
- /**
20
- * The invoice in which this usage period has been billed for.
21
- */
22
- invoice: string | null;
23
-
24
- /**
25
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
26
- */
27
- livemode: boolean;
28
-
29
- period: UsageRecordSummary.Period;
30
-
31
- /**
32
- * The ID of the subscription item this summary is describing.
33
- */
34
- subscription_item: string;
35
-
36
- /**
37
- * The total usage within this usage period.
38
- */
39
- total_usage: number;
40
- }
41
-
42
- namespace UsageRecordSummary {
43
- interface Period {
44
- /**
45
- * The end date of this usage period. All usage up to and including this point in time is included.
46
- */
47
- end: number | null;
48
-
49
- /**
50
- * The start date of this usage period. All usage after this point in time is included.
51
- */
52
- start: number | null;
53
- }
54
- }
55
- }
56
- }
@@ -1,45 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- /**
6
- * Usage records allow you to report customer usage and metrics to Stripe for
7
- * metered billing of subscription prices.
8
- *
9
- * Related guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)
10
- *
11
- * This is our legacy usage-based billing API. See the [updated usage-based billing docs](https://docs.stripe.com/billing/subscriptions/usage-based).
12
- */
13
- interface UsageRecord {
14
- /**
15
- * Unique identifier for the object.
16
- */
17
- id: string;
18
-
19
- /**
20
- * String representing the object's type. Objects of the same type share the same value.
21
- */
22
- object: 'usage_record';
23
-
24
- /**
25
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
26
- */
27
- livemode: boolean;
28
-
29
- /**
30
- * The usage quantity for the specified date.
31
- */
32
- quantity: number;
33
-
34
- /**
35
- * The ID of the subscription item this usage record contains data for.
36
- */
37
- subscription_item: string;
38
-
39
- /**
40
- * The timestamp when this usage occurred.
41
- */
42
- timestamp: number;
43
- }
44
- }
45
- }