stripe 20.1.0-beta.1 → 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 (398) hide show
  1. package/CHANGELOG.md +47 -1500
  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/Quotes.js +0 -32
  11. package/cjs/resources/SubscriptionSchedules.js +0 -4
  12. package/cjs/resources/Subscriptions.js +0 -4
  13. package/cjs/resources.js +2 -88
  14. package/cjs/stripe.core.js +1 -1
  15. package/esm/Error.js +0 -100
  16. package/esm/apiVersion.js +2 -1
  17. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  18. package/esm/resources/Mandates.js +0 -5
  19. package/esm/resources/PaymentIntents.js +0 -8
  20. package/esm/resources/Quotes.js +0 -32
  21. package/esm/resources/SubscriptionSchedules.js +0 -4
  22. package/esm/resources/Subscriptions.js +0 -4
  23. package/esm/resources.js +0 -81
  24. package/esm/stripe.core.js +1 -1
  25. package/package.json +1 -1
  26. package/types/AccountLinks.d.ts +1 -1
  27. package/types/AccountLinksResource.d.ts +1 -5
  28. package/types/AccountSessions.d.ts +2 -47
  29. package/types/AccountSessionsResource.d.ts +0 -264
  30. package/types/Accounts.d.ts +25 -249
  31. package/types/AccountsResource.d.ts +114 -620
  32. package/types/ApplicationFeesResource.d.ts +2 -2
  33. package/types/Apps/Secrets.d.ts +1 -1
  34. package/types/Balance.d.ts +2 -2
  35. package/types/BalanceSettings.d.ts +1 -1
  36. package/types/BalanceTransactions.d.ts +1 -1
  37. package/types/BankAccounts.d.ts +10 -12
  38. package/types/Billing/AlertTriggereds.d.ts +1 -1
  39. package/types/Billing/Alerts.d.ts +1 -1
  40. package/types/Billing/CreditBalanceSummary.d.ts +1 -1
  41. package/types/Billing/CreditBalanceSummaryResource.d.ts +2 -2
  42. package/types/Billing/CreditBalanceTransactionsResource.d.ts +2 -2
  43. package/types/Billing/CreditGrants.d.ts +3 -3
  44. package/types/Billing/CreditGrantsResource.d.ts +3 -3
  45. package/types/Billing/MeterEvents.d.ts +1 -1
  46. package/types/Billing/MeterEventsResource.d.ts +1 -1
  47. package/types/BillingPortal/Configurations.d.ts +10 -3
  48. package/types/BillingPortal/ConfigurationsResource.d.ts +20 -6
  49. package/types/BillingPortal/Sessions.d.ts +7 -7
  50. package/types/BillingPortal/SessionsResource.d.ts +7 -7
  51. package/types/Capabilities.d.ts +16 -18
  52. package/types/Cards.d.ts +2 -7
  53. package/types/CashBalances.d.ts +3 -3
  54. package/types/Charges.d.ts +59 -179
  55. package/types/ChargesResource.d.ts +88 -3868
  56. package/types/Checkout/Sessions.d.ts +20 -297
  57. package/types/Checkout/SessionsResource.d.ts +59 -417
  58. package/types/Climate/Orders.d.ts +1 -1
  59. package/types/Climate/OrdersResource.d.ts +2 -2
  60. package/types/ConfirmationTokens.d.ts +8 -109
  61. package/types/Coupons.d.ts +3 -38
  62. package/types/CouponsResource.d.ts +2 -25
  63. package/types/CreditNoteLineItems.d.ts +3 -17
  64. package/types/CreditNotes.d.ts +8 -5
  65. package/types/CreditNotesResource.d.ts +5 -5
  66. package/types/CustomerBalanceTransactions.d.ts +9 -6
  67. package/types/CustomerCashBalanceTransactions.d.ts +13 -10
  68. package/types/CustomerSessions.d.ts +1 -42
  69. package/types/CustomerSessionsResource.d.ts +0 -41
  70. package/types/Customers.d.ts +8 -5
  71. package/types/CustomersResource.d.ts +21 -23
  72. package/types/Discounts.d.ts +6 -6
  73. package/types/Disputes.d.ts +3 -43
  74. package/types/DisputesResource.d.ts +1 -12
  75. package/types/Entitlements/ActiveEntitlements.d.ts +1 -1
  76. package/types/Errors.d.ts +0 -85
  77. package/types/EventTypes.d.ts +0 -630
  78. package/types/Events.d.ts +1 -97
  79. package/types/ExchangeRates.d.ts +2 -2
  80. package/types/FeeRefunds.d.ts +2 -2
  81. package/types/FileLinks.d.ts +1 -1
  82. package/types/FileLinksResource.d.ts +2 -2
  83. package/types/Files.d.ts +4 -4
  84. package/types/FilesResource.d.ts +3 -3
  85. package/types/FinancialConnections/Accounts.d.ts +4 -37
  86. package/types/FinancialConnections/AccountsResource.d.ts +6 -38
  87. package/types/FinancialConnections/Sessions.d.ts +3 -51
  88. package/types/FinancialConnections/SessionsResource.d.ts +4 -41
  89. package/types/Forwarding/Requests.d.ts +1 -1
  90. package/types/Forwarding/RequestsResource.d.ts +1 -1
  91. package/types/FundingInstructions.d.ts +2 -2
  92. package/types/Identity/VerificationReports.d.ts +8 -8
  93. package/types/Identity/VerificationSessions.d.ts +11 -11
  94. package/types/Identity/VerificationSessionsResource.d.ts +18 -12
  95. package/types/InvoiceItems.d.ts +8 -13
  96. package/types/InvoiceItemsResource.d.ts +16 -114
  97. package/types/InvoiceLineItems.d.ts +10 -46
  98. package/types/InvoicePayments.d.ts +1 -1
  99. package/types/InvoiceRenderingTemplates.d.ts +1 -1
  100. package/types/Invoices.d.ts +60 -204
  101. package/types/InvoicesResource.d.ts +132 -1651
  102. package/types/Issuing/Authorizations.d.ts +20 -20
  103. package/types/Issuing/AuthorizationsResource.d.ts +4 -4
  104. package/types/Issuing/Cardholders.d.ts +13 -13
  105. package/types/Issuing/CardholdersResource.d.ts +21 -22
  106. package/types/Issuing/Cards.d.ts +10 -10
  107. package/types/Issuing/CardsResource.d.ts +13 -13
  108. package/types/Issuing/Disputes.d.ts +7 -7
  109. package/types/Issuing/DisputesResource.d.ts +5 -5
  110. package/types/Issuing/PersonalizationDesigns.d.ts +1 -1
  111. package/types/Issuing/PersonalizationDesignsResource.d.ts +2 -2
  112. package/types/Issuing/Tokens.d.ts +1 -1
  113. package/types/Issuing/Transactions.d.ts +12 -17
  114. package/types/Issuing/TransactionsResource.d.ts +1 -6
  115. package/types/LineItems.d.ts +4 -48
  116. package/types/LoginLinks.d.ts +1 -1
  117. package/types/Mandates.d.ts +1 -69
  118. package/types/MandatesResource.d.ts +0 -31
  119. package/types/PaymentAttemptRecords.d.ts +119 -135
  120. package/types/PaymentIntentAmountDetailsLineItems.d.ts +3 -3
  121. package/types/PaymentIntents.d.ts +48 -705
  122. package/types/PaymentIntentsResource.d.ts +6867 -19451
  123. package/types/PaymentLinks.d.ts +7 -12
  124. package/types/PaymentLinksResource.d.ts +28 -38
  125. package/types/PaymentMethodConfigurations.d.ts +4 -184
  126. package/types/PaymentMethodConfigurationsResource.d.ts +76 -326
  127. package/types/PaymentMethodDomains.d.ts +1 -1
  128. package/types/PaymentMethods.d.ts +10 -116
  129. package/types/PaymentMethodsResource.d.ts +7 -116
  130. package/types/PaymentRecords.d.ts +126 -135
  131. package/types/PaymentRecordsResource.d.ts +7 -7
  132. package/types/Payouts.d.ts +7 -7
  133. package/types/PayoutsResource.d.ts +3 -3
  134. package/types/Persons.d.ts +21 -23
  135. package/types/Plans.d.ts +5 -5
  136. package/types/PlansResource.d.ts +6 -6
  137. package/types/Prices.d.ts +6 -28
  138. package/types/PricesResource.d.ts +10 -32
  139. package/types/Products.d.ts +10 -10
  140. package/types/ProductsResource.d.ts +14 -14
  141. package/types/PromotionCodes.d.ts +5 -5
  142. package/types/PromotionCodesResource.d.ts +5 -5
  143. package/types/Quotes.d.ts +14 -602
  144. package/types/QuotesResource.d.ts +298 -2628
  145. package/types/Radar/EarlyFraudWarnings.d.ts +1 -1
  146. package/types/Radar/ValueListItems.d.ts +1 -1
  147. package/types/Radar/ValueLists.d.ts +2 -2
  148. package/types/Radar/ValueListsResource.d.ts +2 -2
  149. package/types/Refunds.d.ts +3 -17
  150. package/types/RefundsResource.d.ts +3 -3
  151. package/types/Reporting/ReportRuns.d.ts +3 -3
  152. package/types/Reporting/ReportRunsResource.d.ts +2 -2
  153. package/types/Reporting/ReportTypes.d.ts +3 -3
  154. package/types/Reviews.d.ts +1 -1
  155. package/types/SetupAttempts.d.ts +22 -60
  156. package/types/SetupIntents.d.ts +22 -157
  157. package/types/SetupIntentsResource.d.ts +50 -673
  158. package/types/ShippingRates.d.ts +3 -3
  159. package/types/ShippingRatesResource.d.ts +3 -3
  160. package/types/Sigma/ScheduledQueryRuns.d.ts +1 -1
  161. package/types/SourceMandateNotifications.d.ts +3 -3
  162. package/types/Sources.d.ts +5 -34
  163. package/types/SourcesResource.d.ts +2 -2
  164. package/types/SubscriptionItems.d.ts +7 -33
  165. package/types/SubscriptionItemsResource.d.ts +22 -131
  166. package/types/SubscriptionSchedules.d.ts +9 -209
  167. package/types/SubscriptionSchedulesResource.d.ts +39 -1257
  168. package/types/Subscriptions.d.ts +41 -251
  169. package/types/SubscriptionsResource.d.ts +94 -734
  170. package/types/Tax/Associations.d.ts +3 -3
  171. package/types/Tax/AssociationsResource.d.ts +1 -1
  172. package/types/Tax/CalculationLineItems.d.ts +7 -7
  173. package/types/Tax/Calculations.d.ts +12 -12
  174. package/types/Tax/CalculationsResource.d.ts +7 -7
  175. package/types/Tax/Registrations.d.ts +3 -3
  176. package/types/Tax/Settings.d.ts +1 -1
  177. package/types/Tax/SettingsResource.d.ts +1 -1
  178. package/types/Tax/TransactionLineItems.d.ts +5 -5
  179. package/types/Tax/Transactions.d.ts +9 -9
  180. package/types/Tax/TransactionsResource.d.ts +10 -10
  181. package/types/TaxIds.d.ts +6 -6
  182. package/types/TaxIdsResource.d.ts +4 -4
  183. package/types/TaxRates.d.ts +1 -1
  184. package/types/TaxRatesResource.d.ts +2 -2
  185. package/types/Terminal/Configurations.d.ts +0 -9
  186. package/types/Terminal/ConfigurationsResource.d.ts +0 -28
  187. package/types/Terminal/ConnectionTokens.d.ts +1 -1
  188. package/types/Terminal/Locations.d.ts +2 -2
  189. package/types/Terminal/LocationsResource.d.ts +3 -3
  190. package/types/Terminal/Readers.d.ts +10 -30
  191. package/types/Terminal/ReadersResource.d.ts +7 -7
  192. package/types/TestHelpers/ConfirmationTokensResource.d.ts +5 -107
  193. package/types/TestHelpers/CustomersResource.d.ts +2 -2
  194. package/types/TestHelpers/Issuing/AuthorizationsResource.d.ts +10 -10
  195. package/types/TestHelpers/Issuing/TransactionsResource.d.ts +5 -5
  196. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +1 -27
  197. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +1 -27
  198. package/types/Tokens.d.ts +4 -4
  199. package/types/TokensResource.d.ts +17 -17
  200. package/types/Topups.d.ts +3 -3
  201. package/types/TopupsResource.d.ts +3 -3
  202. package/types/TransferReversals.d.ts +4 -4
  203. package/types/Transfers.d.ts +5 -10
  204. package/types/TransfersResource.d.ts +6 -11
  205. package/types/Treasury/CreditReversals.d.ts +3 -3
  206. package/types/Treasury/CreditReversalsResource.d.ts +1 -1
  207. package/types/Treasury/DebitReversals.d.ts +3 -3
  208. package/types/Treasury/DebitReversalsResource.d.ts +1 -1
  209. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  210. package/types/Treasury/FinancialAccounts.d.ts +1 -6
  211. package/types/Treasury/FinancialAccountsResource.d.ts +2 -39
  212. package/types/Treasury/InboundTransfers.d.ts +4 -4
  213. package/types/Treasury/InboundTransfersResource.d.ts +2 -2
  214. package/types/Treasury/OutboundPayments.d.ts +5 -5
  215. package/types/Treasury/OutboundPaymentsResource.d.ts +4 -4
  216. package/types/Treasury/OutboundTransfers.d.ts +4 -30
  217. package/types/Treasury/OutboundTransfersResource.d.ts +3 -29
  218. package/types/Treasury/ReceivedCredits.d.ts +9 -35
  219. package/types/Treasury/ReceivedDebits.d.ts +6 -37
  220. package/types/Treasury/TransactionEntries.d.ts +11 -11
  221. package/types/Treasury/Transactions.d.ts +11 -11
  222. package/types/V2/Core/AccountLinks.d.ts +13 -21
  223. package/types/V2/Core/AccountLinksResource.d.ts +8 -16
  224. package/types/V2/Core/AccountPersons.d.ts +55 -10
  225. package/types/V2/Core/AccountTokensResource.d.ts +129 -24
  226. package/types/V2/Core/Accounts/PersonTokensResource.d.ts +48 -3
  227. package/types/V2/Core/Accounts/PersonsResource.d.ts +101 -11
  228. package/types/V2/Core/Accounts.d.ts +256 -1349
  229. package/types/V2/Core/AccountsResource.d.ts +282 -567
  230. package/types/V2/Core/EventTypes.d.ts +10 -1542
  231. package/types/WebhookEndpoints.d.ts +1 -1
  232. package/types/WebhookEndpointsResource.d.ts +5 -79
  233. package/types/apiVersion.d.ts +2 -1
  234. package/types/index.d.ts +0 -134
  235. package/types/lib.d.ts +0 -10
  236. package/cjs/resources/AccountNotices.js +0 -21
  237. package/cjs/resources/Billing/Analytics/MeterUsage.js +0 -12
  238. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  239. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  240. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  241. package/cjs/resources/ExternalAccounts.js +0 -23
  242. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  243. package/cjs/resources/FxQuotes.js +0 -15
  244. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  245. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  246. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  247. package/cjs/resources/Margins.js +0 -22
  248. package/cjs/resources/Orders.js +0 -24
  249. package/cjs/resources/Privacy/RedactionJobs.js +0 -42
  250. package/cjs/resources/Tax/Forms.js +0 -20
  251. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  252. package/cjs/resources/V2/Billing/BillSettings/Versions.js +0 -17
  253. package/cjs/resources/V2/Billing/BillSettings.js +0 -27
  254. package/cjs/resources/V2/Billing/Cadences.js +0 -23
  255. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +0 -17
  256. package/cjs/resources/V2/Billing/CollectionSettings.js +0 -30
  257. package/cjs/resources/V2/Billing/Profiles.js +0 -19
  258. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -33
  259. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -37
  260. package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
  261. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -29
  262. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
  263. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
  264. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -16
  265. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
  266. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
  267. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
  268. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
  269. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
  270. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
  271. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
  272. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
  273. package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
  274. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
  275. package/esm/resources/AccountNotices.js +0 -18
  276. package/esm/resources/Billing/Analytics/MeterUsage.js +0 -9
  277. package/esm/resources/Capital/FinancingOffers.js +0 -18
  278. package/esm/resources/Capital/FinancingSummary.js +0 -9
  279. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  280. package/esm/resources/ExternalAccounts.js +0 -20
  281. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  282. package/esm/resources/FxQuotes.js +0 -12
  283. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  284. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  285. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  286. package/esm/resources/Margins.js +0 -19
  287. package/esm/resources/Orders.js +0 -21
  288. package/esm/resources/Privacy/RedactionJobs.js +0 -39
  289. package/esm/resources/Tax/Forms.js +0 -17
  290. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  291. package/esm/resources/V2/Billing/BillSettings/Versions.js +0 -14
  292. package/esm/resources/V2/Billing/BillSettings.js +0 -24
  293. package/esm/resources/V2/Billing/Cadences.js +0 -20
  294. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +0 -14
  295. package/esm/resources/V2/Billing/CollectionSettings.js +0 -27
  296. package/esm/resources/V2/Billing/Profiles.js +0 -16
  297. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -30
  298. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -34
  299. package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
  300. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -26
  301. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
  302. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
  303. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -13
  304. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
  305. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
  306. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
  307. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
  308. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
  309. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
  310. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
  311. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
  312. package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
  313. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
  314. package/types/AccountNotices.d.ts +0 -113
  315. package/types/AccountNoticesResource.d.ts +0 -98
  316. package/types/Billing/Analytics/MeterUsage.d.ts +0 -31
  317. package/types/Billing/Analytics/MeterUsageResource.d.ts +0 -689
  318. package/types/Billing/Analytics/MeterUsageRows.d.ts +0 -51
  319. package/types/Capital/FinancingOffers.d.ts +0 -188
  320. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  321. package/types/Capital/FinancingSummary.d.ts +0 -106
  322. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  323. package/types/Capital/FinancingTransactions.d.ts +0 -135
  324. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  325. package/types/ExternalAccountsResource.d.ts +0 -304
  326. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  327. package/types/FinancialConnections/Institutions.d.ts +0 -98
  328. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  329. package/types/FxQuotes.d.ts +0 -155
  330. package/types/FxQuotesResource.d.ts +0 -130
  331. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  332. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  333. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
  334. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  335. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  336. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  337. package/types/Issuing/Settlements.d.ts +0 -113
  338. package/types/Margins.d.ts +0 -56
  339. package/types/MarginsResource.d.ts +0 -114
  340. package/types/Orders.d.ts +0 -1163
  341. package/types/OrdersResource.d.ts +0 -5505
  342. package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -60
  343. package/types/Privacy/RedactionJobs.d.ts +0 -111
  344. package/types/Privacy/RedactionJobsResource.d.ts +0 -230
  345. package/types/QuoteLines.d.ts +0 -634
  346. package/types/QuotePreviewInvoices.d.ts +0 -1771
  347. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -908
  348. package/types/Tax/Forms.d.ts +0 -220
  349. package/types/Tax/FormsResource.d.ts +0 -107
  350. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  351. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  352. package/types/V2/Billing/BillSettingVersions.d.ts +0 -97
  353. package/types/V2/Billing/BillSettings/VersionsResource.d.ts +0 -58
  354. package/types/V2/Billing/BillSettings.d.ts +0 -120
  355. package/types/V2/Billing/BillSettingsResource.d.ts +0 -241
  356. package/types/V2/Billing/Cadences.d.ts +0 -690
  357. package/types/V2/Billing/CadencesResource.d.ts +0 -487
  358. package/types/V2/Billing/CollectionSettingVersions.d.ts +0 -318
  359. package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +0 -62
  360. package/types/V2/Billing/CollectionSettings.d.ts +0 -341
  361. package/types/V2/Billing/CollectionSettingsResource.d.ts +0 -683
  362. package/types/V2/Billing/Profiles.d.ts +0 -70
  363. package/types/V2/Billing/ProfilesResource.d.ts +0 -150
  364. package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
  365. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -194
  366. package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -116
  367. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -198
  368. package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -27
  369. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -32
  370. package/types/V2/MoneyManagement/Adjustments.d.ts +0 -110
  371. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
  372. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -148
  373. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -172
  374. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -175
  375. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -109
  376. package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -212
  377. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
  378. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -170
  379. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -115
  380. package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -278
  381. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
  382. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
  383. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
  384. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -251
  385. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -208
  386. package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -160
  387. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +0 -93
  388. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
  389. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
  390. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -302
  391. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
  392. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -176
  393. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
  394. package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -162
  395. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
  396. package/types/V2/MoneyManagement/Transactions.d.ts +0 -177
  397. package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
  398. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -68
