stripe 19.3.0-beta.1 → 19.3.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 (322) hide show
  1. package/CHANGELOG.md +18 -1466
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +0 -1
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +1 -115
  6. package/cjs/RequestSender.js +1 -1
  7. package/cjs/apiVersion.js +3 -2
  8. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  9. package/cjs/resources/Mandates.js +0 -5
  10. package/cjs/resources/PaymentIntents.js +0 -8
  11. package/cjs/resources/Quotes.js +0 -32
  12. package/cjs/resources/SubscriptionSchedules.js +0 -4
  13. package/cjs/resources/Subscriptions.js +0 -4
  14. package/cjs/resources.js +8 -106
  15. package/cjs/stripe.core.js +1 -1
  16. package/esm/Error.js +0 -100
  17. package/esm/RequestSender.js +1 -1
  18. package/esm/apiVersion.js +2 -1
  19. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  20. package/esm/resources/Mandates.js +0 -5
  21. package/esm/resources/PaymentIntents.js +0 -8
  22. package/esm/resources/Quotes.js +0 -32
  23. package/esm/resources/SubscriptionSchedules.js +0 -4
  24. package/esm/resources/Subscriptions.js +0 -4
  25. package/esm/resources.js +0 -93
  26. package/esm/stripe.core.js +1 -1
  27. package/package.json +1 -1
  28. package/types/AccountLinksResource.d.ts +1 -5
  29. package/types/AccountSessions.d.ts +0 -45
  30. package/types/AccountSessionsResource.d.ts +0 -264
  31. package/types/Accounts.d.ts +2 -215
  32. package/types/AccountsResource.d.ts +2 -546
  33. package/types/BankAccounts.d.ts +0 -2
  34. package/types/Billing/AlertTriggereds.d.ts +1 -1
  35. package/types/Billing/CreditBalanceSummary.d.ts +0 -5
  36. package/types/Billing/CreditBalanceSummaryResource.d.ts +3 -8
  37. package/types/Billing/CreditBalanceTransactionsResource.d.ts +4 -12
  38. package/types/Billing/CreditGrants.d.ts +0 -5
  39. package/types/Billing/CreditGrantsResource.d.ts +3 -13
  40. package/types/BillingPortal/Sessions.d.ts +0 -5
  41. package/types/BillingPortal/SessionsResource.d.ts +4 -12
  42. package/types/Capabilities.d.ts +0 -2
  43. package/types/Cards.d.ts +0 -5
  44. package/types/CashBalances.d.ts +0 -5
  45. package/types/Charges.d.ts +0 -176
  46. package/types/ChargesResource.d.ts +0 -1418
  47. package/types/Checkout/Sessions.d.ts +2 -369
  48. package/types/Checkout/SessionsResource.d.ts +2 -632
  49. package/types/ConfirmationTokens.d.ts +0 -125
  50. package/types/Coupons.d.ts +0 -33
  51. package/types/CouponsResource.d.ts +0 -21
  52. package/types/CreditNoteLineItems.d.ts +0 -17
  53. package/types/CreditNotes.d.ts +0 -5
  54. package/types/CreditNotesResource.d.ts +0 -5
  55. package/types/CustomerBalanceTransactions.d.ts +0 -2
  56. package/types/CustomerCashBalanceTransactions.d.ts +0 -2
  57. package/types/CustomerSessions.d.ts +0 -46
  58. package/types/CustomerSessionsResource.d.ts +2 -48
  59. package/types/Customers.d.ts +0 -2
  60. package/types/CustomersResource.d.ts +0 -8
  61. package/types/Discounts.d.ts +0 -10
  62. package/types/Disputes.d.ts +0 -40
  63. package/types/DisputesResource.d.ts +0 -11
  64. package/types/Errors.d.ts +0 -85
  65. package/types/EventTypes.d.ts +0 -630
  66. package/types/Events.d.ts +0 -95
  67. package/types/FinancialConnections/Accounts.d.ts +1 -36
  68. package/types/FinancialConnections/AccountsResource.d.ts +3 -40
  69. package/types/FinancialConnections/Sessions.d.ts +1 -51
  70. package/types/FinancialConnections/SessionsResource.d.ts +1 -43
  71. package/types/Identity/VerificationSessions.d.ts +0 -5
  72. package/types/Identity/VerificationSessionsResource.d.ts +0 -7
  73. package/types/InvoiceItems.d.ts +0 -10
  74. package/types/InvoiceItemsResource.d.ts +6 -117
  75. package/types/InvoiceLineItems.d.ts +1 -45
  76. package/types/InvoicePayments.d.ts +1 -1
  77. package/types/Invoices.d.ts +5 -204
  78. package/types/InvoicesResource.d.ts +4 -1622
  79. package/types/Issuing/CardholdersResource.d.ts +1 -2
  80. package/types/Issuing/Transactions.d.ts +0 -5
  81. package/types/Issuing/TransactionsResource.d.ts +0 -5
  82. package/types/LineItems.d.ts +0 -49
  83. package/types/Mandates.d.ts +1 -135
  84. package/types/MandatesResource.d.ts +0 -31
  85. package/types/PaymentAttemptRecords.d.ts +0 -141
  86. package/types/PaymentIntents.d.ts +13 -774
  87. package/types/PaymentIntentsResource.d.ts +4680 -9470
  88. package/types/PaymentLinks.d.ts +0 -6
  89. package/types/PaymentLinksResource.d.ts +0 -12
  90. package/types/PaymentMethodConfigurations.d.ts +0 -216
  91. package/types/PaymentMethodConfigurationsResource.d.ts +0 -300
  92. package/types/PaymentMethods.d.ts +0 -130
  93. package/types/PaymentMethodsResource.d.ts +2 -167
  94. package/types/PaymentRecords.d.ts +0 -141
  95. package/types/Persons.d.ts +0 -2
  96. package/types/Prices.d.ts +0 -22
  97. package/types/PricesResource.d.ts +0 -22
  98. package/types/PromotionCodes.d.ts +0 -5
  99. package/types/PromotionCodesResource.d.ts +0 -10
  100. package/types/Quotes.d.ts +1 -594
  101. package/types/QuotesResource.d.ts +290 -2635
  102. package/types/Refunds.d.ts +0 -14
  103. package/types/SetupAttempts.d.ts +1 -51
  104. package/types/SetupIntents.d.ts +5 -219
  105. package/types/SetupIntentsResource.d.ts +3 -953
  106. package/types/Sources.d.ts +0 -29
  107. package/types/SubscriptionItems.d.ts +0 -26
  108. package/types/SubscriptionItemsResource.d.ts +0 -109
  109. package/types/SubscriptionSchedules.d.ts +0 -205
  110. package/types/SubscriptionSchedulesResource.d.ts +4 -1232
  111. package/types/Subscriptions.d.ts +1 -262
  112. package/types/SubscriptionsResource.d.ts +8 -745
  113. package/types/TaxIds.d.ts +0 -10
  114. package/types/TaxIdsResource.d.ts +0 -10
  115. package/types/Terminal/Configurations.d.ts +0 -9
  116. package/types/Terminal/ConfigurationsResource.d.ts +18 -46
  117. package/types/Terminal/Readers.d.ts +0 -20
  118. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -126
  119. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  120. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  121. package/types/Transfers.d.ts +0 -5
  122. package/types/TransfersResource.d.ts +0 -5
  123. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  124. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  125. package/types/Treasury/FinancialAccountsResource.d.ts +0 -37
  126. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  127. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  128. package/types/Treasury/ReceivedCredits.d.ts +0 -26
  129. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  130. package/types/V2/Billing/MeterEvents.d.ts +2 -1
  131. package/types/V2/Core/EventTypes.d.ts +10 -1624
  132. package/types/WebhookEndpointsResource.d.ts +0 -74
  133. package/types/apiVersion.d.ts +2 -1
  134. package/types/index.d.ts +0 -153
  135. package/types/lib.d.ts +0 -10
  136. package/cjs/resources/AccountNotices.js +0 -21
  137. package/cjs/resources/Billing/Analytics/MeterUsage.js +0 -12
  138. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  139. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  140. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  141. package/cjs/resources/ExternalAccounts.js +0 -23
  142. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  143. package/cjs/resources/FxQuotes.js +0 -15
  144. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  145. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  146. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  147. package/cjs/resources/Margins.js +0 -22
  148. package/cjs/resources/Orders.js +0 -24
  149. package/cjs/resources/Privacy/RedactionJobs.js +0 -42
  150. package/cjs/resources/Tax/Associations.js +0 -9
  151. package/cjs/resources/Tax/Forms.js +0 -20
  152. package/cjs/resources/Terminal/OnboardingLinks.js +0 -12
  153. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  154. package/cjs/resources/V2/Billing/BillSettings/Versions.js +0 -17
  155. package/cjs/resources/V2/Billing/BillSettings.js +0 -27
  156. package/cjs/resources/V2/Billing/Cadences.js +0 -23
  157. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +0 -17
  158. package/cjs/resources/V2/Billing/CollectionSettings.js +0 -30
  159. package/cjs/resources/V2/Billing/Profiles.js +0 -19
  160. package/cjs/resources/V2/Core/AccountLinks.js +0 -9
  161. package/cjs/resources/V2/Core/Accounts/Persons.js +0 -29
  162. package/cjs/resources/V2/Core/Accounts.js +0 -25
  163. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -33
  164. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -37
  165. package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
  166. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -29
  167. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
  168. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
  169. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -16
  170. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
  171. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
  172. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
  173. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
  174. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
  175. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
  176. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
  177. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
  178. package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
  179. package/cjs/resources/V2/Payments/OffSessionPayments.js +0 -29
  180. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
  181. package/esm/resources/AccountNotices.js +0 -18
  182. package/esm/resources/Billing/Analytics/MeterUsage.js +0 -9
  183. package/esm/resources/Capital/FinancingOffers.js +0 -18
  184. package/esm/resources/Capital/FinancingSummary.js +0 -9
  185. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  186. package/esm/resources/ExternalAccounts.js +0 -20
  187. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  188. package/esm/resources/FxQuotes.js +0 -12
  189. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  190. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  191. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  192. package/esm/resources/Margins.js +0 -19
  193. package/esm/resources/Orders.js +0 -21
  194. package/esm/resources/Privacy/RedactionJobs.js +0 -39
  195. package/esm/resources/Tax/Associations.js +0 -6
  196. package/esm/resources/Tax/Forms.js +0 -17
  197. package/esm/resources/Terminal/OnboardingLinks.js +0 -9
  198. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  199. package/esm/resources/V2/Billing/BillSettings/Versions.js +0 -14
  200. package/esm/resources/V2/Billing/BillSettings.js +0 -24
  201. package/esm/resources/V2/Billing/Cadences.js +0 -20
  202. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +0 -14
  203. package/esm/resources/V2/Billing/CollectionSettings.js +0 -27
  204. package/esm/resources/V2/Billing/Profiles.js +0 -16
  205. package/esm/resources/V2/Core/AccountLinks.js +0 -6
  206. package/esm/resources/V2/Core/Accounts/Persons.js +0 -26
  207. package/esm/resources/V2/Core/Accounts.js +0 -22
  208. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -30
  209. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -34
  210. package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
  211. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -26
  212. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
  213. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
  214. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -13
  215. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
  216. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
  217. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
  218. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
  219. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
  220. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
  221. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
  222. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
  223. package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
  224. package/esm/resources/V2/Payments/OffSessionPayments.js +0 -26
  225. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
  226. package/types/AccountNotices.d.ts +0 -113
  227. package/types/AccountNoticesResource.d.ts +0 -98
  228. package/types/Billing/Analytics/MeterUsage.d.ts +0 -31
  229. package/types/Billing/Analytics/MeterUsageResource.d.ts +0 -689
  230. package/types/Billing/Analytics/MeterUsageRows.d.ts +0 -51
  231. package/types/Capital/FinancingOffers.d.ts +0 -188
  232. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  233. package/types/Capital/FinancingSummary.d.ts +0 -106
  234. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  235. package/types/Capital/FinancingTransactions.d.ts +0 -135
  236. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  237. package/types/ExternalAccountsResource.d.ts +0 -304
  238. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  239. package/types/FinancialConnections/Institutions.d.ts +0 -98
  240. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  241. package/types/FxQuotes.d.ts +0 -155
  242. package/types/FxQuotesResource.d.ts +0 -130
  243. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  244. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  245. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
  246. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  247. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  248. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  249. package/types/Issuing/Settlements.d.ts +0 -113
  250. package/types/Margins.d.ts +0 -56
  251. package/types/MarginsResource.d.ts +0 -114
  252. package/types/Orders.d.ts +0 -1163
  253. package/types/OrdersResource.d.ts +0 -3139
  254. package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -60
  255. package/types/Privacy/RedactionJobs.d.ts +0 -111
  256. package/types/Privacy/RedactionJobsResource.d.ts +0 -230
  257. package/types/QuoteLines.d.ts +0 -634
  258. package/types/QuotePreviewInvoices.d.ts +0 -1771
  259. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -908
  260. package/types/Tax/Associations.d.ts +0 -82
  261. package/types/Tax/AssociationsResource.d.ts +0 -29
  262. package/types/Tax/Forms.d.ts +0 -220
  263. package/types/Tax/FormsResource.d.ts +0 -107
  264. package/types/Terminal/OnboardingLinks.d.ts +0 -57
  265. package/types/Terminal/OnboardingLinksResource.d.ts +0 -62
  266. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  267. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  268. package/types/V2/Billing/BillSettingVersions.d.ts +0 -97
  269. package/types/V2/Billing/BillSettings/VersionsResource.d.ts +0 -58
  270. package/types/V2/Billing/BillSettings.d.ts +0 -120
  271. package/types/V2/Billing/BillSettingsResource.d.ts +0 -241
  272. package/types/V2/Billing/Cadences.d.ts +0 -686
  273. package/types/V2/Billing/CadencesResource.d.ts +0 -487
  274. package/types/V2/Billing/CollectionSettingVersions.d.ts +0 -314
  275. package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +0 -62
  276. package/types/V2/Billing/CollectionSettings.d.ts +0 -337
  277. package/types/V2/Billing/CollectionSettingsResource.d.ts +0 -675
  278. package/types/V2/Billing/Profiles.d.ts +0 -70
  279. package/types/V2/Billing/ProfilesResource.d.ts +0 -150
  280. package/types/V2/Core/AccountLinks.d.ts +0 -168
  281. package/types/V2/Core/AccountLinksResource.d.ts +0 -152
  282. package/types/V2/Core/AccountPersons.d.ts +0 -615
  283. package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -1153
  284. package/types/V2/Core/Accounts.d.ts +0 -6010
  285. package/types/V2/Core/AccountsResource.d.ts +0 -5104
  286. package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
  287. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -194
  288. package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -116
  289. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -198
  290. package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -27
  291. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -32
  292. package/types/V2/MoneyManagement/Adjustments.d.ts +0 -110
  293. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
  294. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -148
  295. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -172
  296. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -178
  297. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -112
  298. package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -206
  299. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
  300. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -170
  301. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -115
  302. package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -278
  303. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
  304. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
  305. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
  306. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -251
  307. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -208
  308. package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -160
  309. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +0 -93
  310. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
  311. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
  312. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -302
  313. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
  314. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -176
  315. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
  316. package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -162
  317. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
  318. package/types/V2/MoneyManagement/Transactions.d.ts +0 -177
  319. package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
  320. package/types/V2/Payments/OffSessionPayments.d.ts +0 -326
  321. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +0 -401
  322. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -68
