stripe 20.1.0-alpha.4 → 20.1.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 (538) hide show
  1. package/CHANGELOG.md +47 -1920
  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/apiVersion.js +3 -2
  7. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  8. package/cjs/resources/Mandates.js +0 -5
  9. package/cjs/resources/PaymentIntents.js +0 -8
  10. package/cjs/resources/PaymentMethods.js +0 -4
  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 +2 -148
  15. package/cjs/stripe.core.js +1 -1
  16. package/esm/Error.js +0 -100
  17. package/esm/apiVersion.js +2 -1
  18. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  19. package/esm/resources/Mandates.js +0 -5
  20. package/esm/resources/PaymentIntents.js +0 -8
  21. package/esm/resources/PaymentMethods.js +0 -4
  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 -140
  26. package/esm/stripe.core.js +1 -1
  27. package/package.json +1 -1
  28. package/types/AccountLinks.d.ts +1 -1
  29. package/types/AccountLinksResource.d.ts +1 -5
  30. package/types/AccountSessions.d.ts +2 -65
  31. package/types/AccountSessionsResource.d.ts +0 -264
  32. package/types/Accounts.d.ts +25 -249
  33. package/types/AccountsResource.d.ts +114 -756
  34. package/types/ApplicationFees.d.ts +1 -6
  35. package/types/ApplicationFeesResource.d.ts +2 -2
  36. package/types/Apps/Secrets.d.ts +1 -1
  37. package/types/Balance.d.ts +2 -84
  38. package/types/BalanceSettings.d.ts +1 -1
  39. package/types/BalanceTransactions.d.ts +2 -3
  40. package/types/BankAccounts.d.ts +10 -12
  41. package/types/Billing/AlertTriggereds.d.ts +1 -16
  42. package/types/Billing/Alerts.d.ts +2 -117
  43. package/types/Billing/AlertsResource.d.ts +2 -149
  44. package/types/Billing/CreditBalanceSummary.d.ts +3 -119
  45. package/types/Billing/CreditBalanceSummaryResource.d.ts +2 -14
  46. package/types/Billing/CreditBalanceTransactions.d.ts +2 -118
  47. package/types/Billing/CreditBalanceTransactionsResource.d.ts +2 -2
  48. package/types/Billing/CreditGrants.d.ts +4 -74
  49. package/types/Billing/CreditGrantsResource.d.ts +4 -35
  50. package/types/Billing/MeterEventSummaries.d.ts +0 -7
  51. package/types/Billing/MeterEvents.d.ts +1 -1
  52. package/types/Billing/MeterEventsResource.d.ts +1 -1
  53. package/types/Billing/Meters.d.ts +0 -5
  54. package/types/Billing/MetersResource.d.ts +0 -17
  55. package/types/BillingPortal/Configurations.d.ts +10 -3
  56. package/types/BillingPortal/ConfigurationsResource.d.ts +20 -6
  57. package/types/BillingPortal/Sessions.d.ts +7 -7
  58. package/types/BillingPortal/SessionsResource.d.ts +7 -7
  59. package/types/Capabilities.d.ts +16 -18
  60. package/types/Cards.d.ts +2 -21
  61. package/types/CashBalances.d.ts +3 -3
  62. package/types/Charges.d.ts +59 -193
  63. package/types/ChargesResource.d.ts +88 -3868
  64. package/types/Checkout/Sessions.d.ts +20 -355
  65. package/types/Checkout/SessionsResource.d.ts +59 -467
  66. package/types/Climate/Orders.d.ts +1 -1
  67. package/types/Climate/OrdersResource.d.ts +2 -2
  68. package/types/ConfirmationTokens.d.ts +8 -123
  69. package/types/Coupons.d.ts +3 -38
  70. package/types/CouponsResource.d.ts +2 -25
  71. package/types/CreditNoteLineItems.d.ts +3 -17
  72. package/types/CreditNotes.d.ts +8 -5
  73. package/types/CreditNotesResource.d.ts +5 -5
  74. package/types/CustomerBalanceTransactions.d.ts +9 -6
  75. package/types/CustomerCashBalanceTransactions.d.ts +13 -10
  76. package/types/CustomerSessions.d.ts +1 -42
  77. package/types/CustomerSessionsResource.d.ts +0 -41
  78. package/types/Customers.d.ts +8 -5
  79. package/types/CustomersResource.d.ts +21 -23
  80. package/types/Discounts.d.ts +6 -16
  81. package/types/Disputes.d.ts +3 -43
  82. package/types/DisputesResource.d.ts +1 -12
  83. package/types/Entitlements/ActiveEntitlements.d.ts +1 -1
  84. package/types/Errors.d.ts +0 -85
  85. package/types/EventTypes.d.ts +0 -630
  86. package/types/Events.d.ts +1 -97
  87. package/types/ExchangeRates.d.ts +2 -2
  88. package/types/FeeRefunds.d.ts +2 -2
  89. package/types/FileLinks.d.ts +1 -1
  90. package/types/FileLinksResource.d.ts +2 -2
  91. package/types/Files.d.ts +4 -4
  92. package/types/FilesResource.d.ts +3 -3
  93. package/types/FinancialConnections/Accounts.d.ts +4 -37
  94. package/types/FinancialConnections/AccountsResource.d.ts +6 -38
  95. package/types/FinancialConnections/Sessions.d.ts +3 -51
  96. package/types/FinancialConnections/SessionsResource.d.ts +4 -41
  97. package/types/Forwarding/Requests.d.ts +1 -1
  98. package/types/Forwarding/RequestsResource.d.ts +1 -1
  99. package/types/FundingInstructions.d.ts +2 -2
  100. package/types/Identity/VerificationReports.d.ts +8 -18
  101. package/types/Identity/VerificationReportsResource.d.ts +0 -5
  102. package/types/Identity/VerificationSessions.d.ts +11 -11
  103. package/types/Identity/VerificationSessionsResource.d.ts +18 -12
  104. package/types/InvoiceItems.d.ts +10 -130
  105. package/types/InvoiceItemsResource.d.ts +16 -114
  106. package/types/InvoiceLineItems.d.ts +12 -172
  107. package/types/InvoicePayments.d.ts +1 -1
  108. package/types/InvoiceRenderingTemplates.d.ts +1 -1
  109. package/types/Invoices.d.ts +60 -217
  110. package/types/InvoicesResource.d.ts +141 -1819
  111. package/types/Issuing/Authorizations.d.ts +20 -20
  112. package/types/Issuing/AuthorizationsResource.d.ts +4 -4
  113. package/types/Issuing/Cardholders.d.ts +13 -13
  114. package/types/Issuing/CardholdersResource.d.ts +21 -22
  115. package/types/Issuing/Cards.d.ts +10 -10
  116. package/types/Issuing/CardsResource.d.ts +13 -13
  117. package/types/Issuing/Disputes.d.ts +7 -7
  118. package/types/Issuing/DisputesResource.d.ts +5 -5
  119. package/types/Issuing/PersonalizationDesigns.d.ts +1 -1
  120. package/types/Issuing/PersonalizationDesignsResource.d.ts +2 -2
  121. package/types/Issuing/Tokens.d.ts +1 -1
  122. package/types/Issuing/Transactions.d.ts +12 -17
  123. package/types/Issuing/TransactionsResource.d.ts +1 -6
  124. package/types/LineItems.d.ts +4 -48
  125. package/types/LoginLinks.d.ts +1 -1
  126. package/types/Mandates.d.ts +1 -69
  127. package/types/MandatesResource.d.ts +0 -31
  128. package/types/PaymentAttemptRecords.d.ts +119 -135
  129. package/types/PaymentIntentAmountDetailsLineItems.d.ts +3 -3
  130. package/types/PaymentIntents.d.ts +48 -744
  131. package/types/PaymentIntentsResource.d.ts +6824 -19519
  132. package/types/PaymentLinks.d.ts +7 -12
  133. package/types/PaymentLinksResource.d.ts +28 -38
  134. package/types/PaymentMethodConfigurations.d.ts +4 -184
  135. package/types/PaymentMethodConfigurationsResource.d.ts +76 -326
  136. package/types/PaymentMethodDomains.d.ts +1 -1
  137. package/types/PaymentMethods.d.ts +10 -130
  138. package/types/PaymentMethodsResource.d.ts +7 -136
  139. package/types/PaymentRecords.d.ts +126 -135
  140. package/types/PaymentRecordsResource.d.ts +7 -7
  141. package/types/Payouts.d.ts +7 -7
  142. package/types/PayoutsResource.d.ts +3 -3
  143. package/types/Persons.d.ts +21 -51
  144. package/types/Plans.d.ts +5 -5
  145. package/types/PlansResource.d.ts +6 -6
  146. package/types/Prices.d.ts +6 -28
  147. package/types/PricesResource.d.ts +10 -32
  148. package/types/Products.d.ts +10 -10
  149. package/types/ProductsResource.d.ts +14 -14
  150. package/types/PromotionCodes.d.ts +5 -5
  151. package/types/PromotionCodesResource.d.ts +5 -5
  152. package/types/Quotes.d.ts +14 -884
  153. package/types/QuotesResource.d.ts +302 -3250
  154. package/types/Radar/EarlyFraudWarnings.d.ts +1 -1
  155. package/types/Radar/ValueListItems.d.ts +1 -1
  156. package/types/Radar/ValueLists.d.ts +2 -2
  157. package/types/Radar/ValueListsResource.d.ts +2 -2
  158. package/types/Refunds.d.ts +3 -17
  159. package/types/RefundsResource.d.ts +3 -3
  160. package/types/Reporting/ReportRuns.d.ts +3 -3
  161. package/types/Reporting/ReportRunsResource.d.ts +2 -2
  162. package/types/Reporting/ReportTypes.d.ts +3 -3
  163. package/types/Reviews.d.ts +1 -1
  164. package/types/SetupAttempts.d.ts +22 -60
  165. package/types/SetupIntents.d.ts +22 -178
  166. package/types/SetupIntentsResource.d.ts +50 -763
  167. package/types/ShippingRates.d.ts +3 -3
  168. package/types/ShippingRatesResource.d.ts +3 -3
  169. package/types/Sigma/ScheduledQueryRuns.d.ts +1 -1
  170. package/types/SourceMandateNotifications.d.ts +3 -3
  171. package/types/Sources.d.ts +5 -34
  172. package/types/SourcesResource.d.ts +2 -2
  173. package/types/SubscriptionItems.d.ts +7 -46
  174. package/types/SubscriptionItemsResource.d.ts +22 -165
  175. package/types/SubscriptionSchedules.d.ts +9 -333
  176. package/types/SubscriptionSchedulesResource.d.ts +79 -1535
  177. package/types/Subscriptions.d.ts +41 -273
  178. package/types/SubscriptionsResource.d.ts +94 -768
  179. package/types/Tax/Associations.d.ts +3 -3
  180. package/types/Tax/AssociationsResource.d.ts +1 -1
  181. package/types/Tax/CalculationLineItems.d.ts +7 -7
  182. package/types/Tax/Calculations.d.ts +12 -12
  183. package/types/Tax/CalculationsResource.d.ts +7 -7
  184. package/types/Tax/Registrations.d.ts +3 -3
  185. package/types/Tax/Settings.d.ts +1 -1
  186. package/types/Tax/SettingsResource.d.ts +1 -1
  187. package/types/Tax/TransactionLineItems.d.ts +5 -5
  188. package/types/Tax/Transactions.d.ts +9 -9
  189. package/types/Tax/TransactionsResource.d.ts +10 -10
  190. package/types/TaxIds.d.ts +6 -6
  191. package/types/TaxIdsResource.d.ts +4 -4
  192. package/types/TaxRates.d.ts +1 -1
  193. package/types/TaxRatesResource.d.ts +2 -2
  194. package/types/Terminal/Configurations.d.ts +0 -9
  195. package/types/Terminal/ConfigurationsResource.d.ts +0 -28
  196. package/types/Terminal/ConnectionTokens.d.ts +1 -1
  197. package/types/Terminal/Locations.d.ts +2 -2
  198. package/types/Terminal/LocationsResource.d.ts +3 -3
  199. package/types/Terminal/Readers.d.ts +10 -30
  200. package/types/Terminal/ReadersResource.d.ts +7 -7
  201. package/types/TestHelpers/ConfirmationTokensResource.d.ts +5 -107
  202. package/types/TestHelpers/CustomersResource.d.ts +2 -2
  203. package/types/TestHelpers/Issuing/AuthorizationsResource.d.ts +10 -10
  204. package/types/TestHelpers/Issuing/TransactionsResource.d.ts +5 -5
  205. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +1 -27
  206. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +1 -27
  207. package/types/Tokens.d.ts +4 -4
  208. package/types/TokensResource.d.ts +17 -85
  209. package/types/Topups.d.ts +3 -3
  210. package/types/TopupsResource.d.ts +3 -3
  211. package/types/TransferReversals.d.ts +4 -4
  212. package/types/Transfers.d.ts +5 -14
  213. package/types/TransfersResource.d.ts +6 -13
  214. package/types/Treasury/CreditReversals.d.ts +3 -3
  215. package/types/Treasury/CreditReversalsResource.d.ts +1 -1
  216. package/types/Treasury/DebitReversals.d.ts +3 -3
  217. package/types/Treasury/DebitReversalsResource.d.ts +1 -1
  218. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  219. package/types/Treasury/FinancialAccounts.d.ts +1 -6
  220. package/types/Treasury/FinancialAccountsResource.d.ts +2 -39
  221. package/types/Treasury/InboundTransfers.d.ts +4 -4
  222. package/types/Treasury/InboundTransfersResource.d.ts +2 -2
  223. package/types/Treasury/OutboundPayments.d.ts +5 -5
  224. package/types/Treasury/OutboundPaymentsResource.d.ts +4 -4
  225. package/types/Treasury/OutboundTransfers.d.ts +4 -30
  226. package/types/Treasury/OutboundTransfersResource.d.ts +3 -29
  227. package/types/Treasury/ReceivedCredits.d.ts +9 -35
  228. package/types/Treasury/ReceivedDebits.d.ts +6 -37
  229. package/types/Treasury/TransactionEntries.d.ts +11 -11
  230. package/types/Treasury/Transactions.d.ts +11 -11
  231. package/types/V2/Core/AccountLinks.d.ts +13 -21
  232. package/types/V2/Core/AccountLinksResource.d.ts +8 -16
  233. package/types/V2/Core/AccountPersons.d.ts +55 -10
  234. package/types/V2/Core/AccountTokensResource.d.ts +99 -267
  235. package/types/V2/Core/Accounts/PersonTokensResource.d.ts +48 -3
  236. package/types/V2/Core/Accounts/PersonsResource.d.ts +101 -11
  237. package/types/V2/Core/Accounts.d.ts +263 -2861
  238. package/types/V2/Core/AccountsResource.d.ts +594 -2554
  239. package/types/V2/Core/EventTypes.d.ts +10 -4813
  240. package/types/V2/Core/Events.d.ts +0 -61
  241. package/types/V2/Core/EventsResource.d.ts +1 -11
  242. package/types/WebhookEndpoints.d.ts +1 -1
  243. package/types/WebhookEndpointsResource.d.ts +5 -79
  244. package/types/Webhooks.d.ts +0 -2
  245. package/types/apiVersion.d.ts +2 -1
  246. package/types/index.d.ts +0 -233
  247. package/types/lib.d.ts +0 -10
  248. package/cjs/resources/AccountNotices.js +0 -21
  249. package/cjs/resources/BalanceTransfers.js +0 -9
  250. package/cjs/resources/Billing/Analytics/MeterUsage.js +0 -12
  251. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  252. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  253. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  254. package/cjs/resources/DelegatedCheckout/RequestedSessions.js +0 -28
  255. package/cjs/resources/ExternalAccounts.js +0 -23
  256. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  257. package/cjs/resources/FxQuotes.js +0 -15
  258. package/cjs/resources/Identity/BlocklistEntries.js +0 -25
  259. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  260. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  261. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  262. package/cjs/resources/Issuing/Programs.js +0 -22
  263. package/cjs/resources/Margins.js +0 -22
  264. package/cjs/resources/Orders.js +0 -24
  265. package/cjs/resources/Privacy/RedactionJobs.js +0 -42
  266. package/cjs/resources/ProductCatalog/TrialOffers.js +0 -12
  267. package/cjs/resources/Radar/AccountEvaluations.js +0 -20
  268. package/cjs/resources/Tax/Forms.js +0 -20
  269. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  270. package/cjs/resources/TestHelpers/Capital/FinancingOffers.js +0 -16
  271. package/cjs/resources/V2/Billing/BillSettings/Versions.js +0 -17
  272. package/cjs/resources/V2/Billing/BillSettings.js +0 -27
  273. package/cjs/resources/V2/Billing/Cadences.js +0 -23
  274. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +0 -17
  275. package/cjs/resources/V2/Billing/CollectionSettings.js +0 -30
  276. package/cjs/resources/V2/Billing/CustomPricingUnits.js +0 -25
  277. package/cjs/resources/V2/Billing/Intents/Actions.js +0 -17
  278. package/cjs/resources/V2/Billing/Intents.js +0 -36
  279. package/cjs/resources/V2/Billing/LicenseFeeSubscriptions.js +0 -12
  280. package/cjs/resources/V2/Billing/LicenseFees/Versions.js +0 -17
  281. package/cjs/resources/V2/Billing/LicenseFees.js +0 -27
  282. package/cjs/resources/V2/Billing/LicensedItems.js +0 -25
  283. package/cjs/resources/V2/Billing/MeteredItems.js +0 -22
  284. package/cjs/resources/V2/Billing/PricingPlanSubscriptions/Components.js +0 -12
  285. package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +0 -26
  286. package/cjs/resources/V2/Billing/PricingPlans/Components.js +0 -29
  287. package/cjs/resources/V2/Billing/PricingPlans/Versions.js +0 -17
  288. package/cjs/resources/V2/Billing/PricingPlans.js +0 -29
  289. package/cjs/resources/V2/Billing/Profiles.js +0 -19
  290. package/cjs/resources/V2/Billing/RateCardSubscriptions.js +0 -29
  291. package/cjs/resources/V2/Billing/RateCards/Rates.js +0 -25
  292. package/cjs/resources/V2/Billing/RateCards/Versions.js +0 -17
  293. package/cjs/resources/V2/Billing/RateCards.js +0 -29
  294. package/cjs/resources/V2/Billing/ServiceActions.js +0 -20
  295. package/cjs/resources/V2/Core/ClaimableSandboxes.js +0 -16
  296. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -33
  297. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -37
  298. package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
  299. package/cjs/resources/V2/MoneyManagement/CurrencyConversions.js +0 -21
  300. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -29
  301. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
  302. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
  303. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -16
  304. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
  305. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
  306. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
  307. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
  308. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
  309. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
  310. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
  311. package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js +0 -20
  312. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
  313. package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
  314. package/cjs/resources/V2/Payments/OffSessionPayments.js +0 -29
  315. package/cjs/resources/V2/Reporting/ReportRuns.js +0 -13
  316. package/cjs/resources/V2/Reporting/Reports.js +0 -12
  317. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
  318. package/cjs/resources/V2/TestHelpers/MoneyManagement.js +0 -12
  319. package/esm/resources/AccountNotices.js +0 -18
  320. package/esm/resources/BalanceTransfers.js +0 -6
  321. package/esm/resources/Billing/Analytics/MeterUsage.js +0 -9
  322. package/esm/resources/Capital/FinancingOffers.js +0 -18
  323. package/esm/resources/Capital/FinancingSummary.js +0 -9
  324. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  325. package/esm/resources/DelegatedCheckout/RequestedSessions.js +0 -25
  326. package/esm/resources/ExternalAccounts.js +0 -20
  327. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  328. package/esm/resources/FxQuotes.js +0 -12
  329. package/esm/resources/Identity/BlocklistEntries.js +0 -22
  330. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  331. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  332. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  333. package/esm/resources/Issuing/Programs.js +0 -19
  334. package/esm/resources/Margins.js +0 -19
  335. package/esm/resources/Orders.js +0 -21
  336. package/esm/resources/Privacy/RedactionJobs.js +0 -39
  337. package/esm/resources/ProductCatalog/TrialOffers.js +0 -9
  338. package/esm/resources/Radar/AccountEvaluations.js +0 -17
  339. package/esm/resources/Tax/Forms.js +0 -17
  340. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  341. package/esm/resources/TestHelpers/Capital/FinancingOffers.js +0 -13
  342. package/esm/resources/V2/Billing/BillSettings/Versions.js +0 -14
  343. package/esm/resources/V2/Billing/BillSettings.js +0 -24
  344. package/esm/resources/V2/Billing/Cadences.js +0 -20
  345. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +0 -14
  346. package/esm/resources/V2/Billing/CollectionSettings.js +0 -27
  347. package/esm/resources/V2/Billing/CustomPricingUnits.js +0 -22
  348. package/esm/resources/V2/Billing/Intents/Actions.js +0 -14
  349. package/esm/resources/V2/Billing/Intents.js +0 -33
  350. package/esm/resources/V2/Billing/LicenseFeeSubscriptions.js +0 -9
  351. package/esm/resources/V2/Billing/LicenseFees/Versions.js +0 -14
  352. package/esm/resources/V2/Billing/LicenseFees.js +0 -24
  353. package/esm/resources/V2/Billing/LicensedItems.js +0 -22
  354. package/esm/resources/V2/Billing/MeteredItems.js +0 -19
  355. package/esm/resources/V2/Billing/PricingPlanSubscriptions/Components.js +0 -9
  356. package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +0 -23
  357. package/esm/resources/V2/Billing/PricingPlans/Components.js +0 -26
  358. package/esm/resources/V2/Billing/PricingPlans/Versions.js +0 -14
  359. package/esm/resources/V2/Billing/PricingPlans.js +0 -26
  360. package/esm/resources/V2/Billing/Profiles.js +0 -16
  361. package/esm/resources/V2/Billing/RateCardSubscriptions.js +0 -26
  362. package/esm/resources/V2/Billing/RateCards/Rates.js +0 -22
  363. package/esm/resources/V2/Billing/RateCards/Versions.js +0 -14
  364. package/esm/resources/V2/Billing/RateCards.js +0 -26
  365. package/esm/resources/V2/Billing/ServiceActions.js +0 -17
  366. package/esm/resources/V2/Core/ClaimableSandboxes.js +0 -13
  367. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -30
  368. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -34
  369. package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
  370. package/esm/resources/V2/MoneyManagement/CurrencyConversions.js +0 -18
  371. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -26
  372. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
  373. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
  374. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -13
  375. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
  376. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
  377. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
  378. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
  379. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
  380. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
  381. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
  382. package/esm/resources/V2/MoneyManagement/RecipientVerifications.js +0 -17
  383. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
  384. package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
  385. package/esm/resources/V2/Payments/OffSessionPayments.js +0 -26
  386. package/esm/resources/V2/Reporting/ReportRuns.js +0 -10
  387. package/esm/resources/V2/Reporting/Reports.js +0 -9
  388. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
  389. package/esm/resources/V2/TestHelpers/MoneyManagement.js +0 -9
  390. package/types/AccountNotices.d.ts +0 -113
  391. package/types/AccountNoticesResource.d.ts +0 -98
  392. package/types/BalanceTransfers.d.ts +0 -122
  393. package/types/BalanceTransfersResource.d.ts +0 -87
  394. package/types/Billing/Analytics/MeterUsage.d.ts +0 -31
  395. package/types/Billing/Analytics/MeterUsageResource.d.ts +0 -694
  396. package/types/Billing/Analytics/MeterUsageRows.d.ts +0 -58
  397. package/types/Capital/FinancingOffers.d.ts +0 -188
  398. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  399. package/types/Capital/FinancingSummary.d.ts +0 -106
  400. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  401. package/types/Capital/FinancingTransactions.d.ts +0 -135
  402. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  403. package/types/DelegatedCheckout/RequestedSessions.d.ts +0 -399
  404. package/types/DelegatedCheckout/RequestedSessionsResource.d.ts +0 -599
  405. package/types/ExternalAccountsResource.d.ts +0 -304
  406. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  407. package/types/FinancialConnections/Institutions.d.ts +0 -98
  408. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  409. package/types/FxQuotes.d.ts +0 -155
  410. package/types/FxQuotesResource.d.ts +0 -130
  411. package/types/Identity/BlocklistEntries.d.ts +0 -78
  412. package/types/Identity/BlocklistEntriesResource.d.ts +0 -146
  413. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  414. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  415. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
  416. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  417. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  418. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  419. package/types/Issuing/Programs.d.ts +0 -42
  420. package/types/Issuing/ProgramsResource.d.ts +0 -96
  421. package/types/Issuing/Settlements.d.ts +0 -113
  422. package/types/Margins.d.ts +0 -56
  423. package/types/MarginsResource.d.ts +0 -114
  424. package/types/Orders.d.ts +0 -1163
  425. package/types/OrdersResource.d.ts +0 -5505
  426. package/types/PaymentMethodBalances.d.ts +0 -63
  427. package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -60
  428. package/types/Privacy/RedactionJobs.d.ts +0 -111
  429. package/types/Privacy/RedactionJobsResource.d.ts +0 -230
  430. package/types/ProductCatalog/TrialOffers.d.ts +0 -77
  431. package/types/ProductCatalog/TrialOffersResource.d.ts +0 -80
  432. package/types/QuoteLines.d.ts +0 -651
  433. package/types/QuotePreviewInvoices.d.ts +0 -1784
  434. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -1034
  435. package/types/Radar/AccountEvaluations.d.ts +0 -88
  436. package/types/Radar/AccountEvaluationsResource.d.ts +0 -148
  437. package/types/Tax/Forms.d.ts +0 -220
  438. package/types/Tax/FormsResource.d.ts +0 -107
  439. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  440. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  441. package/types/TestHelpers/Capital/FinancingOffersResource.d.ts +0 -130
  442. package/types/TransitBalances.d.ts +0 -40
  443. package/types/V2/Billing/BillSettingVersions.d.ts +0 -97
  444. package/types/V2/Billing/BillSettings/VersionsResource.d.ts +0 -58
  445. package/types/V2/Billing/BillSettings.d.ts +0 -120
  446. package/types/V2/Billing/BillSettingsResource.d.ts +0 -241
  447. package/types/V2/Billing/Cadences.d.ts +0 -735
  448. package/types/V2/Billing/CadencesResource.d.ts +0 -516
  449. package/types/V2/Billing/CollectionSettingVersions.d.ts +0 -318
  450. package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +0 -62
  451. package/types/V2/Billing/CollectionSettings.d.ts +0 -341
  452. package/types/V2/Billing/CollectionSettingsResource.d.ts +0 -683
  453. package/types/V2/Billing/CustomPricingUnits.d.ts +0 -56
  454. package/types/V2/Billing/CustomPricingUnitsResource.d.ts +0 -122
  455. package/types/V2/Billing/IntentActions.d.ts +0 -459
  456. package/types/V2/Billing/Intents/ActionsResource.d.ts +0 -58
  457. package/types/V2/Billing/Intents.d.ts +0 -117
  458. package/types/V2/Billing/IntentsResource.d.ts +0 -575
  459. package/types/V2/Billing/LicenseFeeSubscriptions.d.ts +0 -64
  460. package/types/V2/Billing/LicenseFeeSubscriptionsResource.d.ts +0 -28
  461. package/types/V2/Billing/LicenseFeeVersions.d.ts +0 -106
  462. package/types/V2/Billing/LicenseFees/VersionsResource.d.ts +0 -58
  463. package/types/V2/Billing/LicenseFees.d.ts +0 -164
  464. package/types/V2/Billing/LicenseFeesResource.d.ts +0 -290
  465. package/types/V2/Billing/LicensedItems.d.ts +0 -73
  466. package/types/V2/Billing/LicensedItemsResource.d.ts +0 -157
  467. package/types/V2/Billing/MeteredItems.d.ts +0 -101
  468. package/types/V2/Billing/MeteredItemsResource.d.ts +0 -189
  469. package/types/V2/Billing/PricingPlanComponents.d.ts +0 -109
  470. package/types/V2/Billing/PricingPlanSubscriptionComponents.d.ts +0 -57
  471. package/types/V2/Billing/PricingPlanSubscriptions/ComponentsResource.d.ts +0 -40
  472. package/types/V2/Billing/PricingPlanSubscriptions.d.ts +0 -144
  473. package/types/V2/Billing/PricingPlanSubscriptionsResource.d.ts +0 -120
  474. package/types/V2/Billing/PricingPlanVersions.d.ts +0 -49
  475. package/types/V2/Billing/PricingPlans/ComponentsResource.d.ts +0 -197
  476. package/types/V2/Billing/PricingPlans/VersionsResource.d.ts +0 -58
  477. package/types/V2/Billing/PricingPlans.d.ts +0 -84
  478. package/types/V2/Billing/PricingPlansResource.d.ts +0 -151
  479. package/types/V2/Billing/Profiles.d.ts +0 -70
  480. package/types/V2/Billing/ProfilesResource.d.ts +0 -150
  481. package/types/V2/Billing/RateCardRates.d.ts +0 -144
  482. package/types/V2/Billing/RateCardSubscriptions.d.ts +0 -144
  483. package/types/V2/Billing/RateCardSubscriptionsResource.d.ts +0 -157
  484. package/types/V2/Billing/RateCardVersions.d.ts +0 -39
  485. package/types/V2/Billing/RateCards/RatesResource.d.ts +0 -203
  486. package/types/V2/Billing/RateCards/VersionsResource.d.ts +0 -58
  487. package/types/V2/Billing/RateCards.d.ts +0 -98
  488. package/types/V2/Billing/RateCardsResource.d.ts +0 -162
  489. package/types/V2/Billing/ServiceActions.d.ts +0 -298
  490. package/types/V2/Billing/ServiceActionsResource.d.ts +0 -394
  491. package/types/V2/Core/ClaimableSandboxes.d.ts +0 -132
  492. package/types/V2/Core/ClaimableSandboxesResource.d.ts +0 -74
  493. package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
  494. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -194
  495. package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -116
  496. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -198
  497. package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -27
  498. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -46
  499. package/types/V2/MoneyManagement/Adjustments.d.ts +0 -122
  500. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
  501. package/types/V2/MoneyManagement/CurrencyConversions.d.ts +0 -98
  502. package/types/V2/MoneyManagement/CurrencyConversionsResource.d.ts +0 -141
  503. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -186
  504. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -172
  505. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -178
  506. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -126
  507. package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -250
  508. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -156
  509. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -222
  510. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -127
  511. package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -323
  512. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -259
  513. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
  514. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -330
  515. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -296
  516. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -225
  517. package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -201
  518. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +0 -93
  519. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
  520. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
  521. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -347
  522. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
  523. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -248
  524. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
  525. package/types/V2/MoneyManagement/RecipientVerifications.d.ts +0 -112
  526. package/types/V2/MoneyManagement/RecipientVerificationsResource.d.ts +0 -77
  527. package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -200
  528. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
  529. package/types/V2/MoneyManagement/Transactions.d.ts +0 -227
  530. package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
  531. package/types/V2/Payments/OffSessionPayments.d.ts +0 -249
  532. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +0 -306
  533. package/types/V2/Reporting/ReportRuns.d.ts +0 -154
  534. package/types/V2/Reporting/ReportRunsResource.d.ts +0 -75
  535. package/types/V2/Reporting/Reports.d.ts +0 -120
  536. package/types/V2/Reporting/ReportsResource.d.ts +0 -30
  537. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -85
  538. package/types/V2/TestHelpers/MoneyManagementResource.d.ts +0 -49
