stripe 20.0.0 → 20.1.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (444) hide show
  1. package/CHANGELOG.md +1790 -12
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +1 -0
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +115 -1
  6. package/cjs/apiVersion.js +2 -3
  7. package/cjs/resources/AccountNotices.js +21 -0
  8. package/cjs/resources/BalanceTransfers.js +9 -0
  9. package/cjs/resources/Billing/Analytics/MeterUsage.js +12 -0
  10. package/cjs/resources/Capital/FinancingOffers.js +21 -0
  11. package/cjs/resources/Capital/FinancingSummary.js +12 -0
  12. package/cjs/resources/Capital/FinancingTransactions.js +17 -0
  13. package/cjs/resources/DelegatedCheckout/RequestedSessions.js +28 -0
  14. package/cjs/resources/ExternalAccounts.js +23 -0
  15. package/cjs/resources/FinancialConnections/Accounts.js +5 -0
  16. package/cjs/resources/FinancialConnections/Institutions.js +17 -0
  17. package/cjs/resources/FxQuotes.js +15 -0
  18. package/cjs/resources/Identity/BlocklistEntries.js +25 -0
  19. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
  20. package/cjs/resources/Issuing/DisputeSettlementDetails.js +17 -0
  21. package/cjs/resources/Issuing/FraudLiabilityDebits.js +17 -0
  22. package/cjs/resources/Issuing/Programs.js +22 -0
  23. package/cjs/resources/Mandates.js +5 -0
  24. package/cjs/resources/Margins.js +22 -0
  25. package/cjs/resources/Orders.js +24 -0
  26. package/cjs/resources/PaymentIntents.js +8 -0
  27. package/cjs/resources/PaymentMethods.js +4 -0
  28. package/cjs/resources/Privacy/RedactionJobs.js +42 -0
  29. package/cjs/resources/Quotes.js +32 -0
  30. package/cjs/resources/Radar/AccountEvaluations.js +20 -0
  31. package/cjs/resources/SubscriptionSchedules.js +4 -0
  32. package/cjs/resources/Subscriptions.js +4 -0
  33. package/cjs/resources/Tax/Forms.js +20 -0
  34. package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
  35. package/cjs/resources/TestHelpers/Capital/FinancingOffers.js +16 -0
  36. package/cjs/resources/V2/Billing/BillSettings/Versions.js +17 -0
  37. package/cjs/resources/V2/Billing/BillSettings.js +27 -0
  38. package/cjs/resources/V2/Billing/Cadences.js +23 -0
  39. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +17 -0
  40. package/cjs/resources/V2/Billing/CollectionSettings.js +30 -0
  41. package/cjs/resources/V2/Billing/CustomPricingUnits.js +25 -0
  42. package/cjs/resources/V2/Billing/Intents/Actions.js +17 -0
  43. package/cjs/resources/V2/Billing/Intents.js +36 -0
  44. package/cjs/resources/V2/Billing/LicenseFeeSubscriptions.js +12 -0
  45. package/cjs/resources/V2/Billing/LicenseFees/Versions.js +17 -0
  46. package/cjs/resources/V2/Billing/LicenseFees.js +27 -0
  47. package/cjs/resources/V2/Billing/LicensedItems.js +25 -0
  48. package/cjs/resources/V2/Billing/MeteredItems.js +22 -0
  49. package/cjs/resources/V2/Billing/PricingPlanSubscriptions/Components.js +12 -0
  50. package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +26 -0
  51. package/cjs/resources/V2/Billing/PricingPlans/Components.js +29 -0
  52. package/cjs/resources/V2/Billing/PricingPlans/Versions.js +17 -0
  53. package/cjs/resources/V2/Billing/PricingPlans.js +29 -0
  54. package/cjs/resources/V2/Billing/Profiles.js +19 -0
  55. package/cjs/resources/V2/Billing/RateCardSubscriptions.js +29 -0
  56. package/cjs/resources/V2/Billing/RateCards/Rates.js +25 -0
  57. package/cjs/resources/V2/Billing/RateCards/Versions.js +17 -0
  58. package/cjs/resources/V2/Billing/RateCards.js +29 -0
  59. package/cjs/resources/V2/Billing/ServiceActions.js +20 -0
  60. package/cjs/resources/V2/Core/AccountLinks.js +9 -0
  61. package/cjs/resources/V2/Core/Accounts/Persons.js +29 -0
  62. package/cjs/resources/V2/Core/Accounts.js +25 -0
  63. package/cjs/resources/V2/Core/ClaimableSandboxes.js +16 -0
  64. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +33 -0
  65. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +37 -0
  66. package/cjs/resources/V2/MoneyManagement/Adjustments.js +17 -0
  67. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +29 -0
  68. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +21 -0
  69. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +21 -0
  70. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +16 -0
  71. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +25 -0
  72. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +29 -0
  73. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +25 -0
  74. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +25 -0
  75. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +12 -0
  76. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +17 -0
  77. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +17 -0
  78. package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js +20 -0
  79. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +17 -0
  80. package/cjs/resources/V2/MoneyManagement/Transactions.js +17 -0
  81. package/cjs/resources/V2/Payments/OffSessionPayments.js +29 -0
  82. package/cjs/resources/V2/Reporting/ReportRuns.js +13 -0
  83. package/cjs/resources/V2/Reporting/Reports.js +12 -0
  84. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +16 -0
  85. package/cjs/resources/V2/TestHelpers/MoneyManagement.js +12 -0
  86. package/cjs/resources.js +152 -8
  87. package/cjs/stripe.core.js +1 -1
  88. package/esm/Error.js +100 -0
  89. package/esm/apiVersion.js +1 -2
  90. package/esm/resources/AccountNotices.js +18 -0
  91. package/esm/resources/BalanceTransfers.js +6 -0
  92. package/esm/resources/Billing/Analytics/MeterUsage.js +9 -0
  93. package/esm/resources/Capital/FinancingOffers.js +18 -0
  94. package/esm/resources/Capital/FinancingSummary.js +9 -0
  95. package/esm/resources/Capital/FinancingTransactions.js +14 -0
  96. package/esm/resources/DelegatedCheckout/RequestedSessions.js +25 -0
  97. package/esm/resources/ExternalAccounts.js +20 -0
  98. package/esm/resources/FinancialConnections/Accounts.js +5 -0
  99. package/esm/resources/FinancialConnections/Institutions.js +14 -0
  100. package/esm/resources/FxQuotes.js +12 -0
  101. package/esm/resources/Identity/BlocklistEntries.js +22 -0
  102. package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
  103. package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
  104. package/esm/resources/Issuing/FraudLiabilityDebits.js +14 -0
  105. package/esm/resources/Issuing/Programs.js +19 -0
  106. package/esm/resources/Mandates.js +5 -0
  107. package/esm/resources/Margins.js +19 -0
  108. package/esm/resources/Orders.js +21 -0
  109. package/esm/resources/PaymentIntents.js +8 -0
  110. package/esm/resources/PaymentMethods.js +4 -0
  111. package/esm/resources/Privacy/RedactionJobs.js +39 -0
  112. package/esm/resources/Quotes.js +32 -0
  113. package/esm/resources/Radar/AccountEvaluations.js +17 -0
  114. package/esm/resources/SubscriptionSchedules.js +4 -0
  115. package/esm/resources/Subscriptions.js +4 -0
  116. package/esm/resources/Tax/Forms.js +17 -0
  117. package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
  118. package/esm/resources/TestHelpers/Capital/FinancingOffers.js +13 -0
  119. package/esm/resources/V2/Billing/BillSettings/Versions.js +14 -0
  120. package/esm/resources/V2/Billing/BillSettings.js +24 -0
  121. package/esm/resources/V2/Billing/Cadences.js +20 -0
  122. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +14 -0
  123. package/esm/resources/V2/Billing/CollectionSettings.js +27 -0
  124. package/esm/resources/V2/Billing/CustomPricingUnits.js +22 -0
  125. package/esm/resources/V2/Billing/Intents/Actions.js +14 -0
  126. package/esm/resources/V2/Billing/Intents.js +33 -0
  127. package/esm/resources/V2/Billing/LicenseFeeSubscriptions.js +9 -0
  128. package/esm/resources/V2/Billing/LicenseFees/Versions.js +14 -0
  129. package/esm/resources/V2/Billing/LicenseFees.js +24 -0
  130. package/esm/resources/V2/Billing/LicensedItems.js +22 -0
  131. package/esm/resources/V2/Billing/MeteredItems.js +19 -0
  132. package/esm/resources/V2/Billing/PricingPlanSubscriptions/Components.js +9 -0
  133. package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +23 -0
  134. package/esm/resources/V2/Billing/PricingPlans/Components.js +26 -0
  135. package/esm/resources/V2/Billing/PricingPlans/Versions.js +14 -0
  136. package/esm/resources/V2/Billing/PricingPlans.js +26 -0
  137. package/esm/resources/V2/Billing/Profiles.js +16 -0
  138. package/esm/resources/V2/Billing/RateCardSubscriptions.js +26 -0
  139. package/esm/resources/V2/Billing/RateCards/Rates.js +22 -0
  140. package/esm/resources/V2/Billing/RateCards/Versions.js +14 -0
  141. package/esm/resources/V2/Billing/RateCards.js +26 -0
  142. package/esm/resources/V2/Billing/ServiceActions.js +17 -0
  143. package/esm/resources/V2/Core/AccountLinks.js +6 -0
  144. package/esm/resources/V2/Core/Accounts/Persons.js +26 -0
  145. package/esm/resources/V2/Core/Accounts.js +22 -0
  146. package/esm/resources/V2/Core/ClaimableSandboxes.js +13 -0
  147. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +30 -0
  148. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +34 -0
  149. package/esm/resources/V2/MoneyManagement/Adjustments.js +14 -0
  150. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +26 -0
  151. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +18 -0
  152. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +18 -0
  153. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +13 -0
  154. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +22 -0
  155. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +26 -0
  156. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +22 -0
  157. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +22 -0
  158. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +9 -0
  159. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +14 -0
  160. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +14 -0
  161. package/esm/resources/V2/MoneyManagement/RecipientVerifications.js +17 -0
  162. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +14 -0
  163. package/esm/resources/V2/MoneyManagement/Transactions.js +14 -0
  164. package/esm/resources/V2/Payments/OffSessionPayments.js +26 -0
  165. package/esm/resources/V2/Reporting/ReportRuns.js +10 -0
  166. package/esm/resources/V2/Reporting/Reports.js +9 -0
  167. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +13 -0
  168. package/esm/resources/V2/TestHelpers/MoneyManagement.js +9 -0
  169. package/esm/resources.js +138 -0
  170. package/esm/stripe.core.js +1 -1
  171. package/package.json +1 -1
  172. package/types/AccountLinksResource.d.ts +5 -1
  173. package/types/AccountNotices.d.ts +113 -0
  174. package/types/AccountNoticesResource.d.ts +98 -0
  175. package/types/AccountSessions.d.ts +45 -0
  176. package/types/AccountSessionsResource.d.ts +264 -0
  177. package/types/Accounts.d.ts +232 -1
  178. package/types/AccountsResource.d.ts +674 -0
  179. package/types/ApplicationFees.d.ts +6 -1
  180. package/types/Balance.d.ts +82 -0
  181. package/types/BalanceTransactions.d.ts +2 -1
  182. package/types/BalanceTransfers.d.ts +122 -0
  183. package/types/BalanceTransfersResource.d.ts +87 -0
  184. package/types/BankAccounts.d.ts +2 -0
  185. package/types/Billing/AlertTriggereds.d.ts +16 -1
  186. package/types/Billing/Alerts.d.ts +116 -1
  187. package/types/Billing/AlertsResource.d.ts +149 -2
  188. package/types/Billing/Analytics/MeterUsage.d.ts +31 -0
  189. package/types/Billing/Analytics/MeterUsageResource.d.ts +694 -0
  190. package/types/Billing/Analytics/MeterUsageRows.d.ts +58 -0
  191. package/types/Billing/CreditBalanceSummary.d.ts +123 -2
  192. package/types/Billing/CreditBalanceSummaryResource.d.ts +20 -3
  193. package/types/Billing/CreditBalanceTransactions.d.ts +118 -2
  194. package/types/Billing/CreditBalanceTransactionsResource.d.ts +12 -4
  195. package/types/Billing/CreditGrants.d.ts +76 -1
  196. package/types/Billing/CreditGrantsResource.d.ts +45 -4
  197. package/types/Billing/MeterEventSummaries.d.ts +7 -0
  198. package/types/Billing/Meters.d.ts +5 -0
  199. package/types/Billing/MetersResource.d.ts +17 -0
  200. package/types/BillingPortal/Sessions.d.ts +5 -0
  201. package/types/BillingPortal/SessionsResource.d.ts +12 -4
  202. package/types/Capabilities.d.ts +2 -0
  203. package/types/Capital/FinancingOffers.d.ts +188 -0
  204. package/types/Capital/FinancingOffersResource.d.ts +97 -0
  205. package/types/Capital/FinancingSummary.d.ts +106 -0
  206. package/types/Capital/FinancingSummaryResource.d.ts +27 -0
  207. package/types/Capital/FinancingTransactions.d.ts +135 -0
  208. package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
  209. package/types/Cards.d.ts +19 -0
  210. package/types/CashBalances.d.ts +5 -0
  211. package/types/Charges.d.ts +190 -0
  212. package/types/ChargesResource.d.ts +3855 -75
  213. package/types/Checkout/Sessions.d.ts +427 -2
  214. package/types/Checkout/SessionsResource.d.ts +682 -2
  215. package/types/ConfirmationTokens.d.ts +139 -0
  216. package/types/Coupons.d.ts +35 -0
  217. package/types/CouponsResource.d.ts +23 -0
  218. package/types/CreditNoteLineItems.d.ts +17 -0
  219. package/types/CreditNotes.d.ts +5 -0
  220. package/types/CreditNotesResource.d.ts +5 -0
  221. package/types/CustomerBalanceTransactions.d.ts +2 -0
  222. package/types/CustomerCashBalanceTransactions.d.ts +2 -0
  223. package/types/CustomerSessions.d.ts +46 -0
  224. package/types/CustomerSessionsResource.d.ts +47 -1
  225. package/types/Customers.d.ts +2 -0
  226. package/types/CustomersResource.d.ts +8 -0
  227. package/types/DelegatedCheckout/RequestedSessions.d.ts +384 -0
  228. package/types/DelegatedCheckout/RequestedSessionsResource.d.ts +599 -0
  229. package/types/Discounts.d.ts +20 -0
  230. package/types/Disputes.d.ts +40 -0
  231. package/types/DisputesResource.d.ts +11 -0
  232. package/types/Errors.d.ts +85 -0
  233. package/types/EventTypes.d.ts +630 -0
  234. package/types/Events.d.ts +96 -0
  235. package/types/ExternalAccountsResource.d.ts +304 -0
  236. package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
  237. package/types/FinancialConnections/Accounts.d.ts +36 -1
  238. package/types/FinancialConnections/AccountsResource.d.ts +40 -3
  239. package/types/FinancialConnections/Institutions.d.ts +98 -0
  240. package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
  241. package/types/FinancialConnections/Sessions.d.ts +51 -1
  242. package/types/FinancialConnections/SessionsResource.d.ts +43 -1
  243. package/types/FxQuotes.d.ts +155 -0
  244. package/types/FxQuotesResource.d.ts +130 -0
  245. package/types/Identity/BlocklistEntries.d.ts +78 -0
  246. package/types/Identity/BlocklistEntriesResource.d.ts +146 -0
  247. package/types/Identity/VerificationReports.d.ts +10 -0
  248. package/types/Identity/VerificationReportsResource.d.ts +5 -0
  249. package/types/Identity/VerificationSessions.d.ts +5 -0
  250. package/types/Identity/VerificationSessionsResource.d.ts +7 -0
  251. package/types/InvoiceItems.d.ts +127 -2
  252. package/types/InvoiceItemsResource.d.ts +117 -6
  253. package/types/InvoiceLineItems.d.ts +171 -3
  254. package/types/Invoices.d.ts +216 -4
  255. package/types/InvoicesResource.d.ts +1743 -2
  256. package/types/Issuing/CardholdersResource.d.ts +2 -1
  257. package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
  258. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
  259. package/types/Issuing/DisputeSettlementDetails.d.ts +85 -0
  260. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
  261. package/types/Issuing/FraudLiabilityDebits.d.ts +52 -0
  262. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +52 -0
  263. package/types/Issuing/Programs.d.ts +42 -0
  264. package/types/Issuing/ProgramsResource.d.ts +96 -0
  265. package/types/Issuing/Settlements.d.ts +113 -0
  266. package/types/Issuing/Transactions.d.ts +5 -0
  267. package/types/Issuing/TransactionsResource.d.ts +5 -0
  268. package/types/LineItems.d.ts +49 -0
  269. package/types/Mandates.d.ts +135 -1
  270. package/types/MandatesResource.d.ts +31 -0
  271. package/types/Margins.d.ts +56 -0
  272. package/types/MarginsResource.d.ts +114 -0
  273. package/types/Orders.d.ts +1163 -0
  274. package/types/OrdersResource.d.ts +5505 -0
  275. package/types/PaymentAttemptRecords.d.ts +141 -0
  276. package/types/PaymentIntents.d.ts +779 -3
  277. package/types/PaymentIntentsResource.d.ts +19573 -6528
  278. package/types/PaymentLinks.d.ts +6 -0
  279. package/types/PaymentLinksResource.d.ts +12 -0
  280. package/types/PaymentMethodBalances.d.ts +63 -0
  281. package/types/PaymentMethodConfigurations.d.ts +216 -0
  282. package/types/PaymentMethodConfigurationsResource.d.ts +300 -0
  283. package/types/PaymentMethods.d.ts +144 -0
  284. package/types/PaymentMethodsResource.d.ts +199 -2
  285. package/types/PaymentRecords.d.ts +141 -0
  286. package/types/Persons.d.ts +30 -0
  287. package/types/Prices.d.ts +22 -0
  288. package/types/PricesResource.d.ts +22 -0
  289. package/types/Privacy/RedactionJobValidationErrors.d.ts +60 -0
  290. package/types/Privacy/RedactionJobs.d.ts +111 -0
  291. package/types/Privacy/RedactionJobsResource.d.ts +230 -0
  292. package/types/PromotionCodes.d.ts +5 -0
  293. package/types/PromotionCodesResource.d.ts +10 -0
  294. package/types/QuoteLines.d.ts +634 -0
  295. package/types/QuotePreviewInvoices.d.ts +1784 -0
  296. package/types/QuotePreviewSubscriptionSchedules.d.ts +1108 -0
  297. package/types/Quotes.d.ts +982 -1
  298. package/types/QuotesResource.d.ts +3226 -293
  299. package/types/Radar/AccountEvaluations.d.ts +88 -0
  300. package/types/Radar/AccountEvaluationsResource.d.ts +148 -0
  301. package/types/Refunds.d.ts +14 -0
  302. package/types/SetupAttempts.d.ts +51 -1
  303. package/types/SetupIntents.d.ts +239 -2
  304. package/types/SetupIntentsResource.d.ts +1044 -4
  305. package/types/Sources.d.ts +29 -0
  306. package/types/SubscriptionItems.d.ts +26 -0
  307. package/types/SubscriptionItemsResource.d.ts +109 -0
  308. package/types/SubscriptionSchedules.d.ts +403 -0
  309. package/types/SubscriptionSchedulesResource.d.ts +1437 -0
  310. package/types/Subscriptions.d.ts +370 -1
  311. package/types/SubscriptionsResource.d.ts +757 -8
  312. package/types/Tax/Forms.d.ts +220 -0
  313. package/types/Tax/FormsResource.d.ts +107 -0
  314. package/types/TaxIds.d.ts +10 -0
  315. package/types/TaxIdsResource.d.ts +10 -0
  316. package/types/Terminal/Configurations.d.ts +9 -0
  317. package/types/Terminal/ConfigurationsResource.d.ts +28 -0
  318. package/types/Terminal/ReaderCollectedData.d.ts +51 -0
  319. package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
  320. package/types/Terminal/Readers.d.ts +20 -0
  321. package/types/TestHelpers/Capital/FinancingOffersResource.d.ts +130 -0
  322. package/types/TestHelpers/ConfirmationTokensResource.d.ts +126 -0
  323. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
  324. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
  325. package/types/TokensResource.d.ts +44 -0
  326. package/types/Transfers.d.ts +9 -0
  327. package/types/TransfersResource.d.ts +7 -0
  328. package/types/TransitBalances.d.ts +40 -0
  329. package/types/Treasury/FinancialAccountFeatures.d.ts +7 -0
  330. package/types/Treasury/FinancialAccounts.d.ts +5 -0
  331. package/types/Treasury/FinancialAccountsResource.d.ts +37 -0
  332. package/types/Treasury/OutboundTransfers.d.ts +26 -0
  333. package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
  334. package/types/Treasury/ReceivedCredits.d.ts +26 -0
  335. package/types/Treasury/ReceivedDebits.d.ts +31 -0
  336. package/types/V2/Billing/BillSettingVersions.d.ts +97 -0
  337. package/types/V2/Billing/BillSettings/VersionsResource.d.ts +58 -0
  338. package/types/V2/Billing/BillSettings.d.ts +120 -0
  339. package/types/V2/Billing/BillSettingsResource.d.ts +241 -0
  340. package/types/V2/Billing/Cadences.d.ts +735 -0
  341. package/types/V2/Billing/CadencesResource.d.ts +516 -0
  342. package/types/V2/Billing/CollectionSettingVersions.d.ts +318 -0
  343. package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +62 -0
  344. package/types/V2/Billing/CollectionSettings.d.ts +341 -0
  345. package/types/V2/Billing/CollectionSettingsResource.d.ts +683 -0
  346. package/types/V2/Billing/CustomPricingUnits.d.ts +56 -0
  347. package/types/V2/Billing/CustomPricingUnitsResource.d.ts +122 -0
  348. package/types/V2/Billing/IntentActions.d.ts +459 -0
  349. package/types/V2/Billing/Intents/ActionsResource.d.ts +58 -0
  350. package/types/V2/Billing/Intents.d.ts +117 -0
  351. package/types/V2/Billing/IntentsResource.d.ts +575 -0
  352. package/types/V2/Billing/LicenseFeeSubscriptions.d.ts +64 -0
  353. package/types/V2/Billing/LicenseFeeSubscriptionsResource.d.ts +28 -0
  354. package/types/V2/Billing/LicenseFeeVersions.d.ts +106 -0
  355. package/types/V2/Billing/LicenseFees/VersionsResource.d.ts +58 -0
  356. package/types/V2/Billing/LicenseFees.d.ts +164 -0
  357. package/types/V2/Billing/LicenseFeesResource.d.ts +290 -0
  358. package/types/V2/Billing/LicensedItems.d.ts +73 -0
  359. package/types/V2/Billing/LicensedItemsResource.d.ts +157 -0
  360. package/types/V2/Billing/MeterEvents.d.ts +1 -2
  361. package/types/V2/Billing/MeteredItems.d.ts +101 -0
  362. package/types/V2/Billing/MeteredItemsResource.d.ts +189 -0
  363. package/types/V2/Billing/PricingPlanComponents.d.ts +109 -0
  364. package/types/V2/Billing/PricingPlanSubscriptionComponents.d.ts +57 -0
  365. package/types/V2/Billing/PricingPlanSubscriptions/ComponentsResource.d.ts +40 -0
  366. package/types/V2/Billing/PricingPlanSubscriptions.d.ts +144 -0
  367. package/types/V2/Billing/PricingPlanSubscriptionsResource.d.ts +120 -0
  368. package/types/V2/Billing/PricingPlanVersions.d.ts +49 -0
  369. package/types/V2/Billing/PricingPlans/ComponentsResource.d.ts +197 -0
  370. package/types/V2/Billing/PricingPlans/VersionsResource.d.ts +58 -0
  371. package/types/V2/Billing/PricingPlans.d.ts +84 -0
  372. package/types/V2/Billing/PricingPlansResource.d.ts +151 -0
  373. package/types/V2/Billing/Profiles.d.ts +70 -0
  374. package/types/V2/Billing/ProfilesResource.d.ts +150 -0
  375. package/types/V2/Billing/RateCardRates.d.ts +144 -0
  376. package/types/V2/Billing/RateCardSubscriptions.d.ts +144 -0
  377. package/types/V2/Billing/RateCardSubscriptionsResource.d.ts +157 -0
  378. package/types/V2/Billing/RateCardVersions.d.ts +39 -0
  379. package/types/V2/Billing/RateCards/RatesResource.d.ts +203 -0
  380. package/types/V2/Billing/RateCards/VersionsResource.d.ts +58 -0
  381. package/types/V2/Billing/RateCards.d.ts +98 -0
  382. package/types/V2/Billing/RateCardsResource.d.ts +162 -0
  383. package/types/V2/Billing/ServiceActions.d.ts +274 -0
  384. package/types/V2/Billing/ServiceActionsResource.d.ts +370 -0
  385. package/types/V2/Core/AccountLinks.d.ts +168 -0
  386. package/types/V2/Core/AccountLinksResource.d.ts +152 -0
  387. package/types/V2/Core/AccountPersons.d.ts +615 -0
  388. package/types/V2/Core/Accounts/PersonsResource.d.ts +1153 -0
  389. package/types/V2/Core/Accounts.d.ts +7478 -0
  390. package/types/V2/Core/AccountsResource.d.ts +6723 -0
  391. package/types/V2/Core/ClaimableSandboxes.d.ts +132 -0
  392. package/types/V2/Core/ClaimableSandboxesResource.d.ts +74 -0
  393. package/types/V2/Core/EventTypes.d.ts +8680 -10
  394. package/types/V2/Core/Events.d.ts +14 -0
  395. package/types/V2/Core/EventsResource.d.ts +17 -2
  396. package/types/V2/Core/Vault/GbBankAccounts.d.ts +160 -0
  397. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +194 -0
  398. package/types/V2/Core/Vault/UsBankAccounts.d.ts +116 -0
  399. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +198 -0
  400. package/types/V2/FinancialAddressCreditSimulations.d.ts +27 -0
  401. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +32 -0
  402. package/types/V2/MoneyManagement/Adjustments.d.ts +110 -0
  403. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +83 -0
  404. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +148 -0
  405. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +172 -0
  406. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +178 -0
  407. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +126 -0
  408. package/types/V2/MoneyManagement/InboundTransfers.d.ts +212 -0
  409. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +144 -0
  410. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +170 -0
  411. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +115 -0
  412. package/types/V2/MoneyManagement/OutboundPayments.d.ts +283 -0
  413. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +247 -0
  414. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +97 -0
  415. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +330 -0
  416. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +256 -0
  417. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +213 -0
  418. package/types/V2/MoneyManagement/PayoutMethods.d.ts +201 -0
  419. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +93 -0
  420. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +41 -0
  421. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +113 -0
  422. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +307 -0
  423. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +78 -0
  424. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +186 -0
  425. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +48 -0
  426. package/types/V2/MoneyManagement/RecipientVerifications.d.ts +112 -0
  427. package/types/V2/MoneyManagement/RecipientVerificationsResource.d.ts +77 -0
  428. package/types/V2/MoneyManagement/TransactionEntries.d.ts +162 -0
  429. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +82 -0
  430. package/types/V2/MoneyManagement/Transactions.d.ts +177 -0
  431. package/types/V2/MoneyManagement/TransactionsResource.d.ts +83 -0
  432. package/types/V2/Payments/OffSessionPayments.d.ts +326 -0
  433. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +401 -0
  434. package/types/V2/Reporting/ReportRuns.d.ts +154 -0
  435. package/types/V2/Reporting/ReportRunsResource.d.ts +75 -0
  436. package/types/V2/Reporting/Reports.d.ts +120 -0
  437. package/types/V2/Reporting/ReportsResource.d.ts +30 -0
  438. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +73 -0
  439. package/types/V2/TestHelpers/MoneyManagementResource.d.ts +49 -0
  440. package/types/WebhookEndpointsResource.d.ts +76 -0
  441. package/types/Webhooks.d.ts +2 -0
  442. package/types/apiVersion.d.ts +1 -2
  443. package/types/index.d.ts +233 -0
  444. package/types/lib.d.ts +10 -0
