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
@@ -4,7 +4,7 @@ declare module 'stripe' {
4
4
  namespace Stripe {
5
5
  /**
6
6
  * Shipping rates describe the price of shipping presented to your customers and
7
- * applied to a purchase. For more information, see [Charge for shipping](https://stripe.com/docs/payments/during-payment/charge-shipping).
7
+ * applied to a purchase. For more information, see [Charge for shipping](https://docs.stripe.com/payments/during-payment/charge-shipping).
8
8
  */
9
9
  interface ShippingRate {
10
10
  /**
@@ -45,7 +45,7 @@ declare module 'stripe' {
45
45
  livemode: boolean;
46
46
 
47
47
  /**
48
- * 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.
48
+ * 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.
49
49
  */
50
50
  metadata: Stripe.Metadata;
51
51
 
@@ -55,7 +55,7 @@ declare module 'stripe' {
55
55
  tax_behavior: ShippingRate.TaxBehavior | null;
56
56
 
57
57
  /**
58
- * A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
58
+ * A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
59
59
  */
60
60
  tax_code: string | Stripe.TaxCode | null;
61
61
 
@@ -24,7 +24,7 @@ declare module 'stripe' {
24
24
  fixed_amount?: ShippingRateCreateParams.FixedAmount;
25
25
 
26
26
  /**
27
- * 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`.
27
+ * 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`.
28
28
  */
29
29
  metadata?: Stripe.MetadataParam;
30
30
 
@@ -34,7 +34,7 @@ declare module 'stripe' {
34
34
  tax_behavior?: ShippingRateCreateParams.TaxBehavior;
35
35
 
36
36
  /**
37
- * A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
37
+ * A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
38
38
  */
39
39
  tax_code?: string;
40
40
 
@@ -155,7 +155,7 @@ declare module 'stripe' {
155
155
  fixed_amount?: ShippingRateUpdateParams.FixedAmount;
156
156
 
157
157
  /**
158
- * 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`.
158
+ * 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`.
159
159
  */
160
160
  metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
161
161
 
@@ -4,7 +4,7 @@ declare module 'stripe' {
4
4
  namespace Stripe {
5
5
  namespace Sigma {
6
6
  /**
7
- * If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll
7
+ * If you have [scheduled a Sigma query](https://docs.stripe.com/sigma/scheduled-queries), you'll
8
8
  * receive a `sigma.scheduled_query_run.created` webhook each time the query
9
9
  * runs. The webhook contains a `ScheduledQueryRun` object, which you can use to
10
10
  * retrieve the query results.
@@ -50,11 +50,11 @@ declare module 'stripe' {
50
50
  * just like a `Card` object: once chargeable, they can be charged, or can be
51
51
  * attached to customers.
52
52
  *
53
- * Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).
54
- * We recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).
53
+ * Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources).
54
+ * We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods).
55
55
  * This newer API provides access to our latest features and payment method types.
56
56
  *
57
- * Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).
57
+ * Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers).
58
58
  */
59
59
  source: Stripe.Source;
60
60
 
@@ -8,11 +8,11 @@ declare module 'stripe' {
8
8
  * just like a `Card` object: once chargeable, they can be charged, or can be
9
9
  * attached to customers.
10
10
  *
11
- * Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).
12
- * We recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).
11
+ * Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources).
12
+ * We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods).
13
13
  * This newer API provides access to our latest features and payment method types.
14
14
  *
15
- * Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).
15
+ * Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers).
16
16
  */
17
17
  interface Source {
18
18
  /**
@@ -92,7 +92,7 @@ declare module 'stripe' {
92
92
  livemode: boolean;
93
93
 
94
94
  /**
95
- * 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.
95
+ * 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.
96
96
  */
97
97
  metadata: Stripe.Metadata | null;
98
98
 
@@ -105,8 +105,6 @@ declare module 'stripe' {
105
105
 
106
106
  p24?: Source.P24;
107
107
 
108
- paypal?: Source.Paypal;
109
-
110
108
  receiver?: Source.Receiver;
111
109
 
112
110
  redirect?: Source.Redirect;
@@ -132,7 +130,7 @@ declare module 'stripe' {
132
130
  three_d_secure?: Source.ThreeDSecure;
133
131
 
134
132
  /**
135
- * The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used.
133
+ * The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://docs.stripe.com/sources) used.
136
134
  */
137
135
  type: Source.Type;
138
136
 
@@ -238,8 +236,6 @@ declare module 'stripe' {
238
236
 
239
237
  brand?: string | null;
240
238
 
241
- brand_product?: string | null;
242
-
243
239
  country?: string | null;
244
240
 
245
241
  cvc_check?: string | null;
@@ -280,8 +276,6 @@ declare module 'stripe' {
280
276
 
281
277
  brand?: string | null;
282
278
 
283
- brand_product?: string | null;
284
-
285
279
  country?: string | null;
286
280
 
287
281
  cvm_type?: string;
@@ -485,26 +479,6 @@ declare module 'stripe' {
485
479
  reference?: string | null;
486
480
  }
487
481
 
488
- interface Paypal {
489
- billing_agreement?: string | null;
490
-
491
- fingerprint?: string | null;
492
-
493
- payer_id?: string | null;
494
-
495
- reference_id?: string;
496
-
497
- reference_transaction_amount?: string;
498
-
499
- reference_transaction_charged?: boolean;
500
-
501
- statement_descriptor?: string | null;
502
-
503
- transaction_id?: string;
504
-
505
- verified_email?: string | null;
506
- }
507
-
508
482
  interface Receiver {
509
483
  /**
510
484
  * The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
@@ -706,8 +680,6 @@ declare module 'stripe' {
706
680
 
707
681
  brand?: string | null;
708
682
 
709
- brand_product?: string | null;
710
-
711
683
  card?: string | null;
712
684
 
713
685
  country?: string | null;
@@ -756,7 +728,6 @@ declare module 'stripe' {
756
728
  | 'klarna'
757
729
  | 'multibanco'
758
730
  | 'p24'
759
- | 'paypal'
760
731
  | 'sepa_credit_transfer'
761
732
  | 'sepa_debit'
762
733
  | 'sofort'
@@ -71,7 +71,7 @@ declare module 'stripe' {
71
71
  token?: string;
72
72
 
73
73
  /**
74
- * The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide)
74
+ * The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://docs.stripe.com/sources/connect#cloning-card-sources) guide)
75
75
  */
76
76
  type?: string;
77
77
 
@@ -323,7 +323,7 @@ declare module 'stripe' {
323
323
  mandate?: SourceUpdateParams.Mandate;
324
324
 
325
325
  /**
326
- * 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`.
326
+ * 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`.
327
327
  */
328
328
  metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
329
329
 
@@ -37,11 +37,6 @@ declare module 'stripe' {
37
37
  */
38
38
  object: 'subscription_item';
39
39
 
40
- /**
41
- * The time period the subscription item has been billed for.
42
- */
43
- billed_until?: number | null;
44
-
45
40
  /**
46
41
  * Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
47
42
  */
@@ -73,34 +68,34 @@ declare module 'stripe' {
73
68
  discounts: Array<string | Stripe.Discount>;
74
69
 
75
70
  /**
76
- * 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.
71
+ * 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.
77
72
  */
78
73
  metadata: Stripe.Metadata;
79
74
 
80
75
  /**
81
- * You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
76
+ * You can now model subscriptions more flexibly using the [Prices API](https://api.stripe.com#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
82
77
  *
83
78
  * Plans define the base price, currency, and billing cycle for recurring purchases of products.
84
- * [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
79
+ * [Products](https://api.stripe.com#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
85
80
  *
86
81
  * For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
87
82
  *
88
- * Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview).
83
+ * Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription) and more about [products and prices](https://docs.stripe.com/products-prices/overview).
89
84
  */
90
85
  plan: Stripe.Plan;
91
86
 
92
87
  /**
93
88
  * Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.
94
- * [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
89
+ * [Products](https://api.stripe.com#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
95
90
  *
96
91
  * For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
97
92
  *
98
- * Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).
93
+ * Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), [create an invoice](https://docs.stripe.com/billing/invoices/create), and more about [products and prices](https://docs.stripe.com/products-prices/overview).
99
94
  */
100
95
  price: Stripe.Price;
101
96
 
102
97
  /**
103
- * The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed.
98
+ * The [quantity](https://docs.stripe.com/subscriptions/quantities) of the plan to which the customer should be subscribed.
104
99
  */
105
100
  quantity?: number;
106
101
 
@@ -113,11 +108,6 @@ declare module 'stripe' {
113
108
  * The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
114
109
  */
115
110
  tax_rates: Array<Stripe.TaxRate> | null;
116
-
117
- /**
118
- * Options that configure the trial on the subscription item.
119
- */
120
- trial?: SubscriptionItem.Trial | null;
121
111
  }
122
112
 
123
113
  namespace SubscriptionItem {
@@ -127,22 +117,6 @@ declare module 'stripe' {
127
117
  */
128
118
  usage_gte: number | null;
129
119
  }
130
-
131
- interface Trial {
132
- /**
133
- * List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
134
- */
135
- converts_to?: Array<string> | null;
136
-
137
- /**
138
- * Determines the type of trial for this item.
139
- */
140
- type: Trial.Type;
141
- }
142
-
143
- namespace Trial {
144
- type Type = 'free' | 'paid';
145
- }
146
120
  }
147
121
  }
148
122
  }
@@ -28,16 +28,16 @@ declare module 'stripe' {
28
28
  expand?: Array<string>;
29
29
 
30
30
  /**
31
- * 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`.
31
+ * 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`.
32
32
  */
33
33
  metadata?: Stripe.MetadataParam;
34
34
 
35
35
  /**
36
- * 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.
36
+ * 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.
37
37
  *
38
- * 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.
38
+ * 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.
39
39
  *
40
- * 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).
40
+ * 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).
41
41
  *
42
42
  * 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.
43
43
  */
@@ -54,17 +54,17 @@ declare module 'stripe' {
54
54
  price?: string;
55
55
 
56
56
  /**
57
- * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
57
+ * Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
58
58
  */
59
59
  price_data?: SubscriptionItemCreateParams.PriceData;
60
60
 
61
61
  /**
62
- * 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`.
62
+ * 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`.
63
63
  */
64
64
  proration_behavior?: SubscriptionItemCreateParams.ProrationBehavior;
65
65
 
66
66
  /**
67
- * If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
67
+ * If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint.
68
68
  */
69
69
  proration_date?: number;
70
70
 
@@ -74,20 +74,15 @@ declare module 'stripe' {
74
74
  quantity?: number;
75
75
 
76
76
  /**
77
- * 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.
77
+ * 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.
78
78
  */
79
79
  tax_rates?: Stripe.Emptyable<Array<string>>;
80
-
81
- /**
82
- * Options that configure the trial on the subscription item.
83
- */
84
- trial?: SubscriptionItemCreateParams.Trial;
85
80
  }
86
81
 
87
82
  namespace SubscriptionItemCreateParams {
88
83
  interface BillingThresholds {
89
84
  /**
90
- * 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))
85
+ * 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))
91
86
  */
92
87
  usage_gte: number;
93
88
  }
@@ -103,56 +98,12 @@ declare module 'stripe' {
103
98
  */
104
99
  discount?: string;
105
100
 
106
- /**
107
- * Details to determine how long the discount should be applied for.
108
- */
109
- discount_end?: Discount.DiscountEnd;
110
-
111
101
  /**
112
102
  * ID of the promotion code to create a new discount for.
113
103
  */
114
104
  promotion_code?: string;
115
105
  }
116
106
 
117
- namespace Discount {
118
- interface DiscountEnd {
119
- /**
120
- * Time span for the redeemed discount.
121
- */
122
- duration?: DiscountEnd.Duration;
123
-
124
- /**
125
- * A precise Unix timestamp for the discount to end. Must be in the future.
126
- */
127
- timestamp?: number;
128
-
129
- /**
130
- * The type of calculation made to determine when the discount ends.
131
- */
132
- type: DiscountEnd.Type;
133
- }
134
-
135
- namespace DiscountEnd {
136
- interface Duration {
137
- /**
138
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
139
- */
140
- interval: Duration.Interval;
141
-
142
- /**
143
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
144
- */
145
- interval_count: number;
146
- }
147
-
148
- namespace Duration {
149
- type Interval = 'day' | 'month' | 'week' | 'year';
150
- }
151
-
152
- type Type = 'duration' | 'timestamp';
153
- }
154
- }
155
-
156
107
  type PaymentBehavior =
157
108
  | 'allow_incomplete'
158
109
  | 'default_incomplete'
@@ -176,7 +127,7 @@ declare module 'stripe' {
176
127
  recurring: PriceData.Recurring;
177
128
 
178
129
  /**
179
- * 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.
130
+ * 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.
180
131
  */
181
132
  tax_behavior?: PriceData.TaxBehavior;
182
133
 
@@ -212,22 +163,6 @@ declare module 'stripe' {
212
163
  }
213
164
 
214
165
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
215
-
216
- interface Trial {
217
- /**
218
- * 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.
219
- */
220
- converts_to?: Array<string>;
221
-
222
- /**
223
- * Determines the type of trial for this item.
224
- */
225
- type: Trial.Type;
226
- }
227
-
228
- namespace Trial {
229
- type Type = 'free' | 'paid';
230
- }
231
166
  }
232
167
 
233
168
  interface SubscriptionItemRetrieveParams {
@@ -258,7 +193,7 @@ declare module 'stripe' {
258
193
  expand?: Array<string>;
259
194
 
260
195
  /**
261
- * 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`.
196
+ * 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`.
262
197
  */
263
198
  metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
264
199
 
@@ -268,11 +203,11 @@ declare module 'stripe' {
268
203
  off_session?: boolean;
269
204
 
270
205
  /**
271
- * 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.
206
+ * 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.
272
207
  *
273
- * 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.
208
+ * 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.
274
209
  *
275
- * 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).
210
+ * 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).
276
211
  *
277
212
  * 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.
278
213
  */
@@ -289,17 +224,17 @@ declare module 'stripe' {
289
224
  price?: string;
290
225
 
291
226
  /**
292
- * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
227
+ * Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
293
228
  */
294
229
  price_data?: SubscriptionItemUpdateParams.PriceData;
295
230
 
296
231
  /**
297
- * 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`.
232
+ * 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`.
298
233
  */
299
234
  proration_behavior?: SubscriptionItemUpdateParams.ProrationBehavior;
300
235
 
301
236
  /**
302
- * If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
237
+ * If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint.
303
238
  */
304
239
  proration_date?: number;
305
240
 
@@ -309,7 +244,7 @@ declare module 'stripe' {
309
244
  quantity?: number;
310
245
 
311
246
  /**
312
- * 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.
247
+ * 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.
313
248
  */
314
249
  tax_rates?: Stripe.Emptyable<Array<string>>;
315
250
  }
@@ -317,7 +252,7 @@ declare module 'stripe' {
317
252
  namespace SubscriptionItemUpdateParams {
318
253
  interface BillingThresholds {
319
254
  /**
320
- * 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))
255
+ * 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))
321
256
  */
322
257
  usage_gte: number;
323
258
  }
@@ -333,56 +268,12 @@ declare module 'stripe' {
333
268
  */
334
269
  discount?: string;
335
270
 
336
- /**
337
- * Details to determine how long the discount should be applied for.
338
- */
339
- discount_end?: Discount.DiscountEnd;
340
-
341
271
  /**
342
272
  * ID of the promotion code to create a new discount for.
343
273
  */
344
274
  promotion_code?: string;
345
275
  }
346
276
 
347
- namespace Discount {
348
- interface DiscountEnd {
349
- /**
350
- * Time span for the redeemed discount.
351
- */
352
- duration?: DiscountEnd.Duration;
353
-
354
- /**
355
- * A precise Unix timestamp for the discount to end. Must be in the future.
356
- */
357
- timestamp?: number;
358
-
359
- /**
360
- * The type of calculation made to determine when the discount ends.
361
- */
362
- type: DiscountEnd.Type;
363
- }
364
-
365
- namespace DiscountEnd {
366
- interface Duration {
367
- /**
368
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
369
- */
370
- interval: Duration.Interval;
371
-
372
- /**
373
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
374
- */
375
- interval_count: number;
376
- }
377
-
378
- namespace Duration {
379
- type Interval = 'day' | 'month' | 'week' | 'year';
380
- }
381
-
382
- type Type = 'duration' | 'timestamp';
383
- }
384
- }
385
-
386
277
  type PaymentBehavior =
387
278
  | 'allow_incomplete'
388
279
  | 'default_incomplete'
@@ -406,7 +297,7 @@ declare module 'stripe' {
406
297
  recurring: PriceData.Recurring;
407
298
 
408
299
  /**
409
- * 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.
300
+ * 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.
410
301
  */
411
302
  tax_behavior?: PriceData.TaxBehavior;
412
303
 
@@ -463,12 +354,12 @@ declare module 'stripe' {
463
354
  clear_usage?: boolean;
464
355
 
465
356
  /**
466
- * 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`.
357
+ * 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`.
467
358
  */
468
359
  proration_behavior?: SubscriptionItemDeleteParams.ProrationBehavior;
469
360
 
470
361
  /**
471
- * If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
362
+ * If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint.
472
363
  */
473
364
  proration_date?: number;
474
365
  }