@@ -24,12 +24,7 @@ declare module 'stripe' {
24
24
  backdate_start_date?: number;
25
25
 
26
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
- /**
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.
27
+ * A future timestamp in UTC format to anchor the subscription's [billing cycle](https://docs.stripe.com/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
28
  */
34
29
  billing_cycle_anchor?: number;
35
30
 
@@ -43,11 +38,6 @@ declare module 'stripe' {
43
38
  */
44
39
  billing_mode?: SubscriptionCreateParams.BillingMode;
45
40
 
46
- /**
47
- * Sets the billing schedules for the subscription.
48
- */
49
- billing_schedules?: Array<SubscriptionCreateParams.BillingSchedule>;
50
-
51
41
  /**
52
42
  * 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.
53
43
  */
@@ -81,7 +71,7 @@ declare module 'stripe' {
81
71
  customer?: string;
82
72
 
83
73
  /**
84
- * The identifier of the account to subscribe.
74
+ * The identifier of the account representing the customer to subscribe.
85
75
  */
86
76
  customer_account?: string;
87
77
 
@@ -91,12 +81,12 @@ declare module 'stripe' {
91
81
  days_until_due?: number;
92
82
 
93
83
  /**
94
- * ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
84
+ * ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
95
85
  */
96
86
  default_payment_method?: string;
97
87
 
98
88
  /**
99
- * ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
89
+ * ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
100
90
  */
101
91
  default_source?: string;
102
92
 
@@ -131,7 +121,7 @@ declare module 'stripe' {
131
121
  items?: Array<SubscriptionCreateParams.Item>;
132
122
 
133
123
  /**
134
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
124
+ * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
135
125
  */
136
126
  metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
137
127
 
@@ -148,11 +138,11 @@ declare module 'stripe' {
148
138
  /**
149
139
  * Only applies to subscriptions with `collection_method=charge_automatically`.
150
140
  *
151
- * Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
141
+ * Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
152
142
  *
153
- * Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription's invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.
143
+ * Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription's invoice, such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.
154
144
  *
155
- * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.
145
+ * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/upgrades#2019-03-14) to learn more.
156
146
  *
157
147
  * `pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription.
158
148
  *
@@ -166,19 +156,14 @@ declare module 'stripe' {
166
156
  payment_settings?: SubscriptionCreateParams.PaymentSettings;
167
157
 
168
158
  /**
169
- * Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
159
+ * Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval.
170
160
  */
171
161
  pending_invoice_item_interval?: Stripe.Emptyable<
172
162
  SubscriptionCreateParams.PendingInvoiceItemInterval
173
163
  >;
174
164
 
175
165
  /**
176
- * If specified, the invoicing for the given billing cycle iterations will be processed now.
177
- */
178
- prebilling?: SubscriptionCreateParams.Prebilling;
179
-
180
- /**
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`.
166
+ * Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
182
167
  */
183
168
  proration_behavior?: SubscriptionCreateParams.ProrationBehavior;
184
169
 
@@ -188,17 +173,17 @@ declare module 'stripe' {
188
173
  transfer_data?: SubscriptionCreateParams.TransferData;
189
174
 
190
175
  /**
191
- * Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
176
+ * Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more.
192
177
  */
193
178
  trial_end?: 'now' | number;
194
179
 
195
180
  /**
196
- * Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
181
+ * Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more.
197
182
  */
198
183
  trial_from_plan?: boolean;
199
184
 
200
185
  /**
201
- * Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
186
+ * Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more.
202
187
  */
203
188
  trial_period_days?: number;
204
189
 
@@ -216,7 +201,7 @@ declare module 'stripe' {
216
201
  discounts?: Array<AddInvoiceItem.Discount>;
217
202
 
218
203
  /**
219
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
204
+ * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
220
205
  */
221
206
  metadata?: Stripe.MetadataParam;
222
207
 
@@ -231,7 +216,7 @@ declare module 'stripe' {
231
216
  price?: string;
232
217
 
233
218
  /**
234
- * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
219
+ * Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
235
220
  */
236
221
  price_data?: AddInvoiceItem.PriceData;
237
222
 
@@ -258,56 +243,12 @@ declare module 'stripe' {
258
243
  */
259
244
  discount?: string;
260
245
 
261
- /**
262
- * Details to determine how long the discount should be applied for.
263
- */
264
- discount_end?: Discount.DiscountEnd;
265
-
266
246
  /**
267
247
  * ID of the promotion code to create a new discount for.
268
248
  */
269
249
  promotion_code?: string;
270
250
  }
271
251
 
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
-
311
252
  interface Period {
312
253
  /**
313
254
  * End of the invoice item period.
@@ -366,7 +307,7 @@ declare module 'stripe' {
366
307
  product: string;
367
308
 
368
309
  /**
369
- * Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
310
+ * Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
370
311
  */
371
312
  tax_behavior?: PriceData.TaxBehavior;
372
313
 
@@ -470,74 +411,6 @@ declare module 'stripe' {
470
411
  type Type = 'classic' | 'flexible';
471
412
  }
472
413
 
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 = 'duration' | 'timestamp';
538
- }
539
- }
540
-
541
414
  interface BillingThresholds {
542
415
  /**
543
416
  * Monetary threshold that triggers the subscription to advance to a new billing period
@@ -565,56 +438,12 @@ declare module 'stripe' {
565
438
  */
566
439
  discount?: string;
567
440
 
568
- /**
569
- * Details to determine how long the discount should be applied for.
570
- */
571
- discount_end?: Discount.DiscountEnd;
572
-
573
441
  /**
574
442
  * ID of the promotion code to create a new discount for.
575
443
  */
576
444
  promotion_code?: string;
577
445
  }
578
446
 
579
- namespace Discount {
580
- interface DiscountEnd {
581
- /**
582
- * Time span for the redeemed discount.
583
- */
584
- duration?: DiscountEnd.Duration;
585
-
586
- /**
587
- * A precise Unix timestamp for the discount to end. Must be in the future.
588
- */
589
- timestamp?: number;
590
-
591
- /**
592
- * The type of calculation made to determine when the discount ends.
593
- */
594
- type: DiscountEnd.Type;
595
- }
596
-
597
- namespace DiscountEnd {
598
- interface Duration {
599
- /**
600
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
601
- */
602
- interval: Duration.Interval;
603
-
604
- /**
605
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
606
- */
607
- interval_count: number;
608
- }
609
-
610
- namespace Duration {
611
- type Interval = 'day' | 'month' | 'week' | 'year';
612
- }
613
-
614
- type Type = 'duration' | 'timestamp';
615
- }
616
- }
617
-
618
447
  interface InvoiceSettings {
619
448
  /**
620
449
  * The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
@@ -657,7 +486,7 @@ declare module 'stripe' {
657
486
  discounts?: Stripe.Emptyable<Array<Item.Discount>>;
658
487
 
659
488
  /**
660
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
489
+ * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
661
490
  */
662
491
  metadata?: Stripe.MetadataParam;
663
492
 
@@ -672,7 +501,7 @@ declare module 'stripe' {
672
501
  price?: string;
673
502
 
674
503
  /**
675
- * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
504
+ * Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
676
505
  */
677
506
  price_data?: Item.PriceData;
678
507
 
@@ -682,41 +511,19 @@ declare module 'stripe' {
682
511
  quantity?: number;
683
512
 
684
513
  /**
685
- * 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.
514
+ * A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
686
515
  */
687
516
  tax_rates?: Stripe.Emptyable<Array<string>>;
688
-
689
- /**
690
- * Define options to configure the trial on the subscription item.
691
- */
692
- trial?: Item.Trial;
693
-
694
- /**
695
- * The trial offer to apply to this subscription item.
696
- */
697
- current_trial?: Item.CurrentTrial;
698
517
  }
699
518
 
700
519
  namespace Item {
701
520
  interface BillingThresholds {
702
521
  /**
703
- * Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
522
+ * Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
704
523
  */
705
524
  usage_gte: number;
706
525
  }
707
526
 
708
- interface CurrentTrial {
709
- /**
710
- * Unix timestamp representing the end of the trial offer period. Required when the trial offer has `duration.type=timestamp`. Cannot be specified when `duration.type=relative`.
711
- */
712
- trial_end?: number;
713
-
714
- /**
715
- * The ID of the trial offer to apply to the subscription item.
716
- */
717
- trial_offer: string;
718
- }
719
-
720
527
  interface Discount {
721
528
  /**
722
529
  * ID of the coupon to create a new discount for.
@@ -728,56 +535,12 @@ declare module 'stripe' {
728
535
  */
729
536
  discount?: string;
730
537
 
731
- /**
732
- * Details to determine how long the discount should be applied for.
733
- */
734
- discount_end?: Discount.DiscountEnd;
735
-
736
538
  /**
737
539
  * ID of the promotion code to create a new discount for.
738
540
  */
739
541
  promotion_code?: string;
740
542
  }
741
543
 
742
- namespace Discount {
743
- interface DiscountEnd {
744
- /**
745
- * Time span for the redeemed discount.
746
- */
747
- duration?: DiscountEnd.Duration;
748
-
749
- /**
750
- * A precise Unix timestamp for the discount to end. Must be in the future.
751
- */
752
- timestamp?: number;
753
-
754
- /**
755
- * The type of calculation made to determine when the discount ends.
756
- */
757
- type: DiscountEnd.Type;
758
- }
759
-
760
- namespace DiscountEnd {
761
- interface Duration {
762
- /**
763
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
764
- */
765
- interval: Duration.Interval;
766
-
767
- /**
768
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
769
- */
770
- interval_count: number;
771
- }
772
-
773
- namespace Duration {
774
- type Interval = 'day' | 'month' | 'week' | 'year';
775
- }
776
-
777
- type Type = 'duration' | 'timestamp';
778
- }
779
- }
780
-
781
544
  interface PriceData {
782
545
  /**
783
546
  * 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).
@@ -795,7 +558,7 @@ declare module 'stripe' {
795
558
  recurring: PriceData.Recurring;
796
559
 
797
560
  /**
798
- * Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
561
+ * Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
799
562
  */
800
563
  tax_behavior?: PriceData.TaxBehavior;
801
564
 
@@ -829,22 +592,6 @@ declare module 'stripe' {
829
592
 
830
593
  type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
831
594
  }
832
-
833
- interface Trial {
834
- /**
835
- * 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.
836
- */
837
- converts_to?: Array<string>;
838
-
839
- /**
840
- * Determines the type of trial for this item.
841
- */
842
- type: Trial.Type;
843
- }
844
-
845
- namespace Trial {
846
- type Type = 'free' | 'paid';
847
- }
848
595
  }
849
596
 
850
597
  type PaymentBehavior =
@@ -896,33 +643,21 @@ declare module 'stripe' {
896
643
  PaymentMethodOptions.CustomerBalance
897
644
  >;
898
645
 
899
- /**
900
- * This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
901
- */
902
- id_bank_transfer?: Stripe.Emptyable<
903
- PaymentMethodOptions.IdBankTransfer
904
- >;
905
-
906
646
  /**
907
647
  * This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
908
648
  */
909
649
  konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
910
650
 
911
651
  /**
912
- * This sub-hash contains details about the Pix payment method options to pass to the invoice's PaymentIntent.
652
+ * This sub-hash contains details about the PayTo payment method options to pass to the invoice's PaymentIntent.
913
653
  */
914
- pix?: Stripe.Emptyable<PaymentMethodOptions.Pix>;
654
+ payto?: Stripe.Emptyable<PaymentMethodOptions.Payto>;
915
655
 
916
656
  /**
917
657
  * This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.
918
658
  */
919
659
  sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
920
660
 
921
- /**
922
- * This sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
923
- */
924
- upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
925
-
926
661
  /**
927
662
  * This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
928
663
  */
@@ -982,7 +717,7 @@ declare module 'stripe' {
982
717
  network?: Card.Network;
983
718
 
984
719
  /**
985
- * We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
720
+ * We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
986
721
  */
987
722
  request_three_d_secure?: Card.RequestThreeDSecure;
988
723
  }
@@ -1062,89 +797,46 @@ declare module 'stripe' {
1062
797
  }
1063
798
  }
1064
799
 
1065
- interface IdBankTransfer {}
1066
-
1067
800
  interface Konbini {}
1068
801
 
1069
- interface Pix {
802
+ interface Payto {
1070
803
  /**
1071
- * Configuration options for setting up a mandate
804
+ * Additional fields for Mandate creation.
1072
805
  */
1073
- mandate_options?: Pix.MandateOptions;
806
+ mandate_options?: Payto.MandateOptions;
1074
807
  }
1075
808
 
1076
- namespace Pix {
809
+ namespace Payto {
1077
810
  interface MandateOptions {
1078
811
  /**
1079
- * Amount to be charged for future payments. If not provided, defaults to 40000.
812
+ * The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
1080
813
  */
1081
814
  amount?: number;
1082
815
 
1083
816
  /**
1084
- * Determines if the amount includes the IOF tax. Defaults to `never`.
817
+ * The purpose for which payments are made. Has a default value based on your merchant category code.
1085
818
  */
1086
- amount_includes_iof?: MandateOptions.AmountIncludesIof;
1087
-
1088
- /**
1089
- * 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.
1090
- */
1091
- end_date?: string;
1092
-
1093
- /**
1094
- * Schedule at which the future payments will be charged. Defaults to `weekly`.
1095
- */
1096
- payment_schedule?: MandateOptions.PaymentSchedule;
819
+ purpose?: MandateOptions.Purpose;
1097
820
  }
1098
821
 
1099
822
  namespace MandateOptions {
1100
- type AmountIncludesIof = 'always' | 'never';
1101
-
1102
- type PaymentSchedule =
1103
- | 'halfyearly'
1104
- | 'monthly'
1105
- | 'quarterly'
1106
- | 'weekly'
1107
- | 'yearly';
823
+ type Purpose =
824
+ | 'dependant_support'
825
+ | 'government'
826
+ | 'loan'
827
+ | 'mortgage'
828
+ | 'other'
829
+ | 'pension'
830
+ | 'personal'
831
+ | 'retail'
832
+ | 'salary'
833
+ | 'tax'
834
+ | 'utility';
1108
835
  }
1109
836
  }
1110
837
 
1111
838
  interface SepaDebit {}
1112
839
 
1113
- interface Upi {
1114
- /**
1115
- * Configuration options for setting up an eMandate
1116
- */
1117
- mandate_options?: Upi.MandateOptions;
1118
- }
1119
-
1120
- namespace Upi {
1121
- interface MandateOptions {
1122
- /**
1123
- * Amount to be charged for future payments.
1124
- */
1125
- amount?: number;
1126
-
1127
- /**
1128
- * 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.
1129
- */
1130
- amount_type?: MandateOptions.AmountType;
1131
-
1132
- /**
1133
- * A description of the mandate or subscription that is meant to be displayed to the customer.
1134
- */
1135
- description?: string;
1136
-
1137
- /**
1138
- * 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.
1139
- */
1140
- end_date?: number;
1141
- }
1142
-
1143
- namespace MandateOptions {
1144
- type AmountType = 'fixed' | 'maximum';
1145
- }
1146
- }
1147
-
1148
840
  interface UsBankAccount {
1149
841
  /**
1150
842
  * Additional fields for Financial Connections Session creation
@@ -1181,11 +873,6 @@ declare module 'stripe' {
1181
873
  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
1182
874
  */
1183
875
  account_subcategories?: Array<Filters.AccountSubcategory>;
1184
-
1185
- /**
1186
- * ID of the institution to use to filter for selectable accounts.
1187
- */
1188
- institution?: string;
1189
876
  }
1190
877
 
1191
878
  namespace Filters {
@@ -1198,11 +885,7 @@ declare module 'stripe' {
1198
885
  | 'payment_method'
1199
886
  | 'transactions';
1200
887
 
1201
- type Prefetch =
1202
- | 'balances'
1203
- | 'inferred_balances'
1204
- | 'ownership'
1205
- | 'transactions';
888
+ type Prefetch = 'balances' | 'ownership' | 'transactions';
1206
889
  }
1207
890
 
1208
891
  type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -1228,7 +911,6 @@ declare module 'stripe' {
1228
911
  | 'fpx'
1229
912
  | 'giropay'
1230
913
  | 'grabpay'
1231
- | 'id_bank_transfer'
1232
914
  | 'ideal'
1233
915
  | 'jp_credit_transfer'
1234
916
  | 'kakao_pay'
@@ -1243,15 +925,13 @@ declare module 'stripe' {
1243
925
  | 'payco'
1244
926
  | 'paynow'
1245
927
  | 'paypal'
1246
- | 'pix'
928
+ | 'payto'
1247
929
  | 'promptpay'
1248
930
  | 'revolut_pay'
1249
931
  | 'sepa_credit_transfer'
1250
932
  | 'sepa_debit'
1251
933
  | 'sofort'
1252
- | 'stripe_balance'
1253
934
  | 'swish'
1254
- | 'upi'
1255
935
  | 'us_bank_account'
1256
936
  | 'wechat_pay';
1257
937
 
@@ -1274,22 +954,6 @@ declare module 'stripe' {
1274
954
  type Interval = 'day' | 'month' | 'week' | 'year';
1275
955
  }
1276
956
 
1277
- interface Prebilling {
1278
- /**
1279
- * This is used to determine the number of billing cycles to prebill.
1280
- */
1281
- iterations: number;
1282
-
1283
- /**
1284
- * Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
1285
- */
1286
- update_behavior?: Prebilling.UpdateBehavior;
1287
- }
1288
-
1289
- namespace Prebilling {
1290
- type UpdateBehavior = 'prebill' | 'reset';
1291
- }
1292
-
1293
957
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
1294
958
 
1295
959
  interface TransferData {
@@ -1349,22 +1013,10 @@ declare module 'stripe' {
1349
1013
  automatic_tax?: SubscriptionUpdateParams.AutomaticTax;
1350
1014
 
1351
1015
  /**
1352
- * 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.
1353
- */
1354
- billing_cadence?: string;
1355
-
1356
- /**
1357
- * 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).
1016
+ * 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://docs.stripe.com/billing/subscriptions/billing-cycle).
1358
1017
  */
1359
1018
  billing_cycle_anchor?: SubscriptionUpdateParams.BillingCycleAnchor;
1360
1019
 
1361
- /**
1362
- * Sets the billing schedules for the subscription.
1363
- */
1364
- billing_schedules?: Stripe.Emptyable<
1365
- Array<SubscriptionUpdateParams.BillingSchedule>
1366
- >;
1367
-
1368
1020
  /**
1369
1021
  * 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.
1370
1022
  */
@@ -1398,12 +1050,12 @@ declare module 'stripe' {
1398
1050
  days_until_due?: number;
1399
1051
 
1400
1052
  /**
1401
- * ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
1053
+ * ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
1402
1054
  */
1403
1055
  default_payment_method?: string;
1404
1056
 
1405
1057
  /**
1406
- * ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
1058
+ * ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
1407
1059
  */
1408
1060
  default_source?: Stripe.Emptyable<string>;
1409
1061
 
@@ -1438,7 +1090,7 @@ declare module 'stripe' {
1438
1090
  items?: Array<SubscriptionUpdateParams.Item>;
1439
1091
 
1440
1092
  /**
1441
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1093
+ * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1442
1094
  */
1443
1095
  metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
1444
1096
 
@@ -1453,18 +1105,18 @@ declare module 'stripe' {
1453
1105
  on_behalf_of?: Stripe.Emptyable<string>;
1454
1106
 
1455
1107
  /**
1456
- * If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
1108
+ * If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
1457
1109
  */
1458
1110
  pause_collection?: Stripe.Emptyable<
1459
1111
  SubscriptionUpdateParams.PauseCollection
1460
1112
  >;
1461
1113
 
1462
1114
  /**
1463
- * Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
1115
+ * Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
1464
1116
  *
1465
- * Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
1117
+ * Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
1466
1118
  *
1467
- * Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
1119
+ * Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes).
1468
1120
  *
1469
1121
  * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
1470
1122
  */
@@ -1476,19 +1128,14 @@ declare module 'stripe' {
1476
1128
  payment_settings?: SubscriptionUpdateParams.PaymentSettings;
1477
1129
 
1478
1130
  /**
1479
- * Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
1131
+ * Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval.
1480
1132
  */
1481
1133
  pending_invoice_item_interval?: Stripe.Emptyable<
1482
1134
  SubscriptionUpdateParams.PendingInvoiceItemInterval
1483
1135
  >;
1484
1136
 
1485
1137
  /**
1486
- * If specified, the invoicing for the given billing cycle iterations will be processed now.
1487
- */
1488
- prebilling?: SubscriptionUpdateParams.Prebilling;
1489
-
1490
- /**
1491
- * 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`.
1138
+ * Determines how to handle [prorations](https://docs.stripe.com/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`.
1492
1139
  */
1493
1140
  proration_behavior?: SubscriptionUpdateParams.ProrationBehavior;
1494
1141
 
@@ -1508,7 +1155,7 @@ declare module 'stripe' {
1508
1155
  trial_end?: 'now' | number;
1509
1156
 
1510
1157
  /**
1511
- * Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
1158
+ * Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more.
1512
1159
  */
1513
1160
  trial_from_plan?: boolean;
1514
1161
 
@@ -1526,7 +1173,7 @@ declare module 'stripe' {
1526
1173
  discounts?: Array<AddInvoiceItem.Discount>;
1527
1174
 
1528
1175
  /**
1529
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1176
+ * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1530
1177
  */
1531
1178
  metadata?: Stripe.MetadataParam;
1532
1179
 
@@ -1541,7 +1188,7 @@ declare module 'stripe' {
1541
1188
  price?: string;
1542
1189
 
1543
1190
  /**
1544
- * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
1191
+ * Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
1545
1192
  */
1546
1193
  price_data?: AddInvoiceItem.PriceData;
1547
1194
 
@@ -1568,56 +1215,12 @@ declare module 'stripe' {
1568
1215
  */
1569
1216
  discount?: string;
1570
1217
 
1571
- /**
1572
- * Details to determine how long the discount should be applied for.
1573
- */
1574
- discount_end?: Discount.DiscountEnd;
1575
-
1576
1218
  /**
1577
1219
  * ID of the promotion code to create a new discount for.
1578
1220
  */
1579
1221
  promotion_code?: string;
1580
1222
  }
1581
1223
 
1582
- namespace Discount {
1583
- interface DiscountEnd {
1584
- /**
1585
- * Time span for the redeemed discount.
1586
- */
1587
- duration?: DiscountEnd.Duration;
1588
-
1589
- /**
1590
- * A precise Unix timestamp for the discount to end. Must be in the future.
1591
- */
1592
- timestamp?: number;
1593
-
1594
- /**
1595
- * The type of calculation made to determine when the discount ends.
1596
- */
1597
- type: DiscountEnd.Type;
1598
- }
1599
-
1600
- namespace DiscountEnd {
1601
- interface Duration {
1602
- /**
1603
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1604
- */
1605
- interval: Duration.Interval;
1606
-
1607
- /**
1608
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1609
- */
1610
- interval_count: number;
1611
- }
1612
-
1613
- namespace Duration {
1614
- type Interval = 'day' | 'month' | 'week' | 'year';
1615
- }
1616
-
1617
- type Type = 'duration' | 'timestamp';
1618
- }
1619
- }
1620
-
1621
1224
  interface Period {
1622
1225
  /**
1623
1226
  * End of the invoice item period.
@@ -1676,7 +1279,7 @@ declare module 'stripe' {
1676
1279
  product: string;
1677
1280
 
1678
1281
  /**
1679
- * Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
1282
+ * Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
1680
1283
  */
1681
1284
  tax_behavior?: PriceData.TaxBehavior;
1682
1285
 
@@ -1728,74 +1331,6 @@ declare module 'stripe' {
1728
1331
 
1729
1332
  type BillingCycleAnchor = 'now' | 'unchanged';
1730
1333
 
1731
- interface BillingSchedule {
1732
- /**
1733
- * Configure billing schedule differently for individual subscription items.
1734
- */
1735
- applies_to?: Array<BillingSchedule.AppliesTo>;
1736
-
1737
- /**
1738
- * The end date for the billing schedule.
1739
- */
1740
- bill_until?: BillingSchedule.BillUntil;
1741
-
1742
- /**
1743
- * 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.
1744
- */
1745
- key?: string;
1746
- }
1747
-
1748
- namespace BillingSchedule {
1749
- interface AppliesTo {
1750
- /**
1751
- * The ID of the price object.
1752
- */
1753
- price?: string;
1754
-
1755
- /**
1756
- * Controls which subscription items the billing schedule applies to.
1757
- */
1758
- type: 'price';
1759
- }
1760
-
1761
- interface BillUntil {
1762
- /**
1763
- * Specifies the billing period.
1764
- */
1765
- duration?: BillUntil.Duration;
1766
-
1767
- /**
1768
- * The end date of the billing schedule.
1769
- */
1770
- timestamp?: number;
1771
-
1772
- /**
1773
- * Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
1774
- */
1775
- type: BillUntil.Type;
1776
- }
1777
-
1778
- namespace BillUntil {
1779
- interface Duration {
1780
- /**
1781
- * Specifies billing duration. Either `day`, `week`, `month` or `year`.
1782
- */
1783
- interval: Duration.Interval;
1784
-
1785
- /**
1786
- * The multiplier applied to the interval.
1787
- */
1788
- interval_count?: number;
1789
- }
1790
-
1791
- namespace Duration {
1792
- type Interval = 'day' | 'month' | 'week' | 'year';
1793
- }
1794
-
1795
- type Type = 'duration' | 'timestamp';
1796
- }
1797
- }
1798
-
1799
1334
  interface BillingThresholds {
1800
1335
  /**
1801
1336
  * Monetary threshold that triggers the subscription to advance to a new billing period
@@ -1847,56 +1382,12 @@ declare module 'stripe' {
1847
1382
  */
1848
1383
  discount?: string;
1849
1384
 
1850
- /**
1851
- * Details to determine how long the discount should be applied for.
1852
- */
1853
- discount_end?: Discount.DiscountEnd;
1854
-
1855
1385
  /**
1856
1386
  * ID of the promotion code to create a new discount for.
1857
1387
  */
1858
1388
  promotion_code?: string;
1859
1389
  }
1860
1390
 
1861
- namespace Discount {
1862
- interface DiscountEnd {
1863
- /**
1864
- * Time span for the redeemed discount.
1865
- */
1866
- duration?: DiscountEnd.Duration;
1867
-
1868
- /**
1869
- * A precise Unix timestamp for the discount to end. Must be in the future.
1870
- */
1871
- timestamp?: number;
1872
-
1873
- /**
1874
- * The type of calculation made to determine when the discount ends.
1875
- */
1876
- type: DiscountEnd.Type;
1877
- }
1878
-
1879
- namespace DiscountEnd {
1880
- interface Duration {
1881
- /**
1882
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1883
- */
1884
- interval: Duration.Interval;
1885
-
1886
- /**
1887
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1888
- */
1889
- interval_count: number;
1890
- }
1891
-
1892
- namespace Duration {
1893
- type Interval = 'day' | 'month' | 'week' | 'year';
1894
- }
1895
-
1896
- type Type = 'duration' | 'timestamp';
1897
- }
1898
- }
1899
-
1900
1391
  interface InvoiceSettings {
1901
1392
  /**
1902
1393
  * The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
@@ -1954,7 +1445,7 @@ declare module 'stripe' {
1954
1445
  id?: string;
1955
1446
 
1956
1447
  /**
1957
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1448
+ * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1958
1449
  */
1959
1450
  metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
1960
1451
 
@@ -1969,7 +1460,7 @@ declare module 'stripe' {
1969
1460
  price?: string;
1970
1461
 
1971
1462
  /**
1972
- * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
1463
+ * Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
1973
1464
  */
1974
1465
  price_data?: Item.PriceData;
1975
1466
 
@@ -1979,36 +1470,19 @@ declare module 'stripe' {
1979
1470
  quantity?: number;
1980
1471
 
1981
1472
  /**
1982
- * 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.
1473
+ * A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
1983
1474
  */
1984
1475
  tax_rates?: Stripe.Emptyable<Array<string>>;
1985
-
1986
- /**
1987
- * The trial offer to apply to this subscription item.
1988
- */
1989
- current_trial?: Item.CurrentTrial;
1990
1476
  }
1991
1477
 
1992
1478
  namespace Item {
1993
1479
  interface BillingThresholds {
1994
1480
  /**
1995
- * Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
1481
+ * Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
1996
1482
  */
1997
1483
  usage_gte: number;
1998
1484
  }
1999
1485
 
2000
- interface CurrentTrial {
2001
- /**
2002
- * Unix timestamp representing the end of the trial offer period. Required when the trial offer has `duration.type=timestamp`. Cannot be specified when `duration.type=relative`.
2003
- */
2004
- trial_end?: number;
2005
-
2006
- /**
2007
- * The ID of the trial offer to apply to the subscription item.
2008
- */
2009
- trial_offer: string;
2010
- }
2011
-
2012
1486
  interface Discount {
2013
1487
  /**
2014
1488
  * ID of the coupon to create a new discount for.
@@ -2020,56 +1494,12 @@ declare module 'stripe' {
2020
1494
  */
2021
1495
  discount?: string;
2022
1496
 
2023
- /**
2024
- * Details to determine how long the discount should be applied for.
2025
- */
2026
- discount_end?: Discount.DiscountEnd;
2027
-
2028
1497
  /**
2029
1498
  * ID of the promotion code to create a new discount for.
2030
1499
  */
2031
1500
  promotion_code?: string;
2032
1501
  }
2033
1502
 
2034
- namespace Discount {
2035
- interface DiscountEnd {
2036
- /**
2037
- * Time span for the redeemed discount.
2038
- */
2039
- duration?: DiscountEnd.Duration;
2040
-
2041
- /**
2042
- * A precise Unix timestamp for the discount to end. Must be in the future.
2043
- */
2044
- timestamp?: number;
2045
-
2046
- /**
2047
- * The type of calculation made to determine when the discount ends.
2048
- */
2049
- type: DiscountEnd.Type;
2050
- }
2051
-
2052
- namespace DiscountEnd {
2053
- interface Duration {
2054
- /**
2055
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2056
- */
2057
- interval: Duration.Interval;
2058
-
2059
- /**
2060
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2061
- */
2062
- interval_count: number;
2063
- }
2064
-
2065
- namespace Duration {
2066
- type Interval = 'day' | 'month' | 'week' | 'year';
2067
- }
2068
-
2069
- type Type = 'duration' | 'timestamp';
2070
- }
2071
- }
2072
-
2073
1503
  interface PriceData {
2074
1504
  /**
2075
1505
  * 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).
@@ -2087,7 +1517,7 @@ declare module 'stripe' {
2087
1517
  recurring: PriceData.Recurring;
2088
1518
 
2089
1519
  /**
2090
- * Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
1520
+ * Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
2091
1521
  */
2092
1522
  tax_behavior?: PriceData.TaxBehavior;
2093
1523
 
@@ -2188,33 +1618,21 @@ declare module 'stripe' {
2188
1618
  PaymentMethodOptions.CustomerBalance
2189
1619
  >;
2190
1620
 
2191
- /**
2192
- * This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
2193
- */
2194
- id_bank_transfer?: Stripe.Emptyable<
2195
- PaymentMethodOptions.IdBankTransfer
2196
- >;
2197
-
2198
1621
  /**
2199
1622
  * This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
2200
1623
  */
2201
1624
  konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
2202
1625
 
2203
1626
  /**
2204
- * This sub-hash contains details about the Pix payment method options to pass to the invoice's PaymentIntent.
1627
+ * This sub-hash contains details about the PayTo payment method options to pass to the invoice's PaymentIntent.
2205
1628
  */
2206
- pix?: Stripe.Emptyable<PaymentMethodOptions.Pix>;
1629
+ payto?: Stripe.Emptyable<PaymentMethodOptions.Payto>;
2207
1630
 
2208
1631
  /**
2209
1632
  * This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.
2210
1633
  */
2211
1634
  sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
2212
1635
 
2213
- /**
2214
- * This sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
2215
- */
2216
- upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
2217
-
2218
1636
  /**
2219
1637
  * This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
2220
1638
  */
@@ -2274,7 +1692,7 @@ declare module 'stripe' {
2274
1692
  network?: Card.Network;
2275
1693
 
2276
1694
  /**
2277
- * We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
1695
+ * We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
2278
1696
  */
2279
1697
  request_three_d_secure?: Card.RequestThreeDSecure;
2280
1698
  }
@@ -2354,89 +1772,46 @@ declare module 'stripe' {
2354
1772
  }
2355
1773
  }
2356
1774
 
2357
- interface IdBankTransfer {}
2358
-
2359
1775
  interface Konbini {}
2360
1776
 
2361
- interface Pix {
1777
+ interface Payto {
2362
1778
  /**
2363
- * Configuration options for setting up a mandate
1779
+ * Additional fields for Mandate creation.
2364
1780
  */
2365
- mandate_options?: Pix.MandateOptions;
1781
+ mandate_options?: Payto.MandateOptions;
2366
1782
  }
2367
1783
 
2368
- namespace Pix {
1784
+ namespace Payto {
2369
1785
  interface MandateOptions {
2370
1786
  /**
2371
- * Amount to be charged for future payments. If not provided, defaults to 40000.
1787
+ * The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
2372
1788
  */
2373
1789
  amount?: number;
2374
1790
 
2375
1791
  /**
2376
- * Determines if the amount includes the IOF tax. Defaults to `never`.
1792
+ * The purpose for which payments are made. Has a default value based on your merchant category code.
2377
1793
  */
2378
- amount_includes_iof?: MandateOptions.AmountIncludesIof;
2379
-
2380
- /**
2381
- * 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.
2382
- */
2383
- end_date?: string;
2384
-
2385
- /**
2386
- * Schedule at which the future payments will be charged. Defaults to `weekly`.
2387
- */
2388
- payment_schedule?: MandateOptions.PaymentSchedule;
1794
+ purpose?: MandateOptions.Purpose;
2389
1795
  }
2390
1796
 
2391
1797
  namespace MandateOptions {
2392
- type AmountIncludesIof = 'always' | 'never';
2393
-
2394
- type PaymentSchedule =
2395
- | 'halfyearly'
2396
- | 'monthly'
2397
- | 'quarterly'
2398
- | 'weekly'
2399
- | 'yearly';
1798
+ type Purpose =
1799
+ | 'dependant_support'
1800
+ | 'government'
1801
+ | 'loan'
1802
+ | 'mortgage'
1803
+ | 'other'
1804
+ | 'pension'
1805
+ | 'personal'
1806
+ | 'retail'
1807
+ | 'salary'
1808
+ | 'tax'
1809
+ | 'utility';
2400
1810
  }
2401
1811
  }
2402
1812
 
2403
1813
  interface SepaDebit {}
2404
1814
 
2405
- interface Upi {
2406
- /**
2407
- * Configuration options for setting up an eMandate
2408
- */
2409
- mandate_options?: Upi.MandateOptions;
2410
- }
2411
-
2412
- namespace Upi {
2413
- interface MandateOptions {
2414
- /**
2415
- * Amount to be charged for future payments.
2416
- */
2417
- amount?: number;
2418
-
2419
- /**
2420
- * 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.
2421
- */
2422
- amount_type?: MandateOptions.AmountType;
2423
-
2424
- /**
2425
- * A description of the mandate or subscription that is meant to be displayed to the customer.
2426
- */
2427
- description?: string;
2428
-
2429
- /**
2430
- * 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.
2431
- */
2432
- end_date?: number;
2433
- }
2434
-
2435
- namespace MandateOptions {
2436
- type AmountType = 'fixed' | 'maximum';
2437
- }
2438
- }
2439
-
2440
1815
  interface UsBankAccount {
2441
1816
  /**
2442
1817
  * Additional fields for Financial Connections Session creation
@@ -2473,11 +1848,6 @@ declare module 'stripe' {
2473
1848
  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
2474
1849
  */
2475
1850
  account_subcategories?: Array<Filters.AccountSubcategory>;
2476
-
2477
- /**
2478
- * ID of the institution to use to filter for selectable accounts.
2479
- */
2480
- institution?: string;
2481
1851
  }
2482
1852
 
2483
1853
  namespace Filters {
@@ -2490,11 +1860,7 @@ declare module 'stripe' {
2490
1860
  | 'payment_method'
2491
1861
  | 'transactions';
2492
1862
 
2493
- type Prefetch =
2494
- | 'balances'
2495
- | 'inferred_balances'
2496
- | 'ownership'
2497
- | 'transactions';
1863
+ type Prefetch = 'balances' | 'ownership' | 'transactions';
2498
1864
  }
2499
1865
 
2500
1866
  type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -2520,7 +1886,6 @@ declare module 'stripe' {
2520
1886
  | 'fpx'
2521
1887
  | 'giropay'
2522
1888
  | 'grabpay'
2523
- | 'id_bank_transfer'
2524
1889
  | 'ideal'
2525
1890
  | 'jp_credit_transfer'
2526
1891
  | 'kakao_pay'
@@ -2535,15 +1900,13 @@ declare module 'stripe' {
2535
1900
  | 'payco'
2536
1901
  | 'paynow'
2537
1902
  | 'paypal'
2538
- | 'pix'
1903
+ | 'payto'
2539
1904
  | 'promptpay'
2540
1905
  | 'revolut_pay'
2541
1906
  | 'sepa_credit_transfer'
2542
1907
  | 'sepa_debit'
2543
1908
  | 'sofort'
2544
- | 'stripe_balance'
2545
1909
  | 'swish'
2546
- | 'upi'
2547
1910
  | 'us_bank_account'
2548
1911
  | 'wechat_pay';
2549
1912
 
@@ -2566,22 +1929,6 @@ declare module 'stripe' {
2566
1929
  type Interval = 'day' | 'month' | 'week' | 'year';
2567
1930
  }
2568
1931
 
2569
- interface Prebilling {
2570
- /**
2571
- * This is used to determine the number of billing cycles to prebill.
2572
- */
2573
- iterations: number;
2574
-
2575
- /**
2576
- * Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
2577
- */
2578
- update_behavior?: Prebilling.UpdateBehavior;
2579
- }
2580
-
2581
- namespace Prebilling {
2582
- type UpdateBehavior = 'prebill' | 'reset';
2583
- }
2584
-
2585
1932
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
2586
1933
 
2587
1934
  interface TransferData {
@@ -2644,12 +1991,12 @@ declare module 'stripe' {
2644
1991
  current_period_start?: Stripe.RangeQueryParam | number;
2645
1992
 
2646
1993
  /**
2647
- * The ID of the customer whose subscriptions will be retrieved.
1994
+ * The ID of the customer whose subscriptions you're retrieving.
2648
1995
  */
2649
1996
  customer?: string;
2650
1997
 
2651
1998
  /**
2652
- * The ID of the account whose subscriptions will be retrieved.
1999
+ * The ID of the account representing the customer whose subscriptions you're retrieving.
2653
2000
  */
2654
2001
  customer_account?: string;
2655
2002
 
@@ -2669,7 +2016,7 @@ declare module 'stripe' {
2669
2016
  price?: string;
2670
2017
 
2671
2018
  /**
2672
- * The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
2019
+ * The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://docs.stripe.com/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
2673
2020
  */
2674
2021
  status?: SubscriptionListParams.Status;
2675
2022
 
@@ -2702,18 +2049,6 @@ declare module 'stripe' {
2702
2049
  | 'unpaid';
2703
2050
  }
2704
2051
 
2705
- interface SubscriptionAttachCadenceParams {
2706
- /**
2707
- * 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.
2708
- */
2709
- billing_cadence: string;
2710
-
2711
- /**
2712
- * Specifies which fields in the response should be expanded.
2713
- */
2714
- expand?: Array<string>;
2715
- }
2716
-
2717
2052
  interface SubscriptionCancelParams {
2718
2053
  /**
2719
2054
  * Details about why this subscription was cancelled
@@ -2805,7 +2140,7 @@ declare module 'stripe' {
2805
2140
 
2806
2141
  interface SubscriptionResumeParams {
2807
2142
  /**
2808
- * The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
2143
+ * The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
2809
2144
  */
2810
2145
  billing_cycle_anchor?: SubscriptionResumeParams.BillingCycleAnchor;
2811
2146
 
@@ -2815,7 +2150,7 @@ declare module 'stripe' {
2815
2150
  expand?: Array<string>;
2816
2151
 
2817
2152
  /**
2818
- * Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`.
2153
+ * Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`.
2819
2154
  */
2820
2155
  proration_behavior?: SubscriptionResumeParams.ProrationBehavior;
2821
2156
 
@@ -2833,7 +2168,7 @@ declare module 'stripe' {
2833
2168
 
2834
2169
  interface SubscriptionSearchParams {
2835
2170
  /**
2836
- * The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions).
2171
+ * The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for subscriptions](https://docs.stripe.com/search#query-fields-for-subscriptions).
2837
2172
  */
2838
2173
  query: string;
2839
2174
 
@@ -2922,15 +2257,6 @@ declare module 'stripe' {
2922
2257
  ): ApiListPromise<Stripe.Subscription>;
2923
2258
  list(options?: RequestOptions): ApiListPromise<Stripe.Subscription>;
2924
2259
 
2925
- /**
2926
- * 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.
2927
- */
2928
- attachCadence(
2929
- id: string,
2930
- params: SubscriptionAttachCadenceParams,
2931
- options?: RequestOptions
2932
- ): Promise<Stripe.Response<Stripe.Subscription>>;
2933
-
2934
2260
  /**
2935
2261
  * 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).
2936
2262
  *