@@ -3,11 +3,6 @@
3
3
  declare module 'stripe' {
4
4
  namespace Stripe {
5
5
  interface SubscriptionCreateParams {
6
- /**
7
- * The identifier of the customer to subscribe.
8
- */
9
- customer: string;
10
-
11
6
  /**
12
7
  * A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
13
8
  */
@@ -28,6 +23,11 @@ declare module 'stripe' {
28
23
  */
29
24
  backdate_start_date?: number;
30
25
 
26
+ /**
27
+ * The Billing Cadence which controls the timing of recurring invoice generation for this subscription. If unset, the subscription will bill according to its own configured schedule and create its own invoices. If set, this subscription will be billed by the cadence instead, potentially sharing invoices with the other subscriptions linked to that Cadence.
28
+ */
29
+ billing_cadence?: string;
30
+
31
31
  /**
32
32
  * A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
33
33
  */
@@ -43,6 +43,11 @@ declare module 'stripe' {
43
43
  */
44
44
  billing_mode?: SubscriptionCreateParams.BillingMode;
45
45
 
46
+ /**
47
+ * Sets the billing schedules for the subscription.
48
+ */
49
+ billing_schedules?: Array<SubscriptionCreateParams.BillingSchedule>;
50
+
46
51
  /**
47
52
  * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
48
53
  */
@@ -70,6 +75,16 @@ declare module 'stripe' {
70
75
  */
71
76
  currency?: string;
72
77
 
78
+ /**
79
+ * The identifier of the customer to subscribe.
80
+ */
81
+ customer?: string;
82
+
83
+ /**
84
+ * The identifier of the account to subscribe.
85
+ */
86
+ customer_account?: string;
87
+
73
88
  /**
74
89
  * Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
75
90
  */
@@ -157,6 +172,11 @@ declare module 'stripe' {
157
172
  SubscriptionCreateParams.PendingInvoiceItemInterval
158
173
  >;
159
174
 
175
+ /**
176
+ * If specified, the invoicing for the given billing cycle iterations will be processed now.
177
+ */
178
+ prebilling?: SubscriptionCreateParams.Prebilling;
179
+
160
180
  /**
161
181
  * Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
162
182
  */
@@ -238,12 +258,56 @@ declare module 'stripe' {
238
258
  */
239
259
  discount?: string;
240
260
 
261
+ /**
262
+ * Details to determine how long the discount should be applied for.
263
+ */
264
+ discount_end?: Discount.DiscountEnd;
265
+
241
266
  /**
242
267
  * ID of the promotion code to create a new discount for.
243
268
  */
244
269
  promotion_code?: string;
245
270
  }
246
271
 
272
+ namespace Discount {
273
+ interface DiscountEnd {
274
+ /**
275
+ * Time span for the redeemed discount.
276
+ */
277
+ duration?: DiscountEnd.Duration;
278
+
279
+ /**
280
+ * A precise Unix timestamp for the discount to end. Must be in the future.
281
+ */
282
+ timestamp?: number;
283
+
284
+ /**
285
+ * The type of calculation made to determine when the discount ends.
286
+ */
287
+ type: DiscountEnd.Type;
288
+ }
289
+
290
+ namespace DiscountEnd {
291
+ interface Duration {
292
+ /**
293
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
294
+ */
295
+ interval: Duration.Interval;
296
+
297
+ /**
298
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
299
+ */
300
+ interval_count: number;
301
+ }
302
+
303
+ namespace Duration {
304
+ type Interval = 'day' | 'month' | 'week' | 'year';
305
+ }
306
+
307
+ type Type = 'duration' | 'timestamp';
308
+ }
309
+ }
310
+
247
311
  interface Period {
248
312
  /**
249
313
  * End of the invoice item period.
@@ -406,6 +470,80 @@ declare module 'stripe' {
406
470
  type Type = 'classic' | 'flexible';
407
471
  }
408
472
 
473
+ interface BillingSchedule {
474
+ /**
475
+ * Configure billing schedule differently for individual subscription items.
476
+ */
477
+ applies_to?: Array<BillingSchedule.AppliesTo>;
478
+
479
+ /**
480
+ * The end date for the billing schedule.
481
+ */
482
+ bill_until: BillingSchedule.BillUntil;
483
+
484
+ /**
485
+ * Specify a key for the billing schedule. Must be unique to this field, alphanumeric, and up to 200 characters. If not provided, a unique key will be generated.
486
+ */
487
+ key?: string;
488
+ }
489
+
490
+ namespace BillingSchedule {
491
+ interface AppliesTo {
492
+ /**
493
+ * The ID of the price object.
494
+ */
495
+ price?: string;
496
+
497
+ /**
498
+ * Controls which subscription items the billing schedule applies to.
499
+ */
500
+ type: 'price';
501
+ }
502
+
503
+ interface BillUntil {
504
+ /**
505
+ * Specifies the billing period.
506
+ */
507
+ duration?: BillUntil.Duration;
508
+
509
+ /**
510
+ * The end date of the billing schedule.
511
+ */
512
+ timestamp?: number;
513
+
514
+ /**
515
+ * Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
516
+ */
517
+ type: BillUntil.Type;
518
+ }
519
+
520
+ namespace BillUntil {
521
+ interface Duration {
522
+ /**
523
+ * Specifies billing duration. Either `day`, `week`, `month` or `year`.
524
+ */
525
+ interval: Duration.Interval;
526
+
527
+ /**
528
+ * The multiplier applied to the interval.
529
+ */
530
+ interval_count?: number;
531
+ }
532
+
533
+ namespace Duration {
534
+ type Interval = 'day' | 'month' | 'week' | 'year';
535
+ }
536
+
537
+ type Type =
538
+ | 'amendment_end'
539
+ | 'duration'
540
+ | 'line_ends_at'
541
+ | 'schedule_end'
542
+ | 'timestamp'
543
+ | 'upcoming_invoice';
544
+ }
545
+ }
546
+
409
547
  interface BillingThresholds {
410
548
  /**
411
549
  * Monetary threshold that triggers the subscription to advance to a new billing period
@@ -433,12 +571,56 @@ declare module 'stripe' {
433
571
  */
434
572
  discount?: string;
435
573
 
574
+ /**
575
+ * Details to determine how long the discount should be applied for.
576
+ */
577
+ discount_end?: Discount.DiscountEnd;
578
+
436
579
  /**
437
580
  * ID of the promotion code to create a new discount for.
438
581
  */
439
582
  promotion_code?: string;
440
583
  }
441
584
 
585
+ namespace Discount {
586
+ interface DiscountEnd {
587
+ /**
588
+ * Time span for the redeemed discount.
589
+ */
590
+ duration?: DiscountEnd.Duration;
591
+
592
+ /**
593
+ * A precise Unix timestamp for the discount to end. Must be in the future.
594
+ */
595
+ timestamp?: number;
596
+
597
+ /**
598
+ * The type of calculation made to determine when the discount ends.
599
+ */
600
+ type: DiscountEnd.Type;
601
+ }
602
+
603
+ namespace DiscountEnd {
604
+ interface Duration {
605
+ /**
606
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
607
+ */
608
+ interval: Duration.Interval;
609
+
610
+ /**
611
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
612
+ */
613
+ interval_count: number;
614
+ }
615
+
616
+ namespace Duration {
617
+ type Interval = 'day' | 'month' | 'week' | 'year';
618
+ }
619
+
620
+ type Type = 'duration' | 'timestamp';
621
+ }
622
+ }
623
+
442
624
  interface InvoiceSettings {
443
625
  /**
444
626
  * The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
@@ -509,6 +691,11 @@ declare module 'stripe' {
509
691
  * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
510
692
  */
511
693
  tax_rates?: Stripe.Emptyable<Array<string>>;
694
+
695
+ /**
696
+ * Define options to configure the trial on the subscription item.
697
+ */
698
+ trial?: Item.Trial;
512
699
  }
513
700
 
514
701
  namespace Item {
@@ -530,12 +717,56 @@ declare module 'stripe' {
530
717
  */
531
718
  discount?: string;
532
719
 
720
+ /**
721
+ * Details to determine how long the discount should be applied for.
722
+ */
723
+ discount_end?: Discount.DiscountEnd;
724
+
533
725
  /**
534
726
  * ID of the promotion code to create a new discount for.
535
727
  */
536
728
  promotion_code?: string;
537
729
  }
538
730
 
731
+ namespace Discount {
732
+ interface DiscountEnd {
733
+ /**
734
+ * Time span for the redeemed discount.
735
+ */
736
+ duration?: DiscountEnd.Duration;
737
+
738
+ /**
739
+ * A precise Unix timestamp for the discount to end. Must be in the future.
740
+ */
741
+ timestamp?: number;
742
+
743
+ /**
744
+ * The type of calculation made to determine when the discount ends.
745
+ */
746
+ type: DiscountEnd.Type;
747
+ }
748
+
749
+ namespace DiscountEnd {
750
+ interface Duration {
751
+ /**
752
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
753
+ */
754
+ interval: Duration.Interval;
755
+
756
+ /**
757
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
758
+ */
759
+ interval_count: number;
760
+ }
761
+
762
+ namespace Duration {
763
+ type Interval = 'day' | 'month' | 'week' | 'year';
764
+ }
765
+
766
+ type Type = 'duration' | 'timestamp';
767
+ }
768
+ }
769
+
539
770
  interface PriceData {
540
771
  /**
541
772
  * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -587,6 +818,22 @@ declare module 'stripe' {
587
818
 
588
819
  type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
589
820
  }
821
+
822
+ interface Trial {
823
+ /**
824
+ * List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
825
+ */
826
+ converts_to?: Array<string>;
827
+
828
+ /**
829
+ * Determines the type of trial for this item.
830
+ */
831
+ type: Trial.Type;
832
+ }
833
+
834
+ namespace Trial {
835
+ type Type = 'free' | 'paid';
836
+ }
590
837
  }
591
838
 
592
839
  type PaymentBehavior =
@@ -638,16 +885,33 @@ declare module 'stripe' {
638
885
  PaymentMethodOptions.CustomerBalance
639
886
  >;
640
887
 
888
+ /**
889
+ * This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
890
+ */
891
+ id_bank_transfer?: Stripe.Emptyable<
892
+ PaymentMethodOptions.IdBankTransfer
893
+ >;
894
+
641
895
  /**
642
896
  * This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
643
897
  */
644
898
  konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
645
899
 
900
+ /**
901
+ * This sub-hash contains details about the Pix payment method options to pass to the invoice's PaymentIntent.
902
+ */
903
+ pix?: Stripe.Emptyable<PaymentMethodOptions.Pix>;
904
+
646
905
  /**
647
906
  * This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.
648
907
  */
649
908
  sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
650
909
 
910
+ /**
911
+ * This sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
912
+ */
913
+ upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
914
+
651
915
  /**
652
916
  * This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
653
917
  */
@@ -787,10 +1051,89 @@ declare module 'stripe' {
787
1051
  }
788
1052
  }
789
1053
 
1054
+ interface IdBankTransfer {}
1055
+
790
1056
  interface Konbini {}
791
1057
 
1058
+ interface Pix {
1059
+ /**
1060
+ * Configuration options for setting up a mandate
1061
+ */
1062
+ mandate_options?: Pix.MandateOptions;
1063
+ }
1064
+
1065
+ namespace Pix {
1066
+ interface MandateOptions {
1067
+ /**
1068
+ * Amount to be charged for future payments. If not provided, defaults to 40000.
1069
+ */
1070
+ amount?: number;
1071
+
1072
+ /**
1073
+ * Determines if the amount includes the IOF tax. Defaults to `never`.
1074
+ */
1075
+ amount_includes_iof?: MandateOptions.AmountIncludesIof;
1076
+
1077
+ /**
1078
+ * Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled.
1079
+ */
1080
+ end_date?: string;
1081
+
1082
+ /**
1083
+ * Schedule at which the future payments will be charged. Defaults to `weekly`.
1084
+ */
1085
+ payment_schedule?: MandateOptions.PaymentSchedule;
1086
+ }
1087
+
1088
+ namespace MandateOptions {
1089
+ type AmountIncludesIof = 'always' | 'never';
1090
+
1091
+ type PaymentSchedule =
1092
+ | 'halfyearly'
1093
+ | 'monthly'
1094
+ | 'quarterly'
1095
+ | 'weekly'
1096
+ | 'yearly';
1097
+ }
1098
+ }
1099
+
792
1100
  interface SepaDebit {}
793
1101
 
1102
+ interface Upi {
1103
+ /**
1104
+ * Configuration options for setting up an eMandate
1105
+ */
1106
+ mandate_options?: Upi.MandateOptions;
1107
+ }
1108
+
1109
+ namespace Upi {
1110
+ interface MandateOptions {
1111
+ /**
1112
+ * Amount to be charged for future payments.
1113
+ */
1114
+ amount?: number;
1115
+
1116
+ /**
1117
+ * One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
1118
+ */
1119
+ amount_type?: MandateOptions.AmountType;
1120
+
1121
+ /**
1122
+ * A description of the mandate or subscription that is meant to be displayed to the customer.
1123
+ */
1124
+ description?: string;
1125
+
1126
+ /**
1127
+ * End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
1128
+ */
1129
+ end_date?: number;
1130
+ }
1131
+
1132
+ namespace MandateOptions {
1133
+ type AmountType = 'fixed' | 'maximum';
1134
+ }
1135
+ }
1136
+
794
1137
  interface UsBankAccount {
795
1138
  /**
796
1139
  * Additional fields for Financial Connections Session creation
@@ -827,6 +1170,11 @@ declare module 'stripe' {
827
1170
  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
828
1171
  */
829
1172
  account_subcategories?: Array<Filters.AccountSubcategory>;
1173
+
1174
+ /**
1175
+ * ID of the institution to use to filter for selectable accounts.
1176
+ */
1177
+ institution?: string;
830
1178
  }
831
1179
 
832
1180
  namespace Filters {
@@ -839,7 +1187,11 @@ declare module 'stripe' {
839
1187
  | 'payment_method'
840
1188
  | 'transactions';
841
1189
 
842
- type Prefetch = 'balances' | 'ownership' | 'transactions';
1190
+ type Prefetch =
1191
+ | 'balances'
1192
+ | 'inferred_balances'
1193
+ | 'ownership'
1194
+ | 'transactions';
843
1195
  }
844
1196
 
845
1197
  type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -865,6 +1217,7 @@ declare module 'stripe' {
865
1217
  | 'fpx'
866
1218
  | 'giropay'
867
1219
  | 'grabpay'
1220
+ | 'id_bank_transfer'
868
1221
  | 'ideal'
869
1222
  | 'jp_credit_transfer'
870
1223
  | 'kakao_pay'
@@ -879,12 +1232,15 @@ declare module 'stripe' {
879
1232
  | 'payco'
880
1233
  | 'paynow'
881
1234
  | 'paypal'
1235
+ | 'pix'
882
1236
  | 'promptpay'
883
1237
  | 'revolut_pay'
884
1238
  | 'sepa_credit_transfer'
885
1239
  | 'sepa_debit'
886
1240
  | 'sofort'
1241
+ | 'stripe_balance'
887
1242
  | 'swish'
1243
+ | 'upi'
888
1244
  | 'us_bank_account'
889
1245
  | 'wechat_pay';
890
1246
 
@@ -907,6 +1263,22 @@ declare module 'stripe' {
907
1263
  type Interval = 'day' | 'month' | 'week' | 'year';
908
1264
  }
909
1265
 
1266
+ interface Prebilling {
1267
+ /**
1268
+ * This is used to determine the number of billing cycles to prebill.
1269
+ */
1270
+ iterations: number;
1271
+
1272
+ /**
1273
+ * Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
1274
+ */
1275
+ update_behavior?: Prebilling.UpdateBehavior;
1276
+ }
1277
+
1278
+ namespace Prebilling {
1279
+ type UpdateBehavior = 'prebill' | 'reset';
1280
+ }
1281
+
910
1282
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
911
1283
 
912
1284
  interface TransferData {
@@ -965,11 +1337,23 @@ declare module 'stripe' {
965
1337
  */
966
1338
  automatic_tax?: SubscriptionUpdateParams.AutomaticTax;
967
1339
 
1340
+ /**
1341
+ * The Billing Cadence which controls the timing of recurring invoice generation for this subscription. If unset, the subscription will bill according to its own configured schedule and create its own invoices. If set, this subscription will be billed by the cadence instead, potentially sharing invoices with the other subscriptions linked to that Cadence.
1342
+ */
1343
+ billing_cadence?: string;
1344
+
968
1345
  /**
969
1346
  * Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
970
1347
  */
971
1348
  billing_cycle_anchor?: SubscriptionUpdateParams.BillingCycleAnchor;
972
1349
 
1350
+ /**
1351
+ * Sets the billing schedules for the subscription.
1352
+ */
1353
+ billing_schedules?: Stripe.Emptyable<
1354
+ Array<SubscriptionUpdateParams.BillingSchedule>
1355
+ >;
1356
+
973
1357
  /**
974
1358
  * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
975
1359
  */
@@ -1087,6 +1471,11 @@ declare module 'stripe' {
1087
1471
  SubscriptionUpdateParams.PendingInvoiceItemInterval
1088
1472
  >;
1089
1473
 
1474
+ /**
1475
+ * If specified, the invoicing for the given billing cycle iterations will be processed now.
1476
+ */
1477
+ prebilling?: SubscriptionUpdateParams.Prebilling;
1478
+
1090
1479
  /**
1091
1480
  * Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
1092
1481
  */
@@ -1168,12 +1557,56 @@ declare module 'stripe' {
1168
1557
  */
1169
1558
  discount?: string;
1170
1559
 
1560
+ /**
1561
+ * Details to determine how long the discount should be applied for.
1562
+ */
1563
+ discount_end?: Discount.DiscountEnd;
1564
+
1171
1565
  /**
1172
1566
  * ID of the promotion code to create a new discount for.
1173
1567
  */
1174
1568
  promotion_code?: string;
1175
1569
  }
1176
1570
 
1571
+ namespace Discount {
1572
+ interface DiscountEnd {
1573
+ /**
1574
+ * Time span for the redeemed discount.
1575
+ */
1576
+ duration?: DiscountEnd.Duration;
1577
+
1578
+ /**
1579
+ * A precise Unix timestamp for the discount to end. Must be in the future.
1580
+ */
1581
+ timestamp?: number;
1582
+
1583
+ /**
1584
+ * The type of calculation made to determine when the discount ends.
1585
+ */
1586
+ type: DiscountEnd.Type;
1587
+ }
1588
+
1589
+ namespace DiscountEnd {
1590
+ interface Duration {
1591
+ /**
1592
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1593
+ */
1594
+ interval: Duration.Interval;
1595
+
1596
+ /**
1597
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1598
+ */
1599
+ interval_count: number;
1600
+ }
1601
+
1602
+ namespace Duration {
1603
+ type Interval = 'day' | 'month' | 'week' | 'year';
1604
+ }
1605
+
1606
+ type Type = 'duration' | 'timestamp';
1607
+ }
1608
+ }
1609
+
1177
1610
  interface Period {
1178
1611
  /**
1179
1612
  * End of the invoice item period.
@@ -1284,6 +1717,80 @@ declare module 'stripe' {
1284
1717
 
1285
1718
  type BillingCycleAnchor = 'now' | 'unchanged';
1286
1719
 
1720
+ interface BillingSchedule {
1721
+ /**
1722
+ * Configure billing schedule differently for individual subscription items.
1723
+ */
1724
+ applies_to?: Array<BillingSchedule.AppliesTo>;
1725
+
1726
+ /**
1727
+ * The end date for the billing schedule.
1728
+ */
1729
+ bill_until?: BillingSchedule.BillUntil;
1730
+
1731
+ /**
1732
+ * Specify a key for the billing schedule. Must be unique to this field, alphanumeric, and up to 200 characters. If not provided, a unique key will be generated.
1733
+ */
1734
+ key?: string;
1735
+ }
1736
+
1737
+ namespace BillingSchedule {
1738
+ interface AppliesTo {
1739
+ /**
1740
+ * The ID of the price object.
1741
+ */
1742
+ price?: string;
1743
+
1744
+ /**
1745
+ * Controls which subscription items the billing schedule applies to.
1746
+ */
1747
+ type: 'price';
1748
+ }
1749
+
1750
+ interface BillUntil {
1751
+ /**
1752
+ * Specifies the billing period.
1753
+ */
1754
+ duration?: BillUntil.Duration;
1755
+
1756
+ /**
1757
+ * The end date of the billing schedule.
1758
+ */
1759
+ timestamp?: number;
1760
+
1761
+ /**
1762
+ * Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
1763
+ */
1764
+ type: BillUntil.Type;
1765
+ }
1766
+
1767
+ namespace BillUntil {
1768
+ interface Duration {
1769
+ /**
1770
+ * Specifies billing duration. Either `day`, `week`, `month` or `year`.
1771
+ */
1772
+ interval: Duration.Interval;
1773
+
1774
+ /**
1775
+ * The multiplier applied to the interval.
1776
+ */
1777
+ interval_count?: number;
1778
+ }
1779
+
1780
+ namespace Duration {
1781
+ type Interval = 'day' | 'month' | 'week' | 'year';
1782
+ }
1783
+
1784
+ type Type =
1785
+ | 'amendment_end'
1786
+ | 'duration'
1787
+ | 'line_ends_at'
1788
+ | 'schedule_end'
1789
+ | 'timestamp'
1790
+ | 'upcoming_invoice';
1791
+ }
1792
+ }
1793
+
1287
1794
  interface BillingThresholds {
1288
1795
  /**
1289
1796
  * Monetary threshold that triggers the subscription to advance to a new billing period
@@ -1335,12 +1842,56 @@ declare module 'stripe' {
1335
1842
  */
1336
1843
  discount?: string;
1337
1844
 
1845
+ /**
1846
+ * Details to determine how long the discount should be applied for.
1847
+ */
1848
+ discount_end?: Discount.DiscountEnd;
1849
+
1338
1850
  /**
1339
1851
  * ID of the promotion code to create a new discount for.
1340
1852
  */
1341
1853
  promotion_code?: string;
1342
1854
  }
1343
1855
 
1856
+ namespace Discount {
1857
+ interface DiscountEnd {
1858
+ /**
1859
+ * Time span for the redeemed discount.
1860
+ */
1861
+ duration?: DiscountEnd.Duration;
1862
+
1863
+ /**
1864
+ * A precise Unix timestamp for the discount to end. Must be in the future.
1865
+ */
1866
+ timestamp?: number;
1867
+
1868
+ /**
1869
+ * The type of calculation made to determine when the discount ends.
1870
+ */
1871
+ type: DiscountEnd.Type;
1872
+ }
1873
+
1874
+ namespace DiscountEnd {
1875
+ interface Duration {
1876
+ /**
1877
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1878
+ */
1879
+ interval: Duration.Interval;
1880
+
1881
+ /**
1882
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1883
+ */
1884
+ interval_count: number;
1885
+ }
1886
+
1887
+ namespace Duration {
1888
+ type Interval = 'day' | 'month' | 'week' | 'year';
1889
+ }
1890
+
1891
+ type Type = 'duration' | 'timestamp';
1892
+ }
1893
+ }
1894
+
1344
1895
  interface InvoiceSettings {
1345
1896
  /**
1346
1897
  * The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
@@ -1447,12 +1998,56 @@ declare module 'stripe' {
1447
1998
  */
1448
1999
  discount?: string;
1449
2000
 
2001
+ /**
2002
+ * Details to determine how long the discount should be applied for.
2003
+ */
2004
+ discount_end?: Discount.DiscountEnd;
2005
+
1450
2006
  /**
1451
2007
  * ID of the promotion code to create a new discount for.
1452
2008
  */
1453
2009
  promotion_code?: string;
1454
2010
  }
1455
2011
 
2012
+ namespace Discount {
2013
+ interface DiscountEnd {
2014
+ /**
2015
+ * Time span for the redeemed discount.
2016
+ */
2017
+ duration?: DiscountEnd.Duration;
2018
+
2019
+ /**
2020
+ * A precise Unix timestamp for the discount to end. Must be in the future.
2021
+ */
2022
+ timestamp?: number;
2023
+
2024
+ /**
2025
+ * The type of calculation made to determine when the discount ends.
2026
+ */
2027
+ type: DiscountEnd.Type;
2028
+ }
2029
+
2030
+ namespace DiscountEnd {
2031
+ interface Duration {
2032
+ /**
2033
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2034
+ */
2035
+ interval: Duration.Interval;
2036
+
2037
+ /**
2038
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2039
+ */
2040
+ interval_count: number;
2041
+ }
2042
+
2043
+ namespace Duration {
2044
+ type Interval = 'day' | 'month' | 'week' | 'year';
2045
+ }
2046
+
2047
+ type Type = 'duration' | 'timestamp';
2048
+ }
2049
+ }
2050
+
1456
2051
  interface PriceData {
1457
2052
  /**
1458
2053
  * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -1571,16 +2166,33 @@ declare module 'stripe' {
1571
2166
  PaymentMethodOptions.CustomerBalance
1572
2167
  >;
1573
2168
 
2169
+ /**
2170
+ * This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
2171
+ */
2172
+ id_bank_transfer?: Stripe.Emptyable<
2173
+ PaymentMethodOptions.IdBankTransfer
2174
+ >;
2175
+
1574
2176
  /**
1575
2177
  * This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
1576
2178
  */
1577
2179
  konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
1578
2180
 
2181
+ /**
2182
+ * This sub-hash contains details about the Pix payment method options to pass to the invoice's PaymentIntent.
2183
+ */
2184
+ pix?: Stripe.Emptyable<PaymentMethodOptions.Pix>;
2185
+
1579
2186
  /**
1580
2187
  * This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.
1581
2188
  */
1582
2189
  sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
1583
2190
 
2191
+ /**
2192
+ * This sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
2193
+ */
2194
+ upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
2195
+
1584
2196
  /**
1585
2197
  * This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
1586
2198
  */
@@ -1720,10 +2332,89 @@ declare module 'stripe' {
1720
2332
  }
1721
2333
  }
1722
2334
 
2335
+ interface IdBankTransfer {}
2336
+
1723
2337
  interface Konbini {}
1724
2338
 
2339
+ interface Pix {
2340
+ /**
2341
+ * Configuration options for setting up a mandate
2342
+ */
2343
+ mandate_options?: Pix.MandateOptions;
2344
+ }
2345
+
2346
+ namespace Pix {
2347
+ interface MandateOptions {
2348
+ /**
2349
+ * Amount to be charged for future payments. If not provided, defaults to 40000.
2350
+ */
2351
+ amount?: number;
2352
+
2353
+ /**
2354
+ * Determines if the amount includes the IOF tax. Defaults to `never`.
2355
+ */
2356
+ amount_includes_iof?: MandateOptions.AmountIncludesIof;
2357
+
2358
+ /**
2359
+ * Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled.
2360
+ */
2361
+ end_date?: string;
2362
+
2363
+ /**
2364
+ * Schedule at which the future payments will be charged. Defaults to `weekly`.
2365
+ */
2366
+ payment_schedule?: MandateOptions.PaymentSchedule;
2367
+ }
2368
+
2369
+ namespace MandateOptions {
2370
+ type AmountIncludesIof = 'always' | 'never';
2371
+
2372
+ type PaymentSchedule =
2373
+ | 'halfyearly'
2374
+ | 'monthly'
2375
+ | 'quarterly'
2376
+ | 'weekly'
2377
+ | 'yearly';
2378
+ }
2379
+ }
2380
+
1725
2381
  interface SepaDebit {}
1726
2382
 
2383
+ interface Upi {
2384
+ /**
2385
+ * Configuration options for setting up an eMandate
2386
+ */
2387
+ mandate_options?: Upi.MandateOptions;
2388
+ }
2389
+
2390
+ namespace Upi {
2391
+ interface MandateOptions {
2392
+ /**
2393
+ * Amount to be charged for future payments.
2394
+ */
2395
+ amount?: number;
2396
+
2397
+ /**
2398
+ * One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
2399
+ */
2400
+ amount_type?: MandateOptions.AmountType;
2401
+
2402
+ /**
2403
+ * A description of the mandate or subscription that is meant to be displayed to the customer.
2404
+ */
2405
+ description?: string;
2406
+
2407
+ /**
2408
+ * End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
2409
+ */
2410
+ end_date?: number;
2411
+ }
2412
+
2413
+ namespace MandateOptions {
2414
+ type AmountType = 'fixed' | 'maximum';
2415
+ }
2416
+ }
2417
+
1727
2418
  interface UsBankAccount {
1728
2419
  /**
1729
2420
  * Additional fields for Financial Connections Session creation
@@ -1760,6 +2451,11 @@ declare module 'stripe' {
1760
2451
  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
1761
2452
  */
1762
2453
  account_subcategories?: Array<Filters.AccountSubcategory>;
2454
+
2455
+ /**
2456
+ * ID of the institution to use to filter for selectable accounts.
2457
+ */
2458
+ institution?: string;
1763
2459
  }
1764
2460
 
1765
2461
  namespace Filters {
@@ -1772,7 +2468,11 @@ declare module 'stripe' {
1772
2468
  | 'payment_method'
1773
2469
  | 'transactions';
1774
2470
 
1775
- type Prefetch = 'balances' | 'ownership' | 'transactions';
2471
+ type Prefetch =
2472
+ | 'balances'
2473
+ | 'inferred_balances'
2474
+ | 'ownership'
2475
+ | 'transactions';
1776
2476
  }
1777
2477
 
1778
2478
  type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -1798,6 +2498,7 @@ declare module 'stripe' {
1798
2498
  | 'fpx'
1799
2499
  | 'giropay'
1800
2500
  | 'grabpay'
2501
+ | 'id_bank_transfer'
1801
2502
  | 'ideal'
1802
2503
  | 'jp_credit_transfer'
1803
2504
  | 'kakao_pay'
@@ -1812,12 +2513,15 @@ declare module 'stripe' {
1812
2513
  | 'payco'
1813
2514
  | 'paynow'
1814
2515
  | 'paypal'
2516
+ | 'pix'
1815
2517
  | 'promptpay'
1816
2518
  | 'revolut_pay'
1817
2519
  | 'sepa_credit_transfer'
1818
2520
  | 'sepa_debit'
1819
2521
  | 'sofort'
2522
+ | 'stripe_balance'
1820
2523
  | 'swish'
2524
+ | 'upi'
1821
2525
  | 'us_bank_account'
1822
2526
  | 'wechat_pay';
1823
2527
 
@@ -1840,6 +2544,22 @@ declare module 'stripe' {
1840
2544
  type Interval = 'day' | 'month' | 'week' | 'year';
1841
2545
  }
1842
2546
 
2547
+ interface Prebilling {
2548
+ /**
2549
+ * This is used to determine the number of billing cycles to prebill.
2550
+ */
2551
+ iterations: number;
2552
+
2553
+ /**
2554
+ * Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
2555
+ */
2556
+ update_behavior?: Prebilling.UpdateBehavior;
2557
+ }
2558
+
2559
+ namespace Prebilling {
2560
+ type UpdateBehavior = 'prebill' | 'reset';
2561
+ }
2562
+
1843
2563
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
1844
2564
 
1845
2565
  interface TransferData {
@@ -1906,6 +2626,11 @@ declare module 'stripe' {
1906
2626
  */
1907
2627
  customer?: string;
1908
2628
 
2629
+ /**
2630
+ * The ID of the account whose subscriptions will be retrieved.
2631
+ */
2632
+ customer_account?: string;
2633
+
1909
2634
  /**
1910
2635
  * Specifies which fields in the response should be expanded.
1911
2636
  */
@@ -1955,6 +2680,18 @@ declare module 'stripe' {
1955
2680
  | 'unpaid';
1956
2681
  }
1957
2682
 
2683
+ interface SubscriptionAttachCadenceParams {
2684
+ /**
2685
+ * The Billing Cadence which controls the timing of recurring invoice generation for this subscription. If unset, the subscription will bill according to its own configured schedule and create its own invoices. If set, this subscription will be billed by the cadence instead, potentially sharing invoices with the other subscriptions linked to that Cadence.
2686
+ */
2687
+ billing_cadence: string;
2688
+
2689
+ /**
2690
+ * Specifies which fields in the response should be expanded.
2691
+ */
2692
+ expand?: Array<string>;
2693
+ }
2694
+
1958
2695
  interface SubscriptionCancelParams {
1959
2696
  /**
1960
2697
  * Details about why this subscription was cancelled
@@ -2105,7 +2842,10 @@ declare module 'stripe' {
2105
2842
  * Schedules provide the flexibility to model more complex billing configurations that change over time.
2106
2843
  */
2107
2844
  create(
2108
- params: SubscriptionCreateParams,
2845
+ params?: SubscriptionCreateParams,
2846
+ options?: RequestOptions
2847
+ ): Promise<Stripe.Response<Stripe.Subscription>>;
2848
+ create(
2109
2849
  options?: RequestOptions
2110
2850
  ): Promise<Stripe.Response<Stripe.Subscription>>;
2111
2851
 
@@ -2160,6 +2900,15 @@ declare module 'stripe' {
2160
2900
  ): ApiListPromise<Stripe.Subscription>;
2161
2901
  list(options?: RequestOptions): ApiListPromise<Stripe.Subscription>;
2162
2902
 
2903
+ /**
2904
+ * Attach a Billing Cadence to an existing subscription. When attached, the subscription is billed by the Billing Cadence, potentially sharing invoices with the other subscriptions linked to the Billing Cadence.
2905
+ */
2906
+ attachCadence(
2907
+ id: string,
2908
+ params: SubscriptionAttachCadenceParams,
2909
+ options?: RequestOptions
2910
+ ): Promise<Stripe.Response<Stripe.Subscription>>;
2911
+
2163
2912
  /**
2164
2913
  * Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata).
2165
2914
  *