stripe 22.1.0 → 22.2.0-alpha.2

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 (1310) hide show
  1. package/CHANGELOG.md +2637 -11
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +57 -65
  4. package/VERSION +1 -1
  5. package/cjs/Error.d.ts +53 -0
  6. package/cjs/Error.js +134 -1
  7. package/cjs/Error.js.map +1 -1
  8. package/cjs/Types.d.ts +4 -2
  9. package/cjs/apiVersion.d.ts +1 -2
  10. package/cjs/apiVersion.js +2 -3
  11. package/cjs/apiVersion.js.map +1 -1
  12. package/cjs/resources/AccountLinks.d.ts +5 -1
  13. package/cjs/resources/AccountNotices.d.ts +140 -0
  14. package/cjs/resources/AccountNotices.js +29 -0
  15. package/cjs/resources/AccountNotices.js.map +1 -0
  16. package/cjs/resources/AccountSessions.d.ts +463 -0
  17. package/cjs/resources/AccountSessions.js.map +1 -1
  18. package/cjs/resources/AccountSignals.d.ts +110 -0
  19. package/cjs/resources/AccountSignals.js +4 -0
  20. package/cjs/resources/AccountSignals.js.map +1 -0
  21. package/cjs/resources/Accounts.d.ts +955 -3
  22. package/cjs/resources/Accounts.js +21 -0
  23. package/cjs/resources/Accounts.js.map +1 -1
  24. package/cjs/resources/ApplicationFees.d.ts +28 -1
  25. package/cjs/resources/Balance.d.ts +134 -0
  26. package/cjs/resources/BalanceSettings.d.ts +18 -0
  27. package/cjs/resources/BalanceTransactions.d.ts +1 -1
  28. package/cjs/resources/BalanceTransfers.d.ts +160 -0
  29. package/cjs/resources/BalanceTransfers.js +15 -0
  30. package/cjs/resources/BalanceTransfers.js.map +1 -0
  31. package/cjs/resources/BankAccounts.d.ts +2 -2
  32. package/cjs/resources/Billing/AlertRecovereds.d.ts +40 -0
  33. package/cjs/resources/Billing/AlertRecovereds.js +4 -0
  34. package/cjs/resources/Billing/AlertRecovereds.js.map +1 -0
  35. package/cjs/resources/Billing/AlertTriggereds.d.ts +57 -1
  36. package/cjs/resources/Billing/Alerts.d.ts +406 -5
  37. package/cjs/resources/Billing/Alerts.js +321 -5
  38. package/cjs/resources/Billing/Alerts.js.map +1 -1
  39. package/cjs/resources/Billing/Analytics/MeterUsage.d.ts +88 -0
  40. package/cjs/resources/Billing/Analytics/MeterUsage.js +15 -0
  41. package/cjs/resources/Billing/Analytics/MeterUsage.js.map +1 -0
  42. package/cjs/resources/Billing/Analytics/MeterUsageRows.d.ts +38 -0
  43. package/cjs/resources/Billing/Analytics/MeterUsageRows.js +4 -0
  44. package/cjs/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
  45. package/cjs/resources/Billing/Analytics/index.d.ts +15 -0
  46. package/cjs/resources/Billing/Analytics/index.js +13 -0
  47. package/cjs/resources/Billing/Analytics/index.js.map +1 -0
  48. package/cjs/resources/Billing/CreditBalanceSummary.d.ts +126 -2
  49. package/cjs/resources/Billing/CreditBalanceSummary.js +39 -1
  50. package/cjs/resources/Billing/CreditBalanceSummary.js.map +1 -1
  51. package/cjs/resources/Billing/CreditBalanceTransactions.d.ts +97 -3
  52. package/cjs/resources/Billing/CreditBalanceTransactions.js +100 -1
  53. package/cjs/resources/Billing/CreditBalanceTransactions.js.map +1 -1
  54. package/cjs/resources/Billing/CreditGrants.d.ts +85 -3
  55. package/cjs/resources/Billing/CreditGrants.js +134 -5
  56. package/cjs/resources/Billing/CreditGrants.js.map +1 -1
  57. package/cjs/resources/Billing/MeterEventSummaries.d.ts +6 -0
  58. package/cjs/resources/Billing/Meters.d.ts +31 -0
  59. package/cjs/resources/Billing/index.d.ts +6 -0
  60. package/cjs/resources/Billing/index.js +2 -0
  61. package/cjs/resources/Billing/index.js.map +1 -1
  62. package/cjs/resources/Capabilities.d.ts +2 -2
  63. package/cjs/resources/Capital/FinancingOffers.d.ts +191 -0
  64. package/cjs/resources/Capital/FinancingOffers.js +30 -0
  65. package/cjs/resources/Capital/FinancingOffers.js.map +1 -0
  66. package/cjs/resources/Capital/FinancingSummary.d.ts +98 -0
  67. package/cjs/resources/Capital/FinancingSummary.js +15 -0
  68. package/cjs/resources/Capital/FinancingSummary.js.map +1 -0
  69. package/cjs/resources/Capital/FinancingTransactions.d.ts +143 -0
  70. package/cjs/resources/Capital/FinancingTransactions.js +24 -0
  71. package/cjs/resources/Capital/FinancingTransactions.js.map +1 -0
  72. package/cjs/resources/Capital/index.d.ts +25 -0
  73. package/cjs/resources/Capital/index.js +17 -0
  74. package/cjs/resources/Capital/index.js.map +1 -0
  75. package/cjs/resources/Cards.d.ts +15 -0
  76. package/cjs/resources/Charges.d.ts +3513 -70
  77. package/cjs/resources/Charges.js.map +1 -1
  78. package/cjs/resources/Checkout/Sessions.d.ts +792 -9
  79. package/cjs/resources/Checkout/Sessions.js +88 -0
  80. package/cjs/resources/Checkout/Sessions.js.map +1 -1
  81. package/cjs/resources/Checkout/index.d.ts +1 -0
  82. package/cjs/resources/ConfirmationTokens.d.ts +100 -1
  83. package/cjs/resources/ConfirmationTokens.js.map +1 -1
  84. package/cjs/resources/Coupons.d.ts +110 -2
  85. package/cjs/resources/CreditNoteLineItems.d.ts +15 -1
  86. package/cjs/resources/CreditNotes.d.ts +7 -1
  87. package/cjs/resources/CreditNotes.js +14 -0
  88. package/cjs/resources/CreditNotes.js.map +1 -1
  89. package/cjs/resources/CustomerSessions.d.ts +68 -0
  90. package/cjs/resources/Customers.d.ts +7 -1
  91. package/cjs/resources/Customers.js +15 -0
  92. package/cjs/resources/Customers.js.map +1 -1
  93. package/cjs/resources/DelegatedCheckout/RequestedSessions.d.ts +1280 -0
  94. package/cjs/resources/DelegatedCheckout/RequestedSessions.js +39 -0
  95. package/cjs/resources/DelegatedCheckout/RequestedSessions.js.map +1 -0
  96. package/cjs/resources/DelegatedCheckout/index.d.ts +16 -0
  97. package/cjs/resources/DelegatedCheckout/index.js +13 -0
  98. package/cjs/resources/DelegatedCheckout/index.js.map +1 -0
  99. package/cjs/resources/Discounts.d.ts +19 -0
  100. package/cjs/resources/Disputes.d.ts +37 -0
  101. package/cjs/resources/Events.d.ts +560 -2
  102. package/cjs/resources/ExternalAccounts.d.ts +212 -1
  103. package/cjs/resources/ExternalAccounts.js +44 -0
  104. package/cjs/resources/ExternalAccounts.js.map +1 -1
  105. package/cjs/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
  106. package/cjs/resources/FinancialConnections/AccountInferredBalances.js +4 -0
  107. package/cjs/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
  108. package/cjs/resources/FinancialConnections/Accounts.d.ts +74 -4
  109. package/cjs/resources/FinancialConnections/Accounts.js +8 -0
  110. package/cjs/resources/FinancialConnections/Accounts.js.map +1 -1
  111. package/cjs/resources/FinancialConnections/Authorizations.d.ts +87 -0
  112. package/cjs/resources/FinancialConnections/Authorizations.js +15 -0
  113. package/cjs/resources/FinancialConnections/Authorizations.js.map +1 -0
  114. package/cjs/resources/FinancialConnections/Institutions.d.ts +101 -0
  115. package/cjs/resources/FinancialConnections/Institutions.js +23 -0
  116. package/cjs/resources/FinancialConnections/Institutions.js.map +1 -0
  117. package/cjs/resources/FinancialConnections/Sessions.d.ts +155 -7
  118. package/cjs/resources/FinancialConnections/index.d.ts +21 -6
  119. package/cjs/resources/FinancialConnections/index.js +4 -0
  120. package/cjs/resources/FinancialConnections/index.js.map +1 -1
  121. package/cjs/resources/FrMealVouchersOnboardings.d.ts +173 -0
  122. package/cjs/resources/FrMealVouchersOnboardings.js +42 -0
  123. package/cjs/resources/FrMealVouchersOnboardings.js.map +1 -0
  124. package/cjs/resources/FxQuotes.d.ts +212 -0
  125. package/cjs/resources/FxQuotes.js +29 -0
  126. package/cjs/resources/FxQuotes.js.map +1 -0
  127. package/cjs/resources/Identity/BlocklistEntries.d.ts +157 -0
  128. package/cjs/resources/Identity/BlocklistEntries.js +54 -0
  129. package/cjs/resources/Identity/BlocklistEntries.js.map +1 -0
  130. package/cjs/resources/Identity/VerificationReports.d.ts +33 -2
  131. package/cjs/resources/Identity/VerificationReports.js.map +1 -1
  132. package/cjs/resources/Identity/VerificationSessions.d.ts +11 -3
  133. package/cjs/resources/Identity/index.d.ts +18 -10
  134. package/cjs/resources/Identity/index.js +2 -0
  135. package/cjs/resources/Identity/index.js.map +1 -1
  136. package/cjs/resources/InvoiceItems.d.ts +185 -2
  137. package/cjs/resources/InvoiceItems.js.map +1 -1
  138. package/cjs/resources/InvoiceLineItems.d.ts +174 -4
  139. package/cjs/resources/Invoices.d.ts +2024 -35
  140. package/cjs/resources/Invoices.js +70 -0
  141. package/cjs/resources/Invoices.js.map +1 -1
  142. package/cjs/resources/Issuing/Authorizations.d.ts +255 -0
  143. package/cjs/resources/Issuing/Cardholders.d.ts +5 -4
  144. package/cjs/resources/Issuing/Cards.d.ts +36 -0
  145. package/cjs/resources/Issuing/CreditUnderwritingRecords.d.ts +640 -0
  146. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +47 -0
  147. package/cjs/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
  148. package/cjs/resources/Issuing/DisputeSettlementDetails.d.ts +95 -0
  149. package/cjs/resources/Issuing/DisputeSettlementDetails.js +23 -0
  150. package/cjs/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
  151. package/cjs/resources/Issuing/Disputes.d.ts +140 -0
  152. package/cjs/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
  153. package/cjs/resources/Issuing/FraudLiabilityDebits.js +23 -0
  154. package/cjs/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
  155. package/cjs/resources/Issuing/Programs.d.ts +95 -0
  156. package/cjs/resources/Issuing/Programs.js +35 -0
  157. package/cjs/resources/Issuing/Programs.js.map +1 -0
  158. package/cjs/resources/Issuing/Settlements.d.ts +85 -0
  159. package/cjs/resources/Issuing/Settlements.js +4 -0
  160. package/cjs/resources/Issuing/Settlements.js.map +1 -0
  161. package/cjs/resources/Issuing/Transactions.d.ts +157 -0
  162. package/cjs/resources/Issuing/Transactions.js.map +1 -1
  163. package/cjs/resources/Issuing/index.d.ts +55 -22
  164. package/cjs/resources/Issuing/index.js +8 -0
  165. package/cjs/resources/Issuing/index.js.map +1 -1
  166. package/cjs/resources/LineItems.d.ts +29 -2
  167. package/cjs/resources/Mandates.d.ts +33 -1
  168. package/cjs/resources/Mandates.js +8 -0
  169. package/cjs/resources/Mandates.js.map +1 -1
  170. package/cjs/resources/Margins.d.ts +115 -0
  171. package/cjs/resources/Margins.js +35 -0
  172. package/cjs/resources/Margins.js.map +1 -0
  173. package/cjs/resources/Orchestration/PaymentAttempts.d.ts +34 -0
  174. package/cjs/resources/Orchestration/PaymentAttempts.js +15 -0
  175. package/cjs/resources/Orchestration/PaymentAttempts.js.map +1 -0
  176. package/cjs/resources/Orchestration/index.d.ts +12 -0
  177. package/cjs/resources/Orchestration/index.js +13 -0
  178. package/cjs/resources/Orchestration/index.js.map +1 -0
  179. package/cjs/resources/Orders.d.ts +4761 -0
  180. package/cjs/resources/Orders.js +457 -0
  181. package/cjs/resources/Orders.js.map +1 -0
  182. package/cjs/resources/PaymentAttemptRecords.d.ts +441 -1
  183. package/cjs/resources/PaymentAttemptRecords.js +42 -0
  184. package/cjs/resources/PaymentAttemptRecords.js.map +1 -1
  185. package/cjs/resources/PaymentIntentAmountDetailsLineItems.d.ts +17 -0
  186. package/cjs/resources/PaymentIntents.d.ts +16370 -3527
  187. package/cjs/resources/PaymentIntents.js +40 -0
  188. package/cjs/resources/PaymentIntents.js.map +1 -1
  189. package/cjs/resources/PaymentLinks.d.ts +74 -12
  190. package/cjs/resources/PaymentMethodBalances.d.ts +46 -0
  191. package/cjs/resources/PaymentMethodBalances.js +4 -0
  192. package/cjs/resources/PaymentMethodBalances.js.map +1 -0
  193. package/cjs/resources/PaymentMethodConfigurations.d.ts +350 -0
  194. package/cjs/resources/PaymentMethods.d.ts +216 -3
  195. package/cjs/resources/PaymentMethods.js +6 -0
  196. package/cjs/resources/PaymentMethods.js.map +1 -1
  197. package/cjs/resources/PaymentRecords.d.ts +323 -21
  198. package/cjs/resources/PaymentRecords.js.map +1 -1
  199. package/cjs/resources/Persons.d.ts +24 -2
  200. package/cjs/resources/Plans.d.ts +16 -0
  201. package/cjs/resources/Prices.d.ts +64 -0
  202. package/cjs/resources/Privacy/RedactionJobValidationErrors.d.ts +37 -0
  203. package/cjs/resources/Privacy/RedactionJobValidationErrors.js +4 -0
  204. package/cjs/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
  205. package/cjs/resources/Privacy/RedactionJobs.d.ts +229 -0
  206. package/cjs/resources/Privacy/RedactionJobs.js +73 -0
  207. package/cjs/resources/Privacy/RedactionJobs.js.map +1 -0
  208. package/cjs/resources/Privacy/index.d.ts +22 -0
  209. package/cjs/resources/Privacy/index.js +13 -0
  210. package/cjs/resources/Privacy/index.js.map +1 -0
  211. package/cjs/resources/ProductCatalog/TrialOffers.d.ts +127 -0
  212. package/cjs/resources/ProductCatalog/TrialOffers.js +15 -0
  213. package/cjs/resources/ProductCatalog/TrialOffers.js.map +1 -0
  214. package/cjs/resources/ProductCatalog/index.d.ts +12 -0
  215. package/cjs/resources/ProductCatalog/index.js +13 -0
  216. package/cjs/resources/ProductCatalog/index.js.map +1 -0
  217. package/cjs/resources/Products.d.ts +141 -0
  218. package/cjs/resources/Profiles.d.ts +26 -0
  219. package/cjs/resources/Profiles.js +4 -0
  220. package/cjs/resources/Profiles.js.map +1 -0
  221. package/cjs/resources/PromotionCodes.d.ts +12 -0
  222. package/cjs/resources/PromotionCodes.js +28 -0
  223. package/cjs/resources/PromotionCodes.js.map +1 -1
  224. package/cjs/resources/QuoteLines.d.ts +684 -0
  225. package/cjs/resources/QuoteLines.js +4 -0
  226. package/cjs/resources/QuoteLines.js.map +1 -0
  227. package/cjs/resources/QuotePreviewInvoices.d.ts +1153 -0
  228. package/cjs/resources/QuotePreviewInvoices.js +4 -0
  229. package/cjs/resources/QuotePreviewInvoices.js.map +1 -0
  230. package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +897 -0
  231. package/cjs/resources/QuotePreviewSubscriptionSchedules.js +4 -0
  232. package/cjs/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
  233. package/cjs/resources/Quotes.d.ts +3548 -254
  234. package/cjs/resources/Quotes.js +1184 -16
  235. package/cjs/resources/Quotes.js.map +1 -1
  236. package/cjs/resources/Radar/AccountEvaluations.d.ts +270 -0
  237. package/cjs/resources/Radar/AccountEvaluations.js +27 -0
  238. package/cjs/resources/Radar/AccountEvaluations.js.map +1 -0
  239. package/cjs/resources/Radar/CustomerEvaluations.d.ts +242 -0
  240. package/cjs/resources/Radar/CustomerEvaluations.js +21 -0
  241. package/cjs/resources/Radar/CustomerEvaluations.js.map +1 -0
  242. package/cjs/resources/Radar/IssuingAuthorizationEvaluations.d.ts +435 -0
  243. package/cjs/resources/Radar/IssuingAuthorizationEvaluations.js +15 -0
  244. package/cjs/resources/Radar/IssuingAuthorizationEvaluations.js.map +1 -0
  245. package/cjs/resources/Radar/PaymentEvaluations.d.ts +63 -1
  246. package/cjs/resources/Radar/index.d.ts +34 -16
  247. package/cjs/resources/Radar/index.js +6 -0
  248. package/cjs/resources/Radar/index.js.map +1 -1
  249. package/cjs/resources/Refunds.d.ts +11 -0
  250. package/cjs/resources/Reserve/Holds.d.ts +53 -1
  251. package/cjs/resources/Reserve/Holds.js +19 -0
  252. package/cjs/resources/Reserve/Holds.js.map +1 -1
  253. package/cjs/resources/Reserve/Plans.d.ts +16 -0
  254. package/cjs/resources/Reserve/Plans.js +11 -0
  255. package/cjs/resources/Reserve/Plans.js.map +1 -1
  256. package/cjs/resources/Reserve/Releases.d.ts +41 -1
  257. package/cjs/resources/Reserve/Releases.js +19 -0
  258. package/cjs/resources/Reserve/Releases.js.map +1 -1
  259. package/cjs/resources/Reserve/index.d.ts +14 -3
  260. package/cjs/resources/Reserve/index.js +10 -2
  261. package/cjs/resources/Reserve/index.js.map +1 -1
  262. package/cjs/resources/RiskSignals.d.ts +10 -0
  263. package/cjs/resources/RiskSignals.js +4 -0
  264. package/cjs/resources/RiskSignals.js.map +1 -0
  265. package/cjs/resources/SetupAttempts.d.ts +26 -1
  266. package/cjs/resources/SetupIntents.d.ts +491 -11
  267. package/cjs/resources/SharedPayment/GrantedTokens.d.ts +1101 -0
  268. package/cjs/resources/SharedPayment/GrantedTokens.js +15 -0
  269. package/cjs/resources/SharedPayment/GrantedTokens.js.map +1 -0
  270. package/cjs/resources/SharedPayment/IssuedTokens.d.ts +322 -0
  271. package/cjs/resources/SharedPayment/IssuedTokens.js +27 -0
  272. package/cjs/resources/SharedPayment/IssuedTokens.js.map +1 -0
  273. package/cjs/resources/SharedPayment/index.d.ts +19 -0
  274. package/cjs/resources/SharedPayment/index.js +15 -0
  275. package/cjs/resources/SharedPayment/index.js.map +1 -0
  276. package/cjs/resources/Sources.d.ts +16 -1
  277. package/cjs/resources/SubscriptionItems.d.ts +251 -0
  278. package/cjs/resources/SubscriptionSchedules.d.ts +1943 -19
  279. package/cjs/resources/SubscriptionSchedules.js +48 -0
  280. package/cjs/resources/SubscriptionSchedules.js.map +1 -1
  281. package/cjs/resources/Subscriptions.d.ts +1040 -16
  282. package/cjs/resources/Subscriptions.js +236 -1
  283. package/cjs/resources/Subscriptions.js.map +1 -1
  284. package/cjs/resources/Tax/CalculationLineItems.d.ts +6 -2
  285. package/cjs/resources/Tax/Calculations.d.ts +7 -3
  286. package/cjs/resources/Tax/Forms.d.ts +230 -0
  287. package/cjs/resources/Tax/Forms.js +32 -0
  288. package/cjs/resources/Tax/Forms.js.map +1 -0
  289. package/cjs/resources/Tax/Locations.d.ts +108 -0
  290. package/cjs/resources/Tax/Locations.js +33 -0
  291. package/cjs/resources/Tax/Locations.js.map +1 -0
  292. package/cjs/resources/Tax/Registrations.d.ts +155 -2
  293. package/cjs/resources/Tax/Transactions.d.ts +2 -2
  294. package/cjs/resources/Tax/index.d.ts +27 -13
  295. package/cjs/resources/Tax/index.js +4 -0
  296. package/cjs/resources/Tax/index.js.map +1 -1
  297. package/cjs/resources/TaxCodes.d.ts +15 -0
  298. package/cjs/resources/Terminal/Configurations.d.ts +27 -0
  299. package/cjs/resources/Terminal/ReaderCollectedData.d.ts +52 -0
  300. package/cjs/resources/Terminal/ReaderCollectedData.js +15 -0
  301. package/cjs/resources/Terminal/ReaderCollectedData.js.map +1 -0
  302. package/cjs/resources/Terminal/Readers.d.ts +51 -1
  303. package/cjs/resources/Terminal/index.d.ts +5 -0
  304. package/cjs/resources/Terminal/index.js +2 -0
  305. package/cjs/resources/Terminal/index.js.map +1 -1
  306. package/cjs/resources/TestHelpers/Capital/FinancingOffers.d.ts +81 -0
  307. package/cjs/resources/TestHelpers/Capital/FinancingOffers.js +21 -0
  308. package/cjs/resources/TestHelpers/Capital/FinancingOffers.js.map +1 -0
  309. package/cjs/resources/TestHelpers/Capital/index.d.ts +8 -0
  310. package/cjs/resources/TestHelpers/Capital/index.js +13 -0
  311. package/cjs/resources/TestHelpers/Capital/index.js.map +1 -0
  312. package/cjs/resources/TestHelpers/ConfirmationTokens.d.ts +78 -1
  313. package/cjs/resources/TestHelpers/Issuing/Authorizations.d.ts +8 -0
  314. package/cjs/resources/TestHelpers/Issuing/Transactions.d.ts +16 -0
  315. package/cjs/resources/TestHelpers/PaymentIntents.d.ts +36 -0
  316. package/cjs/resources/TestHelpers/PaymentIntents.js +15 -0
  317. package/cjs/resources/TestHelpers/PaymentIntents.js.map +1 -0
  318. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +75 -0
  319. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +21 -0
  320. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
  321. package/cjs/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
  322. package/cjs/resources/TestHelpers/SharedPayment/index.js +13 -0
  323. package/cjs/resources/TestHelpers/SharedPayment/index.js.map +1 -0
  324. package/cjs/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
  325. package/cjs/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
  326. package/cjs/resources/TestHelpers/index.d.ts +14 -6
  327. package/cjs/resources/TestHelpers/index.js +12 -6
  328. package/cjs/resources/TestHelpers/index.js.map +1 -1
  329. package/cjs/resources/Tokens.d.ts +56 -0
  330. package/cjs/resources/Transfers.d.ts +12 -0
  331. package/cjs/resources/Transfers.js.map +1 -1
  332. package/cjs/resources/TransitBalances.d.ts +25 -0
  333. package/cjs/resources/TransitBalances.js +4 -0
  334. package/cjs/resources/TransitBalances.js.map +1 -0
  335. package/cjs/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
  336. package/cjs/resources/Treasury/FinancialAccounts.d.ts +34 -1
  337. package/cjs/resources/Treasury/OutboundPayments.d.ts +8 -0
  338. package/cjs/resources/Treasury/OutboundTransfers.d.ts +44 -0
  339. package/cjs/resources/Treasury/ReceivedCredits.d.ts +22 -0
  340. package/cjs/resources/Treasury/ReceivedDebits.d.ts +26 -0
  341. package/cjs/resources/V2/Billing/BillSettingVersions.d.ts +75 -0
  342. package/cjs/resources/V2/Billing/BillSettingVersions.js +4 -0
  343. package/cjs/resources/V2/Billing/BillSettingVersions.js.map +1 -0
  344. package/cjs/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
  345. package/cjs/resources/V2/Billing/BillSettings/Versions.js +23 -0
  346. package/cjs/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
  347. package/cjs/resources/V2/Billing/BillSettings.d.ts +284 -0
  348. package/cjs/resources/V2/Billing/BillSettings.js +41 -0
  349. package/cjs/resources/V2/Billing/BillSettings.js.map +1 -0
  350. package/cjs/resources/V2/Billing/CadenceSpendModifiers.d.ts +88 -0
  351. package/cjs/resources/V2/Billing/CadenceSpendModifiers.js +4 -0
  352. package/cjs/resources/V2/Billing/CadenceSpendModifiers.js.map +1 -0
  353. package/cjs/resources/V2/Billing/Cadences/SpendModifierRules.d.ts +37 -0
  354. package/cjs/resources/V2/Billing/Cadences/SpendModifierRules.js +23 -0
  355. package/cjs/resources/V2/Billing/Cadences/SpendModifierRules.js.map +1 -0
  356. package/cjs/resources/V2/Billing/Cadences.d.ts +1015 -0
  357. package/cjs/resources/V2/Billing/Cadences.js +264 -0
  358. package/cjs/resources/V2/Billing/Cadences.js.map +1 -0
  359. package/cjs/resources/V2/Billing/CollectionSettingVersions.d.ts +240 -0
  360. package/cjs/resources/V2/Billing/CollectionSettingVersions.js +4 -0
  361. package/cjs/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
  362. package/cjs/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
  363. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +70 -0
  364. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
  365. package/cjs/resources/V2/Billing/CollectionSettings.d.ts +779 -0
  366. package/cjs/resources/V2/Billing/CollectionSettings.js +166 -0
  367. package/cjs/resources/V2/Billing/CollectionSettings.js.map +1 -0
  368. package/cjs/resources/V2/Billing/CustomPricingUnits.d.ts +125 -0
  369. package/cjs/resources/V2/Billing/CustomPricingUnits.js +35 -0
  370. package/cjs/resources/V2/Billing/CustomPricingUnits.js.map +1 -0
  371. package/cjs/resources/V2/Billing/IntentActions.d.ts +607 -0
  372. package/cjs/resources/V2/Billing/IntentActions.js +4 -0
  373. package/cjs/resources/V2/Billing/IntentActions.js.map +1 -0
  374. package/cjs/resources/V2/Billing/Intents/Actions.d.ts +33 -0
  375. package/cjs/resources/V2/Billing/Intents/Actions.js +70 -0
  376. package/cjs/resources/V2/Billing/Intents/Actions.js.map +1 -0
  377. package/cjs/resources/V2/Billing/Intents.d.ts +1257 -0
  378. package/cjs/resources/V2/Billing/Intents.js +87 -0
  379. package/cjs/resources/V2/Billing/Intents.js.map +1 -0
  380. package/cjs/resources/V2/Billing/LicenseFeeVersions.d.ts +82 -0
  381. package/cjs/resources/V2/Billing/LicenseFeeVersions.js +4 -0
  382. package/cjs/resources/V2/Billing/LicenseFeeVersions.js.map +1 -0
  383. package/cjs/resources/V2/Billing/LicenseFees/Versions.d.ts +33 -0
  384. package/cjs/resources/V2/Billing/LicenseFees/Versions.js +64 -0
  385. package/cjs/resources/V2/Billing/LicenseFees/Versions.js.map +1 -0
  386. package/cjs/resources/V2/Billing/LicenseFees.d.ts +378 -0
  387. package/cjs/resources/V2/Billing/LicenseFees.js +148 -0
  388. package/cjs/resources/V2/Billing/LicenseFees.js.map +1 -0
  389. package/cjs/resources/V2/Billing/LicensedItems.d.ts +174 -0
  390. package/cjs/resources/V2/Billing/LicensedItems.js +35 -0
  391. package/cjs/resources/V2/Billing/LicensedItems.js.map +1 -0
  392. package/cjs/resources/V2/Billing/MeterEventAdjustments.d.ts +5 -5
  393. package/cjs/resources/V2/Billing/MeterEventSession.d.ts +4 -4
  394. package/cjs/resources/V2/Billing/MeterEventSession.js +1 -1
  395. package/cjs/resources/V2/Billing/MeteredItems.d.ts +222 -0
  396. package/cjs/resources/V2/Billing/MeteredItems.js +35 -0
  397. package/cjs/resources/V2/Billing/MeteredItems.js.map +1 -0
  398. package/cjs/resources/V2/Billing/OneTimeItems.d.ts +174 -0
  399. package/cjs/resources/V2/Billing/OneTimeItems.js +35 -0
  400. package/cjs/resources/V2/Billing/OneTimeItems.js.map +1 -0
  401. package/cjs/resources/V2/Billing/PricingPlanComponents.d.ts +84 -0
  402. package/cjs/resources/V2/Billing/PricingPlanComponents.js +4 -0
  403. package/cjs/resources/V2/Billing/PricingPlanComponents.js.map +1 -0
  404. package/cjs/resources/V2/Billing/PricingPlanSubscriptions.d.ts +624 -0
  405. package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +296 -0
  406. package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js.map +1 -0
  407. package/cjs/resources/V2/Billing/PricingPlanVersions.d.ts +30 -0
  408. package/cjs/resources/V2/Billing/PricingPlanVersions.js +4 -0
  409. package/cjs/resources/V2/Billing/PricingPlanVersions.js.map +1 -0
  410. package/cjs/resources/V2/Billing/PricingPlans/Components.d.ts +142 -0
  411. package/cjs/resources/V2/Billing/PricingPlans/Components.js +41 -0
  412. package/cjs/resources/V2/Billing/PricingPlans/Components.js.map +1 -0
  413. package/cjs/resources/V2/Billing/PricingPlans/Versions.d.ts +33 -0
  414. package/cjs/resources/V2/Billing/PricingPlans/Versions.js +23 -0
  415. package/cjs/resources/V2/Billing/PricingPlans/Versions.js.map +1 -0
  416. package/cjs/resources/V2/Billing/PricingPlans.d.ts +177 -0
  417. package/cjs/resources/V2/Billing/PricingPlans.js +43 -0
  418. package/cjs/resources/V2/Billing/PricingPlans.js.map +1 -0
  419. package/cjs/resources/V2/Billing/Profiles.d.ts +166 -0
  420. package/cjs/resources/V2/Billing/Profiles.js +35 -0
  421. package/cjs/resources/V2/Billing/Profiles.js.map +1 -0
  422. package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.d.ts +45 -0
  423. package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js +4 -0
  424. package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js.map +1 -0
  425. package/cjs/resources/V2/Billing/RateCardRates.d.ts +115 -0
  426. package/cjs/resources/V2/Billing/RateCardRates.js +4 -0
  427. package/cjs/resources/V2/Billing/RateCardRates.js.map +1 -0
  428. package/cjs/resources/V2/Billing/RateCardSubscriptions.d.ts +219 -0
  429. package/cjs/resources/V2/Billing/RateCardSubscriptions.js +41 -0
  430. package/cjs/resources/V2/Billing/RateCardSubscriptions.js.map +1 -0
  431. package/cjs/resources/V2/Billing/RateCardVersions.d.ts +22 -0
  432. package/cjs/resources/V2/Billing/RateCardVersions.js +4 -0
  433. package/cjs/resources/V2/Billing/RateCardVersions.js.map +1 -0
  434. package/cjs/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.d.ts +79 -0
  435. package/cjs/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js +35 -0
  436. package/cjs/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js.map +1 -0
  437. package/cjs/resources/V2/Billing/RateCards/Rates.d.ts +145 -0
  438. package/cjs/resources/V2/Billing/RateCards/Rates.js +110 -0
  439. package/cjs/resources/V2/Billing/RateCards/Rates.js.map +1 -0
  440. package/cjs/resources/V2/Billing/RateCards/Versions.d.ts +33 -0
  441. package/cjs/resources/V2/Billing/RateCards/Versions.js +23 -0
  442. package/cjs/resources/V2/Billing/RateCards/Versions.js.map +1 -0
  443. package/cjs/resources/V2/Billing/RateCards.d.ts +357 -0
  444. package/cjs/resources/V2/Billing/RateCards.js +76 -0
  445. package/cjs/resources/V2/Billing/RateCards.js.map +1 -0
  446. package/cjs/resources/V2/Billing/ServiceActions.d.ts +514 -0
  447. package/cjs/resources/V2/Billing/ServiceActions.js +162 -0
  448. package/cjs/resources/V2/Billing/ServiceActions.js.map +1 -0
  449. package/cjs/resources/V2/Billing/index.d.ts +161 -6
  450. package/cjs/resources/V2/Billing/index.js +30 -0
  451. package/cjs/resources/V2/Billing/index.js.map +1 -1
  452. package/cjs/resources/V2/Commerce/ProductCatalog/Imports.d.ts +99 -0
  453. package/cjs/resources/V2/Commerce/ProductCatalog/Imports.js +156 -0
  454. package/cjs/resources/V2/Commerce/ProductCatalog/Imports.js.map +1 -0
  455. package/cjs/resources/V2/Commerce/ProductCatalog/index.d.ts +8 -0
  456. package/cjs/resources/V2/Commerce/ProductCatalog/index.js +13 -0
  457. package/cjs/resources/V2/Commerce/ProductCatalog/index.js.map +1 -0
  458. package/cjs/resources/V2/Commerce/ProductCatalogImports.d.ts +183 -0
  459. package/cjs/resources/V2/Commerce/ProductCatalogImports.js +4 -0
  460. package/cjs/resources/V2/Commerce/ProductCatalogImports.js.map +1 -0
  461. package/cjs/resources/V2/Commerce/index.d.ts +13 -0
  462. package/cjs/resources/V2/Commerce/index.js +13 -0
  463. package/cjs/resources/V2/Commerce/index.js.map +1 -0
  464. package/cjs/resources/V2/Core/AccountEvaluations.d.ts +160 -0
  465. package/cjs/resources/V2/Core/AccountEvaluations.js +15 -0
  466. package/cjs/resources/V2/Core/AccountEvaluations.js.map +1 -0
  467. package/cjs/resources/V2/Core/AccountLinks.d.ts +158 -6
  468. package/cjs/resources/V2/Core/AccountPersons.d.ts +1 -1
  469. package/cjs/resources/V2/Core/AccountTokens.d.ts +222 -4
  470. package/cjs/resources/V2/Core/Accounts/PersonTokens.d.ts +3 -2
  471. package/cjs/resources/V2/Core/Accounts/PersonTokens.js +2 -1
  472. package/cjs/resources/V2/Core/Accounts/PersonTokens.js.map +1 -1
  473. package/cjs/resources/V2/Core/Accounts/Persons.d.ts +2 -2
  474. package/cjs/resources/V2/Core/Accounts.d.ts +5319 -75
  475. package/cjs/resources/V2/Core/Accounts.js +1 -1
  476. package/cjs/resources/V2/Core/ApprovalRequests.d.ts +334 -0
  477. package/cjs/resources/V2/Core/ApprovalRequests.js +46 -0
  478. package/cjs/resources/V2/Core/ApprovalRequests.js.map +1 -0
  479. package/cjs/resources/V2/Core/BatchJobs.d.ts +373 -0
  480. package/cjs/resources/V2/Core/BatchJobs.js +225 -0
  481. package/cjs/resources/V2/Core/BatchJobs.js.map +1 -0
  482. package/cjs/resources/V2/Core/ClaimableSandboxes.d.ts +229 -0
  483. package/cjs/resources/V2/Core/ClaimableSandboxes.js +31 -0
  484. package/cjs/resources/V2/Core/ClaimableSandboxes.js.map +1 -0
  485. package/cjs/resources/V2/Core/ConnectionSessions.d.ts +90 -0
  486. package/cjs/resources/V2/Core/ConnectionSessions.js +21 -0
  487. package/cjs/resources/V2/Core/ConnectionSessions.js.map +1 -0
  488. package/cjs/resources/V2/Core/EventDestinations.d.ts +50 -3
  489. package/cjs/resources/V2/Core/Events.d.ts +7325 -204
  490. package/cjs/resources/V2/Core/Vault/GbBankAccounts.d.ts +285 -0
  491. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +54 -0
  492. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
  493. package/cjs/resources/V2/Core/Vault/UsBankAccounts.d.ts +254 -0
  494. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +62 -0
  495. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
  496. package/cjs/resources/V2/Core/Vault/index.d.ts +28 -0
  497. package/cjs/resources/V2/Core/Vault/index.js +15 -0
  498. package/cjs/resources/V2/Core/Vault/index.js.map +1 -0
  499. package/cjs/resources/V2/Core/index.d.ts +51 -14
  500. package/cjs/resources/V2/Core/index.js +12 -0
  501. package/cjs/resources/V2/Core/index.js.map +1 -1
  502. package/cjs/resources/V2/Data/Analytics/MetricQuery.d.ts +73 -0
  503. package/cjs/resources/V2/Data/Analytics/MetricQuery.js +36 -0
  504. package/cjs/resources/V2/Data/Analytics/MetricQuery.js.map +1 -0
  505. package/cjs/resources/V2/Data/Analytics/MetricQueryResults.d.ts +82 -0
  506. package/cjs/resources/V2/Data/Analytics/MetricQueryResults.js +4 -0
  507. package/cjs/resources/V2/Data/Analytics/MetricQueryResults.js.map +1 -0
  508. package/cjs/resources/V2/Data/Analytics/index.d.ts +12 -0
  509. package/cjs/resources/V2/Data/Analytics/index.js +13 -0
  510. package/cjs/resources/V2/Data/Analytics/index.js.map +1 -0
  511. package/cjs/resources/V2/Data/Reporting/QueryRuns.d.ts +156 -0
  512. package/cjs/resources/V2/Data/Reporting/QueryRuns.js +46 -0
  513. package/cjs/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
  514. package/cjs/resources/V2/Data/Reporting/index.d.ts +13 -0
  515. package/cjs/resources/V2/Data/Reporting/index.js +13 -0
  516. package/cjs/resources/V2/Data/Reporting/index.js.map +1 -0
  517. package/cjs/resources/V2/Data/index.d.ts +13 -0
  518. package/cjs/resources/V2/Data/index.js +15 -0
  519. package/cjs/resources/V2/Data/index.js.map +1 -0
  520. package/cjs/resources/V2/Extend/WorkflowRuns.d.ts +166 -0
  521. package/cjs/resources/V2/Extend/WorkflowRuns.js +23 -0
  522. package/cjs/resources/V2/Extend/WorkflowRuns.js.map +1 -0
  523. package/cjs/resources/V2/Extend/Workflows.d.ts +123 -0
  524. package/cjs/resources/V2/Extend/Workflows.js +30 -0
  525. package/cjs/resources/V2/Extend/Workflows.js.map +1 -0
  526. package/cjs/resources/V2/Extend/index.d.ts +20 -0
  527. package/cjs/resources/V2/Extend/index.js +15 -0
  528. package/cjs/resources/V2/Extend/index.js.map +1 -0
  529. package/cjs/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
  530. package/cjs/resources/V2/FinancialAddressCreditSimulations.js +4 -0
  531. package/cjs/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
  532. package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
  533. package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js +4 -0
  534. package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
  535. package/cjs/resources/V2/Iam/ActivityLogs.d.ts +204 -0
  536. package/cjs/resources/V2/Iam/ActivityLogs.js +17 -0
  537. package/cjs/resources/V2/Iam/ActivityLogs.js.map +1 -0
  538. package/cjs/resources/V2/Iam/ApiKeys.d.ts +280 -0
  539. package/cjs/resources/V2/Iam/ApiKeys.js +47 -0
  540. package/cjs/resources/V2/Iam/ApiKeys.js.map +1 -0
  541. package/cjs/resources/V2/Iam/index.d.ts +22 -0
  542. package/cjs/resources/V2/Iam/index.js +15 -0
  543. package/cjs/resources/V2/Iam/index.js.map +1 -0
  544. package/cjs/resources/V2/MoneyManagement/Adjustments.d.ts +139 -0
  545. package/cjs/resources/V2/MoneyManagement/Adjustments.js +23 -0
  546. package/cjs/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
  547. package/cjs/resources/V2/MoneyManagement/CurrencyConversions.d.ts +135 -0
  548. package/cjs/resources/V2/MoneyManagement/CurrencyConversions.js +31 -0
  549. package/cjs/resources/V2/MoneyManagement/CurrencyConversions.js.map +1 -0
  550. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.d.ts +412 -0
  551. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +44 -0
  552. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
  553. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.d.ts +308 -0
  554. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +31 -0
  555. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
  556. package/cjs/resources/V2/MoneyManagement/InboundTransfers.d.ts +254 -0
  557. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +30 -0
  558. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
  559. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +222 -0
  560. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +22 -0
  561. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
  562. package/cjs/resources/V2/MoneyManagement/OutboundPayments.d.ts +524 -0
  563. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +41 -0
  564. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
  565. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +320 -0
  566. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +49 -0
  567. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
  568. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.d.ts +342 -0
  569. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +39 -0
  570. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
  571. package/cjs/resources/V2/MoneyManagement/PayoutMethods.d.ts +270 -0
  572. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +44 -0
  573. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
  574. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +96 -0
  575. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +17 -0
  576. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
  577. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.d.ts +451 -0
  578. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +23 -0
  579. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
  580. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.d.ts +237 -0
  581. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +23 -0
  582. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
  583. package/cjs/resources/V2/MoneyManagement/RecipientVerifications.d.ts +120 -0
  584. package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js +27 -0
  585. package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js.map +1 -0
  586. package/cjs/resources/V2/MoneyManagement/TransactionEntries.d.ts +245 -0
  587. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +23 -0
  588. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
  589. package/cjs/resources/V2/MoneyManagement/Transactions.d.ts +276 -0
  590. package/cjs/resources/V2/MoneyManagement/Transactions.js +23 -0
  591. package/cjs/resources/V2/MoneyManagement/Transactions.js.map +1 -0
  592. package/cjs/resources/V2/MoneyManagement/index.d.ts +118 -0
  593. package/cjs/resources/V2/MoneyManagement/index.js +43 -0
  594. package/cjs/resources/V2/MoneyManagement/index.js.map +1 -0
  595. package/cjs/resources/V2/Network/BusinessProfiles.d.ts +96 -0
  596. package/cjs/resources/V2/Network/BusinessProfiles.js +21 -0
  597. package/cjs/resources/V2/Network/BusinessProfiles.js.map +1 -0
  598. package/cjs/resources/V2/Network/index.d.ts +13 -0
  599. package/cjs/resources/V2/Network/index.js +13 -0
  600. package/cjs/resources/V2/Network/index.js.map +1 -0
  601. package/cjs/resources/V2/OrchestratedCommerce/Agreements.d.ts +147 -0
  602. package/cjs/resources/V2/OrchestratedCommerce/Agreements.js +41 -0
  603. package/cjs/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
  604. package/cjs/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
  605. package/cjs/resources/V2/OrchestratedCommerce/index.js +13 -0
  606. package/cjs/resources/V2/OrchestratedCommerce/index.js.map +1 -0
  607. package/cjs/resources/V2/Payments/OffSessionPayments.d.ts +827 -0
  608. package/cjs/resources/V2/Payments/OffSessionPayments.js +53 -0
  609. package/cjs/resources/V2/Payments/OffSessionPayments.js.map +1 -0
  610. package/cjs/resources/V2/Payments/SettlementAllocationIntentSplits.d.ts +77 -0
  611. package/cjs/resources/V2/Payments/SettlementAllocationIntentSplits.js +4 -0
  612. package/cjs/resources/V2/Payments/SettlementAllocationIntentSplits.js.map +1 -0
  613. package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.d.ts +85 -0
  614. package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js +35 -0
  615. package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js.map +1 -0
  616. package/cjs/resources/V2/Payments/SettlementAllocationIntents.d.ts +213 -0
  617. package/cjs/resources/V2/Payments/SettlementAllocationIntents.js +53 -0
  618. package/cjs/resources/V2/Payments/SettlementAllocationIntents.js.map +1 -0
  619. package/cjs/resources/V2/Payments/index.d.ts +31 -0
  620. package/cjs/resources/V2/Payments/index.js +15 -0
  621. package/cjs/resources/V2/Payments/index.js.map +1 -0
  622. package/cjs/resources/V2/Reporting/ReportRuns.d.ts +173 -0
  623. package/cjs/resources/V2/Reporting/ReportRuns.js +50 -0
  624. package/cjs/resources/V2/Reporting/ReportRuns.js.map +1 -0
  625. package/cjs/resources/V2/Reporting/Reports.d.ts +110 -0
  626. package/cjs/resources/V2/Reporting/Reports.js +17 -0
  627. package/cjs/resources/V2/Reporting/Reports.js.map +1 -0
  628. package/cjs/resources/V2/Reporting/index.d.ts +18 -0
  629. package/cjs/resources/V2/Reporting/index.js +15 -0
  630. package/cjs/resources/V2/Reporting/index.js.map +1 -0
  631. package/cjs/resources/V2/Tax/ManualRules.d.ts +335 -0
  632. package/cjs/resources/V2/Tax/ManualRules.js +193 -0
  633. package/cjs/resources/V2/Tax/ManualRules.js.map +1 -0
  634. package/cjs/resources/V2/Tax/index.d.ts +16 -0
  635. package/cjs/resources/V2/Tax/index.js +13 -0
  636. package/cjs/resources/V2/Tax/index.js.map +1 -0
  637. package/cjs/resources/V2/TestHelpers/FinancialAddresses.d.ts +44 -0
  638. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +23 -0
  639. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
  640. package/cjs/resources/V2/TestHelpers/MoneyManagement.d.ts +31 -0
  641. package/cjs/resources/V2/TestHelpers/MoneyManagement.js +15 -0
  642. package/cjs/resources/V2/TestHelpers/MoneyManagement.js.map +1 -0
  643. package/cjs/resources/V2/TestHelpers/index.d.ts +10 -0
  644. package/cjs/resources/V2/TestHelpers/index.js +15 -0
  645. package/cjs/resources/V2/TestHelpers/index.js.map +1 -0
  646. package/cjs/resources/V2/index.d.ts +39 -0
  647. package/cjs/resources/V2/index.js +24 -2
  648. package/cjs/resources/V2/index.js.map +1 -1
  649. package/cjs/resources/WebhookEndpoints.d.ts +2 -2
  650. package/cjs/resources.d.ts +14 -0
  651. package/cjs/resources.js +240 -12
  652. package/cjs/resources.js.map +1 -1
  653. package/cjs/stripe.core.d.ts +84 -28
  654. package/cjs/stripe.core.js +59 -31
  655. package/cjs/stripe.core.js.map +1 -1
  656. package/esm/Error.d.ts +53 -0
  657. package/esm/Error.js +117 -0
  658. package/esm/Error.js.map +1 -1
  659. package/esm/Types.d.ts +4 -2
  660. package/esm/apiVersion.d.ts +1 -2
  661. package/esm/apiVersion.js +1 -2
  662. package/esm/apiVersion.js.map +1 -1
  663. package/esm/resources/AccountLinks.d.ts +5 -1
  664. package/esm/resources/AccountNotices.d.ts +140 -0
  665. package/esm/resources/AccountNotices.js +25 -0
  666. package/esm/resources/AccountNotices.js.map +1 -0
  667. package/esm/resources/AccountSessions.d.ts +463 -0
  668. package/esm/resources/AccountSessions.js.map +1 -1
  669. package/esm/resources/AccountSignals.d.ts +110 -0
  670. package/esm/resources/AccountSignals.js +3 -0
  671. package/esm/resources/AccountSignals.js.map +1 -0
  672. package/esm/resources/Accounts.d.ts +955 -3
  673. package/esm/resources/Accounts.js +21 -0
  674. package/esm/resources/Accounts.js.map +1 -1
  675. package/esm/resources/ApplicationFees.d.ts +28 -1
  676. package/esm/resources/Balance.d.ts +134 -0
  677. package/esm/resources/BalanceSettings.d.ts +18 -0
  678. package/esm/resources/BalanceTransactions.d.ts +1 -1
  679. package/esm/resources/BalanceTransfers.d.ts +160 -0
  680. package/esm/resources/BalanceTransfers.js +11 -0
  681. package/esm/resources/BalanceTransfers.js.map +1 -0
  682. package/esm/resources/BankAccounts.d.ts +2 -2
  683. package/esm/resources/Billing/AlertRecovereds.d.ts +40 -0
  684. package/esm/resources/Billing/AlertRecovereds.js +3 -0
  685. package/esm/resources/Billing/AlertRecovereds.js.map +1 -0
  686. package/esm/resources/Billing/AlertTriggereds.d.ts +57 -1
  687. package/esm/resources/Billing/Alerts.d.ts +406 -5
  688. package/esm/resources/Billing/Alerts.js +321 -5
  689. package/esm/resources/Billing/Alerts.js.map +1 -1
  690. package/esm/resources/Billing/Analytics/MeterUsage.d.ts +88 -0
  691. package/esm/resources/Billing/Analytics/MeterUsage.js +11 -0
  692. package/esm/resources/Billing/Analytics/MeterUsage.js.map +1 -0
  693. package/esm/resources/Billing/Analytics/MeterUsageRows.d.ts +38 -0
  694. package/esm/resources/Billing/Analytics/MeterUsageRows.js +3 -0
  695. package/esm/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
  696. package/esm/resources/Billing/Analytics/index.d.ts +15 -0
  697. package/esm/resources/Billing/Analytics/index.js +9 -0
  698. package/esm/resources/Billing/Analytics/index.js.map +1 -0
  699. package/esm/resources/Billing/CreditBalanceSummary.d.ts +126 -2
  700. package/esm/resources/Billing/CreditBalanceSummary.js +39 -1
  701. package/esm/resources/Billing/CreditBalanceSummary.js.map +1 -1
  702. package/esm/resources/Billing/CreditBalanceTransactions.d.ts +97 -3
  703. package/esm/resources/Billing/CreditBalanceTransactions.js +100 -1
  704. package/esm/resources/Billing/CreditBalanceTransactions.js.map +1 -1
  705. package/esm/resources/Billing/CreditGrants.d.ts +85 -3
  706. package/esm/resources/Billing/CreditGrants.js +134 -5
  707. package/esm/resources/Billing/CreditGrants.js.map +1 -1
  708. package/esm/resources/Billing/MeterEventSummaries.d.ts +6 -0
  709. package/esm/resources/Billing/Meters.d.ts +31 -0
  710. package/esm/resources/Billing/index.d.ts +6 -0
  711. package/esm/resources/Billing/index.js +2 -0
  712. package/esm/resources/Billing/index.js.map +1 -1
  713. package/esm/resources/Capabilities.d.ts +2 -2
  714. package/esm/resources/Capital/FinancingOffers.d.ts +191 -0
  715. package/esm/resources/Capital/FinancingOffers.js +26 -0
  716. package/esm/resources/Capital/FinancingOffers.js.map +1 -0
  717. package/esm/resources/Capital/FinancingSummary.d.ts +98 -0
  718. package/esm/resources/Capital/FinancingSummary.js +11 -0
  719. package/esm/resources/Capital/FinancingSummary.js.map +1 -0
  720. package/esm/resources/Capital/FinancingTransactions.d.ts +143 -0
  721. package/esm/resources/Capital/FinancingTransactions.js +20 -0
  722. package/esm/resources/Capital/FinancingTransactions.js.map +1 -0
  723. package/esm/resources/Capital/index.d.ts +25 -0
  724. package/esm/resources/Capital/index.js +13 -0
  725. package/esm/resources/Capital/index.js.map +1 -0
  726. package/esm/resources/Cards.d.ts +15 -0
  727. package/esm/resources/Charges.d.ts +3513 -70
  728. package/esm/resources/Charges.js.map +1 -1
  729. package/esm/resources/Checkout/Sessions.d.ts +792 -9
  730. package/esm/resources/Checkout/Sessions.js +88 -0
  731. package/esm/resources/Checkout/Sessions.js.map +1 -1
  732. package/esm/resources/Checkout/index.d.ts +1 -0
  733. package/esm/resources/ConfirmationTokens.d.ts +100 -1
  734. package/esm/resources/ConfirmationTokens.js.map +1 -1
  735. package/esm/resources/Coupons.d.ts +110 -2
  736. package/esm/resources/CreditNoteLineItems.d.ts +15 -1
  737. package/esm/resources/CreditNotes.d.ts +7 -1
  738. package/esm/resources/CreditNotes.js +14 -0
  739. package/esm/resources/CreditNotes.js.map +1 -1
  740. package/esm/resources/CustomerSessions.d.ts +68 -0
  741. package/esm/resources/Customers.d.ts +7 -1
  742. package/esm/resources/Customers.js +15 -0
  743. package/esm/resources/Customers.js.map +1 -1
  744. package/esm/resources/DelegatedCheckout/RequestedSessions.d.ts +1280 -0
  745. package/esm/resources/DelegatedCheckout/RequestedSessions.js +35 -0
  746. package/esm/resources/DelegatedCheckout/RequestedSessions.js.map +1 -0
  747. package/esm/resources/DelegatedCheckout/index.d.ts +16 -0
  748. package/esm/resources/DelegatedCheckout/index.js +9 -0
  749. package/esm/resources/DelegatedCheckout/index.js.map +1 -0
  750. package/esm/resources/Discounts.d.ts +19 -0
  751. package/esm/resources/Disputes.d.ts +37 -0
  752. package/esm/resources/Events.d.ts +560 -2
  753. package/esm/resources/ExternalAccounts.d.ts +212 -1
  754. package/esm/resources/ExternalAccounts.js +42 -1
  755. package/esm/resources/ExternalAccounts.js.map +1 -1
  756. package/esm/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
  757. package/esm/resources/FinancialConnections/AccountInferredBalances.js +3 -0
  758. package/esm/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
  759. package/esm/resources/FinancialConnections/Accounts.d.ts +74 -4
  760. package/esm/resources/FinancialConnections/Accounts.js +8 -0
  761. package/esm/resources/FinancialConnections/Accounts.js.map +1 -1
  762. package/esm/resources/FinancialConnections/Authorizations.d.ts +87 -0
  763. package/esm/resources/FinancialConnections/Authorizations.js +11 -0
  764. package/esm/resources/FinancialConnections/Authorizations.js.map +1 -0
  765. package/esm/resources/FinancialConnections/Institutions.d.ts +101 -0
  766. package/esm/resources/FinancialConnections/Institutions.js +19 -0
  767. package/esm/resources/FinancialConnections/Institutions.js.map +1 -0
  768. package/esm/resources/FinancialConnections/Sessions.d.ts +155 -7
  769. package/esm/resources/FinancialConnections/index.d.ts +21 -6
  770. package/esm/resources/FinancialConnections/index.js +4 -0
  771. package/esm/resources/FinancialConnections/index.js.map +1 -1
  772. package/esm/resources/FrMealVouchersOnboardings.d.ts +173 -0
  773. package/esm/resources/FrMealVouchersOnboardings.js +38 -0
  774. package/esm/resources/FrMealVouchersOnboardings.js.map +1 -0
  775. package/esm/resources/FxQuotes.d.ts +212 -0
  776. package/esm/resources/FxQuotes.js +25 -0
  777. package/esm/resources/FxQuotes.js.map +1 -0
  778. package/esm/resources/Identity/BlocklistEntries.d.ts +157 -0
  779. package/esm/resources/Identity/BlocklistEntries.js +50 -0
  780. package/esm/resources/Identity/BlocklistEntries.js.map +1 -0
  781. package/esm/resources/Identity/VerificationReports.d.ts +33 -2
  782. package/esm/resources/Identity/VerificationReports.js.map +1 -1
  783. package/esm/resources/Identity/VerificationSessions.d.ts +11 -3
  784. package/esm/resources/Identity/index.d.ts +18 -10
  785. package/esm/resources/Identity/index.js +2 -0
  786. package/esm/resources/Identity/index.js.map +1 -1
  787. package/esm/resources/InvoiceItems.d.ts +185 -2
  788. package/esm/resources/InvoiceItems.js.map +1 -1
  789. package/esm/resources/InvoiceLineItems.d.ts +174 -4
  790. package/esm/resources/Invoices.d.ts +2024 -35
  791. package/esm/resources/Invoices.js +70 -0
  792. package/esm/resources/Invoices.js.map +1 -1
  793. package/esm/resources/Issuing/Authorizations.d.ts +255 -0
  794. package/esm/resources/Issuing/Cardholders.d.ts +5 -4
  795. package/esm/resources/Issuing/Cards.d.ts +36 -0
  796. package/esm/resources/Issuing/CreditUnderwritingRecords.d.ts +640 -0
  797. package/esm/resources/Issuing/CreditUnderwritingRecords.js +43 -0
  798. package/esm/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
  799. package/esm/resources/Issuing/DisputeSettlementDetails.d.ts +95 -0
  800. package/esm/resources/Issuing/DisputeSettlementDetails.js +19 -0
  801. package/esm/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
  802. package/esm/resources/Issuing/Disputes.d.ts +140 -0
  803. package/esm/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
  804. package/esm/resources/Issuing/FraudLiabilityDebits.js +19 -0
  805. package/esm/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
  806. package/esm/resources/Issuing/Programs.d.ts +95 -0
  807. package/esm/resources/Issuing/Programs.js +31 -0
  808. package/esm/resources/Issuing/Programs.js.map +1 -0
  809. package/esm/resources/Issuing/Settlements.d.ts +85 -0
  810. package/esm/resources/Issuing/Settlements.js +3 -0
  811. package/esm/resources/Issuing/Settlements.js.map +1 -0
  812. package/esm/resources/Issuing/Transactions.d.ts +157 -0
  813. package/esm/resources/Issuing/Transactions.js.map +1 -1
  814. package/esm/resources/Issuing/index.d.ts +55 -22
  815. package/esm/resources/Issuing/index.js +8 -0
  816. package/esm/resources/Issuing/index.js.map +1 -1
  817. package/esm/resources/LineItems.d.ts +29 -2
  818. package/esm/resources/Mandates.d.ts +33 -1
  819. package/esm/resources/Mandates.js +8 -0
  820. package/esm/resources/Mandates.js.map +1 -1
  821. package/esm/resources/Margins.d.ts +115 -0
  822. package/esm/resources/Margins.js +31 -0
  823. package/esm/resources/Margins.js.map +1 -0
  824. package/esm/resources/Orchestration/PaymentAttempts.d.ts +34 -0
  825. package/esm/resources/Orchestration/PaymentAttempts.js +11 -0
  826. package/esm/resources/Orchestration/PaymentAttempts.js.map +1 -0
  827. package/esm/resources/Orchestration/index.d.ts +12 -0
  828. package/esm/resources/Orchestration/index.js +9 -0
  829. package/esm/resources/Orchestration/index.js.map +1 -0
  830. package/esm/resources/Orders.d.ts +4761 -0
  831. package/esm/resources/Orders.js +453 -0
  832. package/esm/resources/Orders.js.map +1 -0
  833. package/esm/resources/PaymentAttemptRecords.d.ts +441 -1
  834. package/esm/resources/PaymentAttemptRecords.js +42 -0
  835. package/esm/resources/PaymentAttemptRecords.js.map +1 -1
  836. package/esm/resources/PaymentIntentAmountDetailsLineItems.d.ts +17 -0
  837. package/esm/resources/PaymentIntents.d.ts +16370 -3527
  838. package/esm/resources/PaymentIntents.js +40 -0
  839. package/esm/resources/PaymentIntents.js.map +1 -1
  840. package/esm/resources/PaymentLinks.d.ts +74 -12
  841. package/esm/resources/PaymentMethodBalances.d.ts +46 -0
  842. package/esm/resources/PaymentMethodBalances.js +3 -0
  843. package/esm/resources/PaymentMethodBalances.js.map +1 -0
  844. package/esm/resources/PaymentMethodConfigurations.d.ts +350 -0
  845. package/esm/resources/PaymentMethods.d.ts +216 -3
  846. package/esm/resources/PaymentMethods.js +6 -0
  847. package/esm/resources/PaymentMethods.js.map +1 -1
  848. package/esm/resources/PaymentRecords.d.ts +323 -21
  849. package/esm/resources/PaymentRecords.js.map +1 -1
  850. package/esm/resources/Persons.d.ts +24 -2
  851. package/esm/resources/Plans.d.ts +16 -0
  852. package/esm/resources/Prices.d.ts +64 -0
  853. package/esm/resources/Privacy/RedactionJobValidationErrors.d.ts +37 -0
  854. package/esm/resources/Privacy/RedactionJobValidationErrors.js +3 -0
  855. package/esm/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
  856. package/esm/resources/Privacy/RedactionJobs.d.ts +229 -0
  857. package/esm/resources/Privacy/RedactionJobs.js +69 -0
  858. package/esm/resources/Privacy/RedactionJobs.js.map +1 -0
  859. package/esm/resources/Privacy/index.d.ts +22 -0
  860. package/esm/resources/Privacy/index.js +9 -0
  861. package/esm/resources/Privacy/index.js.map +1 -0
  862. package/esm/resources/ProductCatalog/TrialOffers.d.ts +127 -0
  863. package/esm/resources/ProductCatalog/TrialOffers.js +11 -0
  864. package/esm/resources/ProductCatalog/TrialOffers.js.map +1 -0
  865. package/esm/resources/ProductCatalog/index.d.ts +12 -0
  866. package/esm/resources/ProductCatalog/index.js +9 -0
  867. package/esm/resources/ProductCatalog/index.js.map +1 -0
  868. package/esm/resources/Products.d.ts +141 -0
  869. package/esm/resources/Profiles.d.ts +26 -0
  870. package/esm/resources/Profiles.js +3 -0
  871. package/esm/resources/Profiles.js.map +1 -0
  872. package/esm/resources/PromotionCodes.d.ts +12 -0
  873. package/esm/resources/PromotionCodes.js +28 -0
  874. package/esm/resources/PromotionCodes.js.map +1 -1
  875. package/esm/resources/QuoteLines.d.ts +684 -0
  876. package/esm/resources/QuoteLines.js +3 -0
  877. package/esm/resources/QuoteLines.js.map +1 -0
  878. package/esm/resources/QuotePreviewInvoices.d.ts +1153 -0
  879. package/esm/resources/QuotePreviewInvoices.js +3 -0
  880. package/esm/resources/QuotePreviewInvoices.js.map +1 -0
  881. package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +897 -0
  882. package/esm/resources/QuotePreviewSubscriptionSchedules.js +3 -0
  883. package/esm/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
  884. package/esm/resources/Quotes.d.ts +3548 -254
  885. package/esm/resources/Quotes.js +1184 -16
  886. package/esm/resources/Quotes.js.map +1 -1
  887. package/esm/resources/Radar/AccountEvaluations.d.ts +270 -0
  888. package/esm/resources/Radar/AccountEvaluations.js +23 -0
  889. package/esm/resources/Radar/AccountEvaluations.js.map +1 -0
  890. package/esm/resources/Radar/CustomerEvaluations.d.ts +242 -0
  891. package/esm/resources/Radar/CustomerEvaluations.js +17 -0
  892. package/esm/resources/Radar/CustomerEvaluations.js.map +1 -0
  893. package/esm/resources/Radar/IssuingAuthorizationEvaluations.d.ts +435 -0
  894. package/esm/resources/Radar/IssuingAuthorizationEvaluations.js +11 -0
  895. package/esm/resources/Radar/IssuingAuthorizationEvaluations.js.map +1 -0
  896. package/esm/resources/Radar/PaymentEvaluations.d.ts +63 -1
  897. package/esm/resources/Radar/index.d.ts +34 -16
  898. package/esm/resources/Radar/index.js +6 -0
  899. package/esm/resources/Radar/index.js.map +1 -1
  900. package/esm/resources/Refunds.d.ts +11 -0
  901. package/esm/resources/Reserve/Holds.d.ts +53 -1
  902. package/esm/resources/Reserve/Holds.js +17 -1
  903. package/esm/resources/Reserve/Holds.js.map +1 -1
  904. package/esm/resources/Reserve/Plans.d.ts +16 -0
  905. package/esm/resources/Reserve/Plans.js +9 -1
  906. package/esm/resources/Reserve/Plans.js.map +1 -1
  907. package/esm/resources/Reserve/Releases.d.ts +41 -1
  908. package/esm/resources/Reserve/Releases.js +17 -1
  909. package/esm/resources/Reserve/Releases.js.map +1 -1
  910. package/esm/resources/Reserve/index.d.ts +14 -3
  911. package/esm/resources/Reserve/index.js +10 -2
  912. package/esm/resources/Reserve/index.js.map +1 -1
  913. package/esm/resources/RiskSignals.d.ts +10 -0
  914. package/esm/resources/RiskSignals.js +3 -0
  915. package/esm/resources/RiskSignals.js.map +1 -0
  916. package/esm/resources/SetupAttempts.d.ts +26 -1
  917. package/esm/resources/SetupIntents.d.ts +491 -11
  918. package/esm/resources/SharedPayment/GrantedTokens.d.ts +1101 -0
  919. package/esm/resources/SharedPayment/GrantedTokens.js +11 -0
  920. package/esm/resources/SharedPayment/GrantedTokens.js.map +1 -0
  921. package/esm/resources/SharedPayment/IssuedTokens.d.ts +322 -0
  922. package/esm/resources/SharedPayment/IssuedTokens.js +23 -0
  923. package/esm/resources/SharedPayment/IssuedTokens.js.map +1 -0
  924. package/esm/resources/SharedPayment/index.d.ts +19 -0
  925. package/esm/resources/SharedPayment/index.js +11 -0
  926. package/esm/resources/SharedPayment/index.js.map +1 -0
  927. package/esm/resources/Sources.d.ts +16 -1
  928. package/esm/resources/SubscriptionItems.d.ts +251 -0
  929. package/esm/resources/SubscriptionSchedules.d.ts +1943 -19
  930. package/esm/resources/SubscriptionSchedules.js +48 -0
  931. package/esm/resources/SubscriptionSchedules.js.map +1 -1
  932. package/esm/resources/Subscriptions.d.ts +1040 -16
  933. package/esm/resources/Subscriptions.js +236 -1
  934. package/esm/resources/Subscriptions.js.map +1 -1
  935. package/esm/resources/Tax/CalculationLineItems.d.ts +6 -2
  936. package/esm/resources/Tax/Calculations.d.ts +7 -3
  937. package/esm/resources/Tax/Forms.d.ts +230 -0
  938. package/esm/resources/Tax/Forms.js +28 -0
  939. package/esm/resources/Tax/Forms.js.map +1 -0
  940. package/esm/resources/Tax/Locations.d.ts +108 -0
  941. package/esm/resources/Tax/Locations.js +29 -0
  942. package/esm/resources/Tax/Locations.js.map +1 -0
  943. package/esm/resources/Tax/Registrations.d.ts +155 -2
  944. package/esm/resources/Tax/Transactions.d.ts +2 -2
  945. package/esm/resources/Tax/index.d.ts +27 -13
  946. package/esm/resources/Tax/index.js +4 -0
  947. package/esm/resources/Tax/index.js.map +1 -1
  948. package/esm/resources/TaxCodes.d.ts +15 -0
  949. package/esm/resources/Terminal/Configurations.d.ts +27 -0
  950. package/esm/resources/Terminal/ReaderCollectedData.d.ts +52 -0
  951. package/esm/resources/Terminal/ReaderCollectedData.js +11 -0
  952. package/esm/resources/Terminal/ReaderCollectedData.js.map +1 -0
  953. package/esm/resources/Terminal/Readers.d.ts +51 -1
  954. package/esm/resources/Terminal/index.d.ts +5 -0
  955. package/esm/resources/Terminal/index.js +2 -0
  956. package/esm/resources/Terminal/index.js.map +1 -1
  957. package/esm/resources/TestHelpers/Capital/FinancingOffers.d.ts +81 -0
  958. package/esm/resources/TestHelpers/Capital/FinancingOffers.js +17 -0
  959. package/esm/resources/TestHelpers/Capital/FinancingOffers.js.map +1 -0
  960. package/esm/resources/TestHelpers/Capital/index.d.ts +8 -0
  961. package/esm/resources/TestHelpers/Capital/index.js +9 -0
  962. package/esm/resources/TestHelpers/Capital/index.js.map +1 -0
  963. package/esm/resources/TestHelpers/ConfirmationTokens.d.ts +78 -1
  964. package/esm/resources/TestHelpers/Issuing/Authorizations.d.ts +8 -0
  965. package/esm/resources/TestHelpers/Issuing/Transactions.d.ts +16 -0
  966. package/esm/resources/TestHelpers/PaymentIntents.d.ts +36 -0
  967. package/esm/resources/TestHelpers/PaymentIntents.js +11 -0
  968. package/esm/resources/TestHelpers/PaymentIntents.js.map +1 -0
  969. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +75 -0
  970. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +17 -0
  971. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
  972. package/esm/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
  973. package/esm/resources/TestHelpers/SharedPayment/index.js +9 -0
  974. package/esm/resources/TestHelpers/SharedPayment/index.js.map +1 -0
  975. package/esm/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
  976. package/esm/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
  977. package/esm/resources/TestHelpers/index.d.ts +14 -6
  978. package/esm/resources/TestHelpers/index.js +6 -0
  979. package/esm/resources/TestHelpers/index.js.map +1 -1
  980. package/esm/resources/Tokens.d.ts +56 -0
  981. package/esm/resources/Transfers.d.ts +12 -0
  982. package/esm/resources/Transfers.js.map +1 -1
  983. package/esm/resources/TransitBalances.d.ts +25 -0
  984. package/esm/resources/TransitBalances.js +3 -0
  985. package/esm/resources/TransitBalances.js.map +1 -0
  986. package/esm/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
  987. package/esm/resources/Treasury/FinancialAccounts.d.ts +34 -1
  988. package/esm/resources/Treasury/OutboundPayments.d.ts +8 -0
  989. package/esm/resources/Treasury/OutboundTransfers.d.ts +44 -0
  990. package/esm/resources/Treasury/ReceivedCredits.d.ts +22 -0
  991. package/esm/resources/Treasury/ReceivedDebits.d.ts +26 -0
  992. package/esm/resources/V2/Billing/BillSettingVersions.d.ts +75 -0
  993. package/esm/resources/V2/Billing/BillSettingVersions.js +3 -0
  994. package/esm/resources/V2/Billing/BillSettingVersions.js.map +1 -0
  995. package/esm/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
  996. package/esm/resources/V2/Billing/BillSettings/Versions.js +19 -0
  997. package/esm/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
  998. package/esm/resources/V2/Billing/BillSettings.d.ts +284 -0
  999. package/esm/resources/V2/Billing/BillSettings.js +37 -0
  1000. package/esm/resources/V2/Billing/BillSettings.js.map +1 -0
  1001. package/esm/resources/V2/Billing/CadenceSpendModifiers.d.ts +88 -0
  1002. package/esm/resources/V2/Billing/CadenceSpendModifiers.js +3 -0
  1003. package/esm/resources/V2/Billing/CadenceSpendModifiers.js.map +1 -0
  1004. package/esm/resources/V2/Billing/Cadences/SpendModifierRules.d.ts +37 -0
  1005. package/esm/resources/V2/Billing/Cadences/SpendModifierRules.js +19 -0
  1006. package/esm/resources/V2/Billing/Cadences/SpendModifierRules.js.map +1 -0
  1007. package/esm/resources/V2/Billing/Cadences.d.ts +1015 -0
  1008. package/esm/resources/V2/Billing/Cadences.js +260 -0
  1009. package/esm/resources/V2/Billing/Cadences.js.map +1 -0
  1010. package/esm/resources/V2/Billing/CollectionSettingVersions.d.ts +240 -0
  1011. package/esm/resources/V2/Billing/CollectionSettingVersions.js +3 -0
  1012. package/esm/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
  1013. package/esm/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
  1014. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +66 -0
  1015. package/esm/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
  1016. package/esm/resources/V2/Billing/CollectionSettings.d.ts +779 -0
  1017. package/esm/resources/V2/Billing/CollectionSettings.js +162 -0
  1018. package/esm/resources/V2/Billing/CollectionSettings.js.map +1 -0
  1019. package/esm/resources/V2/Billing/CustomPricingUnits.d.ts +125 -0
  1020. package/esm/resources/V2/Billing/CustomPricingUnits.js +31 -0
  1021. package/esm/resources/V2/Billing/CustomPricingUnits.js.map +1 -0
  1022. package/esm/resources/V2/Billing/IntentActions.d.ts +607 -0
  1023. package/esm/resources/V2/Billing/IntentActions.js +3 -0
  1024. package/esm/resources/V2/Billing/IntentActions.js.map +1 -0
  1025. package/esm/resources/V2/Billing/Intents/Actions.d.ts +33 -0
  1026. package/esm/resources/V2/Billing/Intents/Actions.js +66 -0
  1027. package/esm/resources/V2/Billing/Intents/Actions.js.map +1 -0
  1028. package/esm/resources/V2/Billing/Intents.d.ts +1257 -0
  1029. package/esm/resources/V2/Billing/Intents.js +83 -0
  1030. package/esm/resources/V2/Billing/Intents.js.map +1 -0
  1031. package/esm/resources/V2/Billing/LicenseFeeVersions.d.ts +82 -0
  1032. package/esm/resources/V2/Billing/LicenseFeeVersions.js +3 -0
  1033. package/esm/resources/V2/Billing/LicenseFeeVersions.js.map +1 -0
  1034. package/esm/resources/V2/Billing/LicenseFees/Versions.d.ts +33 -0
  1035. package/esm/resources/V2/Billing/LicenseFees/Versions.js +60 -0
  1036. package/esm/resources/V2/Billing/LicenseFees/Versions.js.map +1 -0
  1037. package/esm/resources/V2/Billing/LicenseFees.d.ts +378 -0
  1038. package/esm/resources/V2/Billing/LicenseFees.js +144 -0
  1039. package/esm/resources/V2/Billing/LicenseFees.js.map +1 -0
  1040. package/esm/resources/V2/Billing/LicensedItems.d.ts +174 -0
  1041. package/esm/resources/V2/Billing/LicensedItems.js +31 -0
  1042. package/esm/resources/V2/Billing/LicensedItems.js.map +1 -0
  1043. package/esm/resources/V2/Billing/MeterEventAdjustments.d.ts +5 -5
  1044. package/esm/resources/V2/Billing/MeterEventSession.d.ts +4 -4
  1045. package/esm/resources/V2/Billing/MeterEventSession.js +1 -1
  1046. package/esm/resources/V2/Billing/MeteredItems.d.ts +222 -0
  1047. package/esm/resources/V2/Billing/MeteredItems.js +31 -0
  1048. package/esm/resources/V2/Billing/MeteredItems.js.map +1 -0
  1049. package/esm/resources/V2/Billing/OneTimeItems.d.ts +174 -0
  1050. package/esm/resources/V2/Billing/OneTimeItems.js +31 -0
  1051. package/esm/resources/V2/Billing/OneTimeItems.js.map +1 -0
  1052. package/esm/resources/V2/Billing/PricingPlanComponents.d.ts +84 -0
  1053. package/esm/resources/V2/Billing/PricingPlanComponents.js +3 -0
  1054. package/esm/resources/V2/Billing/PricingPlanComponents.js.map +1 -0
  1055. package/esm/resources/V2/Billing/PricingPlanSubscriptions.d.ts +624 -0
  1056. package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +292 -0
  1057. package/esm/resources/V2/Billing/PricingPlanSubscriptions.js.map +1 -0
  1058. package/esm/resources/V2/Billing/PricingPlanVersions.d.ts +30 -0
  1059. package/esm/resources/V2/Billing/PricingPlanVersions.js +3 -0
  1060. package/esm/resources/V2/Billing/PricingPlanVersions.js.map +1 -0
  1061. package/esm/resources/V2/Billing/PricingPlans/Components.d.ts +142 -0
  1062. package/esm/resources/V2/Billing/PricingPlans/Components.js +37 -0
  1063. package/esm/resources/V2/Billing/PricingPlans/Components.js.map +1 -0
  1064. package/esm/resources/V2/Billing/PricingPlans/Versions.d.ts +33 -0
  1065. package/esm/resources/V2/Billing/PricingPlans/Versions.js +19 -0
  1066. package/esm/resources/V2/Billing/PricingPlans/Versions.js.map +1 -0
  1067. package/esm/resources/V2/Billing/PricingPlans.d.ts +177 -0
  1068. package/esm/resources/V2/Billing/PricingPlans.js +39 -0
  1069. package/esm/resources/V2/Billing/PricingPlans.js.map +1 -0
  1070. package/esm/resources/V2/Billing/Profiles.d.ts +166 -0
  1071. package/esm/resources/V2/Billing/Profiles.js +31 -0
  1072. package/esm/resources/V2/Billing/Profiles.js.map +1 -0
  1073. package/esm/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.d.ts +45 -0
  1074. package/esm/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js +3 -0
  1075. package/esm/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js.map +1 -0
  1076. package/esm/resources/V2/Billing/RateCardRates.d.ts +115 -0
  1077. package/esm/resources/V2/Billing/RateCardRates.js +3 -0
  1078. package/esm/resources/V2/Billing/RateCardRates.js.map +1 -0
  1079. package/esm/resources/V2/Billing/RateCardSubscriptions.d.ts +219 -0
  1080. package/esm/resources/V2/Billing/RateCardSubscriptions.js +37 -0
  1081. package/esm/resources/V2/Billing/RateCardSubscriptions.js.map +1 -0
  1082. package/esm/resources/V2/Billing/RateCardVersions.d.ts +22 -0
  1083. package/esm/resources/V2/Billing/RateCardVersions.js +3 -0
  1084. package/esm/resources/V2/Billing/RateCardVersions.js.map +1 -0
  1085. package/esm/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.d.ts +79 -0
  1086. package/esm/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js +31 -0
  1087. package/esm/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js.map +1 -0
  1088. package/esm/resources/V2/Billing/RateCards/Rates.d.ts +145 -0
  1089. package/esm/resources/V2/Billing/RateCards/Rates.js +106 -0
  1090. package/esm/resources/V2/Billing/RateCards/Rates.js.map +1 -0
  1091. package/esm/resources/V2/Billing/RateCards/Versions.d.ts +33 -0
  1092. package/esm/resources/V2/Billing/RateCards/Versions.js +19 -0
  1093. package/esm/resources/V2/Billing/RateCards/Versions.js.map +1 -0
  1094. package/esm/resources/V2/Billing/RateCards.d.ts +357 -0
  1095. package/esm/resources/V2/Billing/RateCards.js +72 -0
  1096. package/esm/resources/V2/Billing/RateCards.js.map +1 -0
  1097. package/esm/resources/V2/Billing/ServiceActions.d.ts +514 -0
  1098. package/esm/resources/V2/Billing/ServiceActions.js +158 -0
  1099. package/esm/resources/V2/Billing/ServiceActions.js.map +1 -0
  1100. package/esm/resources/V2/Billing/index.d.ts +161 -6
  1101. package/esm/resources/V2/Billing/index.js +30 -0
  1102. package/esm/resources/V2/Billing/index.js.map +1 -1
  1103. package/esm/resources/V2/Commerce/ProductCatalog/Imports.d.ts +99 -0
  1104. package/esm/resources/V2/Commerce/ProductCatalog/Imports.js +152 -0
  1105. package/esm/resources/V2/Commerce/ProductCatalog/Imports.js.map +1 -0
  1106. package/esm/resources/V2/Commerce/ProductCatalog/index.d.ts +8 -0
  1107. package/esm/resources/V2/Commerce/ProductCatalog/index.js +9 -0
  1108. package/esm/resources/V2/Commerce/ProductCatalog/index.js.map +1 -0
  1109. package/esm/resources/V2/Commerce/ProductCatalogImports.d.ts +183 -0
  1110. package/esm/resources/V2/Commerce/ProductCatalogImports.js +3 -0
  1111. package/esm/resources/V2/Commerce/ProductCatalogImports.js.map +1 -0
  1112. package/esm/resources/V2/Commerce/index.d.ts +13 -0
  1113. package/esm/resources/V2/Commerce/index.js +9 -0
  1114. package/esm/resources/V2/Commerce/index.js.map +1 -0
  1115. package/esm/resources/V2/Core/AccountEvaluations.d.ts +160 -0
  1116. package/esm/resources/V2/Core/AccountEvaluations.js +11 -0
  1117. package/esm/resources/V2/Core/AccountEvaluations.js.map +1 -0
  1118. package/esm/resources/V2/Core/AccountLinks.d.ts +158 -6
  1119. package/esm/resources/V2/Core/AccountPersons.d.ts +1 -1
  1120. package/esm/resources/V2/Core/AccountTokens.d.ts +222 -4
  1121. package/esm/resources/V2/Core/Accounts/PersonTokens.d.ts +3 -2
  1122. package/esm/resources/V2/Core/Accounts/PersonTokens.js +2 -1
  1123. package/esm/resources/V2/Core/Accounts/PersonTokens.js.map +1 -1
  1124. package/esm/resources/V2/Core/Accounts/Persons.d.ts +2 -2
  1125. package/esm/resources/V2/Core/Accounts.d.ts +5319 -75
  1126. package/esm/resources/V2/Core/Accounts.js +1 -1
  1127. package/esm/resources/V2/Core/ApprovalRequests.d.ts +334 -0
  1128. package/esm/resources/V2/Core/ApprovalRequests.js +42 -0
  1129. package/esm/resources/V2/Core/ApprovalRequests.js.map +1 -0
  1130. package/esm/resources/V2/Core/BatchJobs.d.ts +373 -0
  1131. package/esm/resources/V2/Core/BatchJobs.js +221 -0
  1132. package/esm/resources/V2/Core/BatchJobs.js.map +1 -0
  1133. package/esm/resources/V2/Core/ClaimableSandboxes.d.ts +229 -0
  1134. package/esm/resources/V2/Core/ClaimableSandboxes.js +27 -0
  1135. package/esm/resources/V2/Core/ClaimableSandboxes.js.map +1 -0
  1136. package/esm/resources/V2/Core/ConnectionSessions.d.ts +90 -0
  1137. package/esm/resources/V2/Core/ConnectionSessions.js +17 -0
  1138. package/esm/resources/V2/Core/ConnectionSessions.js.map +1 -0
  1139. package/esm/resources/V2/Core/EventDestinations.d.ts +50 -3
  1140. package/esm/resources/V2/Core/Events.d.ts +7325 -204
  1141. package/esm/resources/V2/Core/Vault/GbBankAccounts.d.ts +285 -0
  1142. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +50 -0
  1143. package/esm/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
  1144. package/esm/resources/V2/Core/Vault/UsBankAccounts.d.ts +254 -0
  1145. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +58 -0
  1146. package/esm/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
  1147. package/esm/resources/V2/Core/Vault/index.d.ts +28 -0
  1148. package/esm/resources/V2/Core/Vault/index.js +11 -0
  1149. package/esm/resources/V2/Core/Vault/index.js.map +1 -0
  1150. package/esm/resources/V2/Core/index.d.ts +51 -14
  1151. package/esm/resources/V2/Core/index.js +12 -0
  1152. package/esm/resources/V2/Core/index.js.map +1 -1
  1153. package/esm/resources/V2/Data/Analytics/MetricQuery.d.ts +73 -0
  1154. package/esm/resources/V2/Data/Analytics/MetricQuery.js +32 -0
  1155. package/esm/resources/V2/Data/Analytics/MetricQuery.js.map +1 -0
  1156. package/esm/resources/V2/Data/Analytics/MetricQueryResults.d.ts +82 -0
  1157. package/esm/resources/V2/Data/Analytics/MetricQueryResults.js +3 -0
  1158. package/esm/resources/V2/Data/Analytics/MetricQueryResults.js.map +1 -0
  1159. package/esm/resources/V2/Data/Analytics/index.d.ts +12 -0
  1160. package/esm/resources/V2/Data/Analytics/index.js +9 -0
  1161. package/esm/resources/V2/Data/Analytics/index.js.map +1 -0
  1162. package/esm/resources/V2/Data/Reporting/QueryRuns.d.ts +156 -0
  1163. package/esm/resources/V2/Data/Reporting/QueryRuns.js +42 -0
  1164. package/esm/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
  1165. package/esm/resources/V2/Data/Reporting/index.d.ts +13 -0
  1166. package/esm/resources/V2/Data/Reporting/index.js +9 -0
  1167. package/esm/resources/V2/Data/Reporting/index.js.map +1 -0
  1168. package/esm/resources/V2/Data/index.d.ts +13 -0
  1169. package/esm/resources/V2/Data/index.js +11 -0
  1170. package/esm/resources/V2/Data/index.js.map +1 -0
  1171. package/esm/resources/V2/Extend/WorkflowRuns.d.ts +166 -0
  1172. package/esm/resources/V2/Extend/WorkflowRuns.js +19 -0
  1173. package/esm/resources/V2/Extend/WorkflowRuns.js.map +1 -0
  1174. package/esm/resources/V2/Extend/Workflows.d.ts +123 -0
  1175. package/esm/resources/V2/Extend/Workflows.js +26 -0
  1176. package/esm/resources/V2/Extend/Workflows.js.map +1 -0
  1177. package/esm/resources/V2/Extend/index.d.ts +20 -0
  1178. package/esm/resources/V2/Extend/index.js +11 -0
  1179. package/esm/resources/V2/Extend/index.js.map +1 -0
  1180. package/esm/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
  1181. package/esm/resources/V2/FinancialAddressCreditSimulations.js +3 -0
  1182. package/esm/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
  1183. package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
  1184. package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js +3 -0
  1185. package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
  1186. package/esm/resources/V2/Iam/ActivityLogs.d.ts +204 -0
  1187. package/esm/resources/V2/Iam/ActivityLogs.js +13 -0
  1188. package/esm/resources/V2/Iam/ActivityLogs.js.map +1 -0
  1189. package/esm/resources/V2/Iam/ApiKeys.d.ts +280 -0
  1190. package/esm/resources/V2/Iam/ApiKeys.js +43 -0
  1191. package/esm/resources/V2/Iam/ApiKeys.js.map +1 -0
  1192. package/esm/resources/V2/Iam/index.d.ts +22 -0
  1193. package/esm/resources/V2/Iam/index.js +11 -0
  1194. package/esm/resources/V2/Iam/index.js.map +1 -0
  1195. package/esm/resources/V2/MoneyManagement/Adjustments.d.ts +139 -0
  1196. package/esm/resources/V2/MoneyManagement/Adjustments.js +19 -0
  1197. package/esm/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
  1198. package/esm/resources/V2/MoneyManagement/CurrencyConversions.d.ts +135 -0
  1199. package/esm/resources/V2/MoneyManagement/CurrencyConversions.js +27 -0
  1200. package/esm/resources/V2/MoneyManagement/CurrencyConversions.js.map +1 -0
  1201. package/esm/resources/V2/MoneyManagement/FinancialAccounts.d.ts +412 -0
  1202. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +40 -0
  1203. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
  1204. package/esm/resources/V2/MoneyManagement/FinancialAddresses.d.ts +308 -0
  1205. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +27 -0
  1206. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
  1207. package/esm/resources/V2/MoneyManagement/InboundTransfers.d.ts +254 -0
  1208. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +26 -0
  1209. package/esm/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
  1210. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +222 -0
  1211. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +18 -0
  1212. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
  1213. package/esm/resources/V2/MoneyManagement/OutboundPayments.d.ts +524 -0
  1214. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +37 -0
  1215. package/esm/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
  1216. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +320 -0
  1217. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +45 -0
  1218. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
  1219. package/esm/resources/V2/MoneyManagement/OutboundTransfers.d.ts +342 -0
  1220. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +35 -0
  1221. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
  1222. package/esm/resources/V2/MoneyManagement/PayoutMethods.d.ts +270 -0
  1223. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +40 -0
  1224. package/esm/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
  1225. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +96 -0
  1226. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +13 -0
  1227. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
  1228. package/esm/resources/V2/MoneyManagement/ReceivedCredits.d.ts +451 -0
  1229. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +19 -0
  1230. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
  1231. package/esm/resources/V2/MoneyManagement/ReceivedDebits.d.ts +237 -0
  1232. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +19 -0
  1233. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
  1234. package/esm/resources/V2/MoneyManagement/RecipientVerifications.d.ts +120 -0
  1235. package/esm/resources/V2/MoneyManagement/RecipientVerifications.js +23 -0
  1236. package/esm/resources/V2/MoneyManagement/RecipientVerifications.js.map +1 -0
  1237. package/esm/resources/V2/MoneyManagement/TransactionEntries.d.ts +245 -0
  1238. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +19 -0
  1239. package/esm/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
  1240. package/esm/resources/V2/MoneyManagement/Transactions.d.ts +276 -0
  1241. package/esm/resources/V2/MoneyManagement/Transactions.js +19 -0
  1242. package/esm/resources/V2/MoneyManagement/Transactions.js.map +1 -0
  1243. package/esm/resources/V2/MoneyManagement/index.d.ts +118 -0
  1244. package/esm/resources/V2/MoneyManagement/index.js +39 -0
  1245. package/esm/resources/V2/MoneyManagement/index.js.map +1 -0
  1246. package/esm/resources/V2/Network/BusinessProfiles.d.ts +96 -0
  1247. package/esm/resources/V2/Network/BusinessProfiles.js +17 -0
  1248. package/esm/resources/V2/Network/BusinessProfiles.js.map +1 -0
  1249. package/esm/resources/V2/Network/index.d.ts +13 -0
  1250. package/esm/resources/V2/Network/index.js +9 -0
  1251. package/esm/resources/V2/Network/index.js.map +1 -0
  1252. package/esm/resources/V2/OrchestratedCommerce/Agreements.d.ts +147 -0
  1253. package/esm/resources/V2/OrchestratedCommerce/Agreements.js +37 -0
  1254. package/esm/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
  1255. package/esm/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
  1256. package/esm/resources/V2/OrchestratedCommerce/index.js +9 -0
  1257. package/esm/resources/V2/OrchestratedCommerce/index.js.map +1 -0
  1258. package/esm/resources/V2/Payments/OffSessionPayments.d.ts +827 -0
  1259. package/esm/resources/V2/Payments/OffSessionPayments.js +49 -0
  1260. package/esm/resources/V2/Payments/OffSessionPayments.js.map +1 -0
  1261. package/esm/resources/V2/Payments/SettlementAllocationIntentSplits.d.ts +77 -0
  1262. package/esm/resources/V2/Payments/SettlementAllocationIntentSplits.js +3 -0
  1263. package/esm/resources/V2/Payments/SettlementAllocationIntentSplits.js.map +1 -0
  1264. package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.d.ts +85 -0
  1265. package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js +31 -0
  1266. package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js.map +1 -0
  1267. package/esm/resources/V2/Payments/SettlementAllocationIntents.d.ts +213 -0
  1268. package/esm/resources/V2/Payments/SettlementAllocationIntents.js +49 -0
  1269. package/esm/resources/V2/Payments/SettlementAllocationIntents.js.map +1 -0
  1270. package/esm/resources/V2/Payments/index.d.ts +31 -0
  1271. package/esm/resources/V2/Payments/index.js +11 -0
  1272. package/esm/resources/V2/Payments/index.js.map +1 -0
  1273. package/esm/resources/V2/Reporting/ReportRuns.d.ts +173 -0
  1274. package/esm/resources/V2/Reporting/ReportRuns.js +46 -0
  1275. package/esm/resources/V2/Reporting/ReportRuns.js.map +1 -0
  1276. package/esm/resources/V2/Reporting/Reports.d.ts +110 -0
  1277. package/esm/resources/V2/Reporting/Reports.js +13 -0
  1278. package/esm/resources/V2/Reporting/Reports.js.map +1 -0
  1279. package/esm/resources/V2/Reporting/index.d.ts +18 -0
  1280. package/esm/resources/V2/Reporting/index.js +11 -0
  1281. package/esm/resources/V2/Reporting/index.js.map +1 -0
  1282. package/esm/resources/V2/Tax/ManualRules.d.ts +335 -0
  1283. package/esm/resources/V2/Tax/ManualRules.js +189 -0
  1284. package/esm/resources/V2/Tax/ManualRules.js.map +1 -0
  1285. package/esm/resources/V2/Tax/index.d.ts +16 -0
  1286. package/esm/resources/V2/Tax/index.js +9 -0
  1287. package/esm/resources/V2/Tax/index.js.map +1 -0
  1288. package/esm/resources/V2/TestHelpers/FinancialAddresses.d.ts +44 -0
  1289. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +19 -0
  1290. package/esm/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
  1291. package/esm/resources/V2/TestHelpers/MoneyManagement.d.ts +31 -0
  1292. package/esm/resources/V2/TestHelpers/MoneyManagement.js +11 -0
  1293. package/esm/resources/V2/TestHelpers/MoneyManagement.js.map +1 -0
  1294. package/esm/resources/V2/TestHelpers/index.d.ts +10 -0
  1295. package/esm/resources/V2/TestHelpers/index.js +11 -0
  1296. package/esm/resources/V2/TestHelpers/index.js.map +1 -0
  1297. package/esm/resources/V2/index.d.ts +39 -0
  1298. package/esm/resources/V2/index.js +22 -0
  1299. package/esm/resources/V2/index.js.map +1 -1
  1300. package/esm/resources/WebhookEndpoints.d.ts +2 -2
  1301. package/esm/resources.d.ts +14 -0
  1302. package/esm/resources.js +221 -0
  1303. package/esm/resources.js.map +1 -1
  1304. package/esm/stripe.core.d.ts +84 -28
  1305. package/esm/stripe.core.js +29 -1
  1306. package/esm/stripe.core.js.map +1 -1
  1307. package/esm/stripe.esm.node.d.ts +84 -28
  1308. package/esm/stripe.esm.node.js +29 -1
  1309. package/esm/stripe.esm.node.js.map +1 -1
  1310. package/package.json +1 -1