@@ -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,20 +511,15 @@ 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
517
  }
694
518
 
695
519
  namespace Item {
696
520
  interface BillingThresholds {
697
521
  /**
698
- * 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))
699
523
  */
700
524
  usage_gte: number;
701
525
  }
@@ -711,56 +535,12 @@ declare module 'stripe' {
711
535
  */
712
536
  discount?: string;
713
537
 
714
- /**
715
- * Details to determine how long the discount should be applied for.
716
- */
717
- discount_end?: Discount.DiscountEnd;
718
-
719
538
  /**
720
539
  * ID of the promotion code to create a new discount for.
721
540
  */
722
541
  promotion_code?: string;
723
542
  }
724
543
 
725
- namespace Discount {
726
- interface DiscountEnd {
727
- /**
728
- * Time span for the redeemed discount.
729
- */
730
- duration?: DiscountEnd.Duration;
731
-
732
- /**
733
- * A precise Unix timestamp for the discount to end. Must be in the future.
734
- */
735
- timestamp?: number;
736
-
737
- /**
738
- * The type of calculation made to determine when the discount ends.
739
- */
740
- type: DiscountEnd.Type;
741
- }
742
-
743
- namespace DiscountEnd {
744
- interface Duration {
745
- /**
746
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
747
- */
748
- interval: Duration.Interval;
749
-
750
- /**
751
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
752
- */
753
- interval_count: number;
754
- }
755
-
756
- namespace Duration {
757
- type Interval = 'day' | 'month' | 'week' | 'year';
758
- }
759
-
760
- type Type = 'duration' | 'timestamp';
761
- }
762
- }
763
-
764
544
  interface PriceData {
765
545
  /**
766
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).
@@ -778,7 +558,7 @@ declare module 'stripe' {
778
558
  recurring: PriceData.Recurring;
779
559
 
780
560
  /**
781
- * 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.
782
562
  */
783
563
  tax_behavior?: PriceData.TaxBehavior;
784
564
 
@@ -812,22 +592,6 @@ declare module 'stripe' {
812
592
 
813
593
  type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
814
594
  }
815
-
816
- interface Trial {
817
- /**
818
- * 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.
819
- */
820
- converts_to?: Array<string>;
821
-
822
- /**
823
- * Determines the type of trial for this item.
824
- */
825
- type: Trial.Type;
826
- }
827
-
828
- namespace Trial {
829
- type Type = 'free' | 'paid';
830
- }
831
595
  }
832
596
 
833
597
  type PaymentBehavior =
@@ -879,33 +643,21 @@ declare module 'stripe' {
879
643
  PaymentMethodOptions.CustomerBalance
880
644
  >;
881
645
 
882
- /**
883
- * This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
884
- */
885
- id_bank_transfer?: Stripe.Emptyable<
886
- PaymentMethodOptions.IdBankTransfer
887
- >;
888
-
889
646
  /**
890
647
  * This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
891
648
  */
892
649
  konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
893
650
 
894
651
  /**
895
- * 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.
896
653
  */
897
- pix?: Stripe.Emptyable<PaymentMethodOptions.Pix>;
654
+ payto?: Stripe.Emptyable<PaymentMethodOptions.Payto>;
898
655
 
899
656
  /**
900
657
  * This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.
901
658
  */
902
659
  sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
903
660
 
904
- /**
905
- * This sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
906
- */
907
- upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
908
-
909
661
  /**
910
662
  * This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
911
663
  */
@@ -965,7 +717,7 @@ declare module 'stripe' {
965
717
  network?: Card.Network;
966
718
 
967
719
  /**
968
- * 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.
969
721
  */
970
722
  request_three_d_secure?: Card.RequestThreeDSecure;
971
723
  }
@@ -1045,89 +797,46 @@ declare module 'stripe' {
1045
797
  }
1046
798
  }
1047
799
 
1048
- interface IdBankTransfer {}
1049
-
1050
800
  interface Konbini {}
1051
801
 
1052
- interface Pix {
802
+ interface Payto {
1053
803
  /**
1054
- * Configuration options for setting up a mandate
804
+ * Additional fields for Mandate creation.
1055
805
  */
1056
- mandate_options?: Pix.MandateOptions;
806
+ mandate_options?: Payto.MandateOptions;
1057
807
  }
1058
808
 
1059
- namespace Pix {
809
+ namespace Payto {
1060
810
  interface MandateOptions {
1061
811
  /**
1062
- * 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.
1063
813
  */
1064
814
  amount?: number;
1065
815
 
1066
816
  /**
1067
- * Determines if the amount includes the IOF tax. Defaults to `never`.
1068
- */
1069
- amount_includes_iof?: MandateOptions.AmountIncludesIof;
1070
-
1071
- /**
1072
- * 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.
1073
- */
1074
- end_date?: string;
1075
-
1076
- /**
1077
- * Schedule at which the future payments will be charged. Defaults to `weekly`.
817
+ * The purpose for which payments are made. Has a default value based on your merchant category code.
1078
818
  */
1079
- payment_schedule?: MandateOptions.PaymentSchedule;
819
+ purpose?: MandateOptions.Purpose;
1080
820
  }
1081
821
 
1082
822
  namespace MandateOptions {
1083
- type AmountIncludesIof = 'always' | 'never';
1084
-
1085
- type PaymentSchedule =
1086
- | 'halfyearly'
1087
- | 'monthly'
1088
- | 'quarterly'
1089
- | 'weekly'
1090
- | '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';
1091
835
  }
1092
836
  }
1093
837
 
1094
838
  interface SepaDebit {}
1095
839
 
1096
- interface Upi {
1097
- /**
1098
- * Configuration options for setting up an eMandate
1099
- */
1100
- mandate_options?: Upi.MandateOptions;
1101
- }
1102
-
1103
- namespace Upi {
1104
- interface MandateOptions {
1105
- /**
1106
- * Amount to be charged for future payments.
1107
- */
1108
- amount?: number;
1109
-
1110
- /**
1111
- * 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.
1112
- */
1113
- amount_type?: MandateOptions.AmountType;
1114
-
1115
- /**
1116
- * A description of the mandate or subscription that is meant to be displayed to the customer.
1117
- */
1118
- description?: string;
1119
-
1120
- /**
1121
- * 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.
1122
- */
1123
- end_date?: number;
1124
- }
1125
-
1126
- namespace MandateOptions {
1127
- type AmountType = 'fixed' | 'maximum';
1128
- }
1129
- }
1130
-
1131
840
  interface UsBankAccount {
1132
841
  /**
1133
842
  * Additional fields for Financial Connections Session creation
@@ -1164,11 +873,6 @@ declare module 'stripe' {
1164
873
  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
1165
874
  */
1166
875
  account_subcategories?: Array<Filters.AccountSubcategory>;
1167
-
1168
- /**
1169
- * ID of the institution to use to filter for selectable accounts.
1170
- */
1171
- institution?: string;
1172
876
  }
1173
877
 
1174
878
  namespace Filters {
@@ -1181,11 +885,7 @@ declare module 'stripe' {
1181
885
  | 'payment_method'
1182
886
  | 'transactions';
1183
887
 
1184
- type Prefetch =
1185
- | 'balances'
1186
- | 'inferred_balances'
1187
- | 'ownership'
1188
- | 'transactions';
888
+ type Prefetch = 'balances' | 'ownership' | 'transactions';
1189
889
  }
1190
890
 
1191
891
  type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -1211,7 +911,6 @@ declare module 'stripe' {
1211
911
  | 'fpx'
1212
912
  | 'giropay'
1213
913
  | 'grabpay'
1214
- | 'id_bank_transfer'
1215
914
  | 'ideal'
1216
915
  | 'jp_credit_transfer'
1217
916
  | 'kakao_pay'
@@ -1226,15 +925,13 @@ declare module 'stripe' {
1226
925
  | 'payco'
1227
926
  | 'paynow'
1228
927
  | 'paypal'
1229
- | 'pix'
928
+ | 'payto'
1230
929
  | 'promptpay'
1231
930
  | 'revolut_pay'
1232
931
  | 'sepa_credit_transfer'
1233
932
  | 'sepa_debit'
1234
933
  | 'sofort'
1235
- | 'stripe_balance'
1236
934
  | 'swish'
1237
- | 'upi'
1238
935
  | 'us_bank_account'
1239
936
  | 'wechat_pay';
1240
937
 
@@ -1257,22 +954,6 @@ declare module 'stripe' {
1257
954
  type Interval = 'day' | 'month' | 'week' | 'year';
1258
955
  }
1259
956
 
1260
- interface Prebilling {
1261
- /**
1262
- * This is used to determine the number of billing cycles to prebill.
1263
- */
1264
- iterations: number;
1265
-
1266
- /**
1267
- * Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
1268
- */
1269
- update_behavior?: Prebilling.UpdateBehavior;
1270
- }
1271
-
1272
- namespace Prebilling {
1273
- type UpdateBehavior = 'prebill' | 'reset';
1274
- }
1275
-
1276
957
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
1277
958
 
1278
959
  interface TransferData {
@@ -1332,22 +1013,10 @@ declare module 'stripe' {
1332
1013
  automatic_tax?: SubscriptionUpdateParams.AutomaticTax;
1333
1014
 
1334
1015
  /**
1335
- * 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.
1336
- */
1337
- billing_cadence?: string;
1338
-
1339
- /**
1340
- * 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).
1341
1017
  */
1342
1018
  billing_cycle_anchor?: SubscriptionUpdateParams.BillingCycleAnchor;
1343
1019
 
1344
- /**
1345
- * Sets the billing schedules for the subscription.
1346
- */
1347
- billing_schedules?: Stripe.Emptyable<
1348
- Array<SubscriptionUpdateParams.BillingSchedule>
1349
- >;
1350
-
1351
1020
  /**
1352
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.
1353
1022
  */
@@ -1381,12 +1050,12 @@ declare module 'stripe' {
1381
1050
  days_until_due?: number;
1382
1051
 
1383
1052
  /**
1384
- * 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).
1385
1054
  */
1386
1055
  default_payment_method?: string;
1387
1056
 
1388
1057
  /**
1389
- * 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).
1390
1059
  */
1391
1060
  default_source?: Stripe.Emptyable<string>;
1392
1061
 
@@ -1421,7 +1090,7 @@ declare module 'stripe' {
1421
1090
  items?: Array<SubscriptionUpdateParams.Item>;
1422
1091
 
1423
1092
  /**
1424
- * 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`.
1425
1094
  */
1426
1095
  metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
1427
1096
 
@@ -1436,18 +1105,18 @@ declare module 'stripe' {
1436
1105
  on_behalf_of?: Stripe.Emptyable<string>;
1437
1106
 
1438
1107
  /**
1439
- * 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).
1440
1109
  */
1441
1110
  pause_collection?: Stripe.Emptyable<
1442
1111
  SubscriptionUpdateParams.PauseCollection
1443
1112
  >;
1444
1113
 
1445
1114
  /**
1446
- * 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.
1447
1116
  *
1448
- * 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.
1449
1118
  *
1450
- * 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).
1451
1120
  *
1452
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.
1453
1122
  */
@@ -1459,19 +1128,14 @@ declare module 'stripe' {
1459
1128
  payment_settings?: SubscriptionUpdateParams.PaymentSettings;
1460
1129
 
1461
1130
  /**
1462
- * 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.
1463
1132
  */
1464
1133
  pending_invoice_item_interval?: Stripe.Emptyable<
1465
1134
  SubscriptionUpdateParams.PendingInvoiceItemInterval
1466
1135
  >;
1467
1136
 
1468
1137
  /**
1469
- * If specified, the invoicing for the given billing cycle iterations will be processed now.
1470
- */
1471
- prebilling?: SubscriptionUpdateParams.Prebilling;
1472
-
1473
- /**
1474
- * 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`.
1475
1139
  */
1476
1140
  proration_behavior?: SubscriptionUpdateParams.ProrationBehavior;
1477
1141
 
@@ -1491,7 +1155,7 @@ declare module 'stripe' {
1491
1155
  trial_end?: 'now' | number;
1492
1156
 
1493
1157
  /**
1494
- * 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.
1495
1159
  */
1496
1160
  trial_from_plan?: boolean;
1497
1161
 
@@ -1509,7 +1173,7 @@ declare module 'stripe' {
1509
1173
  discounts?: Array<AddInvoiceItem.Discount>;
1510
1174
 
1511
1175
  /**
1512
- * 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`.
1513
1177
  */
1514
1178
  metadata?: Stripe.MetadataParam;
1515
1179
 
@@ -1524,7 +1188,7 @@ declare module 'stripe' {
1524
1188
  price?: string;
1525
1189
 
1526
1190
  /**
1527
- * 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.
1528
1192
  */
1529
1193
  price_data?: AddInvoiceItem.PriceData;
1530
1194
 
@@ -1551,56 +1215,12 @@ declare module 'stripe' {
1551
1215
  */
1552
1216
  discount?: string;
1553
1217
 
1554
- /**
1555
- * Details to determine how long the discount should be applied for.
1556
- */
1557
- discount_end?: Discount.DiscountEnd;
1558
-
1559
1218
  /**
1560
1219
  * ID of the promotion code to create a new discount for.
1561
1220
  */
1562
1221
  promotion_code?: string;
1563
1222
  }
1564
1223
 
1565
- namespace Discount {
1566
- interface DiscountEnd {
1567
- /**
1568
- * Time span for the redeemed discount.
1569
- */
1570
- duration?: DiscountEnd.Duration;
1571
-
1572
- /**
1573
- * A precise Unix timestamp for the discount to end. Must be in the future.
1574
- */
1575
- timestamp?: number;
1576
-
1577
- /**
1578
- * The type of calculation made to determine when the discount ends.
1579
- */
1580
- type: DiscountEnd.Type;
1581
- }
1582
-
1583
- namespace DiscountEnd {
1584
- interface Duration {
1585
- /**
1586
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1587
- */
1588
- interval: Duration.Interval;
1589
-
1590
- /**
1591
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1592
- */
1593
- interval_count: number;
1594
- }
1595
-
1596
- namespace Duration {
1597
- type Interval = 'day' | 'month' | 'week' | 'year';
1598
- }
1599
-
1600
- type Type = 'duration' | 'timestamp';
1601
- }
1602
- }
1603
-
1604
1224
  interface Period {
1605
1225
  /**
1606
1226
  * End of the invoice item period.
@@ -1659,7 +1279,7 @@ declare module 'stripe' {
1659
1279
  product: string;
1660
1280
 
1661
1281
  /**
1662
- * 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.
1663
1283
  */
1664
1284
  tax_behavior?: PriceData.TaxBehavior;
1665
1285
 
@@ -1711,74 +1331,6 @@ declare module 'stripe' {
1711
1331
 
1712
1332
  type BillingCycleAnchor = 'now' | 'unchanged';
1713
1333
 
1714
- interface BillingSchedule {
1715
- /**
1716
- * Configure billing schedule differently for individual subscription items.
1717
- */
1718
- applies_to?: Array<BillingSchedule.AppliesTo>;
1719
-
1720
- /**
1721
- * The end date for the billing schedule.
1722
- */
1723
- bill_until?: BillingSchedule.BillUntil;
1724
-
1725
- /**
1726
- * 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.
1727
- */
1728
- key?: string;
1729
- }
1730
-
1731
- namespace BillingSchedule {
1732
- interface AppliesTo {
1733
- /**
1734
- * The ID of the price object.
1735
- */
1736
- price?: string;
1737
-
1738
- /**
1739
- * Controls which subscription items the billing schedule applies to.
1740
- */
1741
- type: 'price';
1742
- }
1743
-
1744
- interface BillUntil {
1745
- /**
1746
- * Specifies the billing period.
1747
- */
1748
- duration?: BillUntil.Duration;
1749
-
1750
- /**
1751
- * The end date of the billing schedule.
1752
- */
1753
- timestamp?: number;
1754
-
1755
- /**
1756
- * Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
1757
- */
1758
- type: BillUntil.Type;
1759
- }
1760
-
1761
- namespace BillUntil {
1762
- interface Duration {
1763
- /**
1764
- * Specifies billing duration. Either `day`, `week`, `month` or `year`.
1765
- */
1766
- interval: Duration.Interval;
1767
-
1768
- /**
1769
- * The multiplier applied to the interval.
1770
- */
1771
- interval_count?: number;
1772
- }
1773
-
1774
- namespace Duration {
1775
- type Interval = 'day' | 'month' | 'week' | 'year';
1776
- }
1777
-
1778
- type Type = 'duration' | 'timestamp';
1779
- }
1780
- }
1781
-
1782
1334
  interface BillingThresholds {
1783
1335
  /**
1784
1336
  * Monetary threshold that triggers the subscription to advance to a new billing period
@@ -1830,56 +1382,12 @@ declare module 'stripe' {
1830
1382
  */
1831
1383
  discount?: string;
1832
1384
 
1833
- /**
1834
- * Details to determine how long the discount should be applied for.
1835
- */
1836
- discount_end?: Discount.DiscountEnd;
1837
-
1838
1385
  /**
1839
1386
  * ID of the promotion code to create a new discount for.
1840
1387
  */
1841
1388
  promotion_code?: string;
1842
1389
  }
1843
1390
 
1844
- namespace Discount {
1845
- interface DiscountEnd {
1846
- /**
1847
- * Time span for the redeemed discount.
1848
- */
1849
- duration?: DiscountEnd.Duration;
1850
-
1851
- /**
1852
- * A precise Unix timestamp for the discount to end. Must be in the future.
1853
- */
1854
- timestamp?: number;
1855
-
1856
- /**
1857
- * The type of calculation made to determine when the discount ends.
1858
- */
1859
- type: DiscountEnd.Type;
1860
- }
1861
-
1862
- namespace DiscountEnd {
1863
- interface Duration {
1864
- /**
1865
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1866
- */
1867
- interval: Duration.Interval;
1868
-
1869
- /**
1870
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1871
- */
1872
- interval_count: number;
1873
- }
1874
-
1875
- namespace Duration {
1876
- type Interval = 'day' | 'month' | 'week' | 'year';
1877
- }
1878
-
1879
- type Type = 'duration' | 'timestamp';
1880
- }
1881
- }
1882
-
1883
1391
  interface InvoiceSettings {
1884
1392
  /**
1885
1393
  * The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
@@ -1937,7 +1445,7 @@ declare module 'stripe' {
1937
1445
  id?: string;
1938
1446
 
1939
1447
  /**
1940
- * 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`.
1941
1449
  */
1942
1450
  metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
1943
1451
 
@@ -1952,7 +1460,7 @@ declare module 'stripe' {
1952
1460
  price?: string;
1953
1461
 
1954
1462
  /**
1955
- * 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.
1956
1464
  */
1957
1465
  price_data?: Item.PriceData;
1958
1466
 
@@ -1962,7 +1470,7 @@ declare module 'stripe' {
1962
1470
  quantity?: number;
1963
1471
 
1964
1472
  /**
1965
- * 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.
1966
1474
  */
1967
1475
  tax_rates?: Stripe.Emptyable<Array<string>>;
1968
1476
  }
@@ -1970,7 +1478,7 @@ declare module 'stripe' {
1970
1478
  namespace Item {
1971
1479
  interface BillingThresholds {
1972
1480
  /**
1973
- * 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))
1974
1482
  */
1975
1483
  usage_gte: number;
1976
1484
  }
@@ -1986,56 +1494,12 @@ declare module 'stripe' {
1986
1494
  */
1987
1495
  discount?: string;
1988
1496
 
1989
- /**
1990
- * Details to determine how long the discount should be applied for.
1991
- */
1992
- discount_end?: Discount.DiscountEnd;
1993
-
1994
1497
  /**
1995
1498
  * ID of the promotion code to create a new discount for.
1996
1499
  */
1997
1500
  promotion_code?: string;
1998
1501
  }
1999
1502
 
2000
- namespace Discount {
2001
- interface DiscountEnd {
2002
- /**
2003
- * Time span for the redeemed discount.
2004
- */
2005
- duration?: DiscountEnd.Duration;
2006
-
2007
- /**
2008
- * A precise Unix timestamp for the discount to end. Must be in the future.
2009
- */
2010
- timestamp?: number;
2011
-
2012
- /**
2013
- * The type of calculation made to determine when the discount ends.
2014
- */
2015
- type: DiscountEnd.Type;
2016
- }
2017
-
2018
- namespace DiscountEnd {
2019
- interface Duration {
2020
- /**
2021
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2022
- */
2023
- interval: Duration.Interval;
2024
-
2025
- /**
2026
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2027
- */
2028
- interval_count: number;
2029
- }
2030
-
2031
- namespace Duration {
2032
- type Interval = 'day' | 'month' | 'week' | 'year';
2033
- }
2034
-
2035
- type Type = 'duration' | 'timestamp';
2036
- }
2037
- }
2038
-
2039
1503
  interface PriceData {
2040
1504
  /**
2041
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).
@@ -2053,7 +1517,7 @@ declare module 'stripe' {
2053
1517
  recurring: PriceData.Recurring;
2054
1518
 
2055
1519
  /**
2056
- * 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.
2057
1521
  */
2058
1522
  tax_behavior?: PriceData.TaxBehavior;
2059
1523
 
@@ -2154,33 +1618,21 @@ declare module 'stripe' {
2154
1618
  PaymentMethodOptions.CustomerBalance
2155
1619
  >;
2156
1620
 
2157
- /**
2158
- * This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
2159
- */
2160
- id_bank_transfer?: Stripe.Emptyable<
2161
- PaymentMethodOptions.IdBankTransfer
2162
- >;
2163
-
2164
1621
  /**
2165
1622
  * This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
2166
1623
  */
2167
1624
  konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
2168
1625
 
2169
1626
  /**
2170
- * 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.
2171
1628
  */
2172
- pix?: Stripe.Emptyable<PaymentMethodOptions.Pix>;
1629
+ payto?: Stripe.Emptyable<PaymentMethodOptions.Payto>;
2173
1630
 
2174
1631
  /**
2175
1632
  * This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.
2176
1633
  */
2177
1634
  sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
2178
1635
 
2179
- /**
2180
- * This sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
2181
- */
2182
- upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
2183
-
2184
1636
  /**
2185
1637
  * This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
2186
1638
  */
@@ -2240,7 +1692,7 @@ declare module 'stripe' {
2240
1692
  network?: Card.Network;
2241
1693
 
2242
1694
  /**
2243
- * 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.
2244
1696
  */
2245
1697
  request_three_d_secure?: Card.RequestThreeDSecure;
2246
1698
  }
@@ -2320,89 +1772,46 @@ declare module 'stripe' {
2320
1772
  }
2321
1773
  }
2322
1774
 
2323
- interface IdBankTransfer {}
2324
-
2325
1775
  interface Konbini {}
2326
1776
 
2327
- interface Pix {
1777
+ interface Payto {
2328
1778
  /**
2329
- * Configuration options for setting up a mandate
1779
+ * Additional fields for Mandate creation.
2330
1780
  */
2331
- mandate_options?: Pix.MandateOptions;
1781
+ mandate_options?: Payto.MandateOptions;
2332
1782
  }
2333
1783
 
2334
- namespace Pix {
1784
+ namespace Payto {
2335
1785
  interface MandateOptions {
2336
1786
  /**
2337
- * 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.
2338
1788
  */
2339
1789
  amount?: number;
2340
1790
 
2341
1791
  /**
2342
- * Determines if the amount includes the IOF tax. Defaults to `never`.
2343
- */
2344
- amount_includes_iof?: MandateOptions.AmountIncludesIof;
2345
-
2346
- /**
2347
- * 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.
1792
+ * The purpose for which payments are made. Has a default value based on your merchant category code.
2348
1793
  */
2349
- end_date?: string;
2350
-
2351
- /**
2352
- * Schedule at which the future payments will be charged. Defaults to `weekly`.
2353
- */
2354
- payment_schedule?: MandateOptions.PaymentSchedule;
1794
+ purpose?: MandateOptions.Purpose;
2355
1795
  }
2356
1796
 
2357
1797
  namespace MandateOptions {
2358
- type AmountIncludesIof = 'always' | 'never';
2359
-
2360
- type PaymentSchedule =
2361
- | 'halfyearly'
2362
- | 'monthly'
2363
- | 'quarterly'
2364
- | 'weekly'
2365
- | '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';
2366
1810
  }
2367
1811
  }
2368
1812
 
2369
1813
  interface SepaDebit {}
2370
1814
 
2371
- interface Upi {
2372
- /**
2373
- * Configuration options for setting up an eMandate
2374
- */
2375
- mandate_options?: Upi.MandateOptions;
2376
- }
2377
-
2378
- namespace Upi {
2379
- interface MandateOptions {
2380
- /**
2381
- * Amount to be charged for future payments.
2382
- */
2383
- amount?: number;
2384
-
2385
- /**
2386
- * 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.
2387
- */
2388
- amount_type?: MandateOptions.AmountType;
2389
-
2390
- /**
2391
- * A description of the mandate or subscription that is meant to be displayed to the customer.
2392
- */
2393
- description?: string;
2394
-
2395
- /**
2396
- * 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.
2397
- */
2398
- end_date?: number;
2399
- }
2400
-
2401
- namespace MandateOptions {
2402
- type AmountType = 'fixed' | 'maximum';
2403
- }
2404
- }
2405
-
2406
1815
  interface UsBankAccount {
2407
1816
  /**
2408
1817
  * Additional fields for Financial Connections Session creation
@@ -2439,11 +1848,6 @@ declare module 'stripe' {
2439
1848
  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
2440
1849
  */
2441
1850
  account_subcategories?: Array<Filters.AccountSubcategory>;
2442
-
2443
- /**
2444
- * ID of the institution to use to filter for selectable accounts.
2445
- */
2446
- institution?: string;
2447
1851
  }
2448
1852
 
2449
1853
  namespace Filters {
@@ -2456,11 +1860,7 @@ declare module 'stripe' {
2456
1860
  | 'payment_method'
2457
1861
  | 'transactions';
2458
1862
 
2459
- type Prefetch =
2460
- | 'balances'
2461
- | 'inferred_balances'
2462
- | 'ownership'
2463
- | 'transactions';
1863
+ type Prefetch = 'balances' | 'ownership' | 'transactions';
2464
1864
  }
2465
1865
 
2466
1866
  type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -2486,7 +1886,6 @@ declare module 'stripe' {
2486
1886
  | 'fpx'
2487
1887
  | 'giropay'
2488
1888
  | 'grabpay'
2489
- | 'id_bank_transfer'
2490
1889
  | 'ideal'
2491
1890
  | 'jp_credit_transfer'
2492
1891
  | 'kakao_pay'
@@ -2501,15 +1900,13 @@ declare module 'stripe' {
2501
1900
  | 'payco'
2502
1901
  | 'paynow'
2503
1902
  | 'paypal'
2504
- | 'pix'
1903
+ | 'payto'
2505
1904
  | 'promptpay'
2506
1905
  | 'revolut_pay'
2507
1906
  | 'sepa_credit_transfer'
2508
1907
  | 'sepa_debit'
2509
1908
  | 'sofort'
2510
- | 'stripe_balance'
2511
1909
  | 'swish'
2512
- | 'upi'
2513
1910
  | 'us_bank_account'
2514
1911
  | 'wechat_pay';
2515
1912
 
@@ -2532,22 +1929,6 @@ declare module 'stripe' {
2532
1929
  type Interval = 'day' | 'month' | 'week' | 'year';
2533
1930
  }
2534
1931
 
2535
- interface Prebilling {
2536
- /**
2537
- * This is used to determine the number of billing cycles to prebill.
2538
- */
2539
- iterations: number;
2540
-
2541
- /**
2542
- * Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
2543
- */
2544
- update_behavior?: Prebilling.UpdateBehavior;
2545
- }
2546
-
2547
- namespace Prebilling {
2548
- type UpdateBehavior = 'prebill' | 'reset';
2549
- }
2550
-
2551
1932
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
2552
1933
 
2553
1934
  interface TransferData {
@@ -2610,12 +1991,12 @@ declare module 'stripe' {
2610
1991
  current_period_start?: Stripe.RangeQueryParam | number;
2611
1992
 
2612
1993
  /**
2613
- * The ID of the customer whose subscriptions will be retrieved.
1994
+ * The ID of the customer whose subscriptions you're retrieving.
2614
1995
  */
2615
1996
  customer?: string;
2616
1997
 
2617
1998
  /**
2618
- * The ID of the account whose subscriptions will be retrieved.
1999
+ * The ID of the account representing the customer whose subscriptions you're retrieving.
2619
2000
  */
2620
2001
  customer_account?: string;
2621
2002
 
@@ -2635,7 +2016,7 @@ declare module 'stripe' {
2635
2016
  price?: string;
2636
2017
 
2637
2018
  /**
2638
- * 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.
2639
2020
  */
2640
2021
  status?: SubscriptionListParams.Status;
2641
2022
 
@@ -2668,18 +2049,6 @@ declare module 'stripe' {
2668
2049
  | 'unpaid';
2669
2050
  }
2670
2051
 
2671
- interface SubscriptionAttachCadenceParams {
2672
- /**
2673
- * 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.
2674
- */
2675
- billing_cadence: string;
2676
-
2677
- /**
2678
- * Specifies which fields in the response should be expanded.
2679
- */
2680
- expand?: Array<string>;
2681
- }
2682
-
2683
2052
  interface SubscriptionCancelParams {
2684
2053
  /**
2685
2054
  * Details about why this subscription was cancelled
@@ -2771,7 +2140,7 @@ declare module 'stripe' {
2771
2140
 
2772
2141
  interface SubscriptionResumeParams {
2773
2142
  /**
2774
- * 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).
2775
2144
  */
2776
2145
  billing_cycle_anchor?: SubscriptionResumeParams.BillingCycleAnchor;
2777
2146
 
@@ -2781,7 +2150,7 @@ declare module 'stripe' {
2781
2150
  expand?: Array<string>;
2782
2151
 
2783
2152
  /**
2784
- * 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`.
2785
2154
  */
2786
2155
  proration_behavior?: SubscriptionResumeParams.ProrationBehavior;
2787
2156
 
@@ -2799,7 +2168,7 @@ declare module 'stripe' {
2799
2168
 
2800
2169
  interface SubscriptionSearchParams {
2801
2170
  /**
2802
- * 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).
2803
2172
  */
2804
2173
  query: string;
2805
2174
 
@@ -2888,15 +2257,6 @@ declare module 'stripe' {
2888
2257
  ): ApiListPromise<Stripe.Subscription>;
2889
2258
  list(options?: RequestOptions): ApiListPromise<Stripe.Subscription>;
2890
2259
 
2891
- /**
2892
- * 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.
2893
- */
2894
- attachCadence(
2895
- id: string,
2896
- params: SubscriptionAttachCadenceParams,
2897
- options?: RequestOptions
2898
- ): Promise<Stripe.Response<Stripe.Subscription>>;
2899
-
2900
2260
  /**
2901
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).
2902
2262
  *