@@ -1,401 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace V2 {
6
- namespace Payments {
7
- interface OffSessionPaymentCreateParams {
8
- /**
9
- * The “presentment amount” to be collected from the customer.
10
- */
11
- amount: Amount;
12
-
13
- /**
14
- * The frequency of the underlying payment.
15
- */
16
- cadence: OffSessionPaymentCreateParams.Cadence;
17
-
18
- /**
19
- * ID of the Customer to which this OffSessionPayment belongs.
20
- */
21
- customer: string;
22
-
23
- /**
24
- * Set of [key-value pairs](https://docs.corp.stripe.com/api/metadata) that you can
25
- * attach to an object. This can be useful for storing additional information about
26
- * the object in a structured format. Learn more about
27
- * [storing information in metadata](https://docs.corp.stripe.com/payments/payment-intents#storing-information-in-metadata).
28
- */
29
- metadata: Stripe.MetadataParam;
30
-
31
- /**
32
- * ID of the payment method used in this OffSessionPayment.
33
- */
34
- payment_method: string;
35
-
36
- /**
37
- * Provides industry-specific information about the amount.
38
- */
39
- amount_details?: OffSessionPaymentCreateParams.AmountDetails;
40
-
41
- /**
42
- * Details about the capture configuration for the OffSessionPayment.
43
- */
44
- capture?: OffSessionPaymentCreateParams.Capture;
45
-
46
- /**
47
- * Whether the OffSessionPayment should be captured automatically or manually.
48
- */
49
- capture_method?: OffSessionPaymentCreateParams.CaptureMethod;
50
-
51
- /**
52
- * The account (if any) for which the funds of the OffSessionPayment are intended.
53
- */
54
- on_behalf_of?: string;
55
-
56
- /**
57
- * Payment method options for the off-session payment.
58
- */
59
- payment_method_options?: OffSessionPaymentCreateParams.PaymentMethodOptions;
60
-
61
- /**
62
- * Details about the payments orchestration configuration.
63
- */
64
- payments_orchestration?: OffSessionPaymentCreateParams.PaymentsOrchestration;
65
-
66
- /**
67
- * Details about the OffSessionPayment retries.
68
- */
69
- retry_details?: OffSessionPaymentCreateParams.RetryDetails;
70
-
71
- /**
72
- * Text that appears on the customer's statement as the statement descriptor for a
73
- * non-card charge. This value overrides the account's default statement descriptor.
74
- * For information about requirements, including the 22-character limit, see the
75
- * [Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
76
- */
77
- statement_descriptor?: string;
78
-
79
- /**
80
- * Provides information about a card charge. Concatenated to the account's
81
- * [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
82
- * to form the complete statement descriptor that appears on the customer's statement.
83
- */
84
- statement_descriptor_suffix?: string;
85
-
86
- /**
87
- * Test clock that can be used to advance the retry attempts in a sandbox.
88
- */
89
- test_clock?: string;
90
-
91
- /**
92
- * The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for [connected accounts](https://docs.corp.stripe.com/payments/connected-accounts).
93
- */
94
- transfer_data?: OffSessionPaymentCreateParams.TransferData;
95
- }
96
-
97
- namespace OffSessionPaymentCreateParams {
98
- interface AmountDetails {
99
- /**
100
- * The amount the total transaction was discounted for.
101
- */
102
- discount_amount?: number;
103
-
104
- /**
105
- * A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
106
- */
107
- line_items: Array<AmountDetails.LineItem>;
108
-
109
- /**
110
- * Contains information about the shipping portion of the amount.
111
- */
112
- shipping?: AmountDetails.Shipping;
113
-
114
- /**
115
- * Contains information about the tax portion of the amount.
116
- */
117
- tax?: AmountDetails.Tax;
118
- }
119
-
120
- namespace AmountDetails {
121
- interface LineItem {
122
- /**
123
- * The amount an item was discounted for. Positive integer.
124
- */
125
- discount_amount?: number;
126
-
127
- /**
128
- * Unique identifier of the product. At most 12 characters long.
129
- */
130
- product_code?: string;
131
-
132
- /**
133
- * Name of the product. At most 100 characters long.
134
- */
135
- product_name: string;
136
-
137
- /**
138
- * Number of items of the product. Positive integer.
139
- */
140
- quantity: number;
141
-
142
- /**
143
- * Contains information about the tax on the item.
144
- */
145
- tax?: LineItem.Tax;
146
-
147
- /**
148
- * Cost of the product. Non-negative integer.
149
- */
150
- unit_cost: number;
151
- }
152
-
153
- namespace LineItem {
154
- interface Tax {
155
- /**
156
- * Total portion of the amount that is for tax.
157
- */
158
- total_tax_amount?: number;
159
- }
160
- }
161
-
162
- interface Shipping {
163
- /**
164
- * Portion of the amount that is for shipping.
165
- */
166
- amount?: number;
167
-
168
- /**
169
- * The postal code that represents the shipping source.
170
- */
171
- from_postal_code?: string;
172
-
173
- /**
174
- * The postal code that represents the shipping destination.
175
- */
176
- to_postal_code?: string;
177
- }
178
-
179
- interface Tax {
180
- /**
181
- * Total portion of the amount that is for tax.
182
- */
183
- total_tax_amount?: number;
184
- }
185
- }
186
-
187
- type Cadence = 'recurring' | 'unscheduled';
188
-
189
- interface Capture {
190
- /**
191
- * The method to use to capture the payment.
192
- */
193
- capture_method: Capture.CaptureMethod;
194
- }
195
-
196
- namespace Capture {
197
- type CaptureMethod = 'automatic' | 'manual';
198
- }
199
-
200
- type CaptureMethod = 'automatic' | 'manual';
201
-
202
- interface PaymentMethodOptions {
203
- /**
204
- * Payment method options for the card payment type.
205
- */
206
- card?: PaymentMethodOptions.Card;
207
- }
208
-
209
- namespace PaymentMethodOptions {
210
- interface Card {
211
- /**
212
- * If you are making a Credential On File transaction with a previously saved card, you should pass the Network Transaction ID
213
- * from a prior initial authorization on Stripe (from a successful SetupIntent or a PaymentIntent with `setup_future_usage` set),
214
- * or one that you have obtained from another payment processor. This is a token from the network which uniquely identifies the transaction.
215
- * Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.
216
- * Note that you should pass in a Network Transaction ID if you have one, regardless of whether this is a
217
- * Customer-Initiated Transaction (CIT) or a Merchant-Initiated Transaction (MIT).
218
- */
219
- network_transaction_id: string;
220
- }
221
- }
222
-
223
- interface PaymentsOrchestration {
224
- /**
225
- * True when you want to enable payments orchestration for this off-session payment. False otherwise.
226
- */
227
- enabled: boolean;
228
- }
229
-
230
- interface RetryDetails {
231
- /**
232
- * The pre-configured retry policy to use for the payment.
233
- */
234
- retry_policy?: string;
235
-
236
- /**
237
- * Indicates the strategy for how you want Stripe to retry the payment.
238
- */
239
- retry_strategy: RetryDetails.RetryStrategy;
240
- }
241
-
242
- namespace RetryDetails {
243
- type RetryStrategy = 'heuristic' | 'none' | 'scheduled' | 'smart';
244
- }
245
-
246
- interface TransferData {
247
- /**
248
- * The amount transferred to the destination account. This transfer will occur
249
- * automatically after the payment succeeds. If no amount is specified, by default
250
- * the entire payment amount is transferred to the destination account. The amount
251
- * must be less than or equal to the
252
- * [amount_requested](https://docs.corp.stripe.com/api/v2/off-session-payments/object?api-version=2025-05-28.preview#v2_off_session_payment_object-amount_requested),
253
- * and must be a positive integer representing how much to transfer in the smallest
254
- * currency unit (e.g., 100 cents to charge $1.00).
255
- */
256
- amount?: number;
257
-
258
- /**
259
- * The account (if any) that the payment is attributed to for tax reporting, and
260
- * where funds from the payment are transferred to after payment success.
261
- */
262
- destination: string;
263
- }
264
- }
265
- }
266
-
267
- namespace Payments {
268
- interface OffSessionPaymentRetrieveParams {}
269
- }
270
-
271
- namespace Payments {
272
- interface OffSessionPaymentListParams {
273
- /**
274
- * The page size limit. If not provided, the default is 20.
275
- */
276
- limit?: number;
277
- }
278
- }
279
-
280
- namespace Payments {
281
- interface OffSessionPaymentCancelParams {}
282
- }
283
-
284
- namespace Payments {
285
- interface OffSessionPaymentCaptureParams {
286
- /**
287
- * The amount to capture.
288
- */
289
- amount_to_capture: number;
290
-
291
- /**
292
- * Set of [key-value pairs](https://docs.corp.stripe.com/api/metadata) that you can
293
- * attach to an object. This can be useful for storing additional information about
294
- * the object in a structured format. Learn more about
295
- * [storing information in metadata](https://docs.corp.stripe.com/payments/payment-intents#storing-information-in-metadata).
296
- */
297
- metadata: Stripe.MetadataParam;
298
-
299
- /**
300
- * Text that appears on the customer's statement as the statement descriptor for a
301
- * non-card charge. This value overrides the account's default statement descriptor.
302
- * For information about requirements, including the 22-character limit, see the
303
- * [Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
304
- */
305
- statement_descriptor?: string;
306
-
307
- /**
308
- * Provides information about a card charge. Concatenated to the account's
309
- * [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
310
- * to form the complete statement descriptor that appears on the customer's statement.
311
- */
312
- statement_descriptor_suffix?: string;
313
-
314
- /**
315
- * The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for [connected accounts](https://docs.corp.stripe.com/payments/connected-accounts).
316
- */
317
- transfer_data?: OffSessionPaymentCaptureParams.TransferData;
318
- }
319
-
320
- namespace OffSessionPaymentCaptureParams {
321
- interface TransferData {
322
- /**
323
- * The amount transferred to the destination account. This transfer will occur
324
- * automatically after the payment succeeds. If no amount is specified, by default
325
- * the entire payment amount is transferred to the destination account. The amount
326
- * must be less than or equal to the
327
- * [amount_requested](https://docs.corp.stripe.com/api/v2/off-session-payments/object?api-version=2025-05-28.preview#v2_off_session_payment_object-amount_requested),
328
- * and must be a positive integer representing how much to transfer in the smallest
329
- * currency unit (e.g., 100 cents to charge $1.00).
330
- */
331
- amount?: number;
332
-
333
- /**
334
- * The account (if any) that the payment is attributed to for tax reporting, and
335
- * where funds from the payment are transferred to after payment success.
336
- */
337
- destination: string;
338
- }
339
- }
340
- }
341
-
342
- namespace Payments {
343
- class OffSessionPaymentsResource {
344
- /**
345
- * Creates an OffSessionPayment object.
346
- */
347
- create(
348
- params: OffSessionPaymentCreateParams,
349
- options?: RequestOptions
350
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
351
-
352
- /**
353
- * Retrieves the details of an OffSessionPayment that has previously been created.
354
- */
355
- retrieve(
356
- id: string,
357
- params?: OffSessionPaymentRetrieveParams,
358
- options?: RequestOptions
359
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
360
- retrieve(
361
- id: string,
362
- options?: RequestOptions
363
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
364
-
365
- /**
366
- * Returns a list of OffSessionPayments matching a filter.
367
- */
368
- list(
369
- params?: OffSessionPaymentListParams,
370
- options?: RequestOptions
371
- ): ApiListPromise<Stripe.V2.Payments.OffSessionPayment>;
372
- list(
373
- options?: RequestOptions
374
- ): ApiListPromise<Stripe.V2.Payments.OffSessionPayment>;
375
-
376
- /**
377
- * Cancel an OffSessionPayment that has previously been created.
378
- */
379
- cancel(
380
- id: string,
381
- params?: OffSessionPaymentCancelParams,
382
- options?: RequestOptions
383
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
384
- cancel(
385
- id: string,
386
- options?: RequestOptions
387
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
388
-
389
- /**
390
- * Captures an OffSessionPayment that has previously been created.
391
- */
392
- capture(
393
- id: string,
394
- params: OffSessionPaymentCaptureParams,
395
- options?: RequestOptions
396
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
397
- }
398
- }
399
- }
400
- }
401
- }
@@ -1,68 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace V2 {
6
- namespace TestHelpers {
7
- interface FinancialAddressCreditParams {
8
- /**
9
- * Object containing the amount value and currency to credit.
10
- */
11
- amount: Amount;
12
-
13
- /**
14
- * Open Enum. The network to use in simulating the funds flow. This will be the reflected in the resulting ReceivedCredit.
15
- */
16
- network: FinancialAddressCreditParams.Network;
17
-
18
- /**
19
- * String explaining funds flow. Use this field to populate the statement descriptor of the ReceivedCredit created as an eventual result of this simulation.
20
- */
21
- statement_descriptor?: string;
22
- }
23
-
24
- namespace FinancialAddressCreditParams {
25
- type Network = 'ach' | 'fps' | 'rtp' | 'wire';
26
- }
27
- }
28
-
29
- namespace TestHelpers {
30
- interface FinancialAddressGenerateMicrodepositsParams {}
31
- }
32
-
33
- namespace TestHelpers {
34
- class FinancialAddressesResource {
35
- /**
36
- * Simulate crediting a FinancialAddress in a Sandbox environment. This can be used to add virtual funds and increase your balance for testing.
37
- * @throws Stripe.FeatureNotEnabledError
38
- */
39
- credit(
40
- id: string,
41
- params: FinancialAddressCreditParams,
42
- options?: RequestOptions
43
- ): Promise<
44
- Stripe.Response<Stripe.V2.FinancialAddressCreditSimulation>
45
- >;
46
-
47
- /**
48
- * Generates microdeposits for a FinancialAddress in a Sandbox environment.
49
- * @throws Stripe.FeatureNotEnabledError
50
- */
51
- generateMicrodeposits(
52
- id: string,
53
- params?: FinancialAddressGenerateMicrodepositsParams,
54
- options?: RequestOptions
55
- ): Promise<
56
- Stripe.Response<Stripe.V2.FinancialAddressGeneratedMicrodeposits>
57
- >;
58
- generateMicrodeposits(
59
- id: string,
60
- options?: RequestOptions
61
- ): Promise<
62
- Stripe.Response<Stripe.V2.FinancialAddressGeneratedMicrodeposits>
63
- >;
64
- }
65
- }
66
- }
67
- }
68
- }