@@ -4,6 +4,7 @@ import { Discount, DeletedDiscount } from './Discounts.js';
4
4
  import { TaxId, DeletedTaxId } from './TaxIds.js';
5
5
  import { Application, DeletedApplication } from './Applications.js';
6
6
  import { Customer, DeletedCustomer } from './Customers.js';
7
+ import { Margin } from './Margins.js';
7
8
  import { PaymentMethod } from './PaymentMethods.js';
8
9
  import { CustomerSource } from './CustomerSources.js';
9
10
  import { TaxRate } from './TaxRates.js';
@@ -67,6 +68,10 @@ export declare class InvoiceResource extends StripeResource {
67
68
  * See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more.
68
69
  */
69
70
  attachPayment(id: string, params?: InvoiceAttachPaymentParams, options?: RequestOptions): Promise<Response<Invoice>>;
71
+ /**
72
+ * Detaches a payment from the invoice, removing it from the list of payments
73
+ */
74
+ detachPayment(id: string, params?: InvoiceDetachPaymentParams, options?: RequestOptions): Promise<Response<Invoice>>;
70
75
  /**
71
76
  * Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method.
72
77
  */
@@ -111,6 +116,14 @@ export declare class InvoiceResource extends StripeResource {
111
116
  * Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions)
112
117
  */
113
118
  createPreview(params?: InvoiceCreatePreviewParams, options?: RequestOptions): Promise<Response<Invoice>>;
119
+ serializeBatchUpdate(invoice: string, params?: Record<string, unknown>, options?: {
120
+ apiVersion?: string;
121
+ stripeContext?: string;
122
+ }): string;
123
+ serializeBatchPay(invoice: string, params?: Record<string, unknown>, options?: {
124
+ apiVersion?: string;
125
+ stripeContext?: string;
126
+ }): string;
114
127
  /**
115
128
  * When retrieving an invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
116
129
  */
@@ -164,6 +177,10 @@ export interface Invoice {
164
177
  * This is the sum of all the shipping amounts.
165
178
  */
166
179
  amount_shipping: number;
180
+ /**
181
+ * List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
182
+ */
183
+ amounts_due?: Array<Invoice.AmountsDue> | null;
167
184
  /**
168
185
  * ID of the Connect Application that created the invoice.
169
186
  */
@@ -253,6 +270,10 @@ export interface Invoice {
253
270
  * The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.
254
271
  */
255
272
  customer_tax_ids?: Array<Invoice.CustomerTaxId> | null;
273
+ /**
274
+ * The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
275
+ */
276
+ default_margins?: Array<string | Margin> | null;
256
277
  /**
257
278
  * ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
258
279
  */
@@ -417,6 +438,10 @@ export interface Invoice {
417
438
  * The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
418
439
  */
419
440
  total_excluding_tax: number | null;
441
+ /**
442
+ * The aggregate amounts calculated per margin across all line items.
443
+ */
444
+ total_margin_amounts?: Array<Invoice.TotalMarginAmount> | null;
420
445
  /**
421
446
  * Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
422
447
  */
@@ -445,6 +470,40 @@ export interface DeletedInvoice {
445
470
  deleted: true;
446
471
  }
447
472
  export declare namespace Invoice {
473
+ interface AmountsDue {
474
+ /**
475
+ * Incremental amount due for this payment in cents (or local equivalent).
476
+ */
477
+ amount: number;
478
+ /**
479
+ * The amount in cents (or local equivalent) that was paid for this payment.
480
+ */
481
+ amount_paid: number;
482
+ /**
483
+ * The difference between the payment's amount and amount_paid, in cents (or local equivalent).
484
+ */
485
+ amount_remaining: number;
486
+ /**
487
+ * Number of days from when invoice is finalized until the payment is due.
488
+ */
489
+ days_until_due: number | null;
490
+ /**
491
+ * An arbitrary string attached to the object. Often useful for displaying to users.
492
+ */
493
+ description: string | null;
494
+ /**
495
+ * Date on which a payment plan's payment is due.
496
+ */
497
+ due_date: number | null;
498
+ /**
499
+ * Timestamp when the payment was paid.
500
+ */
501
+ paid_at: number | null;
502
+ /**
503
+ * The status of the payment, one of `open`, `paid`, or `past_due`
504
+ */
505
+ status: AmountsDue.Status;
506
+ }
448
507
  interface AutomaticTax {
449
508
  /**
450
509
  * If Stripe disabled automatic tax, this enum describes why.
@@ -637,10 +696,18 @@ export declare namespace Invoice {
637
696
  type: LastFinalizationError.Type;
638
697
  }
639
698
  interface Parent {
699
+ /**
700
+ * Details about the billing cadence that generated this invoice
701
+ */
702
+ billing_cadence_details?: Parent.BillingCadenceDetails | null;
640
703
  /**
641
704
  * Details about the quote that generated this invoice
642
705
  */
643
706
  quote_details: Parent.QuoteDetails | null;
707
+ /**
708
+ * Details about the schedule that generated this invoice
709
+ */
710
+ schedule_details?: Parent.ScheduleDetails | null;
644
711
  /**
645
712
  * Details about the subscription that generated this invoice
646
713
  */
@@ -762,6 +829,16 @@ export declare namespace Invoice {
762
829
  */
763
830
  discount: string | Discount | DeletedDiscount;
764
831
  }
832
+ interface TotalMarginAmount {
833
+ /**
834
+ * The amount, in cents (or local equivalent), of the reduction in line item amount.
835
+ */
836
+ amount: number;
837
+ /**
838
+ * The margin that was applied to get this margin amount.
839
+ */
840
+ margin: string | Margin;
841
+ }
765
842
  interface TotalPretaxCreditAmount {
766
843
  /**
767
844
  * The amount, in cents (or local equivalent), of the pretax credit amount.
@@ -775,6 +852,10 @@ export declare namespace Invoice {
775
852
  * The discount that was applied to get this pretax credit amount.
776
853
  */
777
854
  discount?: string | Discount | DeletedDiscount;
855
+ /**
856
+ * The margin that was applied to get this pretax credit amount.
857
+ */
858
+ margin?: string | Margin;
778
859
  /**
779
860
  * Type of the pretax credit amount referenced.
780
861
  */
@@ -806,6 +887,9 @@ export declare namespace Invoice {
806
887
  */
807
888
  type: 'tax_rate_details';
808
889
  }
890
+ namespace AmountsDue {
891
+ type Status = 'open' | 'paid' | 'past_due';
892
+ }
809
893
  namespace AutomaticTax {
810
894
  type DisabledReason = 'finalization_requires_location_inputs' | 'finalization_system_error';
811
895
  interface Liability {
@@ -820,32 +904,52 @@ export declare namespace Invoice {
820
904
  }
821
905
  type Status = 'complete' | 'failed' | 'requires_location_inputs';
822
906
  namespace Liability {
823
- type Type = 'account' | 'self';
907
+ type Type = 'account' | 'application' | 'self';
824
908
  }
825
909
  }
826
910
  namespace CustomerTaxId {
827
911
  type Type = 'ad_nrt' | 'ae_trn' | 'al_tin' | 'am_tin' | 'ao_tin' | 'ar_cuit' | 'au_abn' | 'au_arn' | 'aw_tin' | 'az_tin' | 'ba_tin' | 'bb_tin' | 'bd_bin' | 'bf_ifu' | 'bg_uic' | 'bh_vat' | 'bj_ifu' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'bs_tin' | 'by_tin' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'cd_nif' | 'ch_uid' | 'ch_vat' | 'cl_tin' | 'cm_niu' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'cv_nif' | 'de_stn' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'et_tin' | 'eu_oss_vat' | 'eu_vat' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_vat' | 'ma_vat' | 'md_vat' | 'me_pib' | 'mk_vat' | 'mr_nif' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'np_pan' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'pl_nip' | 'py_ruc' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sn_ninea' | 'sr_fin' | 'sv_nit' | 'th_vat' | 'tj_tin' | 'tr_tin' | 'tw_vat' | 'tz_vat' | 'ua_vat' | 'ug_tin' | 'unknown' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin';
828
912
  }
829
913
  namespace Issuer {
830
- type Type = 'account' | 'self';
914
+ type Type = 'account' | 'application' | 'self';
831
915
  }
832
916
  namespace LastFinalizationError {
833
- type Code = 'account_closed' | 'account_country_invalid_address' | 'account_error_country_change_requires_additional_steps' | 'account_information_mismatch' | 'account_invalid' | 'account_number_invalid' | 'account_token_required_for_v2_account' | 'acss_debit_session_incomplete' | 'action_blocked' | 'alipay_upgrade_required' | 'amount_too_large' | 'amount_too_small' | 'api_key_expired' | 'application_fees_not_allowed' | 'approval_required' | 'authentication_required' | 'balance_insufficient' | 'balance_invalid_parameter' | 'bank_account_bad_routing_numbers' | 'bank_account_declined' | 'bank_account_exists' | 'bank_account_restricted' | 'bank_account_unusable' | 'bank_account_unverified' | 'bank_account_verification_failed' | 'billing_invalid_mandate' | 'bitcoin_upgrade_required' | 'capture_charge_authorization_expired' | 'capture_unauthorized_payment' | 'card_decline_rate_limit_exceeded' | 'card_declined' | 'cardholder_phone_number_required' | 'charge_already_captured' | 'charge_already_refunded' | 'charge_disputed' | 'charge_exceeds_source_limit' | 'charge_exceeds_transaction_limit' | 'charge_expired_for_capture' | 'charge_invalid_parameter' | 'charge_not_refundable' | 'clearing_code_unsupported' | 'country_code_invalid' | 'country_unsupported' | 'coupon_expired' | 'customer_max_payment_methods' | 'customer_max_subscriptions' | 'customer_session_expired' | 'customer_tax_location_invalid' | 'debit_not_authorized' | 'email_invalid' | 'expired_card' | 'financial_connections_account_inactive' | 'financial_connections_account_pending_account_numbers' | 'financial_connections_account_unavailable_account_numbers' | 'financial_connections_no_successful_transaction_refresh' | 'forwarding_api_inactive' | 'forwarding_api_invalid_parameter' | 'forwarding_api_retryable_upstream_error' | 'forwarding_api_upstream_connection_error' | 'forwarding_api_upstream_connection_timeout' | 'forwarding_api_upstream_error' | 'idempotency_key_in_use' | 'incorrect_address' | 'incorrect_cvc' | 'incorrect_number' | 'incorrect_zip' | 'india_recurring_payment_mandate_canceled' | 'instant_payouts_config_disabled' | 'instant_payouts_currency_disabled' | 'instant_payouts_limit_exceeded' | 'instant_payouts_unsupported' | 'insufficient_funds' | 'intent_invalid_state' | 'intent_verification_method_missing' | 'invalid_card_type' | 'invalid_characters' | 'invalid_charge_amount' | 'invalid_cvc' | 'invalid_expiry_month' | 'invalid_expiry_year' | 'invalid_mandate_reference_prefix_format' | 'invalid_number' | 'invalid_source_usage' | 'invalid_tax_location' | 'invoice_no_customer_line_items' | 'invoice_no_payment_method_types' | 'invoice_no_subscription_line_items' | 'invoice_not_editable' | 'invoice_on_behalf_of_not_editable' | 'invoice_payment_intent_requires_action' | 'invoice_upcoming_none' | 'livemode_mismatch' | 'lock_timeout' | 'missing' | 'no_account' | 'not_allowed_on_standard_account' | 'out_of_inventory' | 'ownership_declaration_not_allowed' | 'parameter_invalid_empty' | 'parameter_invalid_integer' | 'parameter_invalid_string_blank' | 'parameter_invalid_string_empty' | 'parameter_missing' | 'parameter_unknown' | 'parameters_exclusive' | 'payment_intent_action_required' | 'payment_intent_authentication_failure' | 'payment_intent_incompatible_payment_method' | 'payment_intent_invalid_parameter' | 'payment_intent_konbini_rejected_confirmation_number' | 'payment_intent_mandate_invalid' | 'payment_intent_payment_attempt_expired' | 'payment_intent_payment_attempt_failed' | 'payment_intent_rate_limit_exceeded' | 'payment_intent_unexpected_state' | 'payment_method_bank_account_already_verified' | 'payment_method_bank_account_blocked' | 'payment_method_billing_details_address_missing' | 'payment_method_configuration_failures' | 'payment_method_currency_mismatch' | 'payment_method_customer_decline' | 'payment_method_invalid_parameter' | 'payment_method_invalid_parameter_testmode' | 'payment_method_microdeposit_failed' | 'payment_method_microdeposit_verification_amounts_invalid' | 'payment_method_microdeposit_verification_amounts_mismatch' | 'payment_method_microdeposit_verification_attempts_exceeded' | 'payment_method_microdeposit_verification_descriptor_code_mismatch' | 'payment_method_microdeposit_verification_timeout' | 'payment_method_not_available' | 'payment_method_provider_decline' | 'payment_method_provider_timeout' | 'payment_method_unactivated' | 'payment_method_unexpected_state' | 'payment_method_unsupported_type' | 'payout_reconciliation_not_ready' | 'payouts_limit_exceeded' | 'payouts_not_allowed' | 'platform_account_required' | 'platform_api_key_expired' | 'postal_code_invalid' | 'processing_error' | 'product_inactive' | 'progressive_onboarding_limit_exceeded' | 'rate_limit' | 'refer_to_customer' | 'refund_disputed_payment' | 'request_blocked' | 'resource_already_exists' | 'resource_missing' | 'return_intent_already_processed' | 'routing_number_invalid' | 'secret_key_required' | 'sepa_unsupported_account' | 'service_period_coupon_with_metered_tiered_item_unsupported' | 'setup_attempt_failed' | 'setup_intent_authentication_failure' | 'setup_intent_invalid_parameter' | 'setup_intent_mandate_invalid' | 'setup_intent_mobile_wallet_unsupported' | 'setup_intent_setup_attempt_expired' | 'setup_intent_unexpected_state' | 'shipping_address_invalid' | 'shipping_calculation_failed' | 'sku_inactive' | 'state_unsupported' | 'status_transition_invalid' | 'storer_capability_missing' | 'storer_capability_not_active' | 'stripe_tax_inactive' | 'tax_id_invalid' | 'tax_id_prohibited' | 'taxes_calculation_failed' | 'terminal_location_country_unsupported' | 'terminal_reader_busy' | 'terminal_reader_hardware_fault' | 'terminal_reader_invalid_location_for_activation' | 'terminal_reader_invalid_location_for_payment' | 'terminal_reader_offline' | 'terminal_reader_timeout' | 'testmode_charges_only' | 'tls_version_unsupported' | 'token_already_used' | 'token_card_network_invalid' | 'token_in_use' | 'transfer_source_balance_parameters_mismatch' | 'transfers_not_allowed' | 'url_invalid';
917
+ type Code = 'account_closed' | 'account_country_invalid_address' | 'account_error_country_change_requires_additional_steps' | 'account_information_mismatch' | 'account_invalid' | 'account_number_invalid' | 'account_token_required_for_v2_account' | 'acss_debit_session_incomplete' | 'action_blocked' | 'alipay_upgrade_required' | 'amount_too_large' | 'amount_too_small' | 'api_key_expired' | 'application_fees_not_allowed' | 'approval_required' | 'authentication_required' | 'balance_insufficient' | 'balance_invalid_parameter' | 'bank_account_bad_routing_numbers' | 'bank_account_declined' | 'bank_account_exists' | 'bank_account_restricted' | 'bank_account_unusable' | 'bank_account_unverified' | 'bank_account_verification_failed' | 'billing_invalid_mandate' | 'bitcoin_upgrade_required' | 'capture_charge_authorization_expired' | 'capture_unauthorized_payment' | 'card_decline_rate_limit_exceeded' | 'card_declined' | 'cardholder_phone_number_required' | 'charge_already_captured' | 'charge_already_refunded' | 'charge_disputed' | 'charge_exceeds_source_limit' | 'charge_exceeds_transaction_limit' | 'charge_expired_for_capture' | 'charge_invalid_parameter' | 'charge_not_refundable' | 'clearing_code_unsupported' | 'country_code_invalid' | 'country_unsupported' | 'coupon_expired' | 'customer_max_payment_methods' | 'customer_max_subscriptions' | 'customer_session_expired' | 'customer_tax_location_invalid' | 'debit_not_authorized' | 'email_invalid' | 'expired_card' | 'financial_connections_account_inactive' | 'financial_connections_account_pending_account_numbers' | 'financial_connections_account_unavailable_account_numbers' | 'financial_connections_institution_unavailable' | 'financial_connections_no_successful_transaction_refresh' | 'forwarding_api_inactive' | 'forwarding_api_invalid_parameter' | 'forwarding_api_retryable_upstream_error' | 'forwarding_api_upstream_connection_error' | 'forwarding_api_upstream_connection_timeout' | 'forwarding_api_upstream_error' | 'idempotency_key_in_use' | 'incorrect_address' | 'incorrect_cvc' | 'incorrect_number' | 'incorrect_zip' | 'india_recurring_payment_mandate_canceled' | 'instant_payouts_config_disabled' | 'instant_payouts_currency_disabled' | 'instant_payouts_limit_exceeded' | 'instant_payouts_unsupported' | 'insufficient_funds' | 'intent_invalid_state' | 'intent_verification_method_missing' | 'invalid_card_type' | 'invalid_characters' | 'invalid_charge_amount' | 'invalid_cvc' | 'invalid_expiry_month' | 'invalid_expiry_year' | 'invalid_mandate_reference_prefix_format' | 'invalid_number' | 'invalid_source_usage' | 'invalid_tax_location' | 'invoice_no_customer_line_items' | 'invoice_no_payment_method_types' | 'invoice_no_subscription_line_items' | 'invoice_not_editable' | 'invoice_on_behalf_of_not_editable' | 'invoice_payment_intent_requires_action' | 'invoice_upcoming_none' | 'livemode_mismatch' | 'lock_timeout' | 'missing' | 'no_account' | 'not_allowed_on_standard_account' | 'out_of_inventory' | 'ownership_declaration_not_allowed' | 'parameter_invalid_empty' | 'parameter_invalid_integer' | 'parameter_invalid_string_blank' | 'parameter_invalid_string_empty' | 'parameter_missing' | 'parameter_unknown' | 'parameters_exclusive' | 'payment_intent_action_required' | 'payment_intent_authentication_failure' | 'payment_intent_incompatible_payment_method' | 'payment_intent_invalid_parameter' | 'payment_intent_konbini_rejected_confirmation_number' | 'payment_intent_mandate_invalid' | 'payment_intent_payment_attempt_expired' | 'payment_intent_payment_attempt_failed' | 'payment_intent_rate_limit_exceeded' | 'payment_intent_unexpected_state' | 'payment_method_bank_account_already_verified' | 'payment_method_bank_account_blocked' | 'payment_method_billing_details_address_missing' | 'payment_method_configuration_failures' | 'payment_method_currency_mismatch' | 'payment_method_customer_decline' | 'payment_method_invalid_parameter' | 'payment_method_invalid_parameter_testmode' | 'payment_method_microdeposit_failed' | 'payment_method_microdeposit_verification_amounts_invalid' | 'payment_method_microdeposit_verification_amounts_mismatch' | 'payment_method_microdeposit_verification_attempts_exceeded' | 'payment_method_microdeposit_verification_descriptor_code_mismatch' | 'payment_method_microdeposit_verification_timeout' | 'payment_method_not_available' | 'payment_method_provider_decline' | 'payment_method_provider_timeout' | 'payment_method_unactivated' | 'payment_method_unexpected_state' | 'payment_method_unsupported_type' | 'payout_reconciliation_not_ready' | 'payouts_limit_exceeded' | 'payouts_not_allowed' | 'platform_account_required' | 'platform_api_key_expired' | 'postal_code_invalid' | 'processing_error' | 'product_inactive' | 'progressive_onboarding_limit_exceeded' | 'rate_limit' | 'refer_to_customer' | 'refund_disputed_payment' | 'request_blocked' | 'resource_already_exists' | 'resource_missing' | 'return_intent_already_processed' | 'routing_number_invalid' | 'secret_key_required' | 'sensitive_data_access_expired' | 'sepa_unsupported_account' | 'service_period_coupon_with_metered_tiered_item_unsupported' | 'setup_attempt_failed' | 'setup_intent_authentication_failure' | 'setup_intent_invalid_parameter' | 'setup_intent_mandate_invalid' | 'setup_intent_mobile_wallet_unsupported' | 'setup_intent_setup_attempt_expired' | 'setup_intent_unexpected_state' | 'shipping_address_invalid' | 'shipping_calculation_failed' | 'sku_inactive' | 'state_unsupported' | 'status_transition_invalid' | 'storer_capability_missing' | 'storer_capability_not_active' | 'stripe_tax_inactive' | 'tax_id_invalid' | 'tax_id_prohibited' | 'taxes_calculation_failed' | 'terminal_location_country_unsupported' | 'terminal_reader_busy' | 'terminal_reader_collected_data_invalid' | 'terminal_reader_hardware_fault' | 'terminal_reader_invalid_location_for_activation' | 'terminal_reader_invalid_location_for_payment' | 'terminal_reader_offline' | 'terminal_reader_timeout' | 'testmode_charges_only' | 'tls_version_unsupported' | 'token_already_used' | 'token_card_network_invalid' | 'token_in_use' | 'transfer_source_balance_parameters_mismatch' | 'transfers_not_allowed' | 'url_invalid' | 'v2_account_disconnection_unsupported' | 'v2_account_missing_configuration';
834
918
  type Type = 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error';
835
919
  }
836
920
  namespace Parent {
921
+ interface BillingCadenceDetails {
922
+ /**
923
+ * The billing cadence that generated this invoice
924
+ */
925
+ billing_cadence: string;
926
+ }
837
927
  interface QuoteDetails {
838
928
  /**
839
929
  * The quote that generated this invoice
840
930
  */
841
931
  quote: string;
842
932
  }
933
+ interface ScheduleDetails {
934
+ /**
935
+ * The schedule that generated this invoice
936
+ */
937
+ schedule: string;
938
+ /**
939
+ * The subscription associated with this schedule
940
+ */
941
+ subscription: string | Subscription | null;
942
+ }
843
943
  interface SubscriptionDetails {
844
944
  /**
845
945
  * Set of [key-value pairs](https://docs.stripe.com/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
846
946
  * *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
847
947
  */
848
948
  metadata: Metadata | null;
949
+ /**
950
+ * 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).
951
+ */
952
+ pause_collection?: SubscriptionDetails.PauseCollection | null;
849
953
  /**
850
954
  * The subscription that generated this invoice
851
955
  */
@@ -855,7 +959,22 @@ export declare namespace Invoice {
855
959
  */
856
960
  subscription_proration_date?: number;
857
961
  }
858
- type Type = 'quote_details' | 'subscription_details';
962
+ type Type = 'billing_cadence_details' | 'quote_details' | 'schedule_details' | 'subscription_details';
963
+ namespace SubscriptionDetails {
964
+ interface PauseCollection {
965
+ /**
966
+ * The payment collection behavior for this subscription while paused.
967
+ */
968
+ behavior: PauseCollection.Behavior | null;
969
+ /**
970
+ * The time after which the subscription will resume collecting payments.
971
+ */
972
+ resumes_at: number | null;
973
+ }
974
+ namespace PauseCollection {
975
+ type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
976
+ }
977
+ }
859
978
  }
860
979
  namespace PaymentSettings {
861
980
  interface PaymentMethodOptions {
@@ -867,14 +986,30 @@ export declare namespace Invoice {
867
986
  * If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
868
987
  */
869
988
  bancontact: PaymentMethodOptions.Bancontact | null;
989
+ /**
990
+ * If paying by `bizum`, this sub-hash contains details about the Bizum payment method options to pass to the invoice's PaymentIntent.
991
+ */
992
+ bizum?: PaymentMethodOptions.Bizum | null;
993
+ /**
994
+ * If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
995
+ */
996
+ blik?: PaymentMethodOptions.Blik | null;
870
997
  /**
871
998
  * If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
872
999
  */
873
1000
  card: PaymentMethodOptions.Card | null;
1001
+ /**
1002
+ * If paying by `check_scan`, this sub-hash contains details about the Check Scan payment method options to pass to the invoice's PaymentIntent.
1003
+ */
1004
+ check_scan?: PaymentMethodOptions.CheckScan | null;
874
1005
  /**
875
1006
  * If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
876
1007
  */
877
1008
  customer_balance: PaymentMethodOptions.CustomerBalance | null;
1009
+ /**
1010
+ * If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
1011
+ */
1012
+ id_bank_transfer?: PaymentMethodOptions.IdBankTransfer | null;
878
1013
  /**
879
1014
  * If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
880
1015
  */
@@ -900,7 +1035,7 @@ export declare namespace Invoice {
900
1035
  */
901
1036
  us_bank_account: PaymentMethodOptions.UsBankAccount | null;
902
1037
  }
903
- type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'upi' | 'us_bank_account' | 'wechat_pay';
1038
+ type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'check_scan' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'momo' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'stripe_balance' | 'swish' | 'upi' | 'us_bank_account' | 'wechat_pay';
904
1039
  namespace PaymentMethodOptions {
905
1040
  interface AcssDebit {
906
1041
  mandate_options?: AcssDebit.MandateOptions;
@@ -915,6 +1050,10 @@ export declare namespace Invoice {
915
1050
  */
916
1051
  preferred_language: Bancontact.PreferredLanguage;
917
1052
  }
1053
+ interface Bizum {
1054
+ }
1055
+ interface Blik {
1056
+ }
918
1057
  interface Card {
919
1058
  installments?: Card.Installments;
920
1059
  /**
@@ -922,6 +1061,9 @@ export declare namespace Invoice {
922
1061
  */
923
1062
  request_three_d_secure: Card.RequestThreeDSecure | null;
924
1063
  }
1064
+ interface CheckScan {
1065
+ check_deposit_address?: Address;
1066
+ }
925
1067
  interface CustomerBalance {
926
1068
  bank_transfer?: CustomerBalance.BankTransfer;
927
1069
  /**
@@ -929,6 +1071,8 @@ export declare namespace Invoice {
929
1071
  */
930
1072
  funding_type: 'bank_transfer' | null;
931
1073
  }
1074
+ interface IdBankTransfer {
1075
+ }
932
1076
  interface Konbini {
933
1077
  }
934
1078
  interface Payto {
@@ -1065,9 +1209,13 @@ export declare namespace Invoice {
1065
1209
  * The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
1066
1210
  */
1067
1211
  account_subcategories?: Array<Filters.AccountSubcategory>;
1212
+ /**
1213
+ * The institution to use to filter for possible accounts to link.
1214
+ */
1215
+ institution?: string;
1068
1216
  }
1069
1217
  type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
1070
- type Prefetch = 'balances' | 'ownership' | 'transactions';
1218
+ type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions';
1071
1219
  namespace Filters {
1072
1220
  type AccountSubcategory = 'checking' | 'savings';
1073
1221
  }
@@ -1124,7 +1272,7 @@ export declare namespace Invoice {
1124
1272
  }
1125
1273
  }
1126
1274
  namespace TotalPretaxCreditAmount {
1127
- type Type = 'credit_balance_transaction' | 'discount';
1275
+ type Type = 'credit_balance_transaction' | 'discount' | 'margin';
1128
1276
  }
1129
1277
  namespace TotalTax {
1130
1278
  type TaxBehavior = 'exclusive' | 'inclusive';
@@ -1132,7 +1280,7 @@ export declare namespace Invoice {
1132
1280
  /**
1133
1281
  * ID of the tax rate
1134
1282
  */
1135
- tax_rate: string;
1283
+ tax_rate: string | TaxRate;
1136
1284
  }
1137
1285
  type TaxabilityReason = 'customer_exempt' | 'not_available' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated';
1138
1286
  }
@@ -1142,6 +1290,10 @@ export interface InvoiceCreateParams {
1142
1290
  * The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
1143
1291
  */
1144
1292
  account_tax_ids?: Emptyable<Array<string>>;
1293
+ /**
1294
+ * List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
1295
+ */
1296
+ amounts_due?: Emptyable<Array<InvoiceCreateParams.AmountsDue>>;
1145
1297
  /**
1146
1298
  * A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://docs.stripe.com/billing/invoices/connect#collecting-fees).
1147
1299
  */
@@ -1182,6 +1334,10 @@ export interface InvoiceCreateParams {
1182
1334
  * The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
1183
1335
  */
1184
1336
  days_until_due?: number;
1337
+ /**
1338
+ * The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
1339
+ */
1340
+ default_margins?: Array<string>;
1185
1341
  /**
1186
1342
  * ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
1187
1343
  */
@@ -1272,6 +1428,24 @@ export interface InvoiceCreateParams {
1272
1428
  transfer_data?: InvoiceCreateParams.TransferData;
1273
1429
  }
1274
1430
  export declare namespace InvoiceCreateParams {
1431
+ interface AmountsDue {
1432
+ /**
1433
+ * The amount in cents (or local equivalent).
1434
+ */
1435
+ amount: number;
1436
+ /**
1437
+ * Number of days from when invoice is finalized until the payment is due.
1438
+ */
1439
+ days_until_due?: number;
1440
+ /**
1441
+ * An arbitrary string attached to the object. Often useful for displaying to users.
1442
+ */
1443
+ description: string;
1444
+ /**
1445
+ * Date on which a payment plan's payment is due.
1446
+ */
1447
+ due_date?: number;
1448
+ }
1275
1449
  interface AutomaticTax {
1276
1450
  /**
1277
1451
  * Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
@@ -1302,6 +1476,10 @@ export declare namespace InvoiceCreateParams {
1302
1476
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
1303
1477
  */
1304
1478
  discount?: string;
1479
+ /**
1480
+ * Details to determine how long the discount should be applied for.
1481
+ */
1482
+ discount_end?: Discount.DiscountEnd;
1305
1483
  /**
1306
1484
  * ID of the promotion code to create a new discount for.
1307
1485
  */
@@ -1406,11 +1584,43 @@ export declare namespace InvoiceCreateParams {
1406
1584
  type: Liability.Type;
1407
1585
  }
1408
1586
  namespace Liability {
1409
- type Type = 'account' | 'self';
1587
+ type Type = 'account' | 'application' | 'self';
1588
+ }
1589
+ }
1590
+ namespace Discount {
1591
+ interface DiscountEnd {
1592
+ /**
1593
+ * Time span for the redeemed discount.
1594
+ */
1595
+ duration?: DiscountEnd.Duration;
1596
+ /**
1597
+ * A precise Unix timestamp for the discount to end. Must be in the future.
1598
+ */
1599
+ timestamp?: number;
1600
+ /**
1601
+ * The type of calculation made to determine when the discount ends.
1602
+ */
1603
+ type: DiscountEnd.Type;
1604
+ }
1605
+ namespace DiscountEnd {
1606
+ interface Duration {
1607
+ /**
1608
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1609
+ */
1610
+ interval: Duration.Interval;
1611
+ /**
1612
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1613
+ */
1614
+ interval_count: number;
1615
+ }
1616
+ type Type = 'duration' | 'timestamp';
1617
+ namespace Duration {
1618
+ type Interval = 'day' | 'month' | 'week' | 'year';
1619
+ }
1410
1620
  }
1411
1621
  }
1412
1622
  namespace Issuer {
1413
- type Type = 'account' | 'self';
1623
+ type Type = 'account' | 'application' | 'self';
1414
1624
  }
1415
1625
  namespace PaymentSettings {
1416
1626
  interface PaymentMethodOptions {
@@ -1422,14 +1632,30 @@ export declare namespace InvoiceCreateParams {
1422
1632
  * If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
1423
1633
  */
1424
1634
  bancontact?: Emptyable<PaymentMethodOptions.Bancontact>;
1635
+ /**
1636
+ * If paying by `bizum`, this sub-hash contains details about the Bizum payment method options to pass to the invoice's PaymentIntent.
1637
+ */
1638
+ bizum?: Emptyable<PaymentMethodOptions.Bizum>;
1639
+ /**
1640
+ * If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
1641
+ */
1642
+ blik?: Emptyable<PaymentMethodOptions.Blik>;
1425
1643
  /**
1426
1644
  * If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
1427
1645
  */
1428
1646
  card?: Emptyable<PaymentMethodOptions.Card>;
1647
+ /**
1648
+ * If paying by `check_scan`, this sub-hash contains details about the Check Scan payment method options to pass to the invoice's PaymentIntent.
1649
+ */
1650
+ check_scan?: Emptyable<PaymentMethodOptions.CheckScan>;
1429
1651
  /**
1430
1652
  * If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
1431
1653
  */
1432
1654
  customer_balance?: Emptyable<PaymentMethodOptions.CustomerBalance>;
1655
+ /**
1656
+ * If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
1657
+ */
1658
+ id_bank_transfer?: Emptyable<PaymentMethodOptions.IdBankTransfer>;
1433
1659
  /**
1434
1660
  * If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
1435
1661
  */
@@ -1455,7 +1681,7 @@ export declare namespace InvoiceCreateParams {
1455
1681
  */
1456
1682
  us_bank_account?: Emptyable<PaymentMethodOptions.UsBankAccount>;
1457
1683
  }
1458
- type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'upi' | 'us_bank_account' | 'wechat_pay';
1684
+ type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'check_scan' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'momo' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'stripe_balance' | 'swish' | 'upi' | 'us_bank_account' | 'wechat_pay';
1459
1685
  namespace PaymentMethodOptions {
1460
1686
  interface AcssDebit {
1461
1687
  /**
@@ -1473,6 +1699,10 @@ export declare namespace InvoiceCreateParams {
1473
1699
  */
1474
1700
  preferred_language?: Bancontact.PreferredLanguage;
1475
1701
  }
1702
+ interface Bizum {
1703
+ }
1704
+ interface Blik {
1705
+ }
1476
1706
  interface Card {
1477
1707
  /**
1478
1708
  * Installment configuration for payments attempted on this invoice.
@@ -1485,6 +1715,9 @@ export declare namespace InvoiceCreateParams {
1485
1715
  */
1486
1716
  request_three_d_secure?: Card.RequestThreeDSecure;
1487
1717
  }
1718
+ interface CheckScan {
1719
+ check_deposit_address?: AddressParam;
1720
+ }
1488
1721
  interface CustomerBalance {
1489
1722
  /**
1490
1723
  * Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
@@ -1495,6 +1728,8 @@ export declare namespace InvoiceCreateParams {
1495
1728
  */
1496
1729
  funding_type?: string;
1497
1730
  }
1731
+ interface IdBankTransfer {
1732
+ }
1498
1733
  interface Konbini {
1499
1734
  }
1500
1735
  interface Payto {
@@ -1663,9 +1898,13 @@ export declare namespace InvoiceCreateParams {
1663
1898
  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
1664
1899
  */
1665
1900
  account_subcategories?: Array<Filters.AccountSubcategory>;
1901
+ /**
1902
+ * ID of the institution to use to filter for selectable accounts.
1903
+ */
1904
+ institution?: string;
1666
1905
  }
1667
1906
  type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
1668
- type Prefetch = 'balances' | 'ownership' | 'transactions';
1907
+ type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions';
1669
1908
  namespace Filters {
1670
1909
  type AccountSubcategory = 'checking' | 'savings';
1671
1910
  }
@@ -1803,6 +2042,10 @@ export interface InvoiceUpdateParams {
1803
2042
  * The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
1804
2043
  */
1805
2044
  account_tax_ids?: Emptyable<Array<string>>;
2045
+ /**
2046
+ * List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
2047
+ */
2048
+ amounts_due?: Emptyable<Array<InvoiceUpdateParams.AmountsDue>>;
1806
2049
  /**
1807
2050
  * A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://docs.stripe.com/billing/invoices/connect#collecting-fees).
1808
2051
  */
@@ -1831,6 +2074,10 @@ export interface InvoiceUpdateParams {
1831
2074
  * The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.
1832
2075
  */
1833
2076
  days_until_due?: number;
2077
+ /**
2078
+ * The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
2079
+ */
2080
+ default_margins?: Emptyable<Array<string>>;
1834
2081
  /**
1835
2082
  * ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
1836
2083
  */
@@ -1909,6 +2156,24 @@ export interface InvoiceUpdateParams {
1909
2156
  transfer_data?: Emptyable<InvoiceUpdateParams.TransferData>;
1910
2157
  }
1911
2158
  export declare namespace InvoiceUpdateParams {
2159
+ interface AmountsDue {
2160
+ /**
2161
+ * The amount in cents (or local equivalent).
2162
+ */
2163
+ amount: number;
2164
+ /**
2165
+ * Number of days from when invoice is finalized until the payment is due.
2166
+ */
2167
+ days_until_due?: number;
2168
+ /**
2169
+ * An arbitrary string attached to the object. Often useful for displaying to users.
2170
+ */
2171
+ description: string;
2172
+ /**
2173
+ * Date on which a payment plan's payment is due.
2174
+ */
2175
+ due_date?: number;
2176
+ }
1912
2177
  interface AutomaticTax {
1913
2178
  /**
1914
2179
  * Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
@@ -1939,6 +2204,10 @@ export declare namespace InvoiceUpdateParams {
1939
2204
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
1940
2205
  */
1941
2206
  discount?: string;
2207
+ /**
2208
+ * Details to determine how long the discount should be applied for.
2209
+ */
2210
+ discount_end?: Discount.DiscountEnd;
1942
2211
  /**
1943
2212
  * ID of the promotion code to create a new discount for.
1944
2213
  */
@@ -2032,11 +2301,43 @@ export declare namespace InvoiceUpdateParams {
2032
2301
  type: Liability.Type;
2033
2302
  }
2034
2303
  namespace Liability {
2035
- type Type = 'account' | 'self';
2304
+ type Type = 'account' | 'application' | 'self';
2305
+ }
2306
+ }
2307
+ namespace Discount {
2308
+ interface DiscountEnd {
2309
+ /**
2310
+ * Time span for the redeemed discount.
2311
+ */
2312
+ duration?: DiscountEnd.Duration;
2313
+ /**
2314
+ * A precise Unix timestamp for the discount to end. Must be in the future.
2315
+ */
2316
+ timestamp?: number;
2317
+ /**
2318
+ * The type of calculation made to determine when the discount ends.
2319
+ */
2320
+ type: DiscountEnd.Type;
2321
+ }
2322
+ namespace DiscountEnd {
2323
+ interface Duration {
2324
+ /**
2325
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2326
+ */
2327
+ interval: Duration.Interval;
2328
+ /**
2329
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2330
+ */
2331
+ interval_count: number;
2332
+ }
2333
+ type Type = 'duration' | 'timestamp';
2334
+ namespace Duration {
2335
+ type Interval = 'day' | 'month' | 'week' | 'year';
2336
+ }
2036
2337
  }
2037
2338
  }
2038
2339
  namespace Issuer {
2039
- type Type = 'account' | 'self';
2340
+ type Type = 'account' | 'application' | 'self';
2040
2341
  }
2041
2342
  namespace PaymentSettings {
2042
2343
  interface PaymentMethodOptions {
@@ -2048,14 +2349,30 @@ export declare namespace InvoiceUpdateParams {
2048
2349
  * If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
2049
2350
  */
2050
2351
  bancontact?: Emptyable<PaymentMethodOptions.Bancontact>;
2352
+ /**
2353
+ * If paying by `bizum`, this sub-hash contains details about the Bizum payment method options to pass to the invoice's PaymentIntent.
2354
+ */
2355
+ bizum?: Emptyable<PaymentMethodOptions.Bizum>;
2356
+ /**
2357
+ * If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
2358
+ */
2359
+ blik?: Emptyable<PaymentMethodOptions.Blik>;
2051
2360
  /**
2052
2361
  * If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
2053
2362
  */
2054
2363
  card?: Emptyable<PaymentMethodOptions.Card>;
2364
+ /**
2365
+ * If paying by `check_scan`, this sub-hash contains details about the Check Scan payment method options to pass to the invoice's PaymentIntent.
2366
+ */
2367
+ check_scan?: Emptyable<PaymentMethodOptions.CheckScan>;
2055
2368
  /**
2056
2369
  * If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
2057
2370
  */
2058
2371
  customer_balance?: Emptyable<PaymentMethodOptions.CustomerBalance>;
2372
+ /**
2373
+ * If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
2374
+ */
2375
+ id_bank_transfer?: Emptyable<PaymentMethodOptions.IdBankTransfer>;
2059
2376
  /**
2060
2377
  * If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
2061
2378
  */
@@ -2081,7 +2398,7 @@ export declare namespace InvoiceUpdateParams {
2081
2398
  */
2082
2399
  us_bank_account?: Emptyable<PaymentMethodOptions.UsBankAccount>;
2083
2400
  }
2084
- type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'upi' | 'us_bank_account' | 'wechat_pay';
2401
+ type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'check_scan' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'momo' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'stripe_balance' | 'swish' | 'upi' | 'us_bank_account' | 'wechat_pay';
2085
2402
  namespace PaymentMethodOptions {
2086
2403
  interface AcssDebit {
2087
2404
  /**
@@ -2099,6 +2416,10 @@ export declare namespace InvoiceUpdateParams {
2099
2416
  */
2100
2417
  preferred_language?: Bancontact.PreferredLanguage;
2101
2418
  }
2419
+ interface Bizum {
2420
+ }
2421
+ interface Blik {
2422
+ }
2102
2423
  interface Card {
2103
2424
  /**
2104
2425
  * Installment configuration for payments attempted on this invoice.
@@ -2111,6 +2432,9 @@ export declare namespace InvoiceUpdateParams {
2111
2432
  */
2112
2433
  request_three_d_secure?: Card.RequestThreeDSecure;
2113
2434
  }
2435
+ interface CheckScan {
2436
+ check_deposit_address?: AddressParam;
2437
+ }
2114
2438
  interface CustomerBalance {
2115
2439
  /**
2116
2440
  * Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
@@ -2121,6 +2445,8 @@ export declare namespace InvoiceUpdateParams {
2121
2445
  */
2122
2446
  funding_type?: string;
2123
2447
  }
2448
+ interface IdBankTransfer {
2449
+ }
2124
2450
  interface Konbini {
2125
2451
  }
2126
2452
  interface Payto {
@@ -2289,9 +2615,13 @@ export declare namespace InvoiceUpdateParams {
2289
2615
  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
2290
2616
  */
2291
2617
  account_subcategories?: Array<Filters.AccountSubcategory>;
2618
+ /**
2619
+ * ID of the institution to use to filter for selectable accounts.
2620
+ */
2621
+ institution?: string;
2292
2622
  }
2293
2623
  type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
2294
- type Prefetch = 'balances' | 'ownership' | 'transactions';
2624
+ type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions';
2295
2625
  namespace Filters {
2296
2626
  type AccountSubcategory = 'checking' | 'savings';
2297
2627
  }
@@ -2419,6 +2749,10 @@ export declare namespace InvoiceUpdateParams {
2419
2749
  }
2420
2750
  }
2421
2751
  export interface InvoiceListParams extends PaginationParams {
2752
+ /**
2753
+ * Only return invoices for the cadence specified by this billing cadence ID.
2754
+ */
2755
+ billing_cadence?: string;
2422
2756
  /**
2423
2757
  * The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.
2424
2758
  */
@@ -2493,6 +2827,10 @@ export declare namespace InvoiceAddLinesParams {
2493
2827
  * ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.
2494
2828
  */
2495
2829
  invoice_item?: string;
2830
+ /**
2831
+ * The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
2832
+ */
2833
+ margins?: Emptyable<Array<string>>;
2496
2834
  /**
2497
2835
  * 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`.
2498
2836
  */
@@ -2536,6 +2874,10 @@ export declare namespace InvoiceAddLinesParams {
2536
2874
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
2537
2875
  */
2538
2876
  discount?: string;
2877
+ /**
2878
+ * Details to determine how long the discount should be applied for.
2879
+ */
2880
+ discount_end?: Discount.DiscountEnd;
2539
2881
  /**
2540
2882
  * ID of the promotion code to create a new discount for.
2541
2883
  */
@@ -2603,6 +2945,38 @@ export declare namespace InvoiceAddLinesParams {
2603
2945
  */
2604
2946
  taxable_amount: number;
2605
2947
  }
2948
+ namespace Discount {
2949
+ interface DiscountEnd {
2950
+ /**
2951
+ * Time span for the redeemed discount.
2952
+ */
2953
+ duration?: DiscountEnd.Duration;
2954
+ /**
2955
+ * A precise Unix timestamp for the discount to end. Must be in the future.
2956
+ */
2957
+ timestamp?: number;
2958
+ /**
2959
+ * The type of calculation made to determine when the discount ends.
2960
+ */
2961
+ type: DiscountEnd.Type;
2962
+ }
2963
+ namespace DiscountEnd {
2964
+ interface Duration {
2965
+ /**
2966
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2967
+ */
2968
+ interval: Duration.Interval;
2969
+ /**
2970
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2971
+ */
2972
+ interval_count: number;
2973
+ }
2974
+ type Type = 'duration' | 'timestamp';
2975
+ namespace Duration {
2976
+ type Interval = 'day' | 'month' | 'week' | 'year';
2977
+ }
2978
+ }
2979
+ }
2606
2980
  namespace PriceData {
2607
2981
  interface ProductData {
2608
2982
  /**
@@ -2625,12 +2999,28 @@ export declare namespace InvoiceAddLinesParams {
2625
2999
  * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
2626
3000
  */
2627
3001
  tax_code?: string;
3002
+ /**
3003
+ * Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
3004
+ */
3005
+ tax_details?: ProductData.TaxDetails;
2628
3006
  /**
2629
3007
  * A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
2630
3008
  */
2631
3009
  unit_label?: string;
2632
3010
  }
2633
3011
  type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
3012
+ namespace ProductData {
3013
+ interface TaxDetails {
3014
+ /**
3015
+ * A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
3016
+ */
3017
+ performance_location?: string;
3018
+ /**
3019
+ * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
3020
+ */
3021
+ tax_code?: Emptyable<string>;
3022
+ }
3023
+ }
2634
3024
  }
2635
3025
  namespace TaxAmount {
2636
3026
  interface TaxRateData {
@@ -2680,6 +3070,10 @@ export declare namespace InvoiceAddLinesParams {
2680
3070
  }
2681
3071
  }
2682
3072
  export interface InvoiceAttachPaymentParams {
3073
+ /**
3074
+ * The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.
3075
+ */
3076
+ amount_requested?: number;
2683
3077
  /**
2684
3078
  * Specifies which fields in the response should be expanded.
2685
3079
  */
@@ -2692,12 +3086,48 @@ export interface InvoiceAttachPaymentParams {
2692
3086
  * The ID of the PaymentRecord to attach to the invoice.
2693
3087
  */
2694
3088
  payment_record?: string;
3089
+ /**
3090
+ * The PaymentRecord data for attaching an out of band payment to the invoice.
3091
+ */
3092
+ payment_record_data?: InvoiceAttachPaymentParams.PaymentRecordData;
3093
+ }
3094
+ export declare namespace InvoiceAttachPaymentParams {
3095
+ interface PaymentRecordData {
3096
+ /**
3097
+ * The amount that was paid out of band.
3098
+ */
3099
+ amount: number;
3100
+ /**
3101
+ * The currency that was paid out of band.
3102
+ */
3103
+ currency: string;
3104
+ /**
3105
+ * 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`.
3106
+ */
3107
+ metadata?: Emptyable<MetadataParam>;
3108
+ /**
3109
+ * The type of money movement for this out of band payment record.
3110
+ */
3111
+ money_movement_type: string;
3112
+ /**
3113
+ * The timestamp when this out of band payment was paid.
3114
+ */
3115
+ paid_at?: number;
3116
+ /**
3117
+ * The reference for this out of band payment record.
3118
+ */
3119
+ payment_reference?: string;
3120
+ }
2695
3121
  }
2696
3122
  export interface InvoiceCreatePreviewParams {
2697
3123
  /**
2698
3124
  * Settings for automatic tax lookup for this invoice preview.
2699
3125
  */
2700
3126
  automatic_tax?: InvoiceCreatePreviewParams.AutomaticTax;
3127
+ /**
3128
+ * The identifier of the billing cadence for which you'd like to retrieve the upcoming invoice. Cannot be provided when `subscription`, `schedule`, `subscription_details` or `schedule_details` are provided.
3129
+ */
3130
+ billing_cadence?: string;
2701
3131
  /**
2702
3132
  * The currency to preview this invoice in. Defaults to that of `customer` if not specified.
2703
3133
  */
@@ -2797,10 +3227,18 @@ export declare namespace InvoiceCreatePreviewParams {
2797
3227
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
2798
3228
  */
2799
3229
  discount?: string;
3230
+ /**
3231
+ * Details to determine how long the discount should be applied for.
3232
+ */
3233
+ discount_end?: Discount.DiscountEnd;
2800
3234
  /**
2801
3235
  * ID of the promotion code to create a new discount for.
2802
3236
  */
2803
3237
  promotion_code?: string;
3238
+ /**
3239
+ * Settings for discount application including service period anchoring.
3240
+ */
3241
+ settings?: Discount.Settings;
2804
3242
  }
2805
3243
  interface InvoiceItem {
2806
3244
  /**
@@ -2884,10 +3322,26 @@ export declare namespace InvoiceCreatePreviewParams {
2884
3322
  }
2885
3323
  type PreviewMode = 'next' | 'recurring';
2886
3324
  interface ScheduleDetails {
3325
+ /**
3326
+ * Changes to apply to the phases of the subscription schedule, in the order provided.
3327
+ */
3328
+ amendments?: Array<ScheduleDetails.Amendment>;
3329
+ /**
3330
+ * Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
3331
+ */
3332
+ billing_behavior?: ScheduleDetails.BillingBehavior;
2887
3333
  /**
2888
3334
  * Controls how prorations and invoices for subscriptions are calculated and orchestrated.
2889
3335
  */
2890
3336
  billing_mode?: ScheduleDetails.BillingMode;
3337
+ /**
3338
+ * Sets the billing schedules for the subscription schedule.
3339
+ */
3340
+ billing_schedules?: Emptyable<Array<ScheduleDetails.BillingSchedule>>;
3341
+ /**
3342
+ * Object representing the subscription schedule's default settings.
3343
+ */
3344
+ default_settings?: ScheduleDetails.DefaultSettings;
2891
3345
  /**
2892
3346
  * Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
2893
3347
  */
@@ -2896,6 +3350,10 @@ export declare namespace InvoiceCreatePreviewParams {
2896
3350
  * List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
2897
3351
  */
2898
3352
  phases?: Array<ScheduleDetails.Phase>;
3353
+ /**
3354
+ * Provide any time periods to bill in advance.
3355
+ */
3356
+ prebilling?: Emptyable<Array<ScheduleDetails.Prebilling>>;
2899
3357
  /**
2900
3358
  * In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
2901
3359
  */
@@ -2910,6 +3368,10 @@ export declare namespace InvoiceCreatePreviewParams {
2910
3368
  * Controls how prorations and invoices for subscriptions are calculated and orchestrated.
2911
3369
  */
2912
3370
  billing_mode?: SubscriptionDetails.BillingMode;
3371
+ /**
3372
+ * Sets the billing schedules for the subscription.
3373
+ */
3374
+ billing_schedules?: Emptyable<Array<SubscriptionDetails.BillingSchedule>>;
2913
3375
  /**
2914
3376
  * A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
2915
3377
  */
@@ -2930,6 +3392,10 @@ export declare namespace InvoiceCreatePreviewParams {
2930
3392
  * A list of up to 20 subscription items, each with an attached price.
2931
3393
  */
2932
3394
  items?: Array<SubscriptionDetails.Item>;
3395
+ /**
3396
+ * The pre-billing to apply to the subscription as a preview.
3397
+ */
3398
+ prebilling?: SubscriptionDetails.Prebilling;
2933
3399
  /**
2934
3400
  * 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`.
2935
3401
  */
@@ -2963,7 +3429,7 @@ export declare namespace InvoiceCreatePreviewParams {
2963
3429
  type: Liability.Type;
2964
3430
  }
2965
3431
  namespace Liability {
2966
- type Type = 'account' | 'self';
3432
+ type Type = 'account' | 'application' | 'self';
2967
3433
  }
2968
3434
  }
2969
3435
  namespace CustomerDetails {
@@ -3002,33 +3468,117 @@ export declare namespace InvoiceCreatePreviewParams {
3002
3468
  type Type = 'ad_nrt' | 'ae_trn' | 'al_tin' | 'am_tin' | 'ao_tin' | 'ar_cuit' | 'au_abn' | 'au_arn' | 'aw_tin' | 'az_tin' | 'ba_tin' | 'bb_tin' | 'bd_bin' | 'bf_ifu' | 'bg_uic' | 'bh_vat' | 'bj_ifu' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'bs_tin' | 'by_tin' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'cd_nif' | 'ch_uid' | 'ch_vat' | 'cl_tin' | 'cm_niu' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'cv_nif' | 'de_stn' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'et_tin' | 'eu_oss_vat' | 'eu_vat' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_vat' | 'ma_vat' | 'md_vat' | 'me_pib' | 'mk_vat' | 'mr_nif' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'np_pan' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'pl_nip' | 'py_ruc' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sn_ninea' | 'sr_fin' | 'sv_nit' | 'th_vat' | 'tj_tin' | 'tr_tin' | 'tw_vat' | 'tz_vat' | 'ua_vat' | 'ug_tin' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin';
3003
3469
  }
3004
3470
  }
3005
- namespace InvoiceItem {
3006
- interface Discount {
3471
+ namespace Discount {
3472
+ interface DiscountEnd {
3007
3473
  /**
3008
- * ID of the coupon to create a new discount for.
3474
+ * Time span for the redeemed discount.
3009
3475
  */
3010
- coupon?: string;
3476
+ duration?: DiscountEnd.Duration;
3011
3477
  /**
3012
- * ID of an existing discount on the object (or one of its ancestors) to reuse.
3478
+ * A precise Unix timestamp for the discount to end. Must be in the future.
3013
3479
  */
3014
- discount?: string;
3480
+ timestamp?: number;
3015
3481
  /**
3016
- * ID of the promotion code to create a new discount for.
3482
+ * The type of calculation made to determine when the discount ends.
3017
3483
  */
3018
- promotion_code?: string;
3484
+ type: DiscountEnd.Type;
3019
3485
  }
3020
- interface Period {
3486
+ interface Settings {
3021
3487
  /**
3022
- * The end of the period, which must be greater than or equal to the start. This value is inclusive.
3488
+ * Configures service period cycle anchoring.
3023
3489
  */
3024
- end: number;
3490
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
3025
3491
  /**
3026
- * The start of the period. This value is inclusive.
3492
+ * The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `now` if omitted.
3027
3493
  */
3028
- start: number;
3494
+ start_date?: Settings.StartDate;
3029
3495
  }
3030
- interface PriceData {
3031
- /**
3496
+ namespace DiscountEnd {
3497
+ interface Duration {
3498
+ /**
3499
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
3500
+ */
3501
+ interval: Duration.Interval;
3502
+ /**
3503
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
3504
+ */
3505
+ interval_count: number;
3506
+ }
3507
+ type Type = 'duration' | 'timestamp';
3508
+ namespace Duration {
3509
+ type Interval = 'day' | 'month' | 'week' | 'year';
3510
+ }
3511
+ }
3512
+ namespace Settings {
3513
+ interface ServicePeriodAnchorConfig {
3514
+ /**
3515
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
3516
+ */
3517
+ custom?: ServicePeriodAnchorConfig.Custom;
3518
+ /**
3519
+ * The type of service period anchor config. Defaults to `subscription_service_cycle_anchor` if omitted.
3520
+ */
3521
+ type?: ServicePeriodAnchorConfig.Type;
3522
+ }
3523
+ type StartDate = 'current_period_end' | 'current_period_start' | 'now';
3524
+ namespace ServicePeriodAnchorConfig {
3525
+ interface Custom {
3526
+ /**
3527
+ * The day of the month the anchor should be. Ranges from 1 to 31.
3528
+ */
3529
+ day_of_month: number;
3530
+ /**
3531
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
3532
+ */
3533
+ hour?: number;
3534
+ /**
3535
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
3536
+ */
3537
+ minute?: number;
3538
+ /**
3539
+ * The month to start full cycle periods. Ranges from 1 to 12.
3540
+ */
3541
+ month?: number;
3542
+ /**
3543
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
3544
+ */
3545
+ second?: number;
3546
+ }
3547
+ type Type = 'custom' | 'subscription_service_cycle_anchor';
3548
+ }
3549
+ }
3550
+ }
3551
+ namespace InvoiceItem {
3552
+ interface Discount {
3553
+ /**
3554
+ * ID of the coupon to create a new discount for.
3555
+ */
3556
+ coupon?: string;
3557
+ /**
3558
+ * ID of an existing discount on the object (or one of its ancestors) to reuse.
3559
+ */
3560
+ discount?: string;
3561
+ /**
3562
+ * Details to determine how long the discount should be applied for.
3563
+ */
3564
+ discount_end?: Discount.DiscountEnd;
3565
+ /**
3566
+ * ID of the promotion code to create a new discount for.
3567
+ */
3568
+ promotion_code?: string;
3569
+ }
3570
+ interface Period {
3571
+ /**
3572
+ * The end of the period, which must be greater than or equal to the start. This value is inclusive.
3573
+ */
3574
+ end: number;
3575
+ /**
3576
+ * The start of the period. This value is inclusive.
3577
+ */
3578
+ start: number;
3579
+ }
3580
+ interface PriceData {
3581
+ /**
3032
3582
  * 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).
3033
3583
  */
3034
3584
  currency: string;
@@ -3050,14 +3600,97 @@ export declare namespace InvoiceCreatePreviewParams {
3050
3600
  unit_amount_decimal?: Decimal;
3051
3601
  }
3052
3602
  type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
3603
+ namespace Discount {
3604
+ interface DiscountEnd {
3605
+ /**
3606
+ * Time span for the redeemed discount.
3607
+ */
3608
+ duration?: DiscountEnd.Duration;
3609
+ /**
3610
+ * A precise Unix timestamp for the discount to end. Must be in the future.
3611
+ */
3612
+ timestamp?: number;
3613
+ /**
3614
+ * The type of calculation made to determine when the discount ends.
3615
+ */
3616
+ type: DiscountEnd.Type;
3617
+ }
3618
+ namespace DiscountEnd {
3619
+ interface Duration {
3620
+ /**
3621
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
3622
+ */
3623
+ interval: Duration.Interval;
3624
+ /**
3625
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
3626
+ */
3627
+ interval_count: number;
3628
+ }
3629
+ type Type = 'duration' | 'timestamp';
3630
+ namespace Duration {
3631
+ type Interval = 'day' | 'month' | 'week' | 'year';
3632
+ }
3633
+ }
3634
+ }
3053
3635
  namespace PriceData {
3054
3636
  type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
3055
3637
  }
3056
3638
  }
3057
3639
  namespace Issuer {
3058
- type Type = 'account' | 'self';
3640
+ type Type = 'account' | 'application' | 'self';
3059
3641
  }
3060
3642
  namespace ScheduleDetails {
3643
+ interface Amendment {
3644
+ /**
3645
+ * Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.
3646
+ */
3647
+ amendment_end?: Amendment.AmendmentEnd;
3648
+ /**
3649
+ * Details to identify the earliest timestamp where the proposed change should take effect.
3650
+ */
3651
+ amendment_start: Amendment.AmendmentStart;
3652
+ /**
3653
+ * For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
3654
+ */
3655
+ billing_cycle_anchor?: Amendment.BillingCycleAnchor;
3656
+ /**
3657
+ * Actions to apply to the billing schedules.
3658
+ */
3659
+ billing_schedules_actions?: Array<Amendment.BillingSchedulesAction>;
3660
+ /**
3661
+ * Changes to the coupons being redeemed or discounts being applied during the amendment time span.
3662
+ */
3663
+ discount_actions?: Array<Amendment.DiscountAction>;
3664
+ /**
3665
+ * Configures how the subscription schedule handles billing for phase transitions.
3666
+ */
3667
+ effective_at?: Amendment.EffectiveAt;
3668
+ /**
3669
+ * Changes to the subscription items during the amendment time span.
3670
+ */
3671
+ item_actions?: Array<Amendment.ItemAction>;
3672
+ /**
3673
+ * Instructions for how to modify phase metadata
3674
+ */
3675
+ metadata_actions?: Array<Amendment.MetadataAction>;
3676
+ /**
3677
+ * Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.
3678
+ */
3679
+ proration_behavior?: Amendment.ProrationBehavior;
3680
+ /**
3681
+ * Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
3682
+ */
3683
+ set_pause_collection?: Amendment.SetPauseCollection;
3684
+ /**
3685
+ * Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
3686
+ */
3687
+ set_schedule_end?: Amendment.SetScheduleEnd;
3688
+ /**
3689
+ * Settings related to subscription trials.
3690
+ */
3691
+ trial_settings?: Amendment.TrialSettings;
3692
+ }
3693
+ type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
3061
3694
  interface BillingMode {
3062
3695
  /**
3063
3696
  * Configure behavior for flexible billing mode.
@@ -3068,6 +3701,26 @@ export declare namespace InvoiceCreatePreviewParams {
3068
3701
  */
3069
3702
  type: BillingMode.Type;
3070
3703
  }
3704
+ interface BillingSchedule {
3705
+ /**
3706
+ * Configure billing schedule differently for individual subscription items.
3707
+ */
3708
+ applies_to?: Array<BillingSchedule.AppliesTo>;
3709
+ /**
3710
+ * The end date for the billing schedule.
3711
+ */
3712
+ bill_until?: BillingSchedule.BillUntil;
3713
+ /**
3714
+ * 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.
3715
+ */
3716
+ key?: string;
3717
+ }
3718
+ interface DefaultSettings {
3719
+ /**
3720
+ * Configures how the subscription schedule handles billing for phase transitions.
3721
+ */
3722
+ phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
3723
+ }
3071
3724
  type EndBehavior = 'cancel' | 'release';
3072
3725
  interface Phase {
3073
3726
  /**
@@ -3118,6 +3771,10 @@ export declare namespace InvoiceCreatePreviewParams {
3118
3771
  * The number of intervals the phase should last. If set, `end_date` must not be set.
3119
3772
  */
3120
3773
  duration?: Phase.Duration;
3774
+ /**
3775
+ * Configures how the subscription schedule handles billing for phase transitions.
3776
+ */
3777
+ effective_at?: Phase.EffectiveAt;
3121
3778
  /**
3122
3779
  * The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
3123
3780
  */
@@ -3138,6 +3795,10 @@ export declare namespace InvoiceCreatePreviewParams {
3138
3795
  * The account on behalf of which to charge, for each of the associated subscription's invoices.
3139
3796
  */
3140
3797
  on_behalf_of?: string;
3798
+ /**
3799
+ * 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).
3800
+ */
3801
+ pause_collection?: Phase.PauseCollection;
3141
3802
  /**
3142
3803
  * Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
3143
3804
  */
@@ -3154,12 +3815,702 @@ export declare namespace InvoiceCreatePreviewParams {
3154
3815
  * If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
3155
3816
  */
3156
3817
  trial?: boolean;
3818
+ /**
3819
+ * Specify trial behavior when crossing phase boundaries
3820
+ */
3821
+ trial_continuation?: Phase.TrialContinuation;
3157
3822
  /**
3158
3823
  * Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
3159
3824
  */
3160
3825
  trial_end?: number | 'now';
3826
+ /**
3827
+ * Settings related to subscription trials.
3828
+ */
3829
+ trial_settings?: Phase.TrialSettings;
3830
+ }
3831
+ interface Prebilling {
3832
+ /**
3833
+ * The end of the prebilled time period.
3834
+ */
3835
+ bill_until?: Prebilling.BillUntil;
3836
+ /**
3837
+ * This is used to determine the number of billing cycles to prebill.
3838
+ */
3839
+ iterations?: number;
3161
3840
  }
3162
3841
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
3842
+ namespace Amendment {
3843
+ interface AmendmentEnd {
3844
+ /**
3845
+ * Use the `end` time of a given discount.
3846
+ */
3847
+ discount_end?: AmendmentEnd.DiscountEnd;
3848
+ /**
3849
+ * Time span for the amendment starting from the `amendment_start`.
3850
+ */
3851
+ duration?: AmendmentEnd.Duration;
3852
+ /**
3853
+ * A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
3854
+ */
3855
+ timestamp?: number;
3856
+ /**
3857
+ * Select one of three ways to pass the `amendment_end`.
3858
+ */
3859
+ type: AmendmentEnd.Type;
3860
+ }
3861
+ interface AmendmentStart {
3862
+ /**
3863
+ * Details of another amendment in the same array, immediately after which this amendment should begin.
3864
+ */
3865
+ amendment_end?: AmendmentStart.AmendmentEnd;
3866
+ /**
3867
+ * Use the `end` time of a given discount.
3868
+ */
3869
+ discount_end?: AmendmentStart.DiscountEnd;
3870
+ /**
3871
+ * A precise Unix timestamp for the amendment to start.
3872
+ */
3873
+ timestamp?: number;
3874
+ /**
3875
+ * Select one of three ways to pass the `amendment_start`.
3876
+ */
3877
+ type: AmendmentStart.Type;
3878
+ }
3879
+ type BillingCycleAnchor = 'amendment_start' | 'automatic';
3880
+ interface BillingSchedulesAction {
3881
+ /**
3882
+ * Specify which subscription items the billing schedule applies to.
3883
+ */
3884
+ applies_to?: Array<BillingSchedulesAction.AppliesTo>;
3885
+ /**
3886
+ * Select the action.
3887
+ */
3888
+ type: BillingSchedulesAction.Type;
3889
+ }
3890
+ interface DiscountAction {
3891
+ /**
3892
+ * Details of the discount to add.
3893
+ */
3894
+ add?: DiscountAction.Add;
3895
+ /**
3896
+ * Details of the discount to remove.
3897
+ */
3898
+ remove?: DiscountAction.Remove;
3899
+ /**
3900
+ * Details of the discount to replace the existing discounts with.
3901
+ */
3902
+ set?: DiscountAction.Set;
3903
+ /**
3904
+ * Determines the type of discount action.
3905
+ */
3906
+ type: DiscountAction.Type;
3907
+ }
3908
+ type EffectiveAt = 'amendment_start' | 'billing_period_start';
3909
+ interface ItemAction {
3910
+ /**
3911
+ * Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.
3912
+ */
3913
+ add?: ItemAction.Add;
3914
+ /**
3915
+ * Details of the subscription item to remove.
3916
+ */
3917
+ remove?: ItemAction.Remove;
3918
+ /**
3919
+ * Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.
3920
+ */
3921
+ set?: ItemAction.Set;
3922
+ /**
3923
+ * Determines the type of item action.
3924
+ */
3925
+ type: ItemAction.Type;
3926
+ }
3927
+ interface MetadataAction {
3928
+ /**
3929
+ * Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
3930
+ */
3931
+ add?: {
3932
+ [key: string]: string;
3933
+ };
3934
+ /**
3935
+ * Keys to remove from schedule phase metadata.
3936
+ */
3937
+ remove?: Array<string>;
3938
+ /**
3939
+ * Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
3940
+ */
3941
+ set?: Emptyable<{
3942
+ [key: string]: string;
3943
+ }>;
3944
+ /**
3945
+ * Select one of three ways to update phase-level `metadata` on subscription schedules.
3946
+ */
3947
+ type: MetadataAction.Type;
3948
+ }
3949
+ type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
3950
+ interface SetPauseCollection {
3951
+ /**
3952
+ * Details of the pause_collection behavior to apply to the amendment.
3953
+ */
3954
+ set?: SetPauseCollection.Set;
3955
+ /**
3956
+ * Determines the type of the pause_collection amendment.
3957
+ */
3958
+ type: SetPauseCollection.Type;
3959
+ }
3960
+ type SetScheduleEnd = 'amendment_end' | 'amendment_start';
3961
+ interface TrialSettings {
3962
+ /**
3963
+ * Defines how the subscription should behave when a trial ends.
3964
+ */
3965
+ end_behavior?: TrialSettings.EndBehavior;
3966
+ }
3967
+ namespace AmendmentEnd {
3968
+ interface DiscountEnd {
3969
+ /**
3970
+ * The ID of a specific discount.
3971
+ */
3972
+ discount: string;
3973
+ }
3974
+ interface Duration {
3975
+ /**
3976
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
3977
+ */
3978
+ interval: Duration.Interval;
3979
+ /**
3980
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
3981
+ */
3982
+ interval_count: number;
3983
+ }
3984
+ type Type = 'discount_end' | 'duration' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
3985
+ namespace Duration {
3986
+ type Interval = 'day' | 'month' | 'week' | 'year';
3987
+ }
3988
+ }
3989
+ namespace AmendmentStart {
3990
+ interface AmendmentEnd {
3991
+ /**
3992
+ * The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.
3993
+ */
3994
+ index: number;
3995
+ }
3996
+ interface DiscountEnd {
3997
+ /**
3998
+ * The ID of a specific discount.
3999
+ */
4000
+ discount: string;
4001
+ }
4002
+ type Type = 'amendment_end' | 'discount_end' | 'now' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
4003
+ }
4004
+ namespace BillingSchedulesAction {
4005
+ interface AppliesTo {
4006
+ /**
4007
+ * The ID of the price object.
4008
+ */
4009
+ price?: string;
4010
+ /**
4011
+ * Controls which subscription items the billing schedule applies to.
4012
+ */
4013
+ type: 'price';
4014
+ }
4015
+ type Type = 'remove' | 'set';
4016
+ }
4017
+ namespace DiscountAction {
4018
+ interface Add {
4019
+ /**
4020
+ * The coupon code to redeem.
4021
+ */
4022
+ coupon?: string;
4023
+ /**
4024
+ * An ID of an existing discount for a coupon that was already redeemed.
4025
+ */
4026
+ discount?: string;
4027
+ /**
4028
+ * Details to determine how long the discount should be applied for.
4029
+ */
4030
+ discount_end?: Add.DiscountEnd;
4031
+ /**
4032
+ * The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
4033
+ */
4034
+ index?: number;
4035
+ /**
4036
+ * The promotion code to redeem.
4037
+ */
4038
+ promotion_code?: string;
4039
+ /**
4040
+ * Settings for discount application including service period anchoring.
4041
+ */
4042
+ settings?: Add.Settings;
4043
+ }
4044
+ interface Remove {
4045
+ /**
4046
+ * The coupon code to remove from the `discounts` array.
4047
+ */
4048
+ coupon?: string;
4049
+ /**
4050
+ * The ID of a discount to remove from the `discounts` array.
4051
+ */
4052
+ discount?: string;
4053
+ /**
4054
+ * The ID of a promotion code to remove from the `discounts` array.
4055
+ */
4056
+ promotion_code?: string;
4057
+ }
4058
+ interface Set {
4059
+ /**
4060
+ * The coupon code to replace the `discounts` array with.
4061
+ */
4062
+ coupon?: string;
4063
+ /**
4064
+ * An ID of an existing discount to replace the `discounts` array with.
4065
+ */
4066
+ discount?: string;
4067
+ /**
4068
+ * An ID of an existing promotion code to replace the `discounts` array with.
4069
+ */
4070
+ promotion_code?: string;
4071
+ /**
4072
+ * Settings for discount application including service period anchoring.
4073
+ */
4074
+ settings?: Set.Settings;
4075
+ }
4076
+ type Type = 'add' | 'remove' | 'set';
4077
+ namespace Add {
4078
+ interface DiscountEnd {
4079
+ /**
4080
+ * The type of calculation made to determine when the discount ends.
4081
+ */
4082
+ type: 'amendment_end';
4083
+ }
4084
+ interface Settings {
4085
+ /**
4086
+ * Configures service period cycle anchoring.
4087
+ */
4088
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
4089
+ /**
4090
+ * The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
4091
+ */
4092
+ start_date?: Settings.StartDate;
4093
+ }
4094
+ namespace Settings {
4095
+ interface ServicePeriodAnchorConfig {
4096
+ /**
4097
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
4098
+ */
4099
+ custom?: ServicePeriodAnchorConfig.Custom;
4100
+ /**
4101
+ * The type of service period anchor config. Defaults to `inherit` if omitted.
4102
+ */
4103
+ type?: ServicePeriodAnchorConfig.Type;
4104
+ }
4105
+ type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
4106
+ namespace ServicePeriodAnchorConfig {
4107
+ interface Custom {
4108
+ /**
4109
+ * The day of the month the anchor should be. Ranges from 1 to 31.
4110
+ */
4111
+ day_of_month: number;
4112
+ /**
4113
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
4114
+ */
4115
+ hour?: number;
4116
+ /**
4117
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
4118
+ */
4119
+ minute?: number;
4120
+ /**
4121
+ * The month to start full cycle periods. Ranges from 1 to 12.
4122
+ */
4123
+ month?: number;
4124
+ /**
4125
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
4126
+ */
4127
+ second?: number;
4128
+ }
4129
+ type Type = 'custom' | 'inherit';
4130
+ }
4131
+ }
4132
+ }
4133
+ namespace Set {
4134
+ interface Settings {
4135
+ /**
4136
+ * Configures service period cycle anchoring.
4137
+ */
4138
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
4139
+ /**
4140
+ * The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
4141
+ */
4142
+ start_date?: Settings.StartDate;
4143
+ }
4144
+ namespace Settings {
4145
+ interface ServicePeriodAnchorConfig {
4146
+ /**
4147
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
4148
+ */
4149
+ custom?: ServicePeriodAnchorConfig.Custom;
4150
+ /**
4151
+ * The type of service period anchor config. Defaults to `inherit` if omitted.
4152
+ */
4153
+ type?: ServicePeriodAnchorConfig.Type;
4154
+ }
4155
+ type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
4156
+ namespace ServicePeriodAnchorConfig {
4157
+ interface Custom {
4158
+ /**
4159
+ * The day of the month the anchor should be. Ranges from 1 to 31.
4160
+ */
4161
+ day_of_month: number;
4162
+ /**
4163
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
4164
+ */
4165
+ hour?: number;
4166
+ /**
4167
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
4168
+ */
4169
+ minute?: number;
4170
+ /**
4171
+ * The month to start full cycle periods. Ranges from 1 to 12.
4172
+ */
4173
+ month?: number;
4174
+ /**
4175
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
4176
+ */
4177
+ second?: number;
4178
+ }
4179
+ type Type = 'custom' | 'inherit';
4180
+ }
4181
+ }
4182
+ }
4183
+ }
4184
+ namespace ItemAction {
4185
+ interface Add {
4186
+ /**
4187
+ * The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
4188
+ */
4189
+ discounts?: Array<Add.Discount>;
4190
+ /**
4191
+ * 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`.
4192
+ */
4193
+ metadata?: MetadataParam;
4194
+ /**
4195
+ * The ID of the price object.
4196
+ */
4197
+ price: string;
4198
+ /**
4199
+ * Quantity for this item.
4200
+ */
4201
+ quantity?: number;
4202
+ /**
4203
+ * The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
4204
+ */
4205
+ tax_rates?: Array<string>;
4206
+ /**
4207
+ * Options that configure the trial on the subscription item.
4208
+ */
4209
+ trial?: Add.Trial;
4210
+ /**
4211
+ * The ID of the trial offer to apply to the configuration item.
4212
+ */
4213
+ trial_offer?: string;
4214
+ }
4215
+ interface Remove {
4216
+ /**
4217
+ * ID of a price to remove.
4218
+ */
4219
+ price: string;
4220
+ }
4221
+ interface Set {
4222
+ /**
4223
+ * If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
4224
+ */
4225
+ discounts?: Array<Set.Discount>;
4226
+ /**
4227
+ * If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
4228
+ */
4229
+ metadata?: MetadataParam;
4230
+ /**
4231
+ * The ID of the price object.
4232
+ */
4233
+ price: string;
4234
+ /**
4235
+ * If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
4236
+ */
4237
+ quantity?: number;
4238
+ /**
4239
+ * If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
4240
+ */
4241
+ tax_rates?: Array<string>;
4242
+ /**
4243
+ * If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
4244
+ */
4245
+ trial?: Set.Trial;
4246
+ /**
4247
+ * The ID of the trial offer to apply to the configuration item.
4248
+ */
4249
+ trial_offer?: string;
4250
+ }
4251
+ type Type = 'add' | 'remove' | 'set';
4252
+ namespace Add {
4253
+ interface Discount {
4254
+ /**
4255
+ * ID of the coupon to create a new discount for.
4256
+ */
4257
+ coupon?: string;
4258
+ /**
4259
+ * ID of an existing discount on the object (or one of its ancestors) to reuse.
4260
+ */
4261
+ discount?: string;
4262
+ /**
4263
+ * Details to determine how long the discount should be applied for.
4264
+ */
4265
+ discount_end?: Discount.DiscountEnd;
4266
+ /**
4267
+ * ID of the promotion code to create a new discount for.
4268
+ */
4269
+ promotion_code?: string;
4270
+ /**
4271
+ * Settings for discount application including service period anchoring.
4272
+ */
4273
+ settings?: Discount.Settings;
4274
+ }
4275
+ interface Trial {
4276
+ /**
4277
+ * 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.
4278
+ */
4279
+ converts_to?: Array<string>;
4280
+ /**
4281
+ * Determines the type of trial for this item.
4282
+ */
4283
+ type: Trial.Type;
4284
+ }
4285
+ namespace Discount {
4286
+ interface DiscountEnd {
4287
+ /**
4288
+ * Time span for the redeemed discount.
4289
+ */
4290
+ duration?: DiscountEnd.Duration;
4291
+ /**
4292
+ * A precise Unix timestamp for the discount to end. Must be in the future.
4293
+ */
4294
+ timestamp?: number;
4295
+ /**
4296
+ * The type of calculation made to determine when the discount ends.
4297
+ */
4298
+ type: DiscountEnd.Type;
4299
+ }
4300
+ interface Settings {
4301
+ /**
4302
+ * Configures service period cycle anchoring.
4303
+ */
4304
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
4305
+ /**
4306
+ * The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
4307
+ */
4308
+ start_date?: Settings.StartDate;
4309
+ }
4310
+ namespace DiscountEnd {
4311
+ interface Duration {
4312
+ /**
4313
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4314
+ */
4315
+ interval: Duration.Interval;
4316
+ /**
4317
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4318
+ */
4319
+ interval_count: number;
4320
+ }
4321
+ type Type = 'duration' | 'timestamp';
4322
+ namespace Duration {
4323
+ type Interval = 'day' | 'month' | 'week' | 'year';
4324
+ }
4325
+ }
4326
+ namespace Settings {
4327
+ interface ServicePeriodAnchorConfig {
4328
+ /**
4329
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
4330
+ */
4331
+ custom?: ServicePeriodAnchorConfig.Custom;
4332
+ /**
4333
+ * The type of service period anchor config. Defaults to `inherit` if omitted.
4334
+ */
4335
+ type?: ServicePeriodAnchorConfig.Type;
4336
+ }
4337
+ type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
4338
+ namespace ServicePeriodAnchorConfig {
4339
+ interface Custom {
4340
+ /**
4341
+ * The day of the month the anchor should be. Ranges from 1 to 31.
4342
+ */
4343
+ day_of_month: number;
4344
+ /**
4345
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
4346
+ */
4347
+ hour?: number;
4348
+ /**
4349
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
4350
+ */
4351
+ minute?: number;
4352
+ /**
4353
+ * The month to start full cycle periods. Ranges from 1 to 12.
4354
+ */
4355
+ month?: number;
4356
+ /**
4357
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
4358
+ */
4359
+ second?: number;
4360
+ }
4361
+ type Type = 'custom' | 'inherit';
4362
+ }
4363
+ }
4364
+ }
4365
+ namespace Trial {
4366
+ type Type = 'free' | 'paid';
4367
+ }
4368
+ }
4369
+ namespace Set {
4370
+ interface Discount {
4371
+ /**
4372
+ * ID of the coupon to create a new discount for.
4373
+ */
4374
+ coupon?: string;
4375
+ /**
4376
+ * ID of an existing discount on the object (or one of its ancestors) to reuse.
4377
+ */
4378
+ discount?: string;
4379
+ /**
4380
+ * Details to determine how long the discount should be applied for.
4381
+ */
4382
+ discount_end?: Discount.DiscountEnd;
4383
+ /**
4384
+ * ID of the promotion code to create a new discount for.
4385
+ */
4386
+ promotion_code?: string;
4387
+ /**
4388
+ * Settings for discount application including service period anchoring.
4389
+ */
4390
+ settings?: Discount.Settings;
4391
+ }
4392
+ interface Trial {
4393
+ /**
4394
+ * 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.
4395
+ */
4396
+ converts_to?: Array<string>;
4397
+ /**
4398
+ * Determines the type of trial for this item.
4399
+ */
4400
+ type: Trial.Type;
4401
+ }
4402
+ namespace Discount {
4403
+ interface DiscountEnd {
4404
+ /**
4405
+ * Time span for the redeemed discount.
4406
+ */
4407
+ duration?: DiscountEnd.Duration;
4408
+ /**
4409
+ * A precise Unix timestamp for the discount to end. Must be in the future.
4410
+ */
4411
+ timestamp?: number;
4412
+ /**
4413
+ * The type of calculation made to determine when the discount ends.
4414
+ */
4415
+ type: DiscountEnd.Type;
4416
+ }
4417
+ interface Settings {
4418
+ /**
4419
+ * Configures service period cycle anchoring.
4420
+ */
4421
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
4422
+ /**
4423
+ * The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
4424
+ */
4425
+ start_date?: Settings.StartDate;
4426
+ }
4427
+ namespace DiscountEnd {
4428
+ interface Duration {
4429
+ /**
4430
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4431
+ */
4432
+ interval: Duration.Interval;
4433
+ /**
4434
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4435
+ */
4436
+ interval_count: number;
4437
+ }
4438
+ type Type = 'duration' | 'timestamp';
4439
+ namespace Duration {
4440
+ type Interval = 'day' | 'month' | 'week' | 'year';
4441
+ }
4442
+ }
4443
+ namespace Settings {
4444
+ interface ServicePeriodAnchorConfig {
4445
+ /**
4446
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
4447
+ */
4448
+ custom?: ServicePeriodAnchorConfig.Custom;
4449
+ /**
4450
+ * The type of service period anchor config. Defaults to `inherit` if omitted.
4451
+ */
4452
+ type?: ServicePeriodAnchorConfig.Type;
4453
+ }
4454
+ type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
4455
+ namespace ServicePeriodAnchorConfig {
4456
+ interface Custom {
4457
+ /**
4458
+ * The day of the month the anchor should be. Ranges from 1 to 31.
4459
+ */
4460
+ day_of_month: number;
4461
+ /**
4462
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
4463
+ */
4464
+ hour?: number;
4465
+ /**
4466
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
4467
+ */
4468
+ minute?: number;
4469
+ /**
4470
+ * The month to start full cycle periods. Ranges from 1 to 12.
4471
+ */
4472
+ month?: number;
4473
+ /**
4474
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
4475
+ */
4476
+ second?: number;
4477
+ }
4478
+ type Type = 'custom' | 'inherit';
4479
+ }
4480
+ }
4481
+ }
4482
+ namespace Trial {
4483
+ type Type = 'free' | 'paid';
4484
+ }
4485
+ }
4486
+ }
4487
+ namespace MetadataAction {
4488
+ type Type = 'add' | 'remove' | 'set';
4489
+ }
4490
+ namespace SetPauseCollection {
4491
+ interface Set {
4492
+ /**
4493
+ * The payment collection behavior for this subscription while paused.
4494
+ */
4495
+ behavior: Set.Behavior;
4496
+ }
4497
+ type Type = 'remove' | 'set';
4498
+ namespace Set {
4499
+ type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
4500
+ }
4501
+ }
4502
+ namespace TrialSettings {
4503
+ interface EndBehavior {
4504
+ /**
4505
+ * Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
4506
+ */
4507
+ prorate_up_front?: EndBehavior.ProrateUpFront;
4508
+ }
4509
+ namespace EndBehavior {
4510
+ type ProrateUpFront = 'defer' | 'include';
4511
+ }
4512
+ }
4513
+ }
3163
4514
  namespace BillingMode {
3164
4515
  interface Flexible {
3165
4516
  /**
@@ -3172,6 +4523,51 @@ export declare namespace InvoiceCreatePreviewParams {
3172
4523
  type ProrationDiscounts = 'included' | 'itemized';
3173
4524
  }
3174
4525
  }
4526
+ namespace BillingSchedule {
4527
+ interface AppliesTo {
4528
+ /**
4529
+ * The ID of the price object.
4530
+ */
4531
+ price?: string;
4532
+ /**
4533
+ * Controls which subscription items the billing schedule applies to.
4534
+ */
4535
+ type: 'price';
4536
+ }
4537
+ interface BillUntil {
4538
+ /**
4539
+ * Specifies the billing period.
4540
+ */
4541
+ duration?: BillUntil.Duration;
4542
+ /**
4543
+ * The end date of the billing schedule.
4544
+ */
4545
+ timestamp?: number;
4546
+ /**
4547
+ * Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
4548
+ */
4549
+ type: BillUntil.Type;
4550
+ }
4551
+ namespace BillUntil {
4552
+ interface Duration {
4553
+ /**
4554
+ * Specifies billing duration. Either `day`, `week`, `month` or `year`.
4555
+ */
4556
+ interval: Duration.Interval;
4557
+ /**
4558
+ * The multiplier applied to the interval.
4559
+ */
4560
+ interval_count?: number;
4561
+ }
4562
+ type Type = 'duration' | 'timestamp';
4563
+ namespace Duration {
4564
+ type Interval = 'day' | 'month' | 'week' | 'year';
4565
+ }
4566
+ }
4567
+ }
4568
+ namespace DefaultSettings {
4569
+ type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
4570
+ }
3175
4571
  namespace Phase {
3176
4572
  interface AddInvoiceItem {
3177
4573
  /**
@@ -3234,10 +4630,18 @@ export declare namespace InvoiceCreatePreviewParams {
3234
4630
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3235
4631
  */
3236
4632
  discount?: string;
4633
+ /**
4634
+ * Details to determine how long the discount should be applied for.
4635
+ */
4636
+ discount_end?: Discount.DiscountEnd;
3237
4637
  /**
3238
4638
  * ID of the promotion code to create a new discount for.
3239
4639
  */
3240
4640
  promotion_code?: string;
4641
+ /**
4642
+ * Settings for discount application including service period anchoring.
4643
+ */
4644
+ settings?: Discount.Settings;
3241
4645
  }
3242
4646
  interface Duration {
3243
4647
  /**
@@ -3249,6 +4653,7 @@ export declare namespace InvoiceCreatePreviewParams {
3249
4653
  */
3250
4654
  interval_count?: number;
3251
4655
  }
4656
+ type EffectiveAt = 'billing_period_start' | 'phase_start';
3252
4657
  interface InvoiceSettings {
3253
4658
  /**
3254
4659
  * The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
@@ -3296,6 +4701,20 @@ export declare namespace InvoiceCreatePreviewParams {
3296
4701
  * 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.
3297
4702
  */
3298
4703
  tax_rates?: Emptyable<Array<string>>;
4704
+ /**
4705
+ * Options that configure the trial on the subscription item.
4706
+ */
4707
+ trial?: Item.Trial;
4708
+ /**
4709
+ * The ID of the trial offer to apply to the configuration item.
4710
+ */
4711
+ trial_offer?: string;
4712
+ }
4713
+ interface PauseCollection {
4714
+ /**
4715
+ * The payment collection behavior for this subscription while paused.
4716
+ */
4717
+ behavior: PauseCollection.Behavior;
3299
4718
  }
3300
4719
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
3301
4720
  interface TransferData {
@@ -3308,6 +4727,13 @@ export declare namespace InvoiceCreatePreviewParams {
3308
4727
  */
3309
4728
  destination: string;
3310
4729
  }
4730
+ type TrialContinuation = 'continue' | 'none';
4731
+ interface TrialSettings {
4732
+ /**
4733
+ * Defines how the subscription should behave when a trial ends.
4734
+ */
4735
+ end_behavior?: TrialSettings.EndBehavior;
4736
+ }
3311
4737
  namespace AddInvoiceItem {
3312
4738
  interface Discount {
3313
4739
  /**
@@ -3318,6 +4744,10 @@ export declare namespace InvoiceCreatePreviewParams {
3318
4744
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3319
4745
  */
3320
4746
  discount?: string;
4747
+ /**
4748
+ * Details to determine how long the discount should be applied for.
4749
+ */
4750
+ discount_end?: Discount.DiscountEnd;
3321
4751
  /**
3322
4752
  * ID of the promotion code to create a new discount for.
3323
4753
  */
@@ -3355,6 +4785,38 @@ export declare namespace InvoiceCreatePreviewParams {
3355
4785
  */
3356
4786
  unit_amount_decimal?: Decimal;
3357
4787
  }
4788
+ namespace Discount {
4789
+ interface DiscountEnd {
4790
+ /**
4791
+ * Time span for the redeemed discount.
4792
+ */
4793
+ duration?: DiscountEnd.Duration;
4794
+ /**
4795
+ * A precise Unix timestamp for the discount to end. Must be in the future.
4796
+ */
4797
+ timestamp?: number;
4798
+ /**
4799
+ * The type of calculation made to determine when the discount ends.
4800
+ */
4801
+ type: DiscountEnd.Type;
4802
+ }
4803
+ namespace DiscountEnd {
4804
+ interface Duration {
4805
+ /**
4806
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4807
+ */
4808
+ interval: Duration.Interval;
4809
+ /**
4810
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4811
+ */
4812
+ interval_count: number;
4813
+ }
4814
+ type Type = 'duration' | 'timestamp';
4815
+ namespace Duration {
4816
+ type Interval = 'day' | 'month' | 'week' | 'year';
4817
+ }
4818
+ }
4819
+ }
3358
4820
  namespace Period {
3359
4821
  interface End {
3360
4822
  /**
@@ -3399,7 +4861,87 @@ export declare namespace InvoiceCreatePreviewParams {
3399
4861
  type: Liability.Type;
3400
4862
  }
3401
4863
  namespace Liability {
3402
- type Type = 'account' | 'self';
4864
+ type Type = 'account' | 'application' | 'self';
4865
+ }
4866
+ }
4867
+ namespace Discount {
4868
+ interface DiscountEnd {
4869
+ /**
4870
+ * Time span for the redeemed discount.
4871
+ */
4872
+ duration?: DiscountEnd.Duration;
4873
+ /**
4874
+ * A precise Unix timestamp for the discount to end. Must be in the future.
4875
+ */
4876
+ timestamp?: number;
4877
+ /**
4878
+ * The type of calculation made to determine when the discount ends.
4879
+ */
4880
+ type: DiscountEnd.Type;
4881
+ }
4882
+ interface Settings {
4883
+ /**
4884
+ * Configures service period cycle anchoring.
4885
+ */
4886
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
4887
+ /**
4888
+ * The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `phase_start` if omitted.
4889
+ */
4890
+ start_date?: Settings.StartDate;
4891
+ }
4892
+ namespace DiscountEnd {
4893
+ interface Duration {
4894
+ /**
4895
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4896
+ */
4897
+ interval: Duration.Interval;
4898
+ /**
4899
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4900
+ */
4901
+ interval_count: number;
4902
+ }
4903
+ type Type = 'duration' | 'timestamp';
4904
+ namespace Duration {
4905
+ type Interval = 'day' | 'month' | 'week' | 'year';
4906
+ }
4907
+ }
4908
+ namespace Settings {
4909
+ interface ServicePeriodAnchorConfig {
4910
+ /**
4911
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
4912
+ */
4913
+ custom?: ServicePeriodAnchorConfig.Custom;
4914
+ /**
4915
+ * The type of service period anchor config. Defaults to `inherit` if omitted.
4916
+ */
4917
+ type?: ServicePeriodAnchorConfig.Type;
4918
+ }
4919
+ type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
4920
+ namespace ServicePeriodAnchorConfig {
4921
+ interface Custom {
4922
+ /**
4923
+ * The day of the month the anchor should be. Ranges from 1 to 31.
4924
+ */
4925
+ day_of_month: number;
4926
+ /**
4927
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
4928
+ */
4929
+ hour?: number;
4930
+ /**
4931
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
4932
+ */
4933
+ minute?: number;
4934
+ /**
4935
+ * The month to start full cycle periods. Ranges from 1 to 12.
4936
+ */
4937
+ month?: number;
4938
+ /**
4939
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
4940
+ */
4941
+ second?: number;
4942
+ }
4943
+ type Type = 'custom' | 'inherit';
4944
+ }
3403
4945
  }
3404
4946
  }
3405
4947
  namespace Duration {
@@ -3417,7 +4959,7 @@ export declare namespace InvoiceCreatePreviewParams {
3417
4959
  type: Issuer.Type;
3418
4960
  }
3419
4961
  namespace Issuer {
3420
- type Type = 'account' | 'self';
4962
+ type Type = 'account' | 'application' | 'self';
3421
4963
  }
3422
4964
  }
3423
4965
  namespace Item {
@@ -3436,10 +4978,18 @@ export declare namespace InvoiceCreatePreviewParams {
3436
4978
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3437
4979
  */
3438
4980
  discount?: string;
4981
+ /**
4982
+ * Details to determine how long the discount should be applied for.
4983
+ */
4984
+ discount_end?: Discount.DiscountEnd;
3439
4985
  /**
3440
4986
  * ID of the promotion code to create a new discount for.
3441
4987
  */
3442
4988
  promotion_code?: string;
4989
+ /**
4990
+ * Settings for discount application including service period anchoring.
4991
+ */
4992
+ settings?: Discount.Settings;
3443
4993
  }
3444
4994
  interface PriceData {
3445
4995
  /**
@@ -3467,6 +5017,96 @@ export declare namespace InvoiceCreatePreviewParams {
3467
5017
  */
3468
5018
  unit_amount_decimal?: Decimal;
3469
5019
  }
5020
+ interface Trial {
5021
+ /**
5022
+ * 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.
5023
+ */
5024
+ converts_to?: Array<string>;
5025
+ /**
5026
+ * Determines the type of trial for this item.
5027
+ */
5028
+ type: Trial.Type;
5029
+ }
5030
+ namespace Discount {
5031
+ interface DiscountEnd {
5032
+ /**
5033
+ * Time span for the redeemed discount.
5034
+ */
5035
+ duration?: DiscountEnd.Duration;
5036
+ /**
5037
+ * A precise Unix timestamp for the discount to end. Must be in the future.
5038
+ */
5039
+ timestamp?: number;
5040
+ /**
5041
+ * The type of calculation made to determine when the discount ends.
5042
+ */
5043
+ type: DiscountEnd.Type;
5044
+ }
5045
+ interface Settings {
5046
+ /**
5047
+ * Configures service period cycle anchoring.
5048
+ */
5049
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
5050
+ /**
5051
+ * The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `phase_start` if omitted.
5052
+ */
5053
+ start_date?: Settings.StartDate;
5054
+ }
5055
+ namespace DiscountEnd {
5056
+ interface Duration {
5057
+ /**
5058
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
5059
+ */
5060
+ interval: Duration.Interval;
5061
+ /**
5062
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
5063
+ */
5064
+ interval_count: number;
5065
+ }
5066
+ type Type = 'duration' | 'timestamp';
5067
+ namespace Duration {
5068
+ type Interval = 'day' | 'month' | 'week' | 'year';
5069
+ }
5070
+ }
5071
+ namespace Settings {
5072
+ interface ServicePeriodAnchorConfig {
5073
+ /**
5074
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
5075
+ */
5076
+ custom?: ServicePeriodAnchorConfig.Custom;
5077
+ /**
5078
+ * The type of service period anchor config. Defaults to `inherit` if omitted.
5079
+ */
5080
+ type?: ServicePeriodAnchorConfig.Type;
5081
+ }
5082
+ type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
5083
+ namespace ServicePeriodAnchorConfig {
5084
+ interface Custom {
5085
+ /**
5086
+ * The day of the month the anchor should be. Ranges from 1 to 31.
5087
+ */
5088
+ day_of_month: number;
5089
+ /**
5090
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
5091
+ */
5092
+ hour?: number;
5093
+ /**
5094
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
5095
+ */
5096
+ minute?: number;
5097
+ /**
5098
+ * The month to start full cycle periods. Ranges from 1 to 12.
5099
+ */
5100
+ month?: number;
5101
+ /**
5102
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
5103
+ */
5104
+ second?: number;
5105
+ }
5106
+ type Type = 'custom' | 'inherit';
5107
+ }
5108
+ }
5109
+ }
3470
5110
  namespace PriceData {
3471
5111
  interface Recurring {
3472
5112
  /**
@@ -3483,6 +5123,65 @@ export declare namespace InvoiceCreatePreviewParams {
3483
5123
  type Interval = 'day' | 'month' | 'week' | 'year';
3484
5124
  }
3485
5125
  }
5126
+ namespace Trial {
5127
+ type Type = 'free' | 'paid';
5128
+ }
5129
+ }
5130
+ namespace PauseCollection {
5131
+ type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
5132
+ }
5133
+ namespace TrialSettings {
5134
+ interface EndBehavior {
5135
+ /**
5136
+ * Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
5137
+ */
5138
+ prorate_up_front?: EndBehavior.ProrateUpFront;
5139
+ }
5140
+ namespace EndBehavior {
5141
+ type ProrateUpFront = 'defer' | 'include';
5142
+ }
5143
+ }
5144
+ }
5145
+ namespace Prebilling {
5146
+ interface BillUntil {
5147
+ /**
5148
+ * End the prebilled period when a specified amendment ends.
5149
+ */
5150
+ amendment_end?: BillUntil.AmendmentEnd;
5151
+ /**
5152
+ * Time span for prebilling, starting from `bill_from`.
5153
+ */
5154
+ duration?: BillUntil.Duration;
5155
+ /**
5156
+ * End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
5157
+ */
5158
+ timestamp?: number;
5159
+ /**
5160
+ * Select one of several ways to pass the `bill_until` value.
5161
+ */
5162
+ type: BillUntil.Type;
5163
+ }
5164
+ namespace BillUntil {
5165
+ interface AmendmentEnd {
5166
+ /**
5167
+ * The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.
5168
+ */
5169
+ index: number;
5170
+ }
5171
+ interface Duration {
5172
+ /**
5173
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
5174
+ */
5175
+ interval: Duration.Interval;
5176
+ /**
5177
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
5178
+ */
5179
+ interval_count: number;
5180
+ }
5181
+ type Type = 'amendment_end' | 'duration' | 'schedule_end' | 'timestamp';
5182
+ namespace Duration {
5183
+ type Interval = 'day' | 'month' | 'week' | 'year';
5184
+ }
3486
5185
  }
3487
5186
  }
3488
5187
  }
@@ -3498,6 +5197,20 @@ export declare namespace InvoiceCreatePreviewParams {
3498
5197
  */
3499
5198
  type: BillingMode.Type;
3500
5199
  }
5200
+ interface BillingSchedule {
5201
+ /**
5202
+ * Configure billing schedule differently for individual subscription items.
5203
+ */
5204
+ applies_to?: Array<BillingSchedule.AppliesTo>;
5205
+ /**
5206
+ * The end date for the billing schedule.
5207
+ */
5208
+ bill_until?: BillingSchedule.BillUntil;
5209
+ /**
5210
+ * 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.
5211
+ */
5212
+ key?: string;
5213
+ }
3501
5214
  type CancelAt = 'max_period_end' | 'min_period_end';
3502
5215
  interface Item {
3503
5216
  /**
@@ -3508,6 +5221,10 @@ export declare namespace InvoiceCreatePreviewParams {
3508
5221
  * Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
3509
5222
  */
3510
5223
  clear_usage?: boolean;
5224
+ /**
5225
+ * The trial offer to apply to this subscription item.
5226
+ */
5227
+ current_trial?: Item.CurrentTrial;
3511
5228
  /**
3512
5229
  * A flag that, if set to `true`, will delete the specified item.
3513
5230
  */
@@ -3545,6 +5262,12 @@ export declare namespace InvoiceCreatePreviewParams {
3545
5262
  */
3546
5263
  tax_rates?: Emptyable<Array<string>>;
3547
5264
  }
5265
+ interface Prebilling {
5266
+ /**
5267
+ * This is used to determine the number of billing cycles to prebill.
5268
+ */
5269
+ iterations: number;
5270
+ }
3548
5271
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
3549
5272
  namespace BillingMode {
3550
5273
  interface Flexible {
@@ -3558,6 +5281,48 @@ export declare namespace InvoiceCreatePreviewParams {
3558
5281
  type ProrationDiscounts = 'included' | 'itemized';
3559
5282
  }
3560
5283
  }
5284
+ namespace BillingSchedule {
5285
+ interface AppliesTo {
5286
+ /**
5287
+ * The ID of the price object.
5288
+ */
5289
+ price?: string;
5290
+ /**
5291
+ * Controls which subscription items the billing schedule applies to.
5292
+ */
5293
+ type: 'price';
5294
+ }
5295
+ interface BillUntil {
5296
+ /**
5297
+ * Specifies the billing period.
5298
+ */
5299
+ duration?: BillUntil.Duration;
5300
+ /**
5301
+ * The end date of the billing schedule.
5302
+ */
5303
+ timestamp?: number;
5304
+ /**
5305
+ * Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
5306
+ */
5307
+ type: BillUntil.Type;
5308
+ }
5309
+ namespace BillUntil {
5310
+ interface Duration {
5311
+ /**
5312
+ * Specifies billing duration. Either `day`, `week`, `month` or `year`.
5313
+ */
5314
+ interval: Duration.Interval;
5315
+ /**
5316
+ * The multiplier applied to the interval.
5317
+ */
5318
+ interval_count?: number;
5319
+ }
5320
+ type Type = 'duration' | 'timestamp';
5321
+ namespace Duration {
5322
+ type Interval = 'day' | 'month' | 'week' | 'year';
5323
+ }
5324
+ }
5325
+ }
3561
5326
  namespace Item {
3562
5327
  interface BillingThresholds {
3563
5328
  /**
@@ -3565,6 +5330,16 @@ export declare namespace InvoiceCreatePreviewParams {
3565
5330
  */
3566
5331
  usage_gte: number;
3567
5332
  }
5333
+ interface CurrentTrial {
5334
+ /**
5335
+ * Unix timestamp representing the end of the trial offer period. Required when the trial offer has `duration.type=timestamp`. Cannot be specified when `duration.type=relative`.
5336
+ */
5337
+ trial_end?: number;
5338
+ /**
5339
+ * The ID of the trial offer to apply to the subscription item.
5340
+ */
5341
+ trial_offer: string;
5342
+ }
3568
5343
  interface Discount {
3569
5344
  /**
3570
5345
  * ID of the coupon to create a new discount for.
@@ -3574,10 +5349,18 @@ export declare namespace InvoiceCreatePreviewParams {
3574
5349
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3575
5350
  */
3576
5351
  discount?: string;
5352
+ /**
5353
+ * Details to determine how long the discount should be applied for.
5354
+ */
5355
+ discount_end?: Discount.DiscountEnd;
3577
5356
  /**
3578
5357
  * ID of the promotion code to create a new discount for.
3579
5358
  */
3580
5359
  promotion_code?: string;
5360
+ /**
5361
+ * Settings for discount application including service period anchoring.
5362
+ */
5363
+ settings?: Discount.Settings;
3581
5364
  }
3582
5365
  interface PriceData {
3583
5366
  /**
@@ -3605,6 +5388,86 @@ export declare namespace InvoiceCreatePreviewParams {
3605
5388
  */
3606
5389
  unit_amount_decimal?: Decimal;
3607
5390
  }
5391
+ namespace Discount {
5392
+ interface DiscountEnd {
5393
+ /**
5394
+ * Time span for the redeemed discount.
5395
+ */
5396
+ duration?: DiscountEnd.Duration;
5397
+ /**
5398
+ * A precise Unix timestamp for the discount to end. Must be in the future.
5399
+ */
5400
+ timestamp?: number;
5401
+ /**
5402
+ * The type of calculation made to determine when the discount ends.
5403
+ */
5404
+ type: DiscountEnd.Type;
5405
+ }
5406
+ interface Settings {
5407
+ /**
5408
+ * Configures service period cycle anchoring.
5409
+ */
5410
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
5411
+ /**
5412
+ * The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `now` if omitted.
5413
+ */
5414
+ start_date?: Settings.StartDate;
5415
+ }
5416
+ namespace DiscountEnd {
5417
+ interface Duration {
5418
+ /**
5419
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
5420
+ */
5421
+ interval: Duration.Interval;
5422
+ /**
5423
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
5424
+ */
5425
+ interval_count: number;
5426
+ }
5427
+ type Type = 'duration' | 'timestamp';
5428
+ namespace Duration {
5429
+ type Interval = 'day' | 'month' | 'week' | 'year';
5430
+ }
5431
+ }
5432
+ namespace Settings {
5433
+ interface ServicePeriodAnchorConfig {
5434
+ /**
5435
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
5436
+ */
5437
+ custom?: ServicePeriodAnchorConfig.Custom;
5438
+ /**
5439
+ * The type of service period anchor config. Defaults to `subscription_service_cycle_anchor` if omitted.
5440
+ */
5441
+ type?: ServicePeriodAnchorConfig.Type;
5442
+ }
5443
+ type StartDate = 'current_period_end' | 'current_period_start' | 'now';
5444
+ namespace ServicePeriodAnchorConfig {
5445
+ interface Custom {
5446
+ /**
5447
+ * The day of the month the anchor should be. Ranges from 1 to 31.
5448
+ */
5449
+ day_of_month: number;
5450
+ /**
5451
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
5452
+ */
5453
+ hour?: number;
5454
+ /**
5455
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
5456
+ */
5457
+ minute?: number;
5458
+ /**
5459
+ * The month to start full cycle periods. Ranges from 1 to 12.
5460
+ */
5461
+ month?: number;
5462
+ /**
5463
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
5464
+ */
5465
+ second?: number;
5466
+ }
5467
+ type Type = 'custom' | 'subscription_service_cycle_anchor';
5468
+ }
5469
+ }
5470
+ }
3608
5471
  namespace PriceData {
3609
5472
  interface Recurring {
3610
5473
  /**
@@ -3624,6 +5487,16 @@ export declare namespace InvoiceCreatePreviewParams {
3624
5487
  }
3625
5488
  }
3626
5489
  }
5490
+ export interface InvoiceDetachPaymentParams {
5491
+ /**
5492
+ * Specifies which fields in the response should be expanded.
5493
+ */
5494
+ expand?: Array<string>;
5495
+ /**
5496
+ * The ID of the PaymentIntent to detach from the invoice.
5497
+ */
5498
+ payment_intent?: string;
5499
+ }
3627
5500
  export interface InvoiceFinalizeInvoiceParams {
3628
5501
  /**
3629
5502
  * Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.
@@ -3733,6 +5606,10 @@ export interface InvoiceSendInvoiceParams {
3733
5606
  */
3734
5607
  expand?: Array<string>;
3735
5608
  }
5609
+ export interface InvoiceSerializeBatchPayParams {
5610
+ }
5611
+ export interface InvoiceSerializeBatchUpdateParams {
5612
+ }
3736
5613
  export interface InvoiceUpdateLinesParams {
3737
5614
  /**
3738
5615
  * The line items to update.
@@ -3771,6 +5648,10 @@ export declare namespace InvoiceUpdateLinesParams {
3771
5648
  * ID of an existing line item on the invoice.
3772
5649
  */
3773
5650
  id: string;
5651
+ /**
5652
+ * The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
5653
+ */
5654
+ margins?: Emptyable<Array<string>>;
3774
5655
  /**
3775
5656
  * 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`. For [type=subscription](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
3776
5657
  */
@@ -3814,6 +5695,10 @@ export declare namespace InvoiceUpdateLinesParams {
3814
5695
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3815
5696
  */
3816
5697
  discount?: string;
5698
+ /**
5699
+ * Details to determine how long the discount should be applied for.
5700
+ */
5701
+ discount_end?: Discount.DiscountEnd;
3817
5702
  /**
3818
5703
  * ID of the promotion code to create a new discount for.
3819
5704
  */
@@ -3881,6 +5766,38 @@ export declare namespace InvoiceUpdateLinesParams {
3881
5766
  */
3882
5767
  taxable_amount: number;
3883
5768
  }
5769
+ namespace Discount {
5770
+ interface DiscountEnd {
5771
+ /**
5772
+ * Time span for the redeemed discount.
5773
+ */
5774
+ duration?: DiscountEnd.Duration;
5775
+ /**
5776
+ * A precise Unix timestamp for the discount to end. Must be in the future.
5777
+ */
5778
+ timestamp?: number;
5779
+ /**
5780
+ * The type of calculation made to determine when the discount ends.
5781
+ */
5782
+ type: DiscountEnd.Type;
5783
+ }
5784
+ namespace DiscountEnd {
5785
+ interface Duration {
5786
+ /**
5787
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
5788
+ */
5789
+ interval: Duration.Interval;
5790
+ /**
5791
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
5792
+ */
5793
+ interval_count: number;
5794
+ }
5795
+ type Type = 'duration' | 'timestamp';
5796
+ namespace Duration {
5797
+ type Interval = 'day' | 'month' | 'week' | 'year';
5798
+ }
5799
+ }
5800
+ }
3884
5801
  namespace PriceData {
3885
5802
  interface ProductData {
3886
5803
  /**
@@ -3903,12 +5820,28 @@ export declare namespace InvoiceUpdateLinesParams {
3903
5820
  * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
3904
5821
  */
3905
5822
  tax_code?: string;
5823
+ /**
5824
+ * Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
5825
+ */
5826
+ tax_details?: ProductData.TaxDetails;
3906
5827
  /**
3907
5828
  * A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
3908
5829
  */
3909
5830
  unit_label?: string;
3910
5831
  }
3911
5832
  type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
5833
+ namespace ProductData {
5834
+ interface TaxDetails {
5835
+ /**
5836
+ * A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
5837
+ */
5838
+ performance_location?: string;
5839
+ /**
5840
+ * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
5841
+ */
5842
+ tax_code?: Emptyable<string>;
5843
+ }
5844
+ }
3912
5845
  }
3913
5846
  namespace TaxAmount {
3914
5847
  interface TaxRateData {
@@ -3978,6 +5911,10 @@ export interface InvoiceUpdateLineItemParams {
3978
5911
  * Specifies which fields in the response should be expanded.
3979
5912
  */
3980
5913
  expand?: Array<string>;
5914
+ /**
5915
+ * The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
5916
+ */
5917
+ margins?: Emptyable<Array<string>>;
3981
5918
  /**
3982
5919
  * 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`. For [type=subscription](https://docs.stripe.com/api/invoices/line_item) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](https://docs.stripe.com/api/invoices/line_item) line items, where any existing metadata on the invoice line is merged with the incoming data.
3983
5920
  */
@@ -4021,6 +5958,10 @@ export declare namespace InvoiceUpdateLineItemParams {
4021
5958
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
4022
5959
  */
4023
5960
  discount?: string;
5961
+ /**
5962
+ * Details to determine how long the discount should be applied for.
5963
+ */
5964
+ discount_end?: Discount.DiscountEnd;
4024
5965
  /**
4025
5966
  * ID of the promotion code to create a new discount for.
4026
5967
  */
@@ -4088,6 +6029,38 @@ export declare namespace InvoiceUpdateLineItemParams {
4088
6029
  */
4089
6030
  taxable_amount: number;
4090
6031
  }
6032
+ namespace Discount {
6033
+ interface DiscountEnd {
6034
+ /**
6035
+ * Time span for the redeemed discount.
6036
+ */
6037
+ duration?: DiscountEnd.Duration;
6038
+ /**
6039
+ * A precise Unix timestamp for the discount to end. Must be in the future.
6040
+ */
6041
+ timestamp?: number;
6042
+ /**
6043
+ * The type of calculation made to determine when the discount ends.
6044
+ */
6045
+ type: DiscountEnd.Type;
6046
+ }
6047
+ namespace DiscountEnd {
6048
+ interface Duration {
6049
+ /**
6050
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
6051
+ */
6052
+ interval: Duration.Interval;
6053
+ /**
6054
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
6055
+ */
6056
+ interval_count: number;
6057
+ }
6058
+ type Type = 'duration' | 'timestamp';
6059
+ namespace Duration {
6060
+ type Interval = 'day' | 'month' | 'week' | 'year';
6061
+ }
6062
+ }
6063
+ }
4091
6064
  namespace PriceData {
4092
6065
  interface ProductData {
4093
6066
  /**
@@ -4110,12 +6083,28 @@ export declare namespace InvoiceUpdateLineItemParams {
4110
6083
  * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
4111
6084
  */
4112
6085
  tax_code?: string;
6086
+ /**
6087
+ * Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
6088
+ */
6089
+ tax_details?: ProductData.TaxDetails;
4113
6090
  /**
4114
6091
  * A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
4115
6092
  */
4116
6093
  unit_label?: string;
4117
6094
  }
4118
6095
  type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
6096
+ namespace ProductData {
6097
+ interface TaxDetails {
6098
+ /**
6099
+ * A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
6100
+ */
6101
+ performance_location?: string;
6102
+ /**
6103
+ * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
6104
+ */
6105
+ tax_code?: Emptyable<string>;
6106
+ }
6107
+ }
4119
6108
  }
4120
6109
  namespace TaxAmount {
4121
6110
  interface TaxRateData {