stripe 22.5.0 → 22.6.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 (1674) hide show
  1. package/CHANGELOG.md +3251 -12
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +51 -60
  4. package/VERSION +1 -1
  5. package/cjs/Error.d.ts +61 -0
  6. package/cjs/Error.js +143 -1
  7. package/cjs/Error.js.map +1 -1
  8. package/cjs/RequestSender.d.ts +1 -1
  9. package/cjs/RequestSender.js +14 -5
  10. package/cjs/RequestSender.js.map +1 -1
  11. package/cjs/StripeEventNotificationHandler.d.ts +19 -0
  12. package/cjs/StripeEventNotificationHandler.js +505 -0
  13. package/cjs/StripeEventNotificationHandler.js.map +1 -0
  14. package/cjs/Types.d.ts +9 -2
  15. package/cjs/Types.js.map +1 -1
  16. package/cjs/apiVersion.d.ts +2 -2
  17. package/cjs/apiVersion.js +2 -2
  18. package/cjs/apiVersion.js.map +1 -1
  19. package/cjs/resources/AccountLinks.d.ts +8 -4
  20. package/cjs/resources/AccountNotices.d.ts +140 -0
  21. package/cjs/resources/AccountNotices.js +29 -0
  22. package/cjs/resources/AccountNotices.js.map +1 -0
  23. package/cjs/resources/AccountSessions.d.ts +564 -0
  24. package/cjs/resources/AccountSessions.js.map +1 -1
  25. package/cjs/resources/AccountSignals.d.ts +111 -0
  26. package/cjs/resources/AccountSignals.js +4 -0
  27. package/cjs/resources/AccountSignals.js.map +1 -0
  28. package/cjs/resources/Accounts.d.ts +1143 -85
  29. package/cjs/resources/Accounts.js +47 -0
  30. package/cjs/resources/Accounts.js.map +1 -1
  31. package/cjs/resources/ApplicationFees.d.ts +28 -1
  32. package/cjs/resources/Balance.d.ts +134 -0
  33. package/cjs/resources/BalanceSettings.d.ts +18 -0
  34. package/cjs/resources/BalanceTransactions.d.ts +2 -2
  35. package/cjs/resources/BalanceTransfers.d.ts +160 -0
  36. package/cjs/resources/BalanceTransfers.js +15 -0
  37. package/cjs/resources/BalanceTransfers.js.map +1 -0
  38. package/cjs/resources/BankAccounts.d.ts +4 -4
  39. package/cjs/resources/Billing/AlertNotifications.d.ts +75 -0
  40. package/cjs/resources/Billing/AlertNotifications.js +4 -0
  41. package/cjs/resources/Billing/AlertNotifications.js.map +1 -0
  42. package/cjs/resources/Billing/AlertRecovereds.d.ts +56 -0
  43. package/cjs/resources/Billing/AlertRecovereds.js +4 -0
  44. package/cjs/resources/Billing/AlertRecovereds.js.map +1 -0
  45. package/cjs/resources/Billing/AlertTriggereds.d.ts +55 -1
  46. package/cjs/resources/Billing/Alerts.d.ts +448 -5
  47. package/cjs/resources/Billing/Alerts.js +329 -5
  48. package/cjs/resources/Billing/Alerts.js.map +1 -1
  49. package/cjs/resources/Billing/Analytics/MeterUsage.d.ts +89 -0
  50. package/cjs/resources/Billing/Analytics/MeterUsage.js +15 -0
  51. package/cjs/resources/Billing/Analytics/MeterUsage.js.map +1 -0
  52. package/cjs/resources/Billing/Analytics/MeterUsageRows.d.ts +38 -0
  53. package/cjs/resources/Billing/Analytics/MeterUsageRows.js +4 -0
  54. package/cjs/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
  55. package/cjs/resources/Billing/Analytics/index.d.ts +15 -0
  56. package/cjs/resources/Billing/Analytics/index.js +13 -0
  57. package/cjs/resources/Billing/Analytics/index.js.map +1 -0
  58. package/cjs/resources/Billing/CreditBalanceSummary.d.ts +136 -3
  59. package/cjs/resources/Billing/CreditBalanceSummary.js +39 -1
  60. package/cjs/resources/Billing/CreditBalanceSummary.js.map +1 -1
  61. package/cjs/resources/Billing/CreditBalanceTransactions.d.ts +97 -3
  62. package/cjs/resources/Billing/CreditBalanceTransactions.js +100 -1
  63. package/cjs/resources/Billing/CreditBalanceTransactions.js.map +1 -1
  64. package/cjs/resources/Billing/CreditGrants.d.ts +105 -3
  65. package/cjs/resources/Billing/CreditGrants.js +134 -5
  66. package/cjs/resources/Billing/CreditGrants.js.map +1 -1
  67. package/cjs/resources/Billing/FeedbackOptions.d.ts +32 -0
  68. package/cjs/resources/Billing/FeedbackOptions.js +4 -0
  69. package/cjs/resources/Billing/FeedbackOptions.js.map +1 -0
  70. package/cjs/resources/Billing/MeterEventSummaries.d.ts +6 -0
  71. package/cjs/resources/Billing/Meters.d.ts +31 -0
  72. package/cjs/resources/Billing/index.d.ts +13 -0
  73. package/cjs/resources/Billing/index.js +2 -0
  74. package/cjs/resources/Billing/index.js.map +1 -1
  75. package/cjs/resources/BillingPortal/Configurations.d.ts +14 -9
  76. package/cjs/resources/BillingPortal/Configurations.js.map +1 -1
  77. package/cjs/resources/BillingPortal/Sessions.d.ts +17 -1
  78. package/cjs/resources/Capabilities.d.ts +25 -2
  79. package/cjs/resources/Capital/FinancingOffers.d.ts +194 -0
  80. package/cjs/resources/Capital/FinancingOffers.js +30 -0
  81. package/cjs/resources/Capital/FinancingOffers.js.map +1 -0
  82. package/cjs/resources/Capital/FinancingSummary.d.ts +102 -0
  83. package/cjs/resources/Capital/FinancingSummary.js +15 -0
  84. package/cjs/resources/Capital/FinancingSummary.js.map +1 -0
  85. package/cjs/resources/Capital/FinancingTransactions.d.ts +141 -0
  86. package/cjs/resources/Capital/FinancingTransactions.js +24 -0
  87. package/cjs/resources/Capital/FinancingTransactions.js.map +1 -0
  88. package/cjs/resources/Capital/index.d.ts +25 -0
  89. package/cjs/resources/Capital/index.js +17 -0
  90. package/cjs/resources/Capital/index.js.map +1 -0
  91. package/cjs/resources/Cards.d.ts +29 -1
  92. package/cjs/resources/CashBalances.d.ts +2 -1
  93. package/cjs/resources/Charges.d.ts +3382 -85
  94. package/cjs/resources/Charges.js.map +1 -1
  95. package/cjs/resources/Checkout/Sessions.d.ts +1224 -43
  96. package/cjs/resources/Checkout/Sessions.js +115 -0
  97. package/cjs/resources/Checkout/Sessions.js.map +1 -1
  98. package/cjs/resources/Checkout/index.d.ts +1 -0
  99. package/cjs/resources/Climate/Orders.d.ts +1 -1
  100. package/cjs/resources/Climate/Products.d.ts +1 -1
  101. package/cjs/resources/ConfirmationTokens.d.ts +153 -8
  102. package/cjs/resources/ConfirmationTokens.js.map +1 -1
  103. package/cjs/resources/Coupons.d.ts +128 -2
  104. package/cjs/resources/Coupons.js +41 -0
  105. package/cjs/resources/Coupons.js.map +1 -1
  106. package/cjs/resources/CreditNoteLineItems.d.ts +17 -3
  107. package/cjs/resources/CreditNotes.d.ts +12 -6
  108. package/cjs/resources/CreditNotes.js +13 -0
  109. package/cjs/resources/CreditNotes.js.map +1 -1
  110. package/cjs/resources/Crypto/CustomerConsumerWallets.d.ts +30 -0
  111. package/cjs/resources/Crypto/CustomerConsumerWallets.js +4 -0
  112. package/cjs/resources/Crypto/CustomerConsumerWallets.js.map +1 -0
  113. package/cjs/resources/Crypto/CustomerPaymentTokens.d.ts +80 -0
  114. package/cjs/resources/Crypto/CustomerPaymentTokens.js +4 -0
  115. package/cjs/resources/Crypto/CustomerPaymentTokens.js.map +1 -0
  116. package/cjs/resources/Crypto/Customers.d.ts +111 -0
  117. package/cjs/resources/Crypto/Customers.js +31 -0
  118. package/cjs/resources/Crypto/Customers.js.map +1 -0
  119. package/cjs/resources/Crypto/DepositAddresses.d.ts +128 -0
  120. package/cjs/resources/Crypto/DepositAddresses.js +31 -0
  121. package/cjs/resources/Crypto/DepositAddresses.js.map +1 -0
  122. package/cjs/resources/Crypto/OnrampSessions.d.ts +425 -0
  123. package/cjs/resources/Crypto/OnrampSessions.js +47 -0
  124. package/cjs/resources/Crypto/OnrampSessions.js.map +1 -0
  125. package/cjs/resources/Crypto/OnrampTransactionLimits.d.ts +61 -0
  126. package/cjs/resources/Crypto/OnrampTransactionLimits.js +15 -0
  127. package/cjs/resources/Crypto/OnrampTransactionLimits.js.map +1 -0
  128. package/cjs/resources/Crypto/index.d.ts +41 -0
  129. package/cjs/resources/Crypto/index.js +19 -0
  130. package/cjs/resources/Crypto/index.js.map +1 -0
  131. package/cjs/resources/CustomerSessions.d.ts +94 -0
  132. package/cjs/resources/CustomerSessions.js +13 -0
  133. package/cjs/resources/CustomerSessions.js.map +1 -1
  134. package/cjs/resources/Customers.d.ts +126 -12
  135. package/cjs/resources/Customers.js +195 -0
  136. package/cjs/resources/Customers.js.map +1 -1
  137. package/cjs/resources/DelegatedCheckout/OrderEvents.d.ts +129 -0
  138. package/cjs/resources/DelegatedCheckout/OrderEvents.js +4 -0
  139. package/cjs/resources/DelegatedCheckout/OrderEvents.js.map +1 -0
  140. package/cjs/resources/DelegatedCheckout/Orders.d.ts +159 -0
  141. package/cjs/resources/DelegatedCheckout/Orders.js +15 -0
  142. package/cjs/resources/DelegatedCheckout/Orders.js.map +1 -0
  143. package/cjs/resources/DelegatedCheckout/RequestedSessions.d.ts +1424 -0
  144. package/cjs/resources/DelegatedCheckout/RequestedSessions.js +47 -0
  145. package/cjs/resources/DelegatedCheckout/RequestedSessions.js.map +1 -0
  146. package/cjs/resources/DelegatedCheckout/index.d.ts +25 -0
  147. package/cjs/resources/DelegatedCheckout/index.js +15 -0
  148. package/cjs/resources/DelegatedCheckout/index.js.map +1 -0
  149. package/cjs/resources/Discounts.d.ts +19 -0
  150. package/cjs/resources/Disputes.d.ts +43 -0
  151. package/cjs/resources/Disputes.js +14 -0
  152. package/cjs/resources/Disputes.js.map +1 -1
  153. package/cjs/resources/Events.d.ts +640 -3
  154. package/cjs/resources/ExternalAccounts.d.ts +212 -1
  155. package/cjs/resources/ExternalAccounts.js +44 -0
  156. package/cjs/resources/ExternalAccounts.js.map +1 -1
  157. package/cjs/resources/Files.d.ts +1 -1
  158. package/cjs/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
  159. package/cjs/resources/FinancialConnections/AccountInferredBalances.js +4 -0
  160. package/cjs/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
  161. package/cjs/resources/FinancialConnections/Accounts.d.ts +105 -4
  162. package/cjs/resources/FinancialConnections/Accounts.js +8 -0
  163. package/cjs/resources/FinancialConnections/Accounts.js.map +1 -1
  164. package/cjs/resources/FinancialConnections/Authorizations.d.ts +46 -1
  165. package/cjs/resources/FinancialConnections/Authorizations.js +11 -0
  166. package/cjs/resources/FinancialConnections/Authorizations.js.map +1 -1
  167. package/cjs/resources/FinancialConnections/Institutions.d.ts +99 -0
  168. package/cjs/resources/FinancialConnections/Institutions.js +23 -0
  169. package/cjs/resources/FinancialConnections/Institutions.js.map +1 -0
  170. package/cjs/resources/FinancialConnections/Sessions.d.ts +128 -9
  171. package/cjs/resources/FinancialConnections/Transactions.d.ts +76 -0
  172. package/cjs/resources/FinancialConnections/index.d.ts +21 -9
  173. package/cjs/resources/FinancialConnections/index.js +4 -0
  174. package/cjs/resources/FinancialConnections/index.js.map +1 -1
  175. package/cjs/resources/FxQuotes.d.ts +212 -0
  176. package/cjs/resources/FxQuotes.js +29 -0
  177. package/cjs/resources/FxQuotes.js.map +1 -0
  178. package/cjs/resources/GiftCardOperations.d.ts +249 -0
  179. package/cjs/resources/GiftCardOperations.js +15 -0
  180. package/cjs/resources/GiftCardOperations.js.map +1 -0
  181. package/cjs/resources/GiftCards.d.ts +181 -0
  182. package/cjs/resources/GiftCards.js +51 -0
  183. package/cjs/resources/GiftCards.js.map +1 -0
  184. package/cjs/resources/Identity/BlocklistEntries.d.ts +155 -0
  185. package/cjs/resources/Identity/BlocklistEntries.js +54 -0
  186. package/cjs/resources/Identity/BlocklistEntries.js.map +1 -0
  187. package/cjs/resources/Identity/VerificationReports.d.ts +33 -2
  188. package/cjs/resources/Identity/VerificationReports.js.map +1 -1
  189. package/cjs/resources/Identity/VerificationSessions.d.ts +11 -3
  190. package/cjs/resources/Identity/index.d.ts +18 -10
  191. package/cjs/resources/Identity/index.js +2 -0
  192. package/cjs/resources/Identity/index.js.map +1 -1
  193. package/cjs/resources/InvoiceItems.d.ts +226 -8
  194. package/cjs/resources/InvoiceItems.js +41 -0
  195. package/cjs/resources/InvoiceItems.js.map +1 -1
  196. package/cjs/resources/InvoiceLineItems.d.ts +175 -5
  197. package/cjs/resources/InvoicePayments.d.ts +1 -1
  198. package/cjs/resources/InvoiceRenderingTemplates.d.ts +15 -3
  199. package/cjs/resources/InvoiceRenderingTemplates.js +28 -0
  200. package/cjs/resources/InvoiceRenderingTemplates.js.map +1 -1
  201. package/cjs/resources/Invoices.d.ts +2211 -61
  202. package/cjs/resources/Invoices.js +221 -0
  203. package/cjs/resources/Invoices.js.map +1 -1
  204. package/cjs/resources/Issuing/Authorizations.d.ts +730 -1
  205. package/cjs/resources/Issuing/Authorizations.js.map +1 -1
  206. package/cjs/resources/Issuing/Cardholders.d.ts +40 -22
  207. package/cjs/resources/Issuing/Cards.d.ts +97 -15
  208. package/cjs/resources/Issuing/CreditUnderwritingRecords.d.ts +654 -0
  209. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +53 -0
  210. package/cjs/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
  211. package/cjs/resources/Issuing/DisputeSettlementDetails.d.ts +93 -0
  212. package/cjs/resources/Issuing/DisputeSettlementDetails.js +23 -0
  213. package/cjs/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
  214. package/cjs/resources/Issuing/Disputes.d.ts +246 -0
  215. package/cjs/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
  216. package/cjs/resources/Issuing/FraudLiabilityDebits.js +23 -0
  217. package/cjs/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
  218. package/cjs/resources/Issuing/Programs.d.ts +95 -0
  219. package/cjs/resources/Issuing/Programs.js +35 -0
  220. package/cjs/resources/Issuing/Programs.js.map +1 -0
  221. package/cjs/resources/Issuing/Settlements.d.ts +83 -0
  222. package/cjs/resources/Issuing/Settlements.js +4 -0
  223. package/cjs/resources/Issuing/Settlements.js.map +1 -0
  224. package/cjs/resources/Issuing/Tokens.d.ts +26 -0
  225. package/cjs/resources/Issuing/Transactions.d.ts +233 -0
  226. package/cjs/resources/Issuing/Transactions.js.map +1 -1
  227. package/cjs/resources/Issuing/index.d.ts +56 -22
  228. package/cjs/resources/Issuing/index.js +8 -0
  229. package/cjs/resources/Issuing/index.js.map +1 -1
  230. package/cjs/resources/LineItems.d.ts +29 -2
  231. package/cjs/resources/Mandates.d.ts +49 -4
  232. package/cjs/resources/Mandates.js +8 -0
  233. package/cjs/resources/Mandates.js.map +1 -1
  234. package/cjs/resources/Margins.d.ts +115 -0
  235. package/cjs/resources/Margins.js +35 -0
  236. package/cjs/resources/Margins.js.map +1 -0
  237. package/cjs/resources/Orchestration/PaymentAttempts.d.ts +34 -0
  238. package/cjs/resources/Orchestration/PaymentAttempts.js +15 -0
  239. package/cjs/resources/Orchestration/PaymentAttempts.js.map +1 -0
  240. package/cjs/resources/Orchestration/index.d.ts +12 -0
  241. package/cjs/resources/Orchestration/index.js +13 -0
  242. package/cjs/resources/Orchestration/index.js.map +1 -0
  243. package/cjs/resources/Orders.d.ts +4773 -0
  244. package/cjs/resources/Orders.js +457 -0
  245. package/cjs/resources/Orders.js.map +1 -0
  246. package/cjs/resources/PaymentAttemptRecords.d.ts +696 -19
  247. package/cjs/resources/PaymentAttemptRecords.js +48 -0
  248. package/cjs/resources/PaymentAttemptRecords.js.map +1 -1
  249. package/cjs/resources/PaymentIntentAmountDetailsLineItems.d.ts +52 -0
  250. package/cjs/resources/PaymentIntents.d.ts +17309 -3551
  251. package/cjs/resources/PaymentIntents.js +46 -0
  252. package/cjs/resources/PaymentIntents.js.map +1 -1
  253. package/cjs/resources/PaymentLinks.d.ts +84 -22
  254. package/cjs/resources/PaymentLocationCapabilities.d.ts +123 -0
  255. package/cjs/resources/PaymentLocationCapabilities.js +29 -0
  256. package/cjs/resources/PaymentLocationCapabilities.js.map +1 -0
  257. package/cjs/resources/PaymentLocations.d.ts +178 -0
  258. package/cjs/resources/PaymentLocations.js +41 -0
  259. package/cjs/resources/PaymentLocations.js.map +1 -0
  260. package/cjs/resources/PaymentMethodBalances.d.ts +46 -0
  261. package/cjs/resources/PaymentMethodBalances.js +4 -0
  262. package/cjs/resources/PaymentMethodBalances.js.map +1 -0
  263. package/cjs/resources/PaymentMethodConfigurations.d.ts +420 -0
  264. package/cjs/resources/PaymentMethods.d.ts +311 -14
  265. package/cjs/resources/PaymentMethods.js +20 -0
  266. package/cjs/resources/PaymentMethods.js.map +1 -1
  267. package/cjs/resources/PaymentPlans.d.ts +427 -0
  268. package/cjs/resources/PaymentPlans.js +35 -0
  269. package/cjs/resources/PaymentPlans.js.map +1 -0
  270. package/cjs/resources/PaymentRecords.d.ts +754 -37
  271. package/cjs/resources/PaymentRecords.js +18 -0
  272. package/cjs/resources/PaymentRecords.js.map +1 -1
  273. package/cjs/resources/Payouts.d.ts +3 -3
  274. package/cjs/resources/Persons.d.ts +25 -2
  275. package/cjs/resources/Plans.d.ts +21 -5
  276. package/cjs/resources/Prices.d.ts +91 -15
  277. package/cjs/resources/Prices.js +27 -0
  278. package/cjs/resources/Prices.js.map +1 -1
  279. package/cjs/resources/Privacy/RedactionJobValidationErrors.d.ts +36 -0
  280. package/cjs/resources/Privacy/RedactionJobValidationErrors.js +4 -0
  281. package/cjs/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
  282. package/cjs/resources/Privacy/RedactionJobs.d.ts +227 -0
  283. package/cjs/resources/Privacy/RedactionJobs.js +73 -0
  284. package/cjs/resources/Privacy/RedactionJobs.js.map +1 -0
  285. package/cjs/resources/Privacy/index.d.ts +22 -0
  286. package/cjs/resources/Privacy/index.js +13 -0
  287. package/cjs/resources/Privacy/index.js.map +1 -0
  288. package/cjs/resources/ProductCatalog/TrialOffers.d.ts +158 -0
  289. package/cjs/resources/ProductCatalog/TrialOffers.js +29 -0
  290. package/cjs/resources/ProductCatalog/TrialOffers.js.map +1 -0
  291. package/cjs/resources/ProductCatalog/index.d.ts +14 -0
  292. package/cjs/resources/ProductCatalog/index.js +13 -0
  293. package/cjs/resources/ProductCatalog/index.js.map +1 -0
  294. package/cjs/resources/Products.d.ts +205 -7
  295. package/cjs/resources/Products.js +69 -0
  296. package/cjs/resources/Products.js.map +1 -1
  297. package/cjs/resources/Profiles.d.ts +68 -0
  298. package/cjs/resources/Profiles.js +4 -0
  299. package/cjs/resources/Profiles.js.map +1 -0
  300. package/cjs/resources/PromotionCodes.d.ts +12 -0
  301. package/cjs/resources/PromotionCodes.js +27 -0
  302. package/cjs/resources/PromotionCodes.js.map +1 -1
  303. package/cjs/resources/QuoteLines.d.ts +684 -0
  304. package/cjs/resources/QuoteLines.js +4 -0
  305. package/cjs/resources/QuoteLines.js.map +1 -0
  306. package/cjs/resources/QuotePreviewInvoices.d.ts +1210 -0
  307. package/cjs/resources/QuotePreviewInvoices.js +4 -0
  308. package/cjs/resources/QuotePreviewInvoices.js.map +1 -0
  309. package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +1087 -0
  310. package/cjs/resources/QuotePreviewSubscriptionSchedules.js +4 -0
  311. package/cjs/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
  312. package/cjs/resources/Quotes.d.ts +3558 -264
  313. package/cjs/resources/Quotes.js +1184 -16
  314. package/cjs/resources/Quotes.js.map +1 -1
  315. package/cjs/resources/Radar/AccountEvaluations.d.ts +309 -0
  316. package/cjs/resources/Radar/AccountEvaluations.js +27 -0
  317. package/cjs/resources/Radar/AccountEvaluations.js.map +1 -0
  318. package/cjs/resources/Radar/CustomerEvaluations.d.ts +245 -0
  319. package/cjs/resources/Radar/CustomerEvaluations.js +27 -0
  320. package/cjs/resources/Radar/CustomerEvaluations.js.map +1 -0
  321. package/cjs/resources/Radar/IssuingAuthorizationEvaluations.d.ts +433 -0
  322. package/cjs/resources/Radar/IssuingAuthorizationEvaluations.js +15 -0
  323. package/cjs/resources/Radar/IssuingAuthorizationEvaluations.js.map +1 -0
  324. package/cjs/resources/Radar/PaymentEvaluations.d.ts +116 -2
  325. package/cjs/resources/Radar/ValueListItems.d.ts +39 -1
  326. package/cjs/resources/Radar/ValueListItems.js +13 -0
  327. package/cjs/resources/Radar/ValueListItems.js.map +1 -1
  328. package/cjs/resources/Radar/ValueLists.d.ts +2 -2
  329. package/cjs/resources/Radar/index.d.ts +36 -16
  330. package/cjs/resources/Radar/index.js +6 -0
  331. package/cjs/resources/Radar/index.js.map +1 -1
  332. package/cjs/resources/Refunds.d.ts +41 -2
  333. package/cjs/resources/Refunds.js +27 -0
  334. package/cjs/resources/Refunds.js.map +1 -1
  335. package/cjs/resources/Reporting/ReportRuns.d.ts +3 -3
  336. package/cjs/resources/Reserve/Holds.d.ts +53 -1
  337. package/cjs/resources/Reserve/Holds.js +19 -0
  338. package/cjs/resources/Reserve/Holds.js.map +1 -1
  339. package/cjs/resources/Reserve/Plans.d.ts +16 -0
  340. package/cjs/resources/Reserve/Plans.js +11 -0
  341. package/cjs/resources/Reserve/Plans.js.map +1 -1
  342. package/cjs/resources/Reserve/Releases.d.ts +41 -1
  343. package/cjs/resources/Reserve/Releases.js +19 -0
  344. package/cjs/resources/Reserve/Releases.js.map +1 -1
  345. package/cjs/resources/Reserve/index.d.ts +17 -6
  346. package/cjs/resources/Reserve/index.js +9 -0
  347. package/cjs/resources/Reserve/index.js.map +1 -1
  348. package/cjs/resources/Reviews.d.ts +2 -2
  349. package/cjs/resources/RiskSignals.d.ts +10 -0
  350. package/cjs/resources/RiskSignals.js +4 -0
  351. package/cjs/resources/RiskSignals.js.map +1 -0
  352. package/cjs/resources/SetupAttempts.d.ts +42 -8
  353. package/cjs/resources/SetupAttempts.js.map +1 -1
  354. package/cjs/resources/SetupIntents.d.ts +667 -51
  355. package/cjs/resources/SetupIntents.js.map +1 -1
  356. package/cjs/resources/SharedPayment/GrantedTokens.d.ts +425 -0
  357. package/cjs/resources/SharedPayment/GrantedTokens.js +15 -0
  358. package/cjs/resources/SharedPayment/GrantedTokens.js.map +1 -0
  359. package/cjs/resources/SharedPayment/IssuedTokens.d.ts +344 -0
  360. package/cjs/resources/SharedPayment/IssuedTokens.js +27 -0
  361. package/cjs/resources/SharedPayment/IssuedTokens.js.map +1 -0
  362. package/cjs/resources/SharedPayment/index.d.ts +19 -0
  363. package/cjs/resources/SharedPayment/index.js +15 -0
  364. package/cjs/resources/SharedPayment/index.js.map +1 -0
  365. package/cjs/resources/ShippingRates.d.ts +6 -6
  366. package/cjs/resources/SourceTransactions.d.ts +2 -1
  367. package/cjs/resources/Sources.d.ts +43 -15
  368. package/cjs/resources/SubscriptionItems.d.ts +273 -8
  369. package/cjs/resources/SubscriptionItems.js +41 -0
  370. package/cjs/resources/SubscriptionItems.js.map +1 -1
  371. package/cjs/resources/SubscriptionSchedules.d.ts +2463 -90
  372. package/cjs/resources/SubscriptionSchedules.js +61 -0
  373. package/cjs/resources/SubscriptionSchedules.js.map +1 -1
  374. package/cjs/resources/Subscriptions.d.ts +1011 -43
  375. package/cjs/resources/Subscriptions.js +290 -1
  376. package/cjs/resources/Subscriptions.js.map +1 -1
  377. package/cjs/resources/Tax/CalculationLineItems.d.ts +14 -3
  378. package/cjs/resources/Tax/Calculations.d.ts +49 -7
  379. package/cjs/resources/Tax/Forms.d.ts +228 -0
  380. package/cjs/resources/Tax/Forms.js +32 -0
  381. package/cjs/resources/Tax/Forms.js.map +1 -0
  382. package/cjs/resources/Tax/Locations.d.ts +112 -0
  383. package/cjs/resources/Tax/Locations.js +33 -0
  384. package/cjs/resources/Tax/Locations.js.map +1 -0
  385. package/cjs/resources/Tax/Registrations.d.ts +441 -2
  386. package/cjs/resources/Tax/Registrations.js +27 -0
  387. package/cjs/resources/Tax/Registrations.js.map +1 -1
  388. package/cjs/resources/Tax/Settings.d.ts +10 -2
  389. package/cjs/resources/Tax/Settings.js +13 -0
  390. package/cjs/resources/Tax/Settings.js.map +1 -1
  391. package/cjs/resources/Tax/Transactions.d.ts +11 -3
  392. package/cjs/resources/Tax/Transactions.js +13 -0
  393. package/cjs/resources/Tax/Transactions.js.map +1 -1
  394. package/cjs/resources/Tax/index.d.ts +31 -13
  395. package/cjs/resources/Tax/index.js +4 -0
  396. package/cjs/resources/Tax/index.js.map +1 -1
  397. package/cjs/resources/TaxCodes.d.ts +16 -1
  398. package/cjs/resources/TaxFunds.d.ts +174 -0
  399. package/cjs/resources/TaxFunds.js +23 -0
  400. package/cjs/resources/TaxFunds.js.map +1 -0
  401. package/cjs/resources/TaxIds.d.ts +9 -3
  402. package/cjs/resources/TaxIds.js +13 -0
  403. package/cjs/resources/TaxIds.js.map +1 -1
  404. package/cjs/resources/TaxRates.d.ts +13 -1
  405. package/cjs/resources/TaxRates.js +27 -0
  406. package/cjs/resources/TaxRates.js.map +1 -1
  407. package/cjs/resources/Terminal/Configurations.d.ts +27 -0
  408. package/cjs/resources/Terminal/ReaderCollectedData.d.ts +50 -0
  409. package/cjs/resources/Terminal/ReaderCollectedData.js +15 -0
  410. package/cjs/resources/Terminal/ReaderCollectedData.js.map +1 -0
  411. package/cjs/resources/Terminal/Readers.d.ts +211 -6
  412. package/cjs/resources/Terminal/Readers.js +24 -0
  413. package/cjs/resources/Terminal/Readers.js.map +1 -1
  414. package/cjs/resources/Terminal/index.d.ts +9 -0
  415. package/cjs/resources/Terminal/index.js +2 -0
  416. package/cjs/resources/Terminal/index.js.map +1 -1
  417. package/cjs/resources/TestHelpers/Capital/FinancingOffers.d.ts +82 -0
  418. package/cjs/resources/TestHelpers/Capital/FinancingOffers.js +21 -0
  419. package/cjs/resources/TestHelpers/Capital/FinancingOffers.js.map +1 -0
  420. package/cjs/resources/TestHelpers/Capital/index.d.ts +8 -0
  421. package/cjs/resources/TestHelpers/Capital/index.js +13 -0
  422. package/cjs/resources/TestHelpers/Capital/index.js.map +1 -0
  423. package/cjs/resources/TestHelpers/ConfirmationTokens.d.ts +104 -5
  424. package/cjs/resources/TestHelpers/Issuing/Authorizations.d.ts +115 -13
  425. package/cjs/resources/TestHelpers/Issuing/Disputes.d.ts +127 -0
  426. package/cjs/resources/TestHelpers/Issuing/Disputes.js +39 -0
  427. package/cjs/resources/TestHelpers/Issuing/Disputes.js.map +1 -0
  428. package/cjs/resources/TestHelpers/Issuing/Transactions.d.ts +121 -11
  429. package/cjs/resources/TestHelpers/Issuing/index.d.ts +2 -0
  430. package/cjs/resources/TestHelpers/Issuing/index.js +2 -0
  431. package/cjs/resources/TestHelpers/Issuing/index.js.map +1 -1
  432. package/cjs/resources/TestHelpers/PaymentIntents.d.ts +38 -0
  433. package/cjs/resources/TestHelpers/PaymentIntents.js +15 -0
  434. package/cjs/resources/TestHelpers/PaymentIntents.js.map +1 -0
  435. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +75 -0
  436. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +21 -0
  437. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
  438. package/cjs/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
  439. package/cjs/resources/TestHelpers/SharedPayment/index.js +13 -0
  440. package/cjs/resources/TestHelpers/SharedPayment/index.js.map +1 -0
  441. package/cjs/resources/TestHelpers/Terminal/Readers.d.ts +15 -1
  442. package/cjs/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
  443. package/cjs/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
  444. package/cjs/resources/TestHelpers/index.d.ts +14 -6
  445. package/cjs/resources/TestHelpers/index.js +12 -6
  446. package/cjs/resources/TestHelpers/index.js.map +1 -1
  447. package/cjs/resources/Tokens.d.ts +84 -2
  448. package/cjs/resources/Topups.d.ts +4 -4
  449. package/cjs/resources/Topups.js.map +1 -1
  450. package/cjs/resources/Transfers.d.ts +14 -2
  451. package/cjs/resources/Transfers.js.map +1 -1
  452. package/cjs/resources/TransitBalances.d.ts +25 -0
  453. package/cjs/resources/TransitBalances.js +4 -0
  454. package/cjs/resources/TransitBalances.js.map +1 -0
  455. package/cjs/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
  456. package/cjs/resources/Treasury/FinancialAccounts.d.ts +34 -1
  457. package/cjs/resources/Treasury/OutboundPayments.d.ts +8 -0
  458. package/cjs/resources/Treasury/OutboundTransfers.d.ts +44 -0
  459. package/cjs/resources/Treasury/ReceivedCredits.d.ts +22 -0
  460. package/cjs/resources/Treasury/ReceivedDebits.d.ts +26 -0
  461. package/cjs/resources/V2/Billing/BillSettingVersions.d.ts +72 -0
  462. package/cjs/resources/V2/Billing/BillSettingVersions.js +4 -0
  463. package/cjs/resources/V2/Billing/BillSettingVersions.js.map +1 -0
  464. package/cjs/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
  465. package/cjs/resources/V2/Billing/BillSettings/Versions.js +23 -0
  466. package/cjs/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
  467. package/cjs/resources/V2/Billing/BillSettings.d.ts +281 -0
  468. package/cjs/resources/V2/Billing/BillSettings.js +41 -0
  469. package/cjs/resources/V2/Billing/BillSettings.js.map +1 -0
  470. package/cjs/resources/V2/Billing/CadenceSpendModifiers.d.ts +84 -0
  471. package/cjs/resources/V2/Billing/CadenceSpendModifiers.js +4 -0
  472. package/cjs/resources/V2/Billing/CadenceSpendModifiers.js.map +1 -0
  473. package/cjs/resources/V2/Billing/Cadences/SpendModifierRules.d.ts +37 -0
  474. package/cjs/resources/V2/Billing/Cadences/SpendModifierRules.js +23 -0
  475. package/cjs/resources/V2/Billing/Cadences/SpendModifierRules.js.map +1 -0
  476. package/cjs/resources/V2/Billing/Cadences.d.ts +1011 -0
  477. package/cjs/resources/V2/Billing/Cadences.js +264 -0
  478. package/cjs/resources/V2/Billing/Cadences.js.map +1 -0
  479. package/cjs/resources/V2/Billing/CollectionSettingVersions.d.ts +237 -0
  480. package/cjs/resources/V2/Billing/CollectionSettingVersions.js +4 -0
  481. package/cjs/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
  482. package/cjs/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
  483. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +70 -0
  484. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
  485. package/cjs/resources/V2/Billing/CollectionSettings.d.ts +776 -0
  486. package/cjs/resources/V2/Billing/CollectionSettings.js +166 -0
  487. package/cjs/resources/V2/Billing/CollectionSettings.js.map +1 -0
  488. package/cjs/resources/V2/Billing/ContractPricingLineQuantityChanges.d.ts +47 -0
  489. package/cjs/resources/V2/Billing/ContractPricingLineQuantityChanges.js +4 -0
  490. package/cjs/resources/V2/Billing/ContractPricingLineQuantityChanges.js.map +1 -0
  491. package/cjs/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.d.ts +23 -0
  492. package/cjs/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.js +29 -0
  493. package/cjs/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.js.map +1 -0
  494. package/cjs/resources/V2/Billing/Contracts/PricingLines.d.ts +8 -0
  495. package/cjs/resources/V2/Billing/Contracts/PricingLines.js +15 -0
  496. package/cjs/resources/V2/Billing/Contracts/PricingLines.js.map +1 -0
  497. package/cjs/resources/V2/Billing/Contracts.d.ts +1512 -0
  498. package/cjs/resources/V2/Billing/Contracts.js +331 -0
  499. package/cjs/resources/V2/Billing/Contracts.js.map +1 -0
  500. package/cjs/resources/V2/Billing/CustomPricingUnits.d.ts +125 -0
  501. package/cjs/resources/V2/Billing/CustomPricingUnits.js +35 -0
  502. package/cjs/resources/V2/Billing/CustomPricingUnits.js.map +1 -0
  503. package/cjs/resources/V2/Billing/IntentActions.d.ts +603 -0
  504. package/cjs/resources/V2/Billing/IntentActions.js +4 -0
  505. package/cjs/resources/V2/Billing/IntentActions.js.map +1 -0
  506. package/cjs/resources/V2/Billing/Intents/Actions.d.ts +33 -0
  507. package/cjs/resources/V2/Billing/Intents/Actions.js +70 -0
  508. package/cjs/resources/V2/Billing/Intents/Actions.js.map +1 -0
  509. package/cjs/resources/V2/Billing/Intents.d.ts +1261 -0
  510. package/cjs/resources/V2/Billing/Intents.js +87 -0
  511. package/cjs/resources/V2/Billing/Intents.js.map +1 -0
  512. package/cjs/resources/V2/Billing/LicenseFeeVersions.d.ts +78 -0
  513. package/cjs/resources/V2/Billing/LicenseFeeVersions.js +4 -0
  514. package/cjs/resources/V2/Billing/LicenseFeeVersions.js.map +1 -0
  515. package/cjs/resources/V2/Billing/LicenseFees/Versions.d.ts +33 -0
  516. package/cjs/resources/V2/Billing/LicenseFees/Versions.js +64 -0
  517. package/cjs/resources/V2/Billing/LicenseFees/Versions.js.map +1 -0
  518. package/cjs/resources/V2/Billing/LicenseFees.d.ts +360 -0
  519. package/cjs/resources/V2/Billing/LicenseFees.js +148 -0
  520. package/cjs/resources/V2/Billing/LicenseFees.js.map +1 -0
  521. package/cjs/resources/V2/Billing/LicensedItems.d.ts +170 -0
  522. package/cjs/resources/V2/Billing/LicensedItems.js +35 -0
  523. package/cjs/resources/V2/Billing/LicensedItems.js.map +1 -0
  524. package/cjs/resources/V2/Billing/MeteredItems.d.ts +218 -0
  525. package/cjs/resources/V2/Billing/MeteredItems.js +35 -0
  526. package/cjs/resources/V2/Billing/MeteredItems.js.map +1 -0
  527. package/cjs/resources/V2/Billing/OneTimeItems.d.ts +170 -0
  528. package/cjs/resources/V2/Billing/OneTimeItems.js +35 -0
  529. package/cjs/resources/V2/Billing/OneTimeItems.js.map +1 -0
  530. package/cjs/resources/V2/Billing/PricingPlanComponents.d.ts +80 -0
  531. package/cjs/resources/V2/Billing/PricingPlanComponents.js +4 -0
  532. package/cjs/resources/V2/Billing/PricingPlanComponents.js.map +1 -0
  533. package/cjs/resources/V2/Billing/PricingPlanSubscriptions.d.ts +620 -0
  534. package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +296 -0
  535. package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js.map +1 -0
  536. package/cjs/resources/V2/Billing/PricingPlanVersions.d.ts +30 -0
  537. package/cjs/resources/V2/Billing/PricingPlanVersions.js +4 -0
  538. package/cjs/resources/V2/Billing/PricingPlanVersions.js.map +1 -0
  539. package/cjs/resources/V2/Billing/PricingPlans/Components.d.ts +142 -0
  540. package/cjs/resources/V2/Billing/PricingPlans/Components.js +41 -0
  541. package/cjs/resources/V2/Billing/PricingPlans/Components.js.map +1 -0
  542. package/cjs/resources/V2/Billing/PricingPlans/Versions.d.ts +33 -0
  543. package/cjs/resources/V2/Billing/PricingPlans/Versions.js +23 -0
  544. package/cjs/resources/V2/Billing/PricingPlans/Versions.js.map +1 -0
  545. package/cjs/resources/V2/Billing/PricingPlans.d.ts +169 -0
  546. package/cjs/resources/V2/Billing/PricingPlans.js +43 -0
  547. package/cjs/resources/V2/Billing/PricingPlans.js.map +1 -0
  548. package/cjs/resources/V2/Billing/Profiles.d.ts +162 -0
  549. package/cjs/resources/V2/Billing/Profiles.js +35 -0
  550. package/cjs/resources/V2/Billing/Profiles.js.map +1 -0
  551. package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.d.ts +45 -0
  552. package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js +4 -0
  553. package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js.map +1 -0
  554. package/cjs/resources/V2/Billing/RateCardRates.d.ts +111 -0
  555. package/cjs/resources/V2/Billing/RateCardRates.js +4 -0
  556. package/cjs/resources/V2/Billing/RateCardRates.js.map +1 -0
  557. package/cjs/resources/V2/Billing/RateCardSubscriptions.d.ts +215 -0
  558. package/cjs/resources/V2/Billing/RateCardSubscriptions.js +41 -0
  559. package/cjs/resources/V2/Billing/RateCardSubscriptions.js.map +1 -0
  560. package/cjs/resources/V2/Billing/RateCardVersions.d.ts +22 -0
  561. package/cjs/resources/V2/Billing/RateCardVersions.js +4 -0
  562. package/cjs/resources/V2/Billing/RateCardVersions.js.map +1 -0
  563. package/cjs/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.d.ts +79 -0
  564. package/cjs/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js +35 -0
  565. package/cjs/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js.map +1 -0
  566. package/cjs/resources/V2/Billing/RateCards/Rates.d.ts +145 -0
  567. package/cjs/resources/V2/Billing/RateCards/Rates.js +110 -0
  568. package/cjs/resources/V2/Billing/RateCards/Rates.js.map +1 -0
  569. package/cjs/resources/V2/Billing/RateCards/Versions.d.ts +33 -0
  570. package/cjs/resources/V2/Billing/RateCards/Versions.js +23 -0
  571. package/cjs/resources/V2/Billing/RateCards/Versions.js.map +1 -0
  572. package/cjs/resources/V2/Billing/RateCards.d.ts +336 -0
  573. package/cjs/resources/V2/Billing/RateCards.js +76 -0
  574. package/cjs/resources/V2/Billing/RateCards.js.map +1 -0
  575. package/cjs/resources/V2/Billing/ServiceActions.d.ts +510 -0
  576. package/cjs/resources/V2/Billing/ServiceActions.js +162 -0
  577. package/cjs/resources/V2/Billing/ServiceActions.js.map +1 -0
  578. package/cjs/resources/V2/Billing/index.d.ts +175 -6
  579. package/cjs/resources/V2/Billing/index.js +32 -0
  580. package/cjs/resources/V2/Billing/index.js.map +1 -1
  581. package/cjs/resources/V2/Core/AccountEvaluations.d.ts +159 -0
  582. package/cjs/resources/V2/Core/AccountEvaluations.js +15 -0
  583. package/cjs/resources/V2/Core/AccountEvaluations.js.map +1 -0
  584. package/cjs/resources/V2/Core/AccountLinks.d.ts +158 -6
  585. package/cjs/resources/V2/Core/AccountPersons.d.ts +1 -1
  586. package/cjs/resources/V2/Core/AccountTokens.d.ts +220 -2
  587. package/cjs/resources/V2/Core/Accounts/PersonTokens.d.ts +1 -1
  588. package/cjs/resources/V2/Core/Accounts/Persons.d.ts +2 -2
  589. package/cjs/resources/V2/Core/Accounts.d.ts +16131 -1984
  590. package/cjs/resources/V2/Core/Accounts.js +10379 -53
  591. package/cjs/resources/V2/Core/Accounts.js.map +1 -1
  592. package/cjs/resources/V2/Core/ApprovalRequests.d.ts +331 -0
  593. package/cjs/resources/V2/Core/ApprovalRequests.js +46 -0
  594. package/cjs/resources/V2/Core/ApprovalRequests.js.map +1 -0
  595. package/cjs/resources/V2/Core/BatchJobs.d.ts +360 -0
  596. package/cjs/resources/V2/Core/BatchJobs.js +225 -0
  597. package/cjs/resources/V2/Core/BatchJobs.js.map +1 -0
  598. package/cjs/resources/V2/Core/ClaimableSandboxes.d.ts +225 -0
  599. package/cjs/resources/V2/Core/ClaimableSandboxes.js +31 -0
  600. package/cjs/resources/V2/Core/ClaimableSandboxes.js.map +1 -0
  601. package/cjs/resources/V2/Core/ConnectionSessions.d.ts +86 -0
  602. package/cjs/resources/V2/Core/ConnectionSessions.js +21 -0
  603. package/cjs/resources/V2/Core/ConnectionSessions.js.map +1 -0
  604. package/cjs/resources/V2/Core/Events.d.ts +8083 -223
  605. package/cjs/resources/V2/Core/FeeBatches.d.ts +234 -0
  606. package/cjs/resources/V2/Core/FeeBatches.js +23 -0
  607. package/cjs/resources/V2/Core/FeeBatches.js.map +1 -0
  608. package/cjs/resources/V2/Core/FeeEntries.d.ts +200 -0
  609. package/cjs/resources/V2/Core/FeeEntries.js +23 -0
  610. package/cjs/resources/V2/Core/FeeEntries.js.map +1 -0
  611. package/cjs/resources/V2/Core/Health/AlertHistoryEntries.d.ts +423 -0
  612. package/cjs/resources/V2/Core/Health/AlertHistoryEntries.js +4 -0
  613. package/cjs/resources/V2/Core/Health/AlertHistoryEntries.js.map +1 -0
  614. package/cjs/resources/V2/Core/Health/Alerts/History.d.ts +23 -0
  615. package/cjs/resources/V2/Core/Health/Alerts/History.js +101 -0
  616. package/cjs/resources/V2/Core/Health/Alerts/History.js.map +1 -0
  617. package/cjs/resources/V2/Core/Health/Alerts.d.ts +537 -0
  618. package/cjs/resources/V2/Core/Health/Alerts.js +182 -0
  619. package/cjs/resources/V2/Core/Health/Alerts.js.map +1 -0
  620. package/cjs/resources/V2/Core/Health/index.d.ts +16 -0
  621. package/cjs/resources/V2/Core/Health/index.js +13 -0
  622. package/cjs/resources/V2/Core/Health/index.js.map +1 -0
  623. package/cjs/resources/V2/Core/Vault/GbBankAccounts.d.ts +280 -0
  624. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +54 -0
  625. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
  626. package/cjs/resources/V2/Core/Vault/UsBankAccounts.d.ts +252 -0
  627. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +65 -0
  628. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
  629. package/cjs/resources/V2/Core/Vault/index.d.ts +28 -0
  630. package/cjs/resources/V2/Core/Vault/index.js +15 -0
  631. package/cjs/resources/V2/Core/Vault/index.js.map +1 -0
  632. package/cjs/resources/V2/Core/index.d.ts +66 -14
  633. package/cjs/resources/V2/Core/index.js +18 -0
  634. package/cjs/resources/V2/Core/index.js.map +1 -1
  635. package/cjs/resources/V2/Data/Analytics/MetricQuery.d.ts +74 -0
  636. package/cjs/resources/V2/Data/Analytics/MetricQuery.js +36 -0
  637. package/cjs/resources/V2/Data/Analytics/MetricQuery.js.map +1 -0
  638. package/cjs/resources/V2/Data/Analytics/MetricQueryResults.d.ts +76 -0
  639. package/cjs/resources/V2/Data/Analytics/MetricQueryResults.js +4 -0
  640. package/cjs/resources/V2/Data/Analytics/MetricQueryResults.js.map +1 -0
  641. package/cjs/resources/V2/Data/Analytics/index.d.ts +12 -0
  642. package/cjs/resources/V2/Data/Analytics/index.js +13 -0
  643. package/cjs/resources/V2/Data/Analytics/index.js.map +1 -0
  644. package/cjs/resources/V2/Data/Reporting/QueryRuns.d.ts +172 -0
  645. package/cjs/resources/V2/Data/Reporting/QueryRuns.js +46 -0
  646. package/cjs/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
  647. package/cjs/resources/V2/Data/Reporting/index.d.ts +13 -0
  648. package/cjs/resources/V2/Data/Reporting/index.js +13 -0
  649. package/cjs/resources/V2/Data/Reporting/index.js.map +1 -0
  650. package/cjs/resources/V2/Data/index.d.ts +13 -0
  651. package/cjs/resources/V2/Data/index.js +15 -0
  652. package/cjs/resources/V2/Data/index.js.map +1 -0
  653. package/cjs/resources/V2/Extend/WorkflowRuns.d.ts +163 -0
  654. package/cjs/resources/V2/Extend/WorkflowRuns.js +23 -0
  655. package/cjs/resources/V2/Extend/WorkflowRuns.js.map +1 -0
  656. package/cjs/resources/V2/Extend/Workflows.d.ts +120 -0
  657. package/cjs/resources/V2/Extend/Workflows.js +30 -0
  658. package/cjs/resources/V2/Extend/Workflows.js.map +1 -0
  659. package/cjs/resources/V2/Extend/index.d.ts +20 -0
  660. package/cjs/resources/V2/Extend/index.js +15 -0
  661. package/cjs/resources/V2/Extend/index.js.map +1 -0
  662. package/cjs/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
  663. package/cjs/resources/V2/FinancialAddressCreditSimulations.js +4 -0
  664. package/cjs/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
  665. package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
  666. package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js +4 -0
  667. package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
  668. package/cjs/resources/V2/Iam/ActivityLogs.d.ts +218 -0
  669. package/cjs/resources/V2/Iam/ActivityLogs.js +23 -0
  670. package/cjs/resources/V2/Iam/ActivityLogs.js.map +1 -0
  671. package/cjs/resources/V2/Iam/ApiKeys.d.ts +305 -0
  672. package/cjs/resources/V2/Iam/ApiKeys.js +47 -0
  673. package/cjs/resources/V2/Iam/ApiKeys.js.map +1 -0
  674. package/cjs/resources/V2/Iam/index.d.ts +23 -0
  675. package/cjs/resources/V2/Iam/index.js +15 -0
  676. package/cjs/resources/V2/Iam/index.js.map +1 -0
  677. package/cjs/resources/V2/MoneyManagement/Adjustments.d.ts +135 -0
  678. package/cjs/resources/V2/MoneyManagement/Adjustments.js +23 -0
  679. package/cjs/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
  680. package/cjs/resources/V2/MoneyManagement/CurrencyConversions.d.ts +131 -0
  681. package/cjs/resources/V2/MoneyManagement/CurrencyConversions.js +31 -0
  682. package/cjs/resources/V2/MoneyManagement/CurrencyConversions.js.map +1 -0
  683. package/cjs/resources/V2/MoneyManagement/DebitDisputes.d.ts +169 -0
  684. package/cjs/resources/V2/MoneyManagement/DebitDisputes.js +29 -0
  685. package/cjs/resources/V2/MoneyManagement/DebitDisputes.js.map +1 -0
  686. package/cjs/resources/V2/MoneyManagement/FinancialAccountStatements.d.ts +99 -0
  687. package/cjs/resources/V2/MoneyManagement/FinancialAccountStatements.js +4 -0
  688. package/cjs/resources/V2/MoneyManagement/FinancialAccountStatements.js.map +1 -0
  689. package/cjs/resources/V2/MoneyManagement/FinancialAccounts/Statements.d.ts +49 -0
  690. package/cjs/resources/V2/MoneyManagement/FinancialAccounts/Statements.js +53 -0
  691. package/cjs/resources/V2/MoneyManagement/FinancialAccounts/Statements.js.map +1 -0
  692. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.d.ts +438 -0
  693. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +50 -0
  694. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
  695. package/cjs/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.d.ts +14 -0
  696. package/cjs/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.js +4 -0
  697. package/cjs/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.js.map +1 -0
  698. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.d.ts +304 -0
  699. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +31 -0
  700. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
  701. package/cjs/resources/V2/MoneyManagement/InboundTransfers.d.ts +251 -0
  702. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +30 -0
  703. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
  704. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +329 -0
  705. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +22 -0
  706. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
  707. package/cjs/resources/V2/MoneyManagement/OutboundPayments.d.ts +638 -0
  708. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +41 -0
  709. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
  710. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +318 -0
  711. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +49 -0
  712. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
  713. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.d.ts +394 -0
  714. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +39 -0
  715. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
  716. package/cjs/resources/V2/MoneyManagement/PayoutIntents.d.ts +648 -0
  717. package/cjs/resources/V2/MoneyManagement/PayoutIntents.js +57 -0
  718. package/cjs/resources/V2/MoneyManagement/PayoutIntents.js.map +1 -0
  719. package/cjs/resources/V2/MoneyManagement/PayoutMethods.d.ts +277 -0
  720. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +44 -0
  721. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
  722. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +92 -0
  723. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +17 -0
  724. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
  725. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.d.ts +481 -0
  726. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +23 -0
  727. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
  728. package/cjs/resources/V2/MoneyManagement/ReceivedDebitMandates.d.ts +166 -0
  729. package/cjs/resources/V2/MoneyManagement/ReceivedDebitMandates.js +29 -0
  730. package/cjs/resources/V2/MoneyManagement/ReceivedDebitMandates.js.map +1 -0
  731. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.d.ts +308 -0
  732. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +23 -0
  733. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
  734. package/cjs/resources/V2/MoneyManagement/RecipientVerifications.d.ts +116 -0
  735. package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js +27 -0
  736. package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js.map +1 -0
  737. package/cjs/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.d.ts +34 -0
  738. package/cjs/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.js +15 -0
  739. package/cjs/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.js.map +1 -0
  740. package/cjs/resources/V2/MoneyManagement/TestHelpers/index.d.ts +8 -0
  741. package/cjs/resources/V2/MoneyManagement/TestHelpers/index.js +13 -0
  742. package/cjs/resources/V2/MoneyManagement/TestHelpers/index.js.map +1 -0
  743. package/cjs/resources/V2/MoneyManagement/TransactionEntries.d.ts +266 -0
  744. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +23 -0
  745. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
  746. package/cjs/resources/V2/MoneyManagement/Transactions.d.ts +321 -0
  747. package/cjs/resources/V2/MoneyManagement/Transactions.js +29 -0
  748. package/cjs/resources/V2/MoneyManagement/Transactions.js.map +1 -0
  749. package/cjs/resources/V2/MoneyManagement/index.d.ts +153 -0
  750. package/cjs/resources/V2/MoneyManagement/index.js +51 -0
  751. package/cjs/resources/V2/MoneyManagement/index.js.map +1 -0
  752. package/cjs/resources/V2/Network/BusinessProfiles.d.ts +92 -0
  753. package/cjs/resources/V2/Network/BusinessProfiles.js +21 -0
  754. package/cjs/resources/V2/Network/BusinessProfiles.js.map +1 -0
  755. package/cjs/resources/V2/Network/index.d.ts +13 -0
  756. package/cjs/resources/V2/Network/index.js +13 -0
  757. package/cjs/resources/V2/Network/index.js.map +1 -0
  758. package/cjs/resources/V2/OrchestratedCommerce/Agreements.d.ts +143 -0
  759. package/cjs/resources/V2/OrchestratedCommerce/Agreements.js +41 -0
  760. package/cjs/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
  761. package/cjs/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
  762. package/cjs/resources/V2/OrchestratedCommerce/index.js +13 -0
  763. package/cjs/resources/V2/OrchestratedCommerce/index.js.map +1 -0
  764. package/cjs/resources/V2/Payments/OffSessionPayments.d.ts +835 -0
  765. package/cjs/resources/V2/Payments/OffSessionPayments.js +53 -0
  766. package/cjs/resources/V2/Payments/OffSessionPayments.js.map +1 -0
  767. package/cjs/resources/V2/Payments/SettlementAllocationIntentSplits.d.ts +73 -0
  768. package/cjs/resources/V2/Payments/SettlementAllocationIntentSplits.js +4 -0
  769. package/cjs/resources/V2/Payments/SettlementAllocationIntentSplits.js.map +1 -0
  770. package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.d.ts +85 -0
  771. package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js +35 -0
  772. package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js.map +1 -0
  773. package/cjs/resources/V2/Payments/SettlementAllocationIntents.d.ts +209 -0
  774. package/cjs/resources/V2/Payments/SettlementAllocationIntents.js +53 -0
  775. package/cjs/resources/V2/Payments/SettlementAllocationIntents.js.map +1 -0
  776. package/cjs/resources/V2/Payments/index.d.ts +31 -0
  777. package/cjs/resources/V2/Payments/index.js +15 -0
  778. package/cjs/resources/V2/Payments/index.js.map +1 -0
  779. package/cjs/resources/V2/Reporting/ReportRuns.d.ts +191 -0
  780. package/cjs/resources/V2/Reporting/ReportRuns.js +50 -0
  781. package/cjs/resources/V2/Reporting/ReportRuns.js.map +1 -0
  782. package/cjs/resources/V2/Reporting/Reports.d.ts +106 -0
  783. package/cjs/resources/V2/Reporting/Reports.js +17 -0
  784. package/cjs/resources/V2/Reporting/Reports.js.map +1 -0
  785. package/cjs/resources/V2/Reporting/index.d.ts +18 -0
  786. package/cjs/resources/V2/Reporting/index.js +15 -0
  787. package/cjs/resources/V2/Reporting/index.js.map +1 -0
  788. package/cjs/resources/V2/Risk/Inquiries.d.ts +143 -0
  789. package/cjs/resources/V2/Risk/Inquiries.js +29 -0
  790. package/cjs/resources/V2/Risk/Inquiries.js.map +1 -0
  791. package/cjs/resources/V2/Risk/index.d.ts +14 -0
  792. package/cjs/resources/V2/Risk/index.js +13 -0
  793. package/cjs/resources/V2/Risk/index.js.map +1 -0
  794. package/cjs/resources/V2/Signals/AccountActivity.d.ts +424 -0
  795. package/cjs/resources/V2/Signals/AccountActivity.js +27 -0
  796. package/cjs/resources/V2/Signals/AccountActivity.js.map +1 -0
  797. package/cjs/resources/V2/Signals/AccountEvaluations.d.ts +396 -0
  798. package/cjs/resources/V2/Signals/AccountEvaluations.js +59 -0
  799. package/cjs/resources/V2/Signals/AccountEvaluations.js.map +1 -0
  800. package/cjs/resources/V2/Signals/AccountSignals.d.ts +281 -0
  801. package/cjs/resources/V2/Signals/AccountSignals.js +110 -0
  802. package/cjs/resources/V2/Signals/AccountSignals.js.map +1 -0
  803. package/cjs/resources/V2/Signals/index.d.ts +26 -0
  804. package/cjs/resources/V2/Signals/index.js +17 -0
  805. package/cjs/resources/V2/Signals/index.js.map +1 -0
  806. package/cjs/resources/V2/Tax/ManualRules.d.ts +331 -0
  807. package/cjs/resources/V2/Tax/ManualRules.js +193 -0
  808. package/cjs/resources/V2/Tax/ManualRules.js.map +1 -0
  809. package/cjs/resources/V2/Tax/Operations.d.ts +43 -0
  810. package/cjs/resources/V2/Tax/Operations.js +15 -0
  811. package/cjs/resources/V2/Tax/Operations.js.map +1 -0
  812. package/cjs/resources/V2/Tax/OperationsResolveAddressResults.d.ts +68 -0
  813. package/cjs/resources/V2/Tax/OperationsResolveAddressResults.js +4 -0
  814. package/cjs/resources/V2/Tax/OperationsResolveAddressResults.js.map +1 -0
  815. package/cjs/resources/V2/Tax/index.d.ts +21 -0
  816. package/cjs/resources/V2/Tax/index.js +15 -0
  817. package/cjs/resources/V2/Tax/index.js.map +1 -0
  818. package/cjs/resources/V2/TestHelpers/FinancialAddresses.d.ts +45 -0
  819. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +23 -0
  820. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
  821. package/cjs/resources/V2/TestHelpers/MoneyManagement.d.ts +31 -0
  822. package/cjs/resources/V2/TestHelpers/MoneyManagement.js +15 -0
  823. package/cjs/resources/V2/TestHelpers/MoneyManagement.js.map +1 -0
  824. package/cjs/resources/V2/TestHelpers/index.d.ts +10 -0
  825. package/cjs/resources/V2/TestHelpers/index.js +15 -0
  826. package/cjs/resources/V2/TestHelpers/index.js.map +1 -0
  827. package/cjs/resources/V2/index.d.ts +42 -0
  828. package/cjs/resources/V2/index.js +24 -0
  829. package/cjs/resources/V2/index.js.map +1 -1
  830. package/cjs/resources/WebhookEndpoints.d.ts +3 -3
  831. package/cjs/resources.d.ts +20 -0
  832. package/cjs/resources.js +296 -18
  833. package/cjs/resources.js.map +1 -1
  834. package/cjs/stripe.cjs.node.d.ts +17320 -2862
  835. package/cjs/stripe.cjs.node.js.map +1 -1
  836. package/cjs/stripe.core.d.ts +163 -54
  837. package/cjs/stripe.core.js +74 -31
  838. package/cjs/stripe.core.js.map +1 -1
  839. package/esm/Error.d.ts +61 -0
  840. package/esm/Error.js +125 -0
  841. package/esm/Error.js.map +1 -1
  842. package/esm/RequestSender.d.ts +1 -1
  843. package/esm/RequestSender.js +14 -5
  844. package/esm/RequestSender.js.map +1 -1
  845. package/esm/StripeEventNotificationHandler.d.ts +19 -0
  846. package/esm/StripeEventNotificationHandler.js +501 -0
  847. package/esm/StripeEventNotificationHandler.js.map +1 -0
  848. package/esm/Types.d.ts +9 -2
  849. package/esm/Types.js.map +1 -1
  850. package/esm/apiVersion.d.ts +2 -2
  851. package/esm/apiVersion.js +2 -2
  852. package/esm/apiVersion.js.map +1 -1
  853. package/esm/resources/AccountLinks.d.ts +8 -4
  854. package/esm/resources/AccountNotices.d.ts +140 -0
  855. package/esm/resources/AccountNotices.js +25 -0
  856. package/esm/resources/AccountNotices.js.map +1 -0
  857. package/esm/resources/AccountSessions.d.ts +564 -0
  858. package/esm/resources/AccountSessions.js.map +1 -1
  859. package/esm/resources/AccountSignals.d.ts +111 -0
  860. package/esm/resources/AccountSignals.js +3 -0
  861. package/esm/resources/AccountSignals.js.map +1 -0
  862. package/esm/resources/Accounts.d.ts +1143 -85
  863. package/esm/resources/Accounts.js +47 -0
  864. package/esm/resources/Accounts.js.map +1 -1
  865. package/esm/resources/ApplicationFees.d.ts +28 -1
  866. package/esm/resources/Balance.d.ts +134 -0
  867. package/esm/resources/BalanceSettings.d.ts +18 -0
  868. package/esm/resources/BalanceTransactions.d.ts +2 -2
  869. package/esm/resources/BalanceTransfers.d.ts +160 -0
  870. package/esm/resources/BalanceTransfers.js +11 -0
  871. package/esm/resources/BalanceTransfers.js.map +1 -0
  872. package/esm/resources/BankAccounts.d.ts +4 -4
  873. package/esm/resources/Billing/AlertNotifications.d.ts +75 -0
  874. package/esm/resources/Billing/AlertNotifications.js +3 -0
  875. package/esm/resources/Billing/AlertNotifications.js.map +1 -0
  876. package/esm/resources/Billing/AlertRecovereds.d.ts +56 -0
  877. package/esm/resources/Billing/AlertRecovereds.js +3 -0
  878. package/esm/resources/Billing/AlertRecovereds.js.map +1 -0
  879. package/esm/resources/Billing/AlertTriggereds.d.ts +55 -1
  880. package/esm/resources/Billing/Alerts.d.ts +448 -5
  881. package/esm/resources/Billing/Alerts.js +329 -5
  882. package/esm/resources/Billing/Alerts.js.map +1 -1
  883. package/esm/resources/Billing/Analytics/MeterUsage.d.ts +89 -0
  884. package/esm/resources/Billing/Analytics/MeterUsage.js +11 -0
  885. package/esm/resources/Billing/Analytics/MeterUsage.js.map +1 -0
  886. package/esm/resources/Billing/Analytics/MeterUsageRows.d.ts +38 -0
  887. package/esm/resources/Billing/Analytics/MeterUsageRows.js +3 -0
  888. package/esm/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
  889. package/esm/resources/Billing/Analytics/index.d.ts +15 -0
  890. package/esm/resources/Billing/Analytics/index.js +9 -0
  891. package/esm/resources/Billing/Analytics/index.js.map +1 -0
  892. package/esm/resources/Billing/CreditBalanceSummary.d.ts +136 -3
  893. package/esm/resources/Billing/CreditBalanceSummary.js +39 -1
  894. package/esm/resources/Billing/CreditBalanceSummary.js.map +1 -1
  895. package/esm/resources/Billing/CreditBalanceTransactions.d.ts +97 -3
  896. package/esm/resources/Billing/CreditBalanceTransactions.js +100 -1
  897. package/esm/resources/Billing/CreditBalanceTransactions.js.map +1 -1
  898. package/esm/resources/Billing/CreditGrants.d.ts +105 -3
  899. package/esm/resources/Billing/CreditGrants.js +134 -5
  900. package/esm/resources/Billing/CreditGrants.js.map +1 -1
  901. package/esm/resources/Billing/FeedbackOptions.d.ts +32 -0
  902. package/esm/resources/Billing/FeedbackOptions.js +3 -0
  903. package/esm/resources/Billing/FeedbackOptions.js.map +1 -0
  904. package/esm/resources/Billing/MeterEventSummaries.d.ts +6 -0
  905. package/esm/resources/Billing/Meters.d.ts +31 -0
  906. package/esm/resources/Billing/index.d.ts +13 -0
  907. package/esm/resources/Billing/index.js +2 -0
  908. package/esm/resources/Billing/index.js.map +1 -1
  909. package/esm/resources/BillingPortal/Configurations.d.ts +14 -9
  910. package/esm/resources/BillingPortal/Configurations.js.map +1 -1
  911. package/esm/resources/BillingPortal/Sessions.d.ts +17 -1
  912. package/esm/resources/Capabilities.d.ts +25 -2
  913. package/esm/resources/Capital/FinancingOffers.d.ts +194 -0
  914. package/esm/resources/Capital/FinancingOffers.js +26 -0
  915. package/esm/resources/Capital/FinancingOffers.js.map +1 -0
  916. package/esm/resources/Capital/FinancingSummary.d.ts +102 -0
  917. package/esm/resources/Capital/FinancingSummary.js +11 -0
  918. package/esm/resources/Capital/FinancingSummary.js.map +1 -0
  919. package/esm/resources/Capital/FinancingTransactions.d.ts +141 -0
  920. package/esm/resources/Capital/FinancingTransactions.js +20 -0
  921. package/esm/resources/Capital/FinancingTransactions.js.map +1 -0
  922. package/esm/resources/Capital/index.d.ts +25 -0
  923. package/esm/resources/Capital/index.js +13 -0
  924. package/esm/resources/Capital/index.js.map +1 -0
  925. package/esm/resources/Cards.d.ts +29 -1
  926. package/esm/resources/CashBalances.d.ts +2 -1
  927. package/esm/resources/Charges.d.ts +3382 -85
  928. package/esm/resources/Charges.js.map +1 -1
  929. package/esm/resources/Checkout/Sessions.d.ts +1224 -43
  930. package/esm/resources/Checkout/Sessions.js +115 -0
  931. package/esm/resources/Checkout/Sessions.js.map +1 -1
  932. package/esm/resources/Checkout/index.d.ts +1 -0
  933. package/esm/resources/Climate/Orders.d.ts +1 -1
  934. package/esm/resources/Climate/Products.d.ts +1 -1
  935. package/esm/resources/ConfirmationTokens.d.ts +153 -8
  936. package/esm/resources/ConfirmationTokens.js.map +1 -1
  937. package/esm/resources/Coupons.d.ts +128 -2
  938. package/esm/resources/Coupons.js +41 -0
  939. package/esm/resources/Coupons.js.map +1 -1
  940. package/esm/resources/CreditNoteLineItems.d.ts +17 -3
  941. package/esm/resources/CreditNotes.d.ts +12 -6
  942. package/esm/resources/CreditNotes.js +13 -0
  943. package/esm/resources/CreditNotes.js.map +1 -1
  944. package/esm/resources/Crypto/CustomerConsumerWallets.d.ts +30 -0
  945. package/esm/resources/Crypto/CustomerConsumerWallets.js +3 -0
  946. package/esm/resources/Crypto/CustomerConsumerWallets.js.map +1 -0
  947. package/esm/resources/Crypto/CustomerPaymentTokens.d.ts +80 -0
  948. package/esm/resources/Crypto/CustomerPaymentTokens.js +3 -0
  949. package/esm/resources/Crypto/CustomerPaymentTokens.js.map +1 -0
  950. package/esm/resources/Crypto/Customers.d.ts +111 -0
  951. package/esm/resources/Crypto/Customers.js +27 -0
  952. package/esm/resources/Crypto/Customers.js.map +1 -0
  953. package/esm/resources/Crypto/DepositAddresses.d.ts +128 -0
  954. package/esm/resources/Crypto/DepositAddresses.js +27 -0
  955. package/esm/resources/Crypto/DepositAddresses.js.map +1 -0
  956. package/esm/resources/Crypto/OnrampSessions.d.ts +425 -0
  957. package/esm/resources/Crypto/OnrampSessions.js +43 -0
  958. package/esm/resources/Crypto/OnrampSessions.js.map +1 -0
  959. package/esm/resources/Crypto/OnrampTransactionLimits.d.ts +61 -0
  960. package/esm/resources/Crypto/OnrampTransactionLimits.js +11 -0
  961. package/esm/resources/Crypto/OnrampTransactionLimits.js.map +1 -0
  962. package/esm/resources/Crypto/index.d.ts +41 -0
  963. package/esm/resources/Crypto/index.js +15 -0
  964. package/esm/resources/Crypto/index.js.map +1 -0
  965. package/esm/resources/CustomerSessions.d.ts +94 -0
  966. package/esm/resources/CustomerSessions.js +13 -0
  967. package/esm/resources/CustomerSessions.js.map +1 -1
  968. package/esm/resources/Customers.d.ts +126 -12
  969. package/esm/resources/Customers.js +195 -0
  970. package/esm/resources/Customers.js.map +1 -1
  971. package/esm/resources/DelegatedCheckout/OrderEvents.d.ts +129 -0
  972. package/esm/resources/DelegatedCheckout/OrderEvents.js +3 -0
  973. package/esm/resources/DelegatedCheckout/OrderEvents.js.map +1 -0
  974. package/esm/resources/DelegatedCheckout/Orders.d.ts +159 -0
  975. package/esm/resources/DelegatedCheckout/Orders.js +11 -0
  976. package/esm/resources/DelegatedCheckout/Orders.js.map +1 -0
  977. package/esm/resources/DelegatedCheckout/RequestedSessions.d.ts +1424 -0
  978. package/esm/resources/DelegatedCheckout/RequestedSessions.js +43 -0
  979. package/esm/resources/DelegatedCheckout/RequestedSessions.js.map +1 -0
  980. package/esm/resources/DelegatedCheckout/index.d.ts +25 -0
  981. package/esm/resources/DelegatedCheckout/index.js +11 -0
  982. package/esm/resources/DelegatedCheckout/index.js.map +1 -0
  983. package/esm/resources/Discounts.d.ts +19 -0
  984. package/esm/resources/Disputes.d.ts +43 -0
  985. package/esm/resources/Disputes.js +14 -0
  986. package/esm/resources/Disputes.js.map +1 -1
  987. package/esm/resources/Events.d.ts +640 -3
  988. package/esm/resources/ExternalAccounts.d.ts +212 -1
  989. package/esm/resources/ExternalAccounts.js +42 -1
  990. package/esm/resources/ExternalAccounts.js.map +1 -1
  991. package/esm/resources/Files.d.ts +1 -1
  992. package/esm/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
  993. package/esm/resources/FinancialConnections/AccountInferredBalances.js +3 -0
  994. package/esm/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
  995. package/esm/resources/FinancialConnections/Accounts.d.ts +105 -4
  996. package/esm/resources/FinancialConnections/Accounts.js +8 -0
  997. package/esm/resources/FinancialConnections/Accounts.js.map +1 -1
  998. package/esm/resources/FinancialConnections/Authorizations.d.ts +46 -1
  999. package/esm/resources/FinancialConnections/Authorizations.js +9 -1
  1000. package/esm/resources/FinancialConnections/Authorizations.js.map +1 -1
  1001. package/esm/resources/FinancialConnections/Institutions.d.ts +99 -0
  1002. package/esm/resources/FinancialConnections/Institutions.js +19 -0
  1003. package/esm/resources/FinancialConnections/Institutions.js.map +1 -0
  1004. package/esm/resources/FinancialConnections/Sessions.d.ts +128 -9
  1005. package/esm/resources/FinancialConnections/Transactions.d.ts +76 -0
  1006. package/esm/resources/FinancialConnections/index.d.ts +21 -9
  1007. package/esm/resources/FinancialConnections/index.js +4 -0
  1008. package/esm/resources/FinancialConnections/index.js.map +1 -1
  1009. package/esm/resources/FxQuotes.d.ts +212 -0
  1010. package/esm/resources/FxQuotes.js +25 -0
  1011. package/esm/resources/FxQuotes.js.map +1 -0
  1012. package/esm/resources/GiftCardOperations.d.ts +249 -0
  1013. package/esm/resources/GiftCardOperations.js +11 -0
  1014. package/esm/resources/GiftCardOperations.js.map +1 -0
  1015. package/esm/resources/GiftCards.d.ts +181 -0
  1016. package/esm/resources/GiftCards.js +47 -0
  1017. package/esm/resources/GiftCards.js.map +1 -0
  1018. package/esm/resources/Identity/BlocklistEntries.d.ts +155 -0
  1019. package/esm/resources/Identity/BlocklistEntries.js +50 -0
  1020. package/esm/resources/Identity/BlocklistEntries.js.map +1 -0
  1021. package/esm/resources/Identity/VerificationReports.d.ts +33 -2
  1022. package/esm/resources/Identity/VerificationReports.js.map +1 -1
  1023. package/esm/resources/Identity/VerificationSessions.d.ts +11 -3
  1024. package/esm/resources/Identity/index.d.ts +18 -10
  1025. package/esm/resources/Identity/index.js +2 -0
  1026. package/esm/resources/Identity/index.js.map +1 -1
  1027. package/esm/resources/InvoiceItems.d.ts +226 -8
  1028. package/esm/resources/InvoiceItems.js +41 -0
  1029. package/esm/resources/InvoiceItems.js.map +1 -1
  1030. package/esm/resources/InvoiceLineItems.d.ts +175 -5
  1031. package/esm/resources/InvoicePayments.d.ts +1 -1
  1032. package/esm/resources/InvoiceRenderingTemplates.d.ts +15 -3
  1033. package/esm/resources/InvoiceRenderingTemplates.js +28 -0
  1034. package/esm/resources/InvoiceRenderingTemplates.js.map +1 -1
  1035. package/esm/resources/Invoices.d.ts +2211 -61
  1036. package/esm/resources/Invoices.js +221 -0
  1037. package/esm/resources/Invoices.js.map +1 -1
  1038. package/esm/resources/Issuing/Authorizations.d.ts +730 -1
  1039. package/esm/resources/Issuing/Authorizations.js.map +1 -1
  1040. package/esm/resources/Issuing/Cardholders.d.ts +40 -22
  1041. package/esm/resources/Issuing/Cards.d.ts +97 -15
  1042. package/esm/resources/Issuing/CreditUnderwritingRecords.d.ts +654 -0
  1043. package/esm/resources/Issuing/CreditUnderwritingRecords.js +49 -0
  1044. package/esm/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
  1045. package/esm/resources/Issuing/DisputeSettlementDetails.d.ts +93 -0
  1046. package/esm/resources/Issuing/DisputeSettlementDetails.js +19 -0
  1047. package/esm/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
  1048. package/esm/resources/Issuing/Disputes.d.ts +246 -0
  1049. package/esm/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
  1050. package/esm/resources/Issuing/FraudLiabilityDebits.js +19 -0
  1051. package/esm/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
  1052. package/esm/resources/Issuing/Programs.d.ts +95 -0
  1053. package/esm/resources/Issuing/Programs.js +31 -0
  1054. package/esm/resources/Issuing/Programs.js.map +1 -0
  1055. package/esm/resources/Issuing/Settlements.d.ts +83 -0
  1056. package/esm/resources/Issuing/Settlements.js +3 -0
  1057. package/esm/resources/Issuing/Settlements.js.map +1 -0
  1058. package/esm/resources/Issuing/Tokens.d.ts +26 -0
  1059. package/esm/resources/Issuing/Transactions.d.ts +233 -0
  1060. package/esm/resources/Issuing/Transactions.js.map +1 -1
  1061. package/esm/resources/Issuing/index.d.ts +56 -22
  1062. package/esm/resources/Issuing/index.js +8 -0
  1063. package/esm/resources/Issuing/index.js.map +1 -1
  1064. package/esm/resources/LineItems.d.ts +29 -2
  1065. package/esm/resources/Mandates.d.ts +49 -4
  1066. package/esm/resources/Mandates.js +8 -0
  1067. package/esm/resources/Mandates.js.map +1 -1
  1068. package/esm/resources/Margins.d.ts +115 -0
  1069. package/esm/resources/Margins.js +31 -0
  1070. package/esm/resources/Margins.js.map +1 -0
  1071. package/esm/resources/Orchestration/PaymentAttempts.d.ts +34 -0
  1072. package/esm/resources/Orchestration/PaymentAttempts.js +11 -0
  1073. package/esm/resources/Orchestration/PaymentAttempts.js.map +1 -0
  1074. package/esm/resources/Orchestration/index.d.ts +12 -0
  1075. package/esm/resources/Orchestration/index.js +9 -0
  1076. package/esm/resources/Orchestration/index.js.map +1 -0
  1077. package/esm/resources/Orders.d.ts +4773 -0
  1078. package/esm/resources/Orders.js +453 -0
  1079. package/esm/resources/Orders.js.map +1 -0
  1080. package/esm/resources/PaymentAttemptRecords.d.ts +696 -19
  1081. package/esm/resources/PaymentAttemptRecords.js +48 -0
  1082. package/esm/resources/PaymentAttemptRecords.js.map +1 -1
  1083. package/esm/resources/PaymentIntentAmountDetailsLineItems.d.ts +52 -0
  1084. package/esm/resources/PaymentIntents.d.ts +17309 -3551
  1085. package/esm/resources/PaymentIntents.js +46 -0
  1086. package/esm/resources/PaymentIntents.js.map +1 -1
  1087. package/esm/resources/PaymentLinks.d.ts +84 -22
  1088. package/esm/resources/PaymentLocationCapabilities.d.ts +123 -0
  1089. package/esm/resources/PaymentLocationCapabilities.js +25 -0
  1090. package/esm/resources/PaymentLocationCapabilities.js.map +1 -0
  1091. package/esm/resources/PaymentLocations.d.ts +178 -0
  1092. package/esm/resources/PaymentLocations.js +37 -0
  1093. package/esm/resources/PaymentLocations.js.map +1 -0
  1094. package/esm/resources/PaymentMethodBalances.d.ts +46 -0
  1095. package/esm/resources/PaymentMethodBalances.js +3 -0
  1096. package/esm/resources/PaymentMethodBalances.js.map +1 -0
  1097. package/esm/resources/PaymentMethodConfigurations.d.ts +420 -0
  1098. package/esm/resources/PaymentMethods.d.ts +311 -14
  1099. package/esm/resources/PaymentMethods.js +20 -0
  1100. package/esm/resources/PaymentMethods.js.map +1 -1
  1101. package/esm/resources/PaymentPlans.d.ts +427 -0
  1102. package/esm/resources/PaymentPlans.js +31 -0
  1103. package/esm/resources/PaymentPlans.js.map +1 -0
  1104. package/esm/resources/PaymentRecords.d.ts +754 -37
  1105. package/esm/resources/PaymentRecords.js +18 -0
  1106. package/esm/resources/PaymentRecords.js.map +1 -1
  1107. package/esm/resources/Payouts.d.ts +3 -3
  1108. package/esm/resources/Persons.d.ts +25 -2
  1109. package/esm/resources/Plans.d.ts +21 -5
  1110. package/esm/resources/Prices.d.ts +91 -15
  1111. package/esm/resources/Prices.js +27 -0
  1112. package/esm/resources/Prices.js.map +1 -1
  1113. package/esm/resources/Privacy/RedactionJobValidationErrors.d.ts +36 -0
  1114. package/esm/resources/Privacy/RedactionJobValidationErrors.js +3 -0
  1115. package/esm/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
  1116. package/esm/resources/Privacy/RedactionJobs.d.ts +227 -0
  1117. package/esm/resources/Privacy/RedactionJobs.js +69 -0
  1118. package/esm/resources/Privacy/RedactionJobs.js.map +1 -0
  1119. package/esm/resources/Privacy/index.d.ts +22 -0
  1120. package/esm/resources/Privacy/index.js +9 -0
  1121. package/esm/resources/Privacy/index.js.map +1 -0
  1122. package/esm/resources/ProductCatalog/TrialOffers.d.ts +158 -0
  1123. package/esm/resources/ProductCatalog/TrialOffers.js +25 -0
  1124. package/esm/resources/ProductCatalog/TrialOffers.js.map +1 -0
  1125. package/esm/resources/ProductCatalog/index.d.ts +14 -0
  1126. package/esm/resources/ProductCatalog/index.js +9 -0
  1127. package/esm/resources/ProductCatalog/index.js.map +1 -0
  1128. package/esm/resources/Products.d.ts +205 -7
  1129. package/esm/resources/Products.js +69 -0
  1130. package/esm/resources/Products.js.map +1 -1
  1131. package/esm/resources/Profiles.d.ts +68 -0
  1132. package/esm/resources/Profiles.js +3 -0
  1133. package/esm/resources/Profiles.js.map +1 -0
  1134. package/esm/resources/PromotionCodes.d.ts +12 -0
  1135. package/esm/resources/PromotionCodes.js +27 -0
  1136. package/esm/resources/PromotionCodes.js.map +1 -1
  1137. package/esm/resources/QuoteLines.d.ts +684 -0
  1138. package/esm/resources/QuoteLines.js +3 -0
  1139. package/esm/resources/QuoteLines.js.map +1 -0
  1140. package/esm/resources/QuotePreviewInvoices.d.ts +1210 -0
  1141. package/esm/resources/QuotePreviewInvoices.js +3 -0
  1142. package/esm/resources/QuotePreviewInvoices.js.map +1 -0
  1143. package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +1087 -0
  1144. package/esm/resources/QuotePreviewSubscriptionSchedules.js +3 -0
  1145. package/esm/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
  1146. package/esm/resources/Quotes.d.ts +3558 -264
  1147. package/esm/resources/Quotes.js +1184 -16
  1148. package/esm/resources/Quotes.js.map +1 -1
  1149. package/esm/resources/Radar/AccountEvaluations.d.ts +309 -0
  1150. package/esm/resources/Radar/AccountEvaluations.js +23 -0
  1151. package/esm/resources/Radar/AccountEvaluations.js.map +1 -0
  1152. package/esm/resources/Radar/CustomerEvaluations.d.ts +245 -0
  1153. package/esm/resources/Radar/CustomerEvaluations.js +23 -0
  1154. package/esm/resources/Radar/CustomerEvaluations.js.map +1 -0
  1155. package/esm/resources/Radar/IssuingAuthorizationEvaluations.d.ts +433 -0
  1156. package/esm/resources/Radar/IssuingAuthorizationEvaluations.js +11 -0
  1157. package/esm/resources/Radar/IssuingAuthorizationEvaluations.js.map +1 -0
  1158. package/esm/resources/Radar/PaymentEvaluations.d.ts +116 -2
  1159. package/esm/resources/Radar/ValueListItems.d.ts +39 -1
  1160. package/esm/resources/Radar/ValueListItems.js +13 -0
  1161. package/esm/resources/Radar/ValueListItems.js.map +1 -1
  1162. package/esm/resources/Radar/ValueLists.d.ts +2 -2
  1163. package/esm/resources/Radar/index.d.ts +36 -16
  1164. package/esm/resources/Radar/index.js +6 -0
  1165. package/esm/resources/Radar/index.js.map +1 -1
  1166. package/esm/resources/Refunds.d.ts +41 -2
  1167. package/esm/resources/Refunds.js +27 -0
  1168. package/esm/resources/Refunds.js.map +1 -1
  1169. package/esm/resources/Reporting/ReportRuns.d.ts +3 -3
  1170. package/esm/resources/Reserve/Holds.d.ts +53 -1
  1171. package/esm/resources/Reserve/Holds.js +17 -1
  1172. package/esm/resources/Reserve/Holds.js.map +1 -1
  1173. package/esm/resources/Reserve/Plans.d.ts +16 -0
  1174. package/esm/resources/Reserve/Plans.js +9 -1
  1175. package/esm/resources/Reserve/Plans.js.map +1 -1
  1176. package/esm/resources/Reserve/Releases.d.ts +41 -1
  1177. package/esm/resources/Reserve/Releases.js +17 -1
  1178. package/esm/resources/Reserve/Releases.js.map +1 -1
  1179. package/esm/resources/Reserve/index.d.ts +17 -6
  1180. package/esm/resources/Reserve/index.js +9 -0
  1181. package/esm/resources/Reserve/index.js.map +1 -1
  1182. package/esm/resources/Reviews.d.ts +2 -2
  1183. package/esm/resources/RiskSignals.d.ts +10 -0
  1184. package/esm/resources/RiskSignals.js +3 -0
  1185. package/esm/resources/RiskSignals.js.map +1 -0
  1186. package/esm/resources/SetupAttempts.d.ts +42 -8
  1187. package/esm/resources/SetupAttempts.js.map +1 -1
  1188. package/esm/resources/SetupIntents.d.ts +667 -51
  1189. package/esm/resources/SetupIntents.js.map +1 -1
  1190. package/esm/resources/SharedPayment/GrantedTokens.d.ts +425 -0
  1191. package/esm/resources/SharedPayment/GrantedTokens.js +11 -0
  1192. package/esm/resources/SharedPayment/GrantedTokens.js.map +1 -0
  1193. package/esm/resources/SharedPayment/IssuedTokens.d.ts +344 -0
  1194. package/esm/resources/SharedPayment/IssuedTokens.js +23 -0
  1195. package/esm/resources/SharedPayment/IssuedTokens.js.map +1 -0
  1196. package/esm/resources/SharedPayment/index.d.ts +19 -0
  1197. package/esm/resources/SharedPayment/index.js +11 -0
  1198. package/esm/resources/SharedPayment/index.js.map +1 -0
  1199. package/esm/resources/ShippingRates.d.ts +6 -6
  1200. package/esm/resources/SourceTransactions.d.ts +2 -1
  1201. package/esm/resources/Sources.d.ts +43 -15
  1202. package/esm/resources/SubscriptionItems.d.ts +273 -8
  1203. package/esm/resources/SubscriptionItems.js +41 -0
  1204. package/esm/resources/SubscriptionItems.js.map +1 -1
  1205. package/esm/resources/SubscriptionSchedules.d.ts +2463 -90
  1206. package/esm/resources/SubscriptionSchedules.js +61 -0
  1207. package/esm/resources/SubscriptionSchedules.js.map +1 -1
  1208. package/esm/resources/Subscriptions.d.ts +1011 -43
  1209. package/esm/resources/Subscriptions.js +290 -1
  1210. package/esm/resources/Subscriptions.js.map +1 -1
  1211. package/esm/resources/Tax/CalculationLineItems.d.ts +14 -3
  1212. package/esm/resources/Tax/Calculations.d.ts +49 -7
  1213. package/esm/resources/Tax/Forms.d.ts +228 -0
  1214. package/esm/resources/Tax/Forms.js +28 -0
  1215. package/esm/resources/Tax/Forms.js.map +1 -0
  1216. package/esm/resources/Tax/Locations.d.ts +112 -0
  1217. package/esm/resources/Tax/Locations.js +29 -0
  1218. package/esm/resources/Tax/Locations.js.map +1 -0
  1219. package/esm/resources/Tax/Registrations.d.ts +441 -2
  1220. package/esm/resources/Tax/Registrations.js +27 -0
  1221. package/esm/resources/Tax/Registrations.js.map +1 -1
  1222. package/esm/resources/Tax/Settings.d.ts +10 -2
  1223. package/esm/resources/Tax/Settings.js +13 -0
  1224. package/esm/resources/Tax/Settings.js.map +1 -1
  1225. package/esm/resources/Tax/Transactions.d.ts +11 -3
  1226. package/esm/resources/Tax/Transactions.js +13 -0
  1227. package/esm/resources/Tax/Transactions.js.map +1 -1
  1228. package/esm/resources/Tax/index.d.ts +31 -13
  1229. package/esm/resources/Tax/index.js +4 -0
  1230. package/esm/resources/Tax/index.js.map +1 -1
  1231. package/esm/resources/TaxCodes.d.ts +16 -1
  1232. package/esm/resources/TaxFunds.d.ts +174 -0
  1233. package/esm/resources/TaxFunds.js +19 -0
  1234. package/esm/resources/TaxFunds.js.map +1 -0
  1235. package/esm/resources/TaxIds.d.ts +9 -3
  1236. package/esm/resources/TaxIds.js +13 -0
  1237. package/esm/resources/TaxIds.js.map +1 -1
  1238. package/esm/resources/TaxRates.d.ts +13 -1
  1239. package/esm/resources/TaxRates.js +27 -0
  1240. package/esm/resources/TaxRates.js.map +1 -1
  1241. package/esm/resources/Terminal/Configurations.d.ts +27 -0
  1242. package/esm/resources/Terminal/ReaderCollectedData.d.ts +50 -0
  1243. package/esm/resources/Terminal/ReaderCollectedData.js +11 -0
  1244. package/esm/resources/Terminal/ReaderCollectedData.js.map +1 -0
  1245. package/esm/resources/Terminal/Readers.d.ts +211 -6
  1246. package/esm/resources/Terminal/Readers.js +24 -0
  1247. package/esm/resources/Terminal/Readers.js.map +1 -1
  1248. package/esm/resources/Terminal/index.d.ts +9 -0
  1249. package/esm/resources/Terminal/index.js +2 -0
  1250. package/esm/resources/Terminal/index.js.map +1 -1
  1251. package/esm/resources/TestHelpers/Capital/FinancingOffers.d.ts +82 -0
  1252. package/esm/resources/TestHelpers/Capital/FinancingOffers.js +17 -0
  1253. package/esm/resources/TestHelpers/Capital/FinancingOffers.js.map +1 -0
  1254. package/esm/resources/TestHelpers/Capital/index.d.ts +8 -0
  1255. package/esm/resources/TestHelpers/Capital/index.js +9 -0
  1256. package/esm/resources/TestHelpers/Capital/index.js.map +1 -0
  1257. package/esm/resources/TestHelpers/ConfirmationTokens.d.ts +104 -5
  1258. package/esm/resources/TestHelpers/Issuing/Authorizations.d.ts +115 -13
  1259. package/esm/resources/TestHelpers/Issuing/Disputes.d.ts +127 -0
  1260. package/esm/resources/TestHelpers/Issuing/Disputes.js +35 -0
  1261. package/esm/resources/TestHelpers/Issuing/Disputes.js.map +1 -0
  1262. package/esm/resources/TestHelpers/Issuing/Transactions.d.ts +121 -11
  1263. package/esm/resources/TestHelpers/Issuing/index.d.ts +2 -0
  1264. package/esm/resources/TestHelpers/Issuing/index.js +2 -0
  1265. package/esm/resources/TestHelpers/Issuing/index.js.map +1 -1
  1266. package/esm/resources/TestHelpers/PaymentIntents.d.ts +38 -0
  1267. package/esm/resources/TestHelpers/PaymentIntents.js +11 -0
  1268. package/esm/resources/TestHelpers/PaymentIntents.js.map +1 -0
  1269. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +75 -0
  1270. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +17 -0
  1271. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
  1272. package/esm/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
  1273. package/esm/resources/TestHelpers/SharedPayment/index.js +9 -0
  1274. package/esm/resources/TestHelpers/SharedPayment/index.js.map +1 -0
  1275. package/esm/resources/TestHelpers/Terminal/Readers.d.ts +15 -1
  1276. package/esm/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
  1277. package/esm/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
  1278. package/esm/resources/TestHelpers/index.d.ts +14 -6
  1279. package/esm/resources/TestHelpers/index.js +6 -0
  1280. package/esm/resources/TestHelpers/index.js.map +1 -1
  1281. package/esm/resources/Tokens.d.ts +84 -2
  1282. package/esm/resources/Topups.d.ts +4 -4
  1283. package/esm/resources/Topups.js.map +1 -1
  1284. package/esm/resources/Transfers.d.ts +14 -2
  1285. package/esm/resources/Transfers.js.map +1 -1
  1286. package/esm/resources/TransitBalances.d.ts +25 -0
  1287. package/esm/resources/TransitBalances.js +3 -0
  1288. package/esm/resources/TransitBalances.js.map +1 -0
  1289. package/esm/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
  1290. package/esm/resources/Treasury/FinancialAccounts.d.ts +34 -1
  1291. package/esm/resources/Treasury/OutboundPayments.d.ts +8 -0
  1292. package/esm/resources/Treasury/OutboundTransfers.d.ts +44 -0
  1293. package/esm/resources/Treasury/ReceivedCredits.d.ts +22 -0
  1294. package/esm/resources/Treasury/ReceivedDebits.d.ts +26 -0
  1295. package/esm/resources/V2/Billing/BillSettingVersions.d.ts +72 -0
  1296. package/esm/resources/V2/Billing/BillSettingVersions.js +3 -0
  1297. package/esm/resources/V2/Billing/BillSettingVersions.js.map +1 -0
  1298. package/esm/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
  1299. package/esm/resources/V2/Billing/BillSettings/Versions.js +19 -0
  1300. package/esm/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
  1301. package/esm/resources/V2/Billing/BillSettings.d.ts +281 -0
  1302. package/esm/resources/V2/Billing/BillSettings.js +37 -0
  1303. package/esm/resources/V2/Billing/BillSettings.js.map +1 -0
  1304. package/esm/resources/V2/Billing/CadenceSpendModifiers.d.ts +84 -0
  1305. package/esm/resources/V2/Billing/CadenceSpendModifiers.js +3 -0
  1306. package/esm/resources/V2/Billing/CadenceSpendModifiers.js.map +1 -0
  1307. package/esm/resources/V2/Billing/Cadences/SpendModifierRules.d.ts +37 -0
  1308. package/esm/resources/V2/Billing/Cadences/SpendModifierRules.js +19 -0
  1309. package/esm/resources/V2/Billing/Cadences/SpendModifierRules.js.map +1 -0
  1310. package/esm/resources/V2/Billing/Cadences.d.ts +1011 -0
  1311. package/esm/resources/V2/Billing/Cadences.js +260 -0
  1312. package/esm/resources/V2/Billing/Cadences.js.map +1 -0
  1313. package/esm/resources/V2/Billing/CollectionSettingVersions.d.ts +237 -0
  1314. package/esm/resources/V2/Billing/CollectionSettingVersions.js +3 -0
  1315. package/esm/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
  1316. package/esm/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
  1317. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +66 -0
  1318. package/esm/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
  1319. package/esm/resources/V2/Billing/CollectionSettings.d.ts +776 -0
  1320. package/esm/resources/V2/Billing/CollectionSettings.js +162 -0
  1321. package/esm/resources/V2/Billing/CollectionSettings.js.map +1 -0
  1322. package/esm/resources/V2/Billing/ContractPricingLineQuantityChanges.d.ts +47 -0
  1323. package/esm/resources/V2/Billing/ContractPricingLineQuantityChanges.js +3 -0
  1324. package/esm/resources/V2/Billing/ContractPricingLineQuantityChanges.js.map +1 -0
  1325. package/esm/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.d.ts +23 -0
  1326. package/esm/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.js +25 -0
  1327. package/esm/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.js.map +1 -0
  1328. package/esm/resources/V2/Billing/Contracts/PricingLines.d.ts +8 -0
  1329. package/esm/resources/V2/Billing/Contracts/PricingLines.js +11 -0
  1330. package/esm/resources/V2/Billing/Contracts/PricingLines.js.map +1 -0
  1331. package/esm/resources/V2/Billing/Contracts.d.ts +1512 -0
  1332. package/esm/resources/V2/Billing/Contracts.js +327 -0
  1333. package/esm/resources/V2/Billing/Contracts.js.map +1 -0
  1334. package/esm/resources/V2/Billing/CustomPricingUnits.d.ts +125 -0
  1335. package/esm/resources/V2/Billing/CustomPricingUnits.js +31 -0
  1336. package/esm/resources/V2/Billing/CustomPricingUnits.js.map +1 -0
  1337. package/esm/resources/V2/Billing/IntentActions.d.ts +603 -0
  1338. package/esm/resources/V2/Billing/IntentActions.js +3 -0
  1339. package/esm/resources/V2/Billing/IntentActions.js.map +1 -0
  1340. package/esm/resources/V2/Billing/Intents/Actions.d.ts +33 -0
  1341. package/esm/resources/V2/Billing/Intents/Actions.js +66 -0
  1342. package/esm/resources/V2/Billing/Intents/Actions.js.map +1 -0
  1343. package/esm/resources/V2/Billing/Intents.d.ts +1261 -0
  1344. package/esm/resources/V2/Billing/Intents.js +83 -0
  1345. package/esm/resources/V2/Billing/Intents.js.map +1 -0
  1346. package/esm/resources/V2/Billing/LicenseFeeVersions.d.ts +78 -0
  1347. package/esm/resources/V2/Billing/LicenseFeeVersions.js +3 -0
  1348. package/esm/resources/V2/Billing/LicenseFeeVersions.js.map +1 -0
  1349. package/esm/resources/V2/Billing/LicenseFees/Versions.d.ts +33 -0
  1350. package/esm/resources/V2/Billing/LicenseFees/Versions.js +60 -0
  1351. package/esm/resources/V2/Billing/LicenseFees/Versions.js.map +1 -0
  1352. package/esm/resources/V2/Billing/LicenseFees.d.ts +360 -0
  1353. package/esm/resources/V2/Billing/LicenseFees.js +144 -0
  1354. package/esm/resources/V2/Billing/LicenseFees.js.map +1 -0
  1355. package/esm/resources/V2/Billing/LicensedItems.d.ts +170 -0
  1356. package/esm/resources/V2/Billing/LicensedItems.js +31 -0
  1357. package/esm/resources/V2/Billing/LicensedItems.js.map +1 -0
  1358. package/esm/resources/V2/Billing/MeteredItems.d.ts +218 -0
  1359. package/esm/resources/V2/Billing/MeteredItems.js +31 -0
  1360. package/esm/resources/V2/Billing/MeteredItems.js.map +1 -0
  1361. package/esm/resources/V2/Billing/OneTimeItems.d.ts +170 -0
  1362. package/esm/resources/V2/Billing/OneTimeItems.js +31 -0
  1363. package/esm/resources/V2/Billing/OneTimeItems.js.map +1 -0
  1364. package/esm/resources/V2/Billing/PricingPlanComponents.d.ts +80 -0
  1365. package/esm/resources/V2/Billing/PricingPlanComponents.js +3 -0
  1366. package/esm/resources/V2/Billing/PricingPlanComponents.js.map +1 -0
  1367. package/esm/resources/V2/Billing/PricingPlanSubscriptions.d.ts +620 -0
  1368. package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +292 -0
  1369. package/esm/resources/V2/Billing/PricingPlanSubscriptions.js.map +1 -0
  1370. package/esm/resources/V2/Billing/PricingPlanVersions.d.ts +30 -0
  1371. package/esm/resources/V2/Billing/PricingPlanVersions.js +3 -0
  1372. package/esm/resources/V2/Billing/PricingPlanVersions.js.map +1 -0
  1373. package/esm/resources/V2/Billing/PricingPlans/Components.d.ts +142 -0
  1374. package/esm/resources/V2/Billing/PricingPlans/Components.js +37 -0
  1375. package/esm/resources/V2/Billing/PricingPlans/Components.js.map +1 -0
  1376. package/esm/resources/V2/Billing/PricingPlans/Versions.d.ts +33 -0
  1377. package/esm/resources/V2/Billing/PricingPlans/Versions.js +19 -0
  1378. package/esm/resources/V2/Billing/PricingPlans/Versions.js.map +1 -0
  1379. package/esm/resources/V2/Billing/PricingPlans.d.ts +169 -0
  1380. package/esm/resources/V2/Billing/PricingPlans.js +39 -0
  1381. package/esm/resources/V2/Billing/PricingPlans.js.map +1 -0
  1382. package/esm/resources/V2/Billing/Profiles.d.ts +162 -0
  1383. package/esm/resources/V2/Billing/Profiles.js +31 -0
  1384. package/esm/resources/V2/Billing/Profiles.js.map +1 -0
  1385. package/esm/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.d.ts +45 -0
  1386. package/esm/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js +3 -0
  1387. package/esm/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js.map +1 -0
  1388. package/esm/resources/V2/Billing/RateCardRates.d.ts +111 -0
  1389. package/esm/resources/V2/Billing/RateCardRates.js +3 -0
  1390. package/esm/resources/V2/Billing/RateCardRates.js.map +1 -0
  1391. package/esm/resources/V2/Billing/RateCardSubscriptions.d.ts +215 -0
  1392. package/esm/resources/V2/Billing/RateCardSubscriptions.js +37 -0
  1393. package/esm/resources/V2/Billing/RateCardSubscriptions.js.map +1 -0
  1394. package/esm/resources/V2/Billing/RateCardVersions.d.ts +22 -0
  1395. package/esm/resources/V2/Billing/RateCardVersions.js +3 -0
  1396. package/esm/resources/V2/Billing/RateCardVersions.js.map +1 -0
  1397. package/esm/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.d.ts +79 -0
  1398. package/esm/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js +31 -0
  1399. package/esm/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js.map +1 -0
  1400. package/esm/resources/V2/Billing/RateCards/Rates.d.ts +145 -0
  1401. package/esm/resources/V2/Billing/RateCards/Rates.js +106 -0
  1402. package/esm/resources/V2/Billing/RateCards/Rates.js.map +1 -0
  1403. package/esm/resources/V2/Billing/RateCards/Versions.d.ts +33 -0
  1404. package/esm/resources/V2/Billing/RateCards/Versions.js +19 -0
  1405. package/esm/resources/V2/Billing/RateCards/Versions.js.map +1 -0
  1406. package/esm/resources/V2/Billing/RateCards.d.ts +336 -0
  1407. package/esm/resources/V2/Billing/RateCards.js +72 -0
  1408. package/esm/resources/V2/Billing/RateCards.js.map +1 -0
  1409. package/esm/resources/V2/Billing/ServiceActions.d.ts +510 -0
  1410. package/esm/resources/V2/Billing/ServiceActions.js +158 -0
  1411. package/esm/resources/V2/Billing/ServiceActions.js.map +1 -0
  1412. package/esm/resources/V2/Billing/index.d.ts +175 -6
  1413. package/esm/resources/V2/Billing/index.js +32 -0
  1414. package/esm/resources/V2/Billing/index.js.map +1 -1
  1415. package/esm/resources/V2/Core/AccountEvaluations.d.ts +159 -0
  1416. package/esm/resources/V2/Core/AccountEvaluations.js +11 -0
  1417. package/esm/resources/V2/Core/AccountEvaluations.js.map +1 -0
  1418. package/esm/resources/V2/Core/AccountLinks.d.ts +158 -6
  1419. package/esm/resources/V2/Core/AccountPersons.d.ts +1 -1
  1420. package/esm/resources/V2/Core/AccountTokens.d.ts +220 -2
  1421. package/esm/resources/V2/Core/Accounts/PersonTokens.d.ts +1 -1
  1422. package/esm/resources/V2/Core/Accounts/Persons.d.ts +2 -2
  1423. package/esm/resources/V2/Core/Accounts.d.ts +16131 -1984
  1424. package/esm/resources/V2/Core/Accounts.js +10379 -53
  1425. package/esm/resources/V2/Core/Accounts.js.map +1 -1
  1426. package/esm/resources/V2/Core/ApprovalRequests.d.ts +331 -0
  1427. package/esm/resources/V2/Core/ApprovalRequests.js +42 -0
  1428. package/esm/resources/V2/Core/ApprovalRequests.js.map +1 -0
  1429. package/esm/resources/V2/Core/BatchJobs.d.ts +360 -0
  1430. package/esm/resources/V2/Core/BatchJobs.js +221 -0
  1431. package/esm/resources/V2/Core/BatchJobs.js.map +1 -0
  1432. package/esm/resources/V2/Core/ClaimableSandboxes.d.ts +225 -0
  1433. package/esm/resources/V2/Core/ClaimableSandboxes.js +27 -0
  1434. package/esm/resources/V2/Core/ClaimableSandboxes.js.map +1 -0
  1435. package/esm/resources/V2/Core/ConnectionSessions.d.ts +86 -0
  1436. package/esm/resources/V2/Core/ConnectionSessions.js +17 -0
  1437. package/esm/resources/V2/Core/ConnectionSessions.js.map +1 -0
  1438. package/esm/resources/V2/Core/Events.d.ts +8083 -223
  1439. package/esm/resources/V2/Core/FeeBatches.d.ts +234 -0
  1440. package/esm/resources/V2/Core/FeeBatches.js +19 -0
  1441. package/esm/resources/V2/Core/FeeBatches.js.map +1 -0
  1442. package/esm/resources/V2/Core/FeeEntries.d.ts +200 -0
  1443. package/esm/resources/V2/Core/FeeEntries.js +19 -0
  1444. package/esm/resources/V2/Core/FeeEntries.js.map +1 -0
  1445. package/esm/resources/V2/Core/Health/AlertHistoryEntries.d.ts +423 -0
  1446. package/esm/resources/V2/Core/Health/AlertHistoryEntries.js +3 -0
  1447. package/esm/resources/V2/Core/Health/AlertHistoryEntries.js.map +1 -0
  1448. package/esm/resources/V2/Core/Health/Alerts/History.d.ts +23 -0
  1449. package/esm/resources/V2/Core/Health/Alerts/History.js +97 -0
  1450. package/esm/resources/V2/Core/Health/Alerts/History.js.map +1 -0
  1451. package/esm/resources/V2/Core/Health/Alerts.d.ts +537 -0
  1452. package/esm/resources/V2/Core/Health/Alerts.js +178 -0
  1453. package/esm/resources/V2/Core/Health/Alerts.js.map +1 -0
  1454. package/esm/resources/V2/Core/Health/index.d.ts +16 -0
  1455. package/esm/resources/V2/Core/Health/index.js +9 -0
  1456. package/esm/resources/V2/Core/Health/index.js.map +1 -0
  1457. package/esm/resources/V2/Core/Vault/GbBankAccounts.d.ts +280 -0
  1458. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +50 -0
  1459. package/esm/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
  1460. package/esm/resources/V2/Core/Vault/UsBankAccounts.d.ts +252 -0
  1461. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +61 -0
  1462. package/esm/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
  1463. package/esm/resources/V2/Core/Vault/index.d.ts +28 -0
  1464. package/esm/resources/V2/Core/Vault/index.js +11 -0
  1465. package/esm/resources/V2/Core/Vault/index.js.map +1 -0
  1466. package/esm/resources/V2/Core/index.d.ts +66 -14
  1467. package/esm/resources/V2/Core/index.js +18 -0
  1468. package/esm/resources/V2/Core/index.js.map +1 -1
  1469. package/esm/resources/V2/Data/Analytics/MetricQuery.d.ts +74 -0
  1470. package/esm/resources/V2/Data/Analytics/MetricQuery.js +32 -0
  1471. package/esm/resources/V2/Data/Analytics/MetricQuery.js.map +1 -0
  1472. package/esm/resources/V2/Data/Analytics/MetricQueryResults.d.ts +76 -0
  1473. package/esm/resources/V2/Data/Analytics/MetricQueryResults.js +3 -0
  1474. package/esm/resources/V2/Data/Analytics/MetricQueryResults.js.map +1 -0
  1475. package/esm/resources/V2/Data/Analytics/index.d.ts +12 -0
  1476. package/esm/resources/V2/Data/Analytics/index.js +9 -0
  1477. package/esm/resources/V2/Data/Analytics/index.js.map +1 -0
  1478. package/esm/resources/V2/Data/Reporting/QueryRuns.d.ts +172 -0
  1479. package/esm/resources/V2/Data/Reporting/QueryRuns.js +42 -0
  1480. package/esm/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
  1481. package/esm/resources/V2/Data/Reporting/index.d.ts +13 -0
  1482. package/esm/resources/V2/Data/Reporting/index.js +9 -0
  1483. package/esm/resources/V2/Data/Reporting/index.js.map +1 -0
  1484. package/esm/resources/V2/Data/index.d.ts +13 -0
  1485. package/esm/resources/V2/Data/index.js +11 -0
  1486. package/esm/resources/V2/Data/index.js.map +1 -0
  1487. package/esm/resources/V2/Extend/WorkflowRuns.d.ts +163 -0
  1488. package/esm/resources/V2/Extend/WorkflowRuns.js +19 -0
  1489. package/esm/resources/V2/Extend/WorkflowRuns.js.map +1 -0
  1490. package/esm/resources/V2/Extend/Workflows.d.ts +120 -0
  1491. package/esm/resources/V2/Extend/Workflows.js +26 -0
  1492. package/esm/resources/V2/Extend/Workflows.js.map +1 -0
  1493. package/esm/resources/V2/Extend/index.d.ts +20 -0
  1494. package/esm/resources/V2/Extend/index.js +11 -0
  1495. package/esm/resources/V2/Extend/index.js.map +1 -0
  1496. package/esm/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
  1497. package/esm/resources/V2/FinancialAddressCreditSimulations.js +3 -0
  1498. package/esm/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
  1499. package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
  1500. package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js +3 -0
  1501. package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
  1502. package/esm/resources/V2/Iam/ActivityLogs.d.ts +218 -0
  1503. package/esm/resources/V2/Iam/ActivityLogs.js +19 -0
  1504. package/esm/resources/V2/Iam/ActivityLogs.js.map +1 -0
  1505. package/esm/resources/V2/Iam/ApiKeys.d.ts +305 -0
  1506. package/esm/resources/V2/Iam/ApiKeys.js +43 -0
  1507. package/esm/resources/V2/Iam/ApiKeys.js.map +1 -0
  1508. package/esm/resources/V2/Iam/index.d.ts +23 -0
  1509. package/esm/resources/V2/Iam/index.js +11 -0
  1510. package/esm/resources/V2/Iam/index.js.map +1 -0
  1511. package/esm/resources/V2/MoneyManagement/Adjustments.d.ts +135 -0
  1512. package/esm/resources/V2/MoneyManagement/Adjustments.js +19 -0
  1513. package/esm/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
  1514. package/esm/resources/V2/MoneyManagement/CurrencyConversions.d.ts +131 -0
  1515. package/esm/resources/V2/MoneyManagement/CurrencyConversions.js +27 -0
  1516. package/esm/resources/V2/MoneyManagement/CurrencyConversions.js.map +1 -0
  1517. package/esm/resources/V2/MoneyManagement/DebitDisputes.d.ts +169 -0
  1518. package/esm/resources/V2/MoneyManagement/DebitDisputes.js +25 -0
  1519. package/esm/resources/V2/MoneyManagement/DebitDisputes.js.map +1 -0
  1520. package/esm/resources/V2/MoneyManagement/FinancialAccountStatements.d.ts +99 -0
  1521. package/esm/resources/V2/MoneyManagement/FinancialAccountStatements.js +3 -0
  1522. package/esm/resources/V2/MoneyManagement/FinancialAccountStatements.js.map +1 -0
  1523. package/esm/resources/V2/MoneyManagement/FinancialAccounts/Statements.d.ts +49 -0
  1524. package/esm/resources/V2/MoneyManagement/FinancialAccounts/Statements.js +49 -0
  1525. package/esm/resources/V2/MoneyManagement/FinancialAccounts/Statements.js.map +1 -0
  1526. package/esm/resources/V2/MoneyManagement/FinancialAccounts.d.ts +438 -0
  1527. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +46 -0
  1528. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
  1529. package/esm/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.d.ts +14 -0
  1530. package/esm/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.js +3 -0
  1531. package/esm/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.js.map +1 -0
  1532. package/esm/resources/V2/MoneyManagement/FinancialAddresses.d.ts +304 -0
  1533. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +27 -0
  1534. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
  1535. package/esm/resources/V2/MoneyManagement/InboundTransfers.d.ts +251 -0
  1536. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +26 -0
  1537. package/esm/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
  1538. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +329 -0
  1539. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +18 -0
  1540. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
  1541. package/esm/resources/V2/MoneyManagement/OutboundPayments.d.ts +638 -0
  1542. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +37 -0
  1543. package/esm/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
  1544. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +318 -0
  1545. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +45 -0
  1546. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
  1547. package/esm/resources/V2/MoneyManagement/OutboundTransfers.d.ts +394 -0
  1548. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +35 -0
  1549. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
  1550. package/esm/resources/V2/MoneyManagement/PayoutIntents.d.ts +648 -0
  1551. package/esm/resources/V2/MoneyManagement/PayoutIntents.js +53 -0
  1552. package/esm/resources/V2/MoneyManagement/PayoutIntents.js.map +1 -0
  1553. package/esm/resources/V2/MoneyManagement/PayoutMethods.d.ts +277 -0
  1554. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +40 -0
  1555. package/esm/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
  1556. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +92 -0
  1557. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +13 -0
  1558. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
  1559. package/esm/resources/V2/MoneyManagement/ReceivedCredits.d.ts +481 -0
  1560. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +19 -0
  1561. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
  1562. package/esm/resources/V2/MoneyManagement/ReceivedDebitMandates.d.ts +166 -0
  1563. package/esm/resources/V2/MoneyManagement/ReceivedDebitMandates.js +25 -0
  1564. package/esm/resources/V2/MoneyManagement/ReceivedDebitMandates.js.map +1 -0
  1565. package/esm/resources/V2/MoneyManagement/ReceivedDebits.d.ts +308 -0
  1566. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +19 -0
  1567. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
  1568. package/esm/resources/V2/MoneyManagement/RecipientVerifications.d.ts +116 -0
  1569. package/esm/resources/V2/MoneyManagement/RecipientVerifications.js +23 -0
  1570. package/esm/resources/V2/MoneyManagement/RecipientVerifications.js.map +1 -0
  1571. package/esm/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.d.ts +34 -0
  1572. package/esm/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.js +11 -0
  1573. package/esm/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.js.map +1 -0
  1574. package/esm/resources/V2/MoneyManagement/TestHelpers/index.d.ts +8 -0
  1575. package/esm/resources/V2/MoneyManagement/TestHelpers/index.js +9 -0
  1576. package/esm/resources/V2/MoneyManagement/TestHelpers/index.js.map +1 -0
  1577. package/esm/resources/V2/MoneyManagement/TransactionEntries.d.ts +266 -0
  1578. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +19 -0
  1579. package/esm/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
  1580. package/esm/resources/V2/MoneyManagement/Transactions.d.ts +321 -0
  1581. package/esm/resources/V2/MoneyManagement/Transactions.js +25 -0
  1582. package/esm/resources/V2/MoneyManagement/Transactions.js.map +1 -0
  1583. package/esm/resources/V2/MoneyManagement/index.d.ts +153 -0
  1584. package/esm/resources/V2/MoneyManagement/index.js +47 -0
  1585. package/esm/resources/V2/MoneyManagement/index.js.map +1 -0
  1586. package/esm/resources/V2/Network/BusinessProfiles.d.ts +92 -0
  1587. package/esm/resources/V2/Network/BusinessProfiles.js +17 -0
  1588. package/esm/resources/V2/Network/BusinessProfiles.js.map +1 -0
  1589. package/esm/resources/V2/Network/index.d.ts +13 -0
  1590. package/esm/resources/V2/Network/index.js +9 -0
  1591. package/esm/resources/V2/Network/index.js.map +1 -0
  1592. package/esm/resources/V2/OrchestratedCommerce/Agreements.d.ts +143 -0
  1593. package/esm/resources/V2/OrchestratedCommerce/Agreements.js +37 -0
  1594. package/esm/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
  1595. package/esm/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
  1596. package/esm/resources/V2/OrchestratedCommerce/index.js +9 -0
  1597. package/esm/resources/V2/OrchestratedCommerce/index.js.map +1 -0
  1598. package/esm/resources/V2/Payments/OffSessionPayments.d.ts +835 -0
  1599. package/esm/resources/V2/Payments/OffSessionPayments.js +49 -0
  1600. package/esm/resources/V2/Payments/OffSessionPayments.js.map +1 -0
  1601. package/esm/resources/V2/Payments/SettlementAllocationIntentSplits.d.ts +73 -0
  1602. package/esm/resources/V2/Payments/SettlementAllocationIntentSplits.js +3 -0
  1603. package/esm/resources/V2/Payments/SettlementAllocationIntentSplits.js.map +1 -0
  1604. package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.d.ts +85 -0
  1605. package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js +31 -0
  1606. package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js.map +1 -0
  1607. package/esm/resources/V2/Payments/SettlementAllocationIntents.d.ts +209 -0
  1608. package/esm/resources/V2/Payments/SettlementAllocationIntents.js +49 -0
  1609. package/esm/resources/V2/Payments/SettlementAllocationIntents.js.map +1 -0
  1610. package/esm/resources/V2/Payments/index.d.ts +31 -0
  1611. package/esm/resources/V2/Payments/index.js +11 -0
  1612. package/esm/resources/V2/Payments/index.js.map +1 -0
  1613. package/esm/resources/V2/Reporting/ReportRuns.d.ts +191 -0
  1614. package/esm/resources/V2/Reporting/ReportRuns.js +46 -0
  1615. package/esm/resources/V2/Reporting/ReportRuns.js.map +1 -0
  1616. package/esm/resources/V2/Reporting/Reports.d.ts +106 -0
  1617. package/esm/resources/V2/Reporting/Reports.js +13 -0
  1618. package/esm/resources/V2/Reporting/Reports.js.map +1 -0
  1619. package/esm/resources/V2/Reporting/index.d.ts +18 -0
  1620. package/esm/resources/V2/Reporting/index.js +11 -0
  1621. package/esm/resources/V2/Reporting/index.js.map +1 -0
  1622. package/esm/resources/V2/Risk/Inquiries.d.ts +143 -0
  1623. package/esm/resources/V2/Risk/Inquiries.js +25 -0
  1624. package/esm/resources/V2/Risk/Inquiries.js.map +1 -0
  1625. package/esm/resources/V2/Risk/index.d.ts +14 -0
  1626. package/esm/resources/V2/Risk/index.js +9 -0
  1627. package/esm/resources/V2/Risk/index.js.map +1 -0
  1628. package/esm/resources/V2/Signals/AccountActivity.d.ts +424 -0
  1629. package/esm/resources/V2/Signals/AccountActivity.js +23 -0
  1630. package/esm/resources/V2/Signals/AccountActivity.js.map +1 -0
  1631. package/esm/resources/V2/Signals/AccountEvaluations.d.ts +396 -0
  1632. package/esm/resources/V2/Signals/AccountEvaluations.js +55 -0
  1633. package/esm/resources/V2/Signals/AccountEvaluations.js.map +1 -0
  1634. package/esm/resources/V2/Signals/AccountSignals.d.ts +281 -0
  1635. package/esm/resources/V2/Signals/AccountSignals.js +106 -0
  1636. package/esm/resources/V2/Signals/AccountSignals.js.map +1 -0
  1637. package/esm/resources/V2/Signals/index.d.ts +26 -0
  1638. package/esm/resources/V2/Signals/index.js +13 -0
  1639. package/esm/resources/V2/Signals/index.js.map +1 -0
  1640. package/esm/resources/V2/Tax/ManualRules.d.ts +331 -0
  1641. package/esm/resources/V2/Tax/ManualRules.js +189 -0
  1642. package/esm/resources/V2/Tax/ManualRules.js.map +1 -0
  1643. package/esm/resources/V2/Tax/Operations.d.ts +43 -0
  1644. package/esm/resources/V2/Tax/Operations.js +11 -0
  1645. package/esm/resources/V2/Tax/Operations.js.map +1 -0
  1646. package/esm/resources/V2/Tax/OperationsResolveAddressResults.d.ts +68 -0
  1647. package/esm/resources/V2/Tax/OperationsResolveAddressResults.js +3 -0
  1648. package/esm/resources/V2/Tax/OperationsResolveAddressResults.js.map +1 -0
  1649. package/esm/resources/V2/Tax/index.d.ts +21 -0
  1650. package/esm/resources/V2/Tax/index.js +11 -0
  1651. package/esm/resources/V2/Tax/index.js.map +1 -0
  1652. package/esm/resources/V2/TestHelpers/FinancialAddresses.d.ts +45 -0
  1653. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +19 -0
  1654. package/esm/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
  1655. package/esm/resources/V2/TestHelpers/MoneyManagement.d.ts +31 -0
  1656. package/esm/resources/V2/TestHelpers/MoneyManagement.js +11 -0
  1657. package/esm/resources/V2/TestHelpers/MoneyManagement.js.map +1 -0
  1658. package/esm/resources/V2/TestHelpers/index.d.ts +10 -0
  1659. package/esm/resources/V2/TestHelpers/index.js +11 -0
  1660. package/esm/resources/V2/TestHelpers/index.js.map +1 -0
  1661. package/esm/resources/V2/index.d.ts +42 -0
  1662. package/esm/resources/V2/index.js +24 -0
  1663. package/esm/resources/V2/index.js.map +1 -1
  1664. package/esm/resources/WebhookEndpoints.d.ts +3 -3
  1665. package/esm/resources.d.ts +20 -0
  1666. package/esm/resources.js +266 -0
  1667. package/esm/resources.js.map +1 -1
  1668. package/esm/stripe.core.d.ts +163 -54
  1669. package/esm/stripe.core.js +45 -2
  1670. package/esm/stripe.core.js.map +1 -1
  1671. package/esm/stripe.esm.node.d.ts +163 -54
  1672. package/esm/stripe.esm.node.js +45 -2
  1673. package/esm/stripe.esm.node.js.map +1 -1
  1674. package/package.json +1 -1
@@ -4,11 +4,14 @@ 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';
10
11
  import { Account } from './Accounts.js';
12
+ import { PaymentPlan } from './PaymentPlans.js';
11
13
  import { InvoicePayment } from './InvoicePayments.js';
14
+ import { GiftCardOperation } from './GiftCardOperations.js';
12
15
  import { PaymentIntent } from './PaymentIntents.js';
13
16
  import { SetupIntent } from './SetupIntents.js';
14
17
  import { Subscription } from './Subscriptions.js';
@@ -67,6 +70,10 @@ export declare class InvoiceResource extends StripeResource {
67
70
  * See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more.
68
71
  */
69
72
  attachPayment(id: string, params?: InvoiceAttachPaymentParams, options?: RequestOptions): Promise<Response<Invoice>>;
73
+ /**
74
+ * Detaches a payment from the invoice, removing it from the list of payments
75
+ */
76
+ detachPayment(id: string, params?: InvoiceDetachPaymentParams, options?: RequestOptions): Promise<Response<Invoice>>;
70
77
  /**
71
78
  * 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
79
  */
@@ -111,6 +118,54 @@ export declare class InvoiceResource extends StripeResource {
111
118
  * 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
119
  */
113
120
  createPreview(params?: InvoiceCreatePreviewParams, options?: RequestOptions): Promise<Response<Invoice>>;
121
+ serializeBatchDelete(invoice: string, params?: Record<string, unknown>, options?: {
122
+ apiVersion?: string;
123
+ stripeContext?: string;
124
+ }): string;
125
+ serializeBatchUpdate(invoice: string, params?: Record<string, unknown>, options?: {
126
+ apiVersion?: string;
127
+ stripeContext?: string;
128
+ }): string;
129
+ serializeBatchCreate(params?: Record<string, unknown>, options?: {
130
+ apiVersion?: string;
131
+ stripeContext?: string;
132
+ }): string;
133
+ serializeBatchAddLines(invoice: string, params?: Record<string, unknown>, options?: {
134
+ apiVersion?: string;
135
+ stripeContext?: string;
136
+ }): string;
137
+ serializeBatchFinalizeInvoice(invoice: string, params?: Record<string, unknown>, options?: {
138
+ apiVersion?: string;
139
+ stripeContext?: string;
140
+ }): string;
141
+ serializeBatchMarkUncollectible(invoice: string, params?: Record<string, unknown>, options?: {
142
+ apiVersion?: string;
143
+ stripeContext?: string;
144
+ }): string;
145
+ serializeBatchPay(invoice: string, params?: Record<string, unknown>, options?: {
146
+ apiVersion?: string;
147
+ stripeContext?: string;
148
+ }): string;
149
+ serializeBatchRemoveLines(invoice: string, params?: Record<string, unknown>, options?: {
150
+ apiVersion?: string;
151
+ stripeContext?: string;
152
+ }): string;
153
+ serializeBatchSendInvoice(invoice: string, params?: Record<string, unknown>, options?: {
154
+ apiVersion?: string;
155
+ stripeContext?: string;
156
+ }): string;
157
+ serializeBatchUpdateLines(invoice: string, params?: Record<string, unknown>, options?: {
158
+ apiVersion?: string;
159
+ stripeContext?: string;
160
+ }): string;
161
+ serializeBatchVoidInvoice(invoice: string, params?: Record<string, unknown>, options?: {
162
+ apiVersion?: string;
163
+ stripeContext?: string;
164
+ }): string;
165
+ serializeBatchCreatePreview(params?: Record<string, unknown>, options?: {
166
+ apiVersion?: string;
167
+ stripeContext?: string;
168
+ }): string;
114
169
  /**
115
170
  * 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
171
  */
@@ -122,6 +177,10 @@ export declare class InvoiceResource extends StripeResource {
122
177
  * Updating an invoice's line item is only possible before the invoice is finalized.
123
178
  */
124
179
  updateLineItem(invoiceId: string, id: string, params?: InvoiceUpdateLineItemParams, options?: RequestOptions): Promise<Response<InvoiceLineItem>>;
180
+ serializeBatchUpdateLineItem(invoice: string, lineItemId: string, params?: Record<string, unknown>, options?: {
181
+ apiVersion?: string;
182
+ stripeContext?: string;
183
+ }): string;
125
184
  }
126
185
  export interface Invoice {
127
186
  /**
@@ -168,6 +227,10 @@ export interface Invoice {
168
227
  * This is the sum of all the shipping amounts.
169
228
  */
170
229
  amount_shipping: number;
230
+ /**
231
+ * List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
232
+ */
233
+ amounts_due?: Array<Invoice.AmountsDue> | null;
171
234
  /**
172
235
  * ID of the Connect Application that created the invoice.
173
236
  */
@@ -233,6 +296,10 @@ export interface Invoice {
233
296
  * The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
234
297
  */
235
298
  customer_address: Address | null;
299
+ /**
300
+ * The customer balance amounts applied to this invoice.
301
+ */
302
+ customer_balance?: Invoice.CustomerBalance | null;
236
303
  /**
237
304
  * The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.
238
305
  */
@@ -257,6 +324,10 @@ export interface Invoice {
257
324
  * 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.
258
325
  */
259
326
  customer_tax_ids?: Array<Invoice.CustomerTaxId> | null;
327
+ /**
328
+ * The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
329
+ */
330
+ default_margins?: Array<string | Margin> | null;
260
331
  /**
261
332
  * 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.
262
333
  */
@@ -326,6 +397,7 @@ export interface Invoice {
326
397
  * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
327
398
  */
328
399
  livemode: boolean;
400
+ managed_payments?: Invoice.ManagedPayments | null;
329
401
  /**
330
402
  * 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.
331
403
  */
@@ -346,6 +418,10 @@ export interface Invoice {
346
418
  * The parent that generated this invoice
347
419
  */
348
420
  parent: Invoice.Parent | null;
421
+ /**
422
+ * The ID of the payment plan associated with this invoice, if any. Use `expand[]=payment_plan` to include the full payment plan object.
423
+ */
424
+ payment_plan?: string | PaymentPlan;
349
425
  payment_settings: Invoice.PaymentSettings;
350
426
  /**
351
427
  * Payments for this invoice. Use [invoice payment](https://docs.stripe.com/api/invoice-payment) to get more details.
@@ -421,6 +497,10 @@ export interface Invoice {
421
497
  * The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
422
498
  */
423
499
  total_excluding_tax: number | null;
500
+ /**
501
+ * The aggregate amounts calculated per margin across all line items.
502
+ */
503
+ total_margin_amounts?: Array<Invoice.TotalMarginAmount> | null;
424
504
  /**
425
505
  * 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.
426
506
  */
@@ -449,6 +529,40 @@ export interface DeletedInvoice {
449
529
  deleted: true;
450
530
  }
451
531
  export declare namespace Invoice {
532
+ interface AmountsDue {
533
+ /**
534
+ * Incremental amount due for this payment in cents (or local equivalent).
535
+ */
536
+ amount: number;
537
+ /**
538
+ * The amount in cents (or local equivalent) that was paid for this payment.
539
+ */
540
+ amount_paid: number;
541
+ /**
542
+ * The difference between the payment's amount and amount_paid, in cents (or local equivalent).
543
+ */
544
+ amount_remaining: number;
545
+ /**
546
+ * Number of days from when invoice is finalized until the payment is due.
547
+ */
548
+ days_until_due: number | null;
549
+ /**
550
+ * An arbitrary string attached to the object. Often useful for displaying to users.
551
+ */
552
+ description: string | null;
553
+ /**
554
+ * Date on which a payment plan's payment is due.
555
+ */
556
+ due_date: number | null;
557
+ /**
558
+ * Timestamp when the payment was paid.
559
+ */
560
+ paid_at: number | null;
561
+ /**
562
+ * The status of the payment, one of `open`, `paid`, or `past_due`
563
+ */
564
+ status: AmountsDue.Status;
565
+ }
452
566
  interface AutomaticTax {
453
567
  /**
454
568
  * If Stripe disabled automatic tax, this enum describes why.
@@ -471,7 +585,7 @@ export declare namespace Invoice {
471
585
  */
472
586
  status: AutomaticTax.Status | null;
473
587
  }
474
- type BillingReason = 'automatic_pending_invoice_item_invoice' | 'manual' | 'quote_accept' | 'subscription' | 'subscription_create' | 'subscription_cycle' | 'subscription_threshold' | 'subscription_update' | 'upcoming';
588
+ type BillingReason = 'automatic_pending_invoice_item_invoice' | 'manual' | 'quote_accept' | 'subscription' | 'subscription_create' | 'subscription_cycle' | 'subscription_threshold' | 'subscription_update' | 'upcoming' | OtherString;
475
589
  type CollectionMethod = 'charge_automatically' | 'send_invoice' | OtherString;
476
590
  interface ConfirmationSecret {
477
591
  /**
@@ -493,6 +607,20 @@ export declare namespace Invoice {
493
607
  */
494
608
  value: string;
495
609
  }
610
+ interface CustomerBalance {
611
+ /**
612
+ * The total amount of customer balance applied to this invoice (automatically + manually).
613
+ */
614
+ applied_balance: number;
615
+ /**
616
+ * The amount of customer balance automatically applied during invoice finalization.
617
+ */
618
+ automatically_applied_balance: number;
619
+ /**
620
+ * The total amount of customer balance manually applied after finalization.
621
+ */
622
+ manually_applied_balance: number;
623
+ }
496
624
  interface CustomerShipping {
497
625
  address?: Address;
498
626
  /**
@@ -512,7 +640,7 @@ export declare namespace Invoice {
512
640
  */
513
641
  tracking_number?: string | null;
514
642
  }
515
- type CustomerTaxExempt = 'exempt' | 'none' | 'reverse';
643
+ type CustomerTaxExempt = 'exempt' | 'none' | 'reverse' | OtherString;
516
644
  interface CustomerTaxId {
517
645
  /**
518
646
  * The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, `ic_nif`, or `unknown`
@@ -564,6 +692,11 @@ export declare namespace Invoice {
564
692
  * A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported.
565
693
  */
566
694
  doc_url?: string;
695
+ /**
696
+ * A GiftCardOperation represents an operation performed on a third-party gift card,
697
+ * such as activation, reload, cashout, balance check, or void.
698
+ */
699
+ gift_card_operation?: GiftCardOperation;
567
700
  /**
568
701
  * A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
569
702
  */
@@ -640,11 +773,25 @@ export declare namespace Invoice {
640
773
  */
641
774
  type: LastFinalizationError.Type;
642
775
  }
776
+ interface ManagedPayments {
777
+ /**
778
+ * Set to `true` to enable [Managed Payments](https://docs.stripe.com/payments/managed-payments), Stripe's merchant of record solution, for this session.
779
+ */
780
+ enabled: boolean;
781
+ }
643
782
  interface Parent {
783
+ /**
784
+ * Details about the billing cadence that generated this invoice
785
+ */
786
+ billing_cadence_details?: Parent.BillingCadenceDetails | null;
644
787
  /**
645
788
  * Details about the quote that generated this invoice
646
789
  */
647
790
  quote_details: Parent.QuoteDetails | null;
791
+ /**
792
+ * Details about the schedule that generated this invoice
793
+ */
794
+ schedule_details?: Parent.ScheduleDetails | null;
648
795
  /**
649
796
  * Details about the subscription that generated this invoice
650
797
  */
@@ -766,6 +913,16 @@ export declare namespace Invoice {
766
913
  */
767
914
  discount: string | Discount | DeletedDiscount;
768
915
  }
916
+ interface TotalMarginAmount {
917
+ /**
918
+ * The amount, in cents (or local equivalent), of the reduction in line item amount.
919
+ */
920
+ amount: number;
921
+ /**
922
+ * The margin that was applied to get this margin amount.
923
+ */
924
+ margin: string | Margin;
925
+ }
769
926
  interface TotalPretaxCreditAmount {
770
927
  /**
771
928
  * The amount, in cents (or local equivalent), of the pretax credit amount.
@@ -779,6 +936,10 @@ export declare namespace Invoice {
779
936
  * The discount that was applied to get this pretax credit amount.
780
937
  */
781
938
  discount?: string | Discount | DeletedDiscount;
939
+ /**
940
+ * The margin that was applied to get this pretax credit amount.
941
+ */
942
+ margin?: string | Margin;
782
943
  /**
783
944
  * Type of the pretax credit amount referenced.
784
945
  */
@@ -810,6 +971,9 @@ export declare namespace Invoice {
810
971
  */
811
972
  type: 'tax_rate_details';
812
973
  }
974
+ namespace AmountsDue {
975
+ type Status = 'open' | 'paid' | 'past_due' | OtherString;
976
+ }
813
977
  namespace AutomaticTax {
814
978
  type DisabledReason = 'finalization_requires_location_inputs' | 'finalization_system_error' | OtherString;
815
979
  interface Liability {
@@ -824,32 +988,52 @@ export declare namespace Invoice {
824
988
  }
825
989
  type Status = 'complete' | 'failed' | 'requires_location_inputs' | OtherString;
826
990
  namespace Liability {
827
- type Type = 'account' | 'self' | OtherString;
991
+ type Type = 'account' | 'application' | 'self' | OtherString;
828
992
  }
829
993
  }
830
994
  namespace CustomerTaxId {
831
- 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' | 'ic_nif' | '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';
995
+ 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' | 'ic_nif' | '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' | OtherString;
832
996
  }
833
997
  namespace Issuer {
834
- type Type = 'account' | 'self' | OtherString;
998
+ type Type = 'account' | 'application' | 'self' | OtherString;
835
999
  }
836
1000
  namespace LastFinalizationError {
837
- 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' | 'anomalous_money_movement_request' | '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' | 'failed_tax_calculation' | 'financial_account_balance_does_not_support_currency' | 'financial_account_capability_not_enabled' | 'financial_account_capability_restricted' | '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_processing_error' | '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' | 'siret_invalid' | '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';
838
- type Type = 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error';
1001
+ 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' | 'anomalous_money_movement_request' | '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' | 'failed_tax_calculation' | 'financial_account_balance_does_not_support_currency' | 'financial_account_capability_not_enabled' | 'financial_account_capability_restricted' | '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_processing_error' | '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' | 'siret_invalid' | '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' | OtherString;
1002
+ type Type = 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error' | OtherString;
839
1003
  }
840
1004
  namespace Parent {
1005
+ interface BillingCadenceDetails {
1006
+ /**
1007
+ * The billing cadence that generated this invoice
1008
+ */
1009
+ billing_cadence: string;
1010
+ }
841
1011
  interface QuoteDetails {
842
1012
  /**
843
1013
  * The quote that generated this invoice
844
1014
  */
845
1015
  quote: string;
846
1016
  }
1017
+ interface ScheduleDetails {
1018
+ /**
1019
+ * The schedule that generated this invoice
1020
+ */
1021
+ schedule: string;
1022
+ /**
1023
+ * The subscription associated with this schedule
1024
+ */
1025
+ subscription: string | Subscription | null;
1026
+ }
847
1027
  interface SubscriptionDetails {
848
1028
  /**
849
1029
  * 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.
850
1030
  * *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
851
1031
  */
852
1032
  metadata: Metadata | null;
1033
+ /**
1034
+ * 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).
1035
+ */
1036
+ pause_collection?: SubscriptionDetails.PauseCollection | null;
853
1037
  /**
854
1038
  * The subscription that generated this invoice
855
1039
  */
@@ -859,7 +1043,22 @@ export declare namespace Invoice {
859
1043
  */
860
1044
  subscription_proration_date?: number;
861
1045
  }
862
- type Type = 'quote_details' | 'subscription_details' | OtherString;
1046
+ type Type = 'billing_cadence_details' | 'quote_details' | 'schedule_details' | 'subscription_details' | OtherString;
1047
+ namespace SubscriptionDetails {
1048
+ interface PauseCollection {
1049
+ /**
1050
+ * The payment collection behavior for this subscription while paused.
1051
+ */
1052
+ behavior: PauseCollection.Behavior | null;
1053
+ /**
1054
+ * The time after which the subscription will resume collecting payments.
1055
+ */
1056
+ resumes_at: number | null;
1057
+ }
1058
+ namespace PauseCollection {
1059
+ type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void' | OtherString;
1060
+ }
1061
+ }
863
1062
  }
864
1063
  namespace PaymentSettings {
865
1064
  interface PaymentMethodOptions {
@@ -871,14 +1070,34 @@ export declare namespace Invoice {
871
1070
  * If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
872
1071
  */
873
1072
  bancontact: PaymentMethodOptions.Bancontact | null;
1073
+ /**
1074
+ * If paying by `billie`, this sub-hash contains details about the Billie payment method options to pass to the invoice's PaymentIntent.
1075
+ */
1076
+ billie?: PaymentMethodOptions.Billie | null;
1077
+ /**
1078
+ * If paying by `bizum`, this sub-hash contains details about the Bizum payment method options to pass to the invoice's PaymentIntent.
1079
+ */
1080
+ bizum?: PaymentMethodOptions.Bizum | null;
1081
+ /**
1082
+ * If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
1083
+ */
1084
+ blik?: PaymentMethodOptions.Blik | null;
874
1085
  /**
875
1086
  * If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
876
1087
  */
877
1088
  card: PaymentMethodOptions.Card | null;
1089
+ /**
1090
+ * If paying by `check_scan`, this sub-hash contains details about the Check Scan payment method options to pass to the invoice's PaymentIntent.
1091
+ */
1092
+ check_scan?: PaymentMethodOptions.CheckScan | null;
878
1093
  /**
879
1094
  * If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
880
1095
  */
881
1096
  customer_balance: PaymentMethodOptions.CustomerBalance | null;
1097
+ /**
1098
+ * 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.
1099
+ */
1100
+ id_bank_transfer?: PaymentMethodOptions.IdBankTransfer | null;
882
1101
  /**
883
1102
  * If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
884
1103
  */
@@ -903,8 +1122,12 @@ export declare namespace Invoice {
903
1122
  * If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
904
1123
  */
905
1124
  us_bank_account: PaymentMethodOptions.UsBankAccount | null;
1125
+ /**
1126
+ * If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the invoice's PaymentIntent.
1127
+ */
1128
+ wechat_pay?: PaymentMethodOptions.WechatPay | null;
906
1129
  }
907
- type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'alipay' | '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' | 'mb_way' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | OtherString;
1130
+ type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'alipay' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | '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' | 'mb_way' | 'momo' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sequra' | 'sofort' | 'stripe_balance' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'vipps' | 'wechat_pay' | OtherString;
908
1131
  namespace PaymentMethodOptions {
909
1132
  interface AcssDebit {
910
1133
  mandate_options?: AcssDebit.MandateOptions;
@@ -919,6 +1142,12 @@ export declare namespace Invoice {
919
1142
  */
920
1143
  preferred_language: Bancontact.PreferredLanguage;
921
1144
  }
1145
+ interface Billie {
1146
+ }
1147
+ interface Bizum {
1148
+ }
1149
+ interface Blik {
1150
+ }
922
1151
  interface Card {
923
1152
  installments?: Card.Installments;
924
1153
  /**
@@ -926,6 +1155,8 @@ export declare namespace Invoice {
926
1155
  */
927
1156
  request_three_d_secure: Card.RequestThreeDSecure | null;
928
1157
  }
1158
+ interface CheckScan {
1159
+ }
929
1160
  interface CustomerBalance {
930
1161
  bank_transfer?: CustomerBalance.BankTransfer;
931
1162
  /**
@@ -933,6 +1164,8 @@ export declare namespace Invoice {
933
1164
  */
934
1165
  funding_type: 'bank_transfer' | null;
935
1166
  }
1167
+ interface IdBankTransfer {
1168
+ }
936
1169
  interface Konbini {
937
1170
  }
938
1171
  interface Payto {
@@ -960,6 +1193,16 @@ export declare namespace Invoice {
960
1193
  */
961
1194
  verification_method?: UsBankAccount.VerificationMethod;
962
1195
  }
1196
+ interface WechatPay {
1197
+ /**
1198
+ * The app ID registered with WeChat Pay. Only required when client is `ios` or `android`.
1199
+ */
1200
+ app_id?: string;
1201
+ /**
1202
+ * The client type that the end customer will pay from.
1203
+ */
1204
+ client?: WechatPay.Client;
1205
+ }
963
1206
  namespace AcssDebit {
964
1207
  interface MandateOptions {
965
1208
  /**
@@ -1000,7 +1243,7 @@ export declare namespace Invoice {
1000
1243
  country: EuBankTransfer.Country;
1001
1244
  }
1002
1245
  namespace EuBankTransfer {
1003
- type Country = 'BE' | 'DE' | 'ES' | 'FR' | 'IE' | 'NL';
1246
+ type Country = 'BE' | 'DE' | 'ES' | 'FR' | 'IE' | 'NL' | OtherString;
1004
1247
  }
1005
1248
  }
1006
1249
  }
@@ -1069,14 +1312,21 @@ export declare namespace Invoice {
1069
1312
  * The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
1070
1313
  */
1071
1314
  account_subcategories?: Array<Filters.AccountSubcategory>;
1315
+ /**
1316
+ * The institution to use to filter for possible accounts to link.
1317
+ */
1318
+ institution?: string;
1072
1319
  }
1073
1320
  type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions' | OtherString;
1074
- type Prefetch = 'balances' | 'ownership' | 'transactions' | OtherString;
1321
+ type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions' | OtherString;
1075
1322
  namespace Filters {
1076
1323
  type AccountSubcategory = 'checking' | 'savings' | OtherString;
1077
1324
  }
1078
1325
  }
1079
1326
  }
1327
+ namespace WechatPay {
1328
+ type Client = 'android' | 'ios' | 'mobile_web' | 'web' | OtherString;
1329
+ }
1080
1330
  }
1081
1331
  }
1082
1332
  namespace Rendering {
@@ -1087,7 +1337,7 @@ export declare namespace Invoice {
1087
1337
  page_size: Pdf.PageSize | null;
1088
1338
  }
1089
1339
  namespace Pdf {
1090
- type PageSize = 'a4' | 'auto' | 'letter';
1340
+ type PageSize = 'a4' | 'auto' | 'letter' | OtherString;
1091
1341
  }
1092
1342
  }
1093
1343
  namespace ShippingCost {
@@ -1128,15 +1378,15 @@ export declare namespace Invoice {
1128
1378
  }
1129
1379
  }
1130
1380
  namespace TotalPretaxCreditAmount {
1131
- type Type = 'credit_balance_transaction' | 'discount' | OtherString;
1381
+ type Type = 'credit_balance_transaction' | 'discount' | 'margin' | OtherString;
1132
1382
  }
1133
1383
  namespace TotalTax {
1134
- type TaxBehavior = 'exclusive' | 'inclusive';
1384
+ type TaxBehavior = 'exclusive' | 'inclusive' | OtherString;
1135
1385
  interface TaxRateDetails {
1136
1386
  /**
1137
1387
  * ID of the tax rate
1138
1388
  */
1139
- tax_rate: string;
1389
+ tax_rate: string | TaxRate;
1140
1390
  }
1141
1391
  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' | OtherString;
1142
1392
  }
@@ -1146,6 +1396,10 @@ export interface InvoiceCreateParams {
1146
1396
  * The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
1147
1397
  */
1148
1398
  account_tax_ids?: Emptyable<Array<string>>;
1399
+ /**
1400
+ * List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
1401
+ */
1402
+ amounts_due?: Emptyable<Array<InvoiceCreateParams.AmountsDue>>;
1149
1403
  /**
1150
1404
  * 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).
1151
1405
  */
@@ -1186,6 +1440,10 @@ export interface InvoiceCreateParams {
1186
1440
  * The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
1187
1441
  */
1188
1442
  days_until_due?: number;
1443
+ /**
1444
+ * The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
1445
+ */
1446
+ default_margins?: Array<string>;
1189
1447
  /**
1190
1448
  * 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.
1191
1449
  */
@@ -1230,6 +1488,10 @@ export interface InvoiceCreateParams {
1230
1488
  * The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1231
1489
  */
1232
1490
  issuer?: InvoiceCreateParams.Issuer;
1491
+ /**
1492
+ * Settings for Managed Payments for this invoice.
1493
+ */
1494
+ managed_payments?: InvoiceCreateParams.ManagedPayments;
1233
1495
  /**
1234
1496
  * 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`.
1235
1497
  */
@@ -1276,6 +1538,24 @@ export interface InvoiceCreateParams {
1276
1538
  transfer_data?: InvoiceCreateParams.TransferData;
1277
1539
  }
1278
1540
  export declare namespace InvoiceCreateParams {
1541
+ interface AmountsDue {
1542
+ /**
1543
+ * The amount in cents (or local equivalent).
1544
+ */
1545
+ amount: number;
1546
+ /**
1547
+ * Number of days from when invoice is finalized until the payment is due.
1548
+ */
1549
+ days_until_due?: number;
1550
+ /**
1551
+ * An arbitrary string attached to the object. Often useful for displaying to users.
1552
+ */
1553
+ description: string;
1554
+ /**
1555
+ * Date on which a payment plan's payment is due.
1556
+ */
1557
+ due_date?: number;
1558
+ }
1279
1559
  interface AutomaticTax {
1280
1560
  /**
1281
1561
  * 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.
@@ -1286,7 +1566,7 @@ export declare namespace InvoiceCreateParams {
1286
1566
  */
1287
1567
  liability?: AutomaticTax.Liability;
1288
1568
  }
1289
- type CollectionMethod = 'charge_automatically' | 'send_invoice';
1569
+ type CollectionMethod = 'charge_automatically' | 'send_invoice' | OtherString;
1290
1570
  interface CustomField {
1291
1571
  /**
1292
1572
  * The name of the custom field. This may be up to 40 characters.
@@ -1306,6 +1586,10 @@ export declare namespace InvoiceCreateParams {
1306
1586
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
1307
1587
  */
1308
1588
  discount?: string;
1589
+ /**
1590
+ * Details to determine how long the discount should be applied for.
1591
+ */
1592
+ discount_end?: Discount.DiscountEnd;
1309
1593
  /**
1310
1594
  * ID of the promotion code to create a new discount for.
1311
1595
  */
@@ -1331,6 +1615,12 @@ export declare namespace InvoiceCreateParams {
1331
1615
  */
1332
1616
  type: Issuer.Type;
1333
1617
  }
1618
+ interface ManagedPayments {
1619
+ /**
1620
+ * Set to `true` to enable [Managed Payments](https://docs.stripe.com/payments/managed-payments), Stripe's merchant of record solution.
1621
+ */
1622
+ enabled?: boolean;
1623
+ }
1334
1624
  interface PaymentSettings {
1335
1625
  /**
1336
1626
  * ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.
@@ -1410,11 +1700,43 @@ export declare namespace InvoiceCreateParams {
1410
1700
  type: Liability.Type;
1411
1701
  }
1412
1702
  namespace Liability {
1413
- type Type = 'account' | 'self' | OtherString;
1703
+ type Type = 'account' | 'application' | 'self' | OtherString;
1704
+ }
1705
+ }
1706
+ namespace Discount {
1707
+ interface DiscountEnd {
1708
+ /**
1709
+ * Time span for the redeemed discount.
1710
+ */
1711
+ duration?: DiscountEnd.Duration;
1712
+ /**
1713
+ * A precise Unix timestamp for the discount to end. Must be in the future.
1714
+ */
1715
+ timestamp?: number;
1716
+ /**
1717
+ * The type of calculation made to determine when the discount ends.
1718
+ */
1719
+ type: DiscountEnd.Type;
1720
+ }
1721
+ namespace DiscountEnd {
1722
+ interface Duration {
1723
+ /**
1724
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1725
+ */
1726
+ interval: Duration.Interval;
1727
+ /**
1728
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1729
+ */
1730
+ interval_count: number;
1731
+ }
1732
+ type Type = 'duration' | 'timestamp' | OtherString;
1733
+ namespace Duration {
1734
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
1735
+ }
1414
1736
  }
1415
1737
  }
1416
1738
  namespace Issuer {
1417
- type Type = 'account' | 'self' | OtherString;
1739
+ type Type = 'account' | 'application' | 'self' | OtherString;
1418
1740
  }
1419
1741
  namespace PaymentSettings {
1420
1742
  interface PaymentMethodOptions {
@@ -1426,14 +1748,30 @@ export declare namespace InvoiceCreateParams {
1426
1748
  * If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
1427
1749
  */
1428
1750
  bancontact?: Emptyable<PaymentMethodOptions.Bancontact>;
1751
+ /**
1752
+ * If paying by `bizum`, this sub-hash contains details about the Bizum payment method options to pass to the invoice's PaymentIntent.
1753
+ */
1754
+ bizum?: Emptyable<PaymentMethodOptions.Bizum>;
1755
+ /**
1756
+ * If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
1757
+ */
1758
+ blik?: Emptyable<PaymentMethodOptions.Blik>;
1429
1759
  /**
1430
1760
  * If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
1431
1761
  */
1432
1762
  card?: Emptyable<PaymentMethodOptions.Card>;
1763
+ /**
1764
+ * If paying by `check_scan`, this sub-hash contains details about the Check Scan payment method options to pass to the invoice's PaymentIntent.
1765
+ */
1766
+ check_scan?: Emptyable<PaymentMethodOptions.CheckScan>;
1433
1767
  /**
1434
1768
  * If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
1435
1769
  */
1436
1770
  customer_balance?: Emptyable<PaymentMethodOptions.CustomerBalance>;
1771
+ /**
1772
+ * 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.
1773
+ */
1774
+ id_bank_transfer?: Emptyable<PaymentMethodOptions.IdBankTransfer>;
1437
1775
  /**
1438
1776
  * If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
1439
1777
  */
@@ -1458,8 +1796,12 @@ export declare namespace InvoiceCreateParams {
1458
1796
  * If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
1459
1797
  */
1460
1798
  us_bank_account?: Emptyable<PaymentMethodOptions.UsBankAccount>;
1799
+ /**
1800
+ * If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the invoice's PaymentIntent.
1801
+ */
1802
+ wechat_pay?: Emptyable<PaymentMethodOptions.WechatPay>;
1461
1803
  }
1462
- type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'alipay' | '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' | 'mb_way' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | OtherString;
1804
+ type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'alipay' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | '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' | 'mb_way' | 'momo' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sequra' | 'sofort' | 'stripe_balance' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'vipps' | 'wechat_pay' | OtherString;
1463
1805
  namespace PaymentMethodOptions {
1464
1806
  interface AcssDebit {
1465
1807
  /**
@@ -1477,6 +1819,10 @@ export declare namespace InvoiceCreateParams {
1477
1819
  */
1478
1820
  preferred_language?: Bancontact.PreferredLanguage;
1479
1821
  }
1822
+ interface Bizum {
1823
+ }
1824
+ interface Blik {
1825
+ }
1480
1826
  interface Card {
1481
1827
  /**
1482
1828
  * Installment configuration for payments attempted on this invoice.
@@ -1489,6 +1835,8 @@ export declare namespace InvoiceCreateParams {
1489
1835
  */
1490
1836
  request_three_d_secure?: Card.RequestThreeDSecure;
1491
1837
  }
1838
+ interface CheckScan {
1839
+ }
1492
1840
  interface CustomerBalance {
1493
1841
  /**
1494
1842
  * Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
@@ -1499,6 +1847,8 @@ export declare namespace InvoiceCreateParams {
1499
1847
  */
1500
1848
  funding_type?: string;
1501
1849
  }
1850
+ interface IdBankTransfer {
1851
+ }
1502
1852
  interface Konbini {
1503
1853
  }
1504
1854
  interface Payto {
@@ -1535,6 +1885,16 @@ export declare namespace InvoiceCreateParams {
1535
1885
  */
1536
1886
  verification_method?: UsBankAccount.VerificationMethod;
1537
1887
  }
1888
+ interface WechatPay {
1889
+ /**
1890
+ * The app ID registered with WeChat Pay. Only required when client is `ios` or `android`.
1891
+ */
1892
+ app_id?: string;
1893
+ /**
1894
+ * The client type that the end customer will pay from.
1895
+ */
1896
+ client?: WechatPay.Client;
1897
+ }
1538
1898
  namespace AcssDebit {
1539
1899
  interface MandateOptions {
1540
1900
  /**
@@ -1667,18 +2027,25 @@ export declare namespace InvoiceCreateParams {
1667
2027
  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
1668
2028
  */
1669
2029
  account_subcategories?: Array<Filters.AccountSubcategory>;
2030
+ /**
2031
+ * ID of the institution to use to filter for selectable accounts.
2032
+ */
2033
+ institution?: string;
1670
2034
  }
1671
- type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
1672
- type Prefetch = 'balances' | 'ownership' | 'transactions' | OtherString;
2035
+ type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions' | OtherString;
2036
+ type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions' | OtherString;
1673
2037
  namespace Filters {
1674
2038
  type AccountSubcategory = 'checking' | 'savings' | OtherString;
1675
2039
  }
1676
2040
  }
1677
2041
  }
2042
+ namespace WechatPay {
2043
+ type Client = 'android' | 'ios' | 'mobile_web' | 'web' | OtherString;
2044
+ }
1678
2045
  }
1679
2046
  }
1680
2047
  namespace Rendering {
1681
- type AmountTaxDisplay = 'exclude_tax' | 'include_inclusive_tax';
2048
+ type AmountTaxDisplay = 'exclude_tax' | 'include_inclusive_tax' | OtherString;
1682
2049
  interface Pdf {
1683
2050
  /**
1684
2051
  * Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.
@@ -1688,7 +2055,7 @@ export declare namespace InvoiceCreateParams {
1688
2055
  page_size?: Pdf.PageSize;
1689
2056
  }
1690
2057
  namespace Pdf {
1691
- type PageSize = 'a4' | 'auto' | 'letter';
2058
+ type PageSize = 'a4' | 'auto' | 'letter' | OtherString;
1692
2059
  }
1693
2060
  }
1694
2061
  namespace ShippingCost {
@@ -1749,7 +2116,7 @@ export declare namespace InvoiceCreateParams {
1749
2116
  [key: string]: FixedAmount.CurrencyOptions;
1750
2117
  };
1751
2118
  }
1752
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
2119
+ type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
1753
2120
  namespace DeliveryEstimate {
1754
2121
  interface Maximum {
1755
2122
  /**
@@ -1790,7 +2157,7 @@ export declare namespace InvoiceCreateParams {
1790
2157
  tax_behavior?: CurrencyOptions.TaxBehavior;
1791
2158
  }
1792
2159
  namespace CurrencyOptions {
1793
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
2160
+ type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
1794
2161
  }
1795
2162
  }
1796
2163
  }
@@ -1807,6 +2174,10 @@ export interface InvoiceUpdateParams {
1807
2174
  * The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
1808
2175
  */
1809
2176
  account_tax_ids?: Emptyable<Array<string>>;
2177
+ /**
2178
+ * List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
2179
+ */
2180
+ amounts_due?: Emptyable<Array<InvoiceUpdateParams.AmountsDue>>;
1810
2181
  /**
1811
2182
  * 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).
1812
2183
  */
@@ -1835,6 +2206,10 @@ export interface InvoiceUpdateParams {
1835
2206
  * 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.
1836
2207
  */
1837
2208
  days_until_due?: number;
2209
+ /**
2210
+ * The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
2211
+ */
2212
+ default_margins?: Emptyable<Array<string>>;
1838
2213
  /**
1839
2214
  * 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.
1840
2215
  */
@@ -1913,6 +2288,24 @@ export interface InvoiceUpdateParams {
1913
2288
  transfer_data?: Emptyable<InvoiceUpdateParams.TransferData>;
1914
2289
  }
1915
2290
  export declare namespace InvoiceUpdateParams {
2291
+ interface AmountsDue {
2292
+ /**
2293
+ * The amount in cents (or local equivalent).
2294
+ */
2295
+ amount: number;
2296
+ /**
2297
+ * Number of days from when invoice is finalized until the payment is due.
2298
+ */
2299
+ days_until_due?: number;
2300
+ /**
2301
+ * An arbitrary string attached to the object. Often useful for displaying to users.
2302
+ */
2303
+ description: string;
2304
+ /**
2305
+ * Date on which a payment plan's payment is due.
2306
+ */
2307
+ due_date?: number;
2308
+ }
1916
2309
  interface AutomaticTax {
1917
2310
  /**
1918
2311
  * 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.
@@ -1923,7 +2316,7 @@ export declare namespace InvoiceUpdateParams {
1923
2316
  */
1924
2317
  liability?: AutomaticTax.Liability;
1925
2318
  }
1926
- type CollectionMethod = 'charge_automatically' | 'send_invoice';
2319
+ type CollectionMethod = 'charge_automatically' | 'send_invoice' | OtherString;
1927
2320
  interface CustomField {
1928
2321
  /**
1929
2322
  * The name of the custom field. This may be up to 40 characters.
@@ -1943,6 +2336,10 @@ export declare namespace InvoiceUpdateParams {
1943
2336
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
1944
2337
  */
1945
2338
  discount?: string;
2339
+ /**
2340
+ * Details to determine how long the discount should be applied for.
2341
+ */
2342
+ discount_end?: Discount.DiscountEnd;
1946
2343
  /**
1947
2344
  * ID of the promotion code to create a new discount for.
1948
2345
  */
@@ -2036,11 +2433,43 @@ export declare namespace InvoiceUpdateParams {
2036
2433
  type: Liability.Type;
2037
2434
  }
2038
2435
  namespace Liability {
2039
- type Type = 'account' | 'self' | OtherString;
2436
+ type Type = 'account' | 'application' | 'self' | OtherString;
2437
+ }
2438
+ }
2439
+ namespace Discount {
2440
+ interface DiscountEnd {
2441
+ /**
2442
+ * Time span for the redeemed discount.
2443
+ */
2444
+ duration?: DiscountEnd.Duration;
2445
+ /**
2446
+ * A precise Unix timestamp for the discount to end. Must be in the future.
2447
+ */
2448
+ timestamp?: number;
2449
+ /**
2450
+ * The type of calculation made to determine when the discount ends.
2451
+ */
2452
+ type: DiscountEnd.Type;
2453
+ }
2454
+ namespace DiscountEnd {
2455
+ interface Duration {
2456
+ /**
2457
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2458
+ */
2459
+ interval: Duration.Interval;
2460
+ /**
2461
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2462
+ */
2463
+ interval_count: number;
2464
+ }
2465
+ type Type = 'duration' | 'timestamp' | OtherString;
2466
+ namespace Duration {
2467
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
2468
+ }
2040
2469
  }
2041
2470
  }
2042
2471
  namespace Issuer {
2043
- type Type = 'account' | 'self' | OtherString;
2472
+ type Type = 'account' | 'application' | 'self' | OtherString;
2044
2473
  }
2045
2474
  namespace PaymentSettings {
2046
2475
  interface PaymentMethodOptions {
@@ -2052,14 +2481,30 @@ export declare namespace InvoiceUpdateParams {
2052
2481
  * If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
2053
2482
  */
2054
2483
  bancontact?: Emptyable<PaymentMethodOptions.Bancontact>;
2484
+ /**
2485
+ * If paying by `bizum`, this sub-hash contains details about the Bizum payment method options to pass to the invoice's PaymentIntent.
2486
+ */
2487
+ bizum?: Emptyable<PaymentMethodOptions.Bizum>;
2488
+ /**
2489
+ * If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
2490
+ */
2491
+ blik?: Emptyable<PaymentMethodOptions.Blik>;
2055
2492
  /**
2056
2493
  * If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
2057
2494
  */
2058
2495
  card?: Emptyable<PaymentMethodOptions.Card>;
2496
+ /**
2497
+ * If paying by `check_scan`, this sub-hash contains details about the Check Scan payment method options to pass to the invoice's PaymentIntent.
2498
+ */
2499
+ check_scan?: Emptyable<PaymentMethodOptions.CheckScan>;
2059
2500
  /**
2060
2501
  * If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
2061
2502
  */
2062
2503
  customer_balance?: Emptyable<PaymentMethodOptions.CustomerBalance>;
2504
+ /**
2505
+ * 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.
2506
+ */
2507
+ id_bank_transfer?: Emptyable<PaymentMethodOptions.IdBankTransfer>;
2063
2508
  /**
2064
2509
  * If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
2065
2510
  */
@@ -2084,8 +2529,12 @@ export declare namespace InvoiceUpdateParams {
2084
2529
  * If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
2085
2530
  */
2086
2531
  us_bank_account?: Emptyable<PaymentMethodOptions.UsBankAccount>;
2532
+ /**
2533
+ * If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the invoice's PaymentIntent.
2534
+ */
2535
+ wechat_pay?: Emptyable<PaymentMethodOptions.WechatPay>;
2087
2536
  }
2088
- type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'alipay' | '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' | 'mb_way' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | OtherString;
2537
+ type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'alipay' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | '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' | 'mb_way' | 'momo' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sequra' | 'sofort' | 'stripe_balance' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'vipps' | 'wechat_pay' | OtherString;
2089
2538
  namespace PaymentMethodOptions {
2090
2539
  interface AcssDebit {
2091
2540
  /**
@@ -2103,6 +2552,10 @@ export declare namespace InvoiceUpdateParams {
2103
2552
  */
2104
2553
  preferred_language?: Bancontact.PreferredLanguage;
2105
2554
  }
2555
+ interface Bizum {
2556
+ }
2557
+ interface Blik {
2558
+ }
2106
2559
  interface Card {
2107
2560
  /**
2108
2561
  * Installment configuration for payments attempted on this invoice.
@@ -2115,6 +2568,8 @@ export declare namespace InvoiceUpdateParams {
2115
2568
  */
2116
2569
  request_three_d_secure?: Card.RequestThreeDSecure;
2117
2570
  }
2571
+ interface CheckScan {
2572
+ }
2118
2573
  interface CustomerBalance {
2119
2574
  /**
2120
2575
  * Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
@@ -2125,6 +2580,8 @@ export declare namespace InvoiceUpdateParams {
2125
2580
  */
2126
2581
  funding_type?: string;
2127
2582
  }
2583
+ interface IdBankTransfer {
2584
+ }
2128
2585
  interface Konbini {
2129
2586
  }
2130
2587
  interface Payto {
@@ -2161,6 +2618,16 @@ export declare namespace InvoiceUpdateParams {
2161
2618
  */
2162
2619
  verification_method?: UsBankAccount.VerificationMethod;
2163
2620
  }
2621
+ interface WechatPay {
2622
+ /**
2623
+ * The app ID registered with WeChat Pay. Only required when client is `ios` or `android`.
2624
+ */
2625
+ app_id?: string;
2626
+ /**
2627
+ * The client type that the end customer will pay from.
2628
+ */
2629
+ client?: WechatPay.Client;
2630
+ }
2164
2631
  namespace AcssDebit {
2165
2632
  interface MandateOptions {
2166
2633
  /**
@@ -2293,18 +2760,25 @@ export declare namespace InvoiceUpdateParams {
2293
2760
  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
2294
2761
  */
2295
2762
  account_subcategories?: Array<Filters.AccountSubcategory>;
2763
+ /**
2764
+ * ID of the institution to use to filter for selectable accounts.
2765
+ */
2766
+ institution?: string;
2296
2767
  }
2297
- type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
2298
- type Prefetch = 'balances' | 'ownership' | 'transactions' | OtherString;
2768
+ type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions' | OtherString;
2769
+ type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions' | OtherString;
2299
2770
  namespace Filters {
2300
2771
  type AccountSubcategory = 'checking' | 'savings' | OtherString;
2301
2772
  }
2302
2773
  }
2303
2774
  }
2775
+ namespace WechatPay {
2776
+ type Client = 'android' | 'ios' | 'mobile_web' | 'web' | OtherString;
2777
+ }
2304
2778
  }
2305
2779
  }
2306
2780
  namespace Rendering {
2307
- type AmountTaxDisplay = 'exclude_tax' | 'include_inclusive_tax';
2781
+ type AmountTaxDisplay = 'exclude_tax' | 'include_inclusive_tax' | OtherString;
2308
2782
  interface Pdf {
2309
2783
  /**
2310
2784
  * Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.
@@ -2314,7 +2788,7 @@ export declare namespace InvoiceUpdateParams {
2314
2788
  page_size?: Pdf.PageSize;
2315
2789
  }
2316
2790
  namespace Pdf {
2317
- type PageSize = 'a4' | 'auto' | 'letter';
2791
+ type PageSize = 'a4' | 'auto' | 'letter' | OtherString;
2318
2792
  }
2319
2793
  }
2320
2794
  namespace ShippingCost {
@@ -2375,7 +2849,7 @@ export declare namespace InvoiceUpdateParams {
2375
2849
  [key: string]: FixedAmount.CurrencyOptions;
2376
2850
  };
2377
2851
  }
2378
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
2852
+ type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
2379
2853
  namespace DeliveryEstimate {
2380
2854
  interface Maximum {
2381
2855
  /**
@@ -2416,13 +2890,17 @@ export declare namespace InvoiceUpdateParams {
2416
2890
  tax_behavior?: CurrencyOptions.TaxBehavior;
2417
2891
  }
2418
2892
  namespace CurrencyOptions {
2419
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
2893
+ type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
2420
2894
  }
2421
2895
  }
2422
2896
  }
2423
2897
  }
2424
2898
  }
2425
2899
  export interface InvoiceListParams extends PaginationParams {
2900
+ /**
2901
+ * Only return invoices for the cadence specified by this billing cadence ID.
2902
+ */
2903
+ billing_cadence?: string;
2426
2904
  /**
2427
2905
  * The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.
2428
2906
  */
@@ -2454,7 +2932,7 @@ export interface InvoiceListParams extends PaginationParams {
2454
2932
  subscription?: string;
2455
2933
  }
2456
2934
  export declare namespace InvoiceListParams {
2457
- type CollectionMethod = 'charge_automatically' | 'send_invoice';
2935
+ type CollectionMethod = 'charge_automatically' | 'send_invoice' | OtherString;
2458
2936
  type Status = 'draft' | 'open' | 'paid' | 'uncollectible' | 'void' | OtherString;
2459
2937
  }
2460
2938
  export interface InvoiceDeleteParams {
@@ -2497,6 +2975,10 @@ export declare namespace InvoiceAddLinesParams {
2497
2975
  * ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.
2498
2976
  */
2499
2977
  invoice_item?: string;
2978
+ /**
2979
+ * 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.
2980
+ */
2981
+ margins?: Emptyable<Array<string>>;
2500
2982
  /**
2501
2983
  * 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`.
2502
2984
  */
@@ -2540,6 +3022,10 @@ export declare namespace InvoiceAddLinesParams {
2540
3022
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
2541
3023
  */
2542
3024
  discount?: string;
3025
+ /**
3026
+ * Details to determine how long the discount should be applied for.
3027
+ */
3028
+ discount_end?: Discount.DiscountEnd;
2543
3029
  /**
2544
3030
  * ID of the promotion code to create a new discount for.
2545
3031
  */
@@ -2607,6 +3093,38 @@ export declare namespace InvoiceAddLinesParams {
2607
3093
  */
2608
3094
  taxable_amount: number;
2609
3095
  }
3096
+ namespace Discount {
3097
+ interface DiscountEnd {
3098
+ /**
3099
+ * Time span for the redeemed discount.
3100
+ */
3101
+ duration?: DiscountEnd.Duration;
3102
+ /**
3103
+ * A precise Unix timestamp for the discount to end. Must be in the future.
3104
+ */
3105
+ timestamp?: number;
3106
+ /**
3107
+ * The type of calculation made to determine when the discount ends.
3108
+ */
3109
+ type: DiscountEnd.Type;
3110
+ }
3111
+ namespace DiscountEnd {
3112
+ interface Duration {
3113
+ /**
3114
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
3115
+ */
3116
+ interval: Duration.Interval;
3117
+ /**
3118
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
3119
+ */
3120
+ interval_count: number;
3121
+ }
3122
+ type Type = 'duration' | 'timestamp' | OtherString;
3123
+ namespace Duration {
3124
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
3125
+ }
3126
+ }
3127
+ }
2610
3128
  namespace PriceData {
2611
3129
  interface ProductData {
2612
3130
  /**
@@ -2629,12 +3147,28 @@ export declare namespace InvoiceAddLinesParams {
2629
3147
  * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
2630
3148
  */
2631
3149
  tax_code?: string;
3150
+ /**
3151
+ * Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
3152
+ */
3153
+ tax_details?: ProductData.TaxDetails;
2632
3154
  /**
2633
3155
  * A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
2634
3156
  */
2635
3157
  unit_label?: string;
2636
3158
  }
2637
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
3159
+ type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
3160
+ namespace ProductData {
3161
+ interface TaxDetails {
3162
+ /**
3163
+ * 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.
3164
+ */
3165
+ performance_location?: string;
3166
+ /**
3167
+ * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
3168
+ */
3169
+ tax_code?: Emptyable<string>;
3170
+ }
3171
+ }
2638
3172
  }
2639
3173
  namespace TaxAmount {
2640
3174
  interface TaxRateData {
@@ -2685,7 +3219,11 @@ export declare namespace InvoiceAddLinesParams {
2685
3219
  }
2686
3220
  export interface InvoiceAttachPaymentParams {
2687
3221
  /**
2688
- * Specifies which fields in the response should be expanded.
3222
+ * The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.
3223
+ */
3224
+ amount_requested?: number;
3225
+ /**
3226
+ * Specifies which fields in the response should be expanded.
2689
3227
  */
2690
3228
  expand?: Array<string>;
2691
3229
  /**
@@ -2696,12 +3234,48 @@ export interface InvoiceAttachPaymentParams {
2696
3234
  * The ID of the PaymentRecord to attach to the invoice.
2697
3235
  */
2698
3236
  payment_record?: string;
3237
+ /**
3238
+ * The PaymentRecord data for attaching an out of band payment to the invoice.
3239
+ */
3240
+ payment_record_data?: InvoiceAttachPaymentParams.PaymentRecordData;
3241
+ }
3242
+ export declare namespace InvoiceAttachPaymentParams {
3243
+ interface PaymentRecordData {
3244
+ /**
3245
+ * The amount that was paid out of band.
3246
+ */
3247
+ amount: number;
3248
+ /**
3249
+ * The currency that was paid out of band.
3250
+ */
3251
+ currency: string;
3252
+ /**
3253
+ * 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`.
3254
+ */
3255
+ metadata?: Emptyable<MetadataParam>;
3256
+ /**
3257
+ * The type of money movement for this out of band payment record.
3258
+ */
3259
+ money_movement_type: string;
3260
+ /**
3261
+ * The timestamp when this out of band payment was paid.
3262
+ */
3263
+ paid_at?: number;
3264
+ /**
3265
+ * The reference for this out of band payment record.
3266
+ */
3267
+ payment_reference?: string;
3268
+ }
2699
3269
  }
2700
3270
  export interface InvoiceCreatePreviewParams {
2701
3271
  /**
2702
3272
  * Settings for automatic tax lookup for this invoice preview.
2703
3273
  */
2704
3274
  automatic_tax?: InvoiceCreatePreviewParams.AutomaticTax;
3275
+ /**
3276
+ * 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.
3277
+ */
3278
+ billing_cadence?: string;
2705
3279
  /**
2706
3280
  * The currency to preview this invoice in. Defaults to that of `customer` if not specified.
2707
3281
  */
@@ -2801,10 +3375,18 @@ export declare namespace InvoiceCreatePreviewParams {
2801
3375
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
2802
3376
  */
2803
3377
  discount?: string;
3378
+ /**
3379
+ * Details to determine how long the discount should be applied for.
3380
+ */
3381
+ discount_end?: Discount.DiscountEnd;
2804
3382
  /**
2805
3383
  * ID of the promotion code to create a new discount for.
2806
3384
  */
2807
3385
  promotion_code?: string;
3386
+ /**
3387
+ * Settings for discount application including service period anchoring.
3388
+ */
3389
+ settings?: Discount.Settings;
2808
3390
  }
2809
3391
  interface InvoiceItem {
2810
3392
  /**
@@ -2888,10 +3470,26 @@ export declare namespace InvoiceCreatePreviewParams {
2888
3470
  }
2889
3471
  type PreviewMode = 'next' | 'recurring' | OtherString;
2890
3472
  interface ScheduleDetails {
3473
+ /**
3474
+ * Changes to apply to the phases of the subscription schedule, in the order provided.
3475
+ */
3476
+ amendments?: Array<ScheduleDetails.Amendment>;
3477
+ /**
3478
+ * 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.
3479
+ */
3480
+ billing_behavior?: ScheduleDetails.BillingBehavior;
2891
3481
  /**
2892
3482
  * Controls how prorations and invoices for subscriptions are calculated and orchestrated.
2893
3483
  */
2894
3484
  billing_mode?: ScheduleDetails.BillingMode;
3485
+ /**
3486
+ * Sets the billing schedules for the subscription schedule.
3487
+ */
3488
+ billing_schedules?: Emptyable<Array<ScheduleDetails.BillingSchedule>>;
3489
+ /**
3490
+ * Object representing the subscription schedule's default settings.
3491
+ */
3492
+ default_settings?: ScheduleDetails.DefaultSettings;
2895
3493
  /**
2896
3494
  * 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.
2897
3495
  */
@@ -2900,6 +3498,10 @@ export declare namespace InvoiceCreatePreviewParams {
2900
3498
  * 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.
2901
3499
  */
2902
3500
  phases?: Array<ScheduleDetails.Phase>;
3501
+ /**
3502
+ * Provide any time periods to bill in advance.
3503
+ */
3504
+ prebilling?: Emptyable<Array<ScheduleDetails.Prebilling>>;
2903
3505
  /**
2904
3506
  * In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
2905
3507
  */
@@ -2942,6 +3544,18 @@ export declare namespace InvoiceCreatePreviewParams {
2942
3544
  * 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`.
2943
3545
  */
2944
3546
  metadata?: Emptyable<MetadataParam>;
3547
+ /**
3548
+ * Previews the invoice that would be generated when pausing the subscription. Passing an empty hash won't preview pausing and instead returns the next invoice.
3549
+ *
3550
+ * To receive a preview invoice, set `invoicing_behavior` to `invoice`. A preview isn't available if the `bill_for` options produce no billable amounts.
3551
+ *
3552
+ * `pending_invoice_item` never has a preview available because pausing wouldn't generate an invoice, and paused subscriptions don't generate invoices either.
3553
+ */
3554
+ pause?: SubscriptionDetails.Pause;
3555
+ /**
3556
+ * The pre-billing to apply to the subscription as a preview.
3557
+ */
3558
+ prebilling?: SubscriptionDetails.Prebilling;
2945
3559
  /**
2946
3560
  * 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`.
2947
3561
  */
@@ -2975,7 +3589,7 @@ export declare namespace InvoiceCreatePreviewParams {
2975
3589
  type: Liability.Type;
2976
3590
  }
2977
3591
  namespace Liability {
2978
- type Type = 'account' | 'self' | OtherString;
3592
+ type Type = 'account' | 'application' | 'self' | OtherString;
2979
3593
  }
2980
3594
  }
2981
3595
  namespace CustomerDetails {
@@ -2999,7 +3613,7 @@ export declare namespace InvoiceCreatePreviewParams {
2999
3613
  */
3000
3614
  ip_address?: Emptyable<string>;
3001
3615
  }
3002
- type TaxExempt = 'exempt' | 'none' | 'reverse';
3616
+ type TaxExempt = 'exempt' | 'none' | 'reverse' | OtherString;
3003
3617
  interface TaxId {
3004
3618
  /**
3005
3619
  * Type of the tax ID, one of `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`, `ic_nif`, `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`, or `zw_tin`
@@ -3011,7 +3625,87 @@ export declare namespace InvoiceCreatePreviewParams {
3011
3625
  value: string;
3012
3626
  }
3013
3627
  namespace TaxId {
3014
- 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' | 'ic_nif' | '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';
3628
+ 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' | 'ic_nif' | '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' | OtherString;
3629
+ }
3630
+ }
3631
+ namespace Discount {
3632
+ interface DiscountEnd {
3633
+ /**
3634
+ * Time span for the redeemed discount.
3635
+ */
3636
+ duration?: DiscountEnd.Duration;
3637
+ /**
3638
+ * A precise Unix timestamp for the discount to end. Must be in the future.
3639
+ */
3640
+ timestamp?: number;
3641
+ /**
3642
+ * The type of calculation made to determine when the discount ends.
3643
+ */
3644
+ type: DiscountEnd.Type;
3645
+ }
3646
+ interface Settings {
3647
+ /**
3648
+ * Configures service period cycle anchoring.
3649
+ */
3650
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
3651
+ /**
3652
+ * 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.
3653
+ */
3654
+ start_date?: Settings.StartDate;
3655
+ }
3656
+ namespace DiscountEnd {
3657
+ interface Duration {
3658
+ /**
3659
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
3660
+ */
3661
+ interval: Duration.Interval;
3662
+ /**
3663
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
3664
+ */
3665
+ interval_count: number;
3666
+ }
3667
+ type Type = 'duration' | 'timestamp' | OtherString;
3668
+ namespace Duration {
3669
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
3670
+ }
3671
+ }
3672
+ namespace Settings {
3673
+ interface ServicePeriodAnchorConfig {
3674
+ /**
3675
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
3676
+ */
3677
+ custom?: ServicePeriodAnchorConfig.Custom;
3678
+ /**
3679
+ * The type of service period anchor config. Defaults to `subscription_service_cycle_anchor` if omitted.
3680
+ */
3681
+ type?: ServicePeriodAnchorConfig.Type;
3682
+ }
3683
+ type StartDate = 'current_period_end' | 'current_period_start' | 'now' | OtherString;
3684
+ namespace ServicePeriodAnchorConfig {
3685
+ interface Custom {
3686
+ /**
3687
+ * The day of the month the anchor should be. Ranges from 1 to 31.
3688
+ */
3689
+ day_of_month: number;
3690
+ /**
3691
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
3692
+ */
3693
+ hour?: number;
3694
+ /**
3695
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
3696
+ */
3697
+ minute?: number;
3698
+ /**
3699
+ * The month to start full cycle periods. Ranges from 1 to 12.
3700
+ */
3701
+ month?: number;
3702
+ /**
3703
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
3704
+ */
3705
+ second?: number;
3706
+ }
3707
+ type Type = 'custom' | 'subscription_service_cycle_anchor' | OtherString;
3708
+ }
3015
3709
  }
3016
3710
  }
3017
3711
  namespace InvoiceItem {
@@ -3024,6 +3718,10 @@ export declare namespace InvoiceCreatePreviewParams {
3024
3718
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3025
3719
  */
3026
3720
  discount?: string;
3721
+ /**
3722
+ * Details to determine how long the discount should be applied for.
3723
+ */
3724
+ discount_end?: Discount.DiscountEnd;
3027
3725
  /**
3028
3726
  * ID of the promotion code to create a new discount for.
3029
3727
  */
@@ -3061,15 +3759,98 @@ export declare namespace InvoiceCreatePreviewParams {
3061
3759
  */
3062
3760
  unit_amount_decimal?: Decimal;
3063
3761
  }
3064
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
3762
+ type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
3763
+ namespace Discount {
3764
+ interface DiscountEnd {
3765
+ /**
3766
+ * Time span for the redeemed discount.
3767
+ */
3768
+ duration?: DiscountEnd.Duration;
3769
+ /**
3770
+ * A precise Unix timestamp for the discount to end. Must be in the future.
3771
+ */
3772
+ timestamp?: number;
3773
+ /**
3774
+ * The type of calculation made to determine when the discount ends.
3775
+ */
3776
+ type: DiscountEnd.Type;
3777
+ }
3778
+ namespace DiscountEnd {
3779
+ interface Duration {
3780
+ /**
3781
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
3782
+ */
3783
+ interval: Duration.Interval;
3784
+ /**
3785
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
3786
+ */
3787
+ interval_count: number;
3788
+ }
3789
+ type Type = 'duration' | 'timestamp' | OtherString;
3790
+ namespace Duration {
3791
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
3792
+ }
3793
+ }
3794
+ }
3065
3795
  namespace PriceData {
3066
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
3796
+ type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
3067
3797
  }
3068
3798
  }
3069
3799
  namespace Issuer {
3070
- type Type = 'account' | 'self' | OtherString;
3800
+ type Type = 'account' | 'application' | 'self' | OtherString;
3071
3801
  }
3072
3802
  namespace ScheduleDetails {
3803
+ interface Amendment {
3804
+ /**
3805
+ * 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.
3806
+ */
3807
+ amendment_end?: Amendment.AmendmentEnd;
3808
+ /**
3809
+ * Details to identify the earliest timestamp where the proposed change should take effect.
3810
+ */
3811
+ amendment_start: Amendment.AmendmentStart;
3812
+ /**
3813
+ * 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.
3814
+ */
3815
+ billing_cycle_anchor?: Amendment.BillingCycleAnchor;
3816
+ /**
3817
+ * Actions to apply to the billing schedules.
3818
+ */
3819
+ billing_schedules_actions?: Array<Amendment.BillingSchedulesAction>;
3820
+ /**
3821
+ * Changes to the coupons being redeemed or discounts being applied during the amendment time span.
3822
+ */
3823
+ discount_actions?: Array<Amendment.DiscountAction>;
3824
+ /**
3825
+ * Configures how the subscription schedule handles billing for phase transitions.
3826
+ */
3827
+ effective_at?: Amendment.EffectiveAt;
3828
+ /**
3829
+ * Changes to the subscription items during the amendment time span.
3830
+ */
3831
+ item_actions?: Array<Amendment.ItemAction>;
3832
+ /**
3833
+ * Instructions for how to modify phase metadata
3834
+ */
3835
+ metadata_actions?: Array<Amendment.MetadataAction>;
3836
+ /**
3837
+ * 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`.
3838
+ */
3839
+ proration_behavior?: Amendment.ProrationBehavior;
3840
+ /**
3841
+ * Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
3842
+ */
3843
+ set_pause_collection?: Amendment.SetPauseCollection;
3844
+ /**
3845
+ * Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
3846
+ */
3847
+ set_schedule_end?: Amendment.SetScheduleEnd;
3848
+ /**
3849
+ * Settings related to subscription trials.
3850
+ */
3851
+ trial_settings?: Amendment.TrialSettings;
3852
+ }
3853
+ type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front' | OtherString;
3073
3854
  interface BillingMode {
3074
3855
  /**
3075
3856
  * Configure behavior for flexible billing mode.
@@ -3080,7 +3861,27 @@ export declare namespace InvoiceCreatePreviewParams {
3080
3861
  */
3081
3862
  type: BillingMode.Type;
3082
3863
  }
3083
- type EndBehavior = 'cancel' | 'release';
3864
+ interface BillingSchedule {
3865
+ /**
3866
+ * Configure billing schedule differently for individual subscription items.
3867
+ */
3868
+ applies_to?: Array<BillingSchedule.AppliesTo>;
3869
+ /**
3870
+ * The end date for the billing schedule.
3871
+ */
3872
+ bill_until?: BillingSchedule.BillUntil;
3873
+ /**
3874
+ * 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.
3875
+ */
3876
+ key?: string;
3877
+ }
3878
+ interface DefaultSettings {
3879
+ /**
3880
+ * Configures how the subscription schedule handles billing for phase transitions.
3881
+ */
3882
+ phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
3883
+ }
3884
+ type EndBehavior = 'cancel' | 'release' | OtherString;
3084
3885
  interface Phase {
3085
3886
  /**
3086
3887
  * A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
@@ -3130,6 +3931,10 @@ export declare namespace InvoiceCreatePreviewParams {
3130
3931
  * The number of intervals the phase should last. If set, `end_date` must not be set.
3131
3932
  */
3132
3933
  duration?: Phase.Duration;
3934
+ /**
3935
+ * Configures how the subscription schedule handles billing for phase transitions.
3936
+ */
3937
+ effective_at?: Phase.EffectiveAt;
3133
3938
  /**
3134
3939
  * The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
3135
3940
  */
@@ -3150,6 +3955,10 @@ export declare namespace InvoiceCreatePreviewParams {
3150
3955
  * The account on behalf of which to charge, for each of the associated subscription's invoices.
3151
3956
  */
3152
3957
  on_behalf_of?: string;
3958
+ /**
3959
+ * 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).
3960
+ */
3961
+ pause_collection?: Phase.PauseCollection;
3153
3962
  /**
3154
3963
  * 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.
3155
3964
  */
@@ -3166,12 +3975,702 @@ export declare namespace InvoiceCreatePreviewParams {
3166
3975
  * If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
3167
3976
  */
3168
3977
  trial?: boolean;
3978
+ /**
3979
+ * Specify trial behavior when crossing phase boundaries
3980
+ */
3981
+ trial_continuation?: Phase.TrialContinuation;
3169
3982
  /**
3170
3983
  * Sets the phase to trialing from the start date to this date. Must be within the phase. When previewing an update, if combined with `trial=true`, it must match the phase end date.
3171
3984
  */
3172
3985
  trial_end?: number | 'now';
3986
+ /**
3987
+ * Settings related to subscription trials.
3988
+ */
3989
+ trial_settings?: Phase.TrialSettings;
3990
+ }
3991
+ interface Prebilling {
3992
+ /**
3993
+ * The end of the prebilled time period.
3994
+ */
3995
+ bill_until?: Prebilling.BillUntil;
3996
+ /**
3997
+ * This is used to determine the number of billing cycles to prebill.
3998
+ */
3999
+ iterations?: number;
3173
4000
  }
3174
4001
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
4002
+ namespace Amendment {
4003
+ interface AmendmentEnd {
4004
+ /**
4005
+ * Use the `end` time of a given discount.
4006
+ */
4007
+ discount_end?: AmendmentEnd.DiscountEnd;
4008
+ /**
4009
+ * Time span for the amendment starting from the `amendment_start`.
4010
+ */
4011
+ duration?: AmendmentEnd.Duration;
4012
+ /**
4013
+ * A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
4014
+ */
4015
+ timestamp?: number;
4016
+ /**
4017
+ * Select one of three ways to pass the `amendment_end`.
4018
+ */
4019
+ type: AmendmentEnd.Type;
4020
+ }
4021
+ interface AmendmentStart {
4022
+ /**
4023
+ * Details of another amendment in the same array, immediately after which this amendment should begin.
4024
+ */
4025
+ amendment_end?: AmendmentStart.AmendmentEnd;
4026
+ /**
4027
+ * Use the `end` time of a given discount.
4028
+ */
4029
+ discount_end?: AmendmentStart.DiscountEnd;
4030
+ /**
4031
+ * A precise Unix timestamp for the amendment to start.
4032
+ */
4033
+ timestamp?: number;
4034
+ /**
4035
+ * Select one of three ways to pass the `amendment_start`.
4036
+ */
4037
+ type: AmendmentStart.Type;
4038
+ }
4039
+ type BillingCycleAnchor = 'amendment_start' | 'automatic' | OtherString;
4040
+ interface BillingSchedulesAction {
4041
+ /**
4042
+ * Specify which subscription items the billing schedule applies to.
4043
+ */
4044
+ applies_to?: Array<BillingSchedulesAction.AppliesTo>;
4045
+ /**
4046
+ * Select the action.
4047
+ */
4048
+ type: BillingSchedulesAction.Type;
4049
+ }
4050
+ interface DiscountAction {
4051
+ /**
4052
+ * Details of the discount to add.
4053
+ */
4054
+ add?: DiscountAction.Add;
4055
+ /**
4056
+ * Details of the discount to remove.
4057
+ */
4058
+ remove?: DiscountAction.Remove;
4059
+ /**
4060
+ * Details of the discount to replace the existing discounts with.
4061
+ */
4062
+ set?: DiscountAction.Set;
4063
+ /**
4064
+ * Determines the type of discount action.
4065
+ */
4066
+ type: DiscountAction.Type;
4067
+ }
4068
+ type EffectiveAt = 'amendment_start' | 'billing_period_start' | OtherString;
4069
+ interface ItemAction {
4070
+ /**
4071
+ * 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.
4072
+ */
4073
+ add?: ItemAction.Add;
4074
+ /**
4075
+ * Details of the subscription item to remove.
4076
+ */
4077
+ remove?: ItemAction.Remove;
4078
+ /**
4079
+ * 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.
4080
+ */
4081
+ set?: ItemAction.Set;
4082
+ /**
4083
+ * Determines the type of item action.
4084
+ */
4085
+ type: ItemAction.Type;
4086
+ }
4087
+ interface MetadataAction {
4088
+ /**
4089
+ * Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
4090
+ */
4091
+ add?: {
4092
+ [key: string]: string;
4093
+ };
4094
+ /**
4095
+ * Keys to remove from schedule phase metadata.
4096
+ */
4097
+ remove?: Array<string>;
4098
+ /**
4099
+ * Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
4100
+ */
4101
+ set?: Emptyable<{
4102
+ [key: string]: string;
4103
+ }>;
4104
+ /**
4105
+ * Select one of three ways to update phase-level `metadata` on subscription schedules.
4106
+ */
4107
+ type: MetadataAction.Type;
4108
+ }
4109
+ type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
4110
+ interface SetPauseCollection {
4111
+ /**
4112
+ * Details of the pause_collection behavior to apply to the amendment.
4113
+ */
4114
+ set?: SetPauseCollection.Set;
4115
+ /**
4116
+ * Determines the type of the pause_collection amendment.
4117
+ */
4118
+ type: SetPauseCollection.Type;
4119
+ }
4120
+ type SetScheduleEnd = 'amendment_end' | 'amendment_start' | OtherString;
4121
+ interface TrialSettings {
4122
+ /**
4123
+ * Defines how the subscription should behave when a trial ends.
4124
+ */
4125
+ end_behavior?: TrialSettings.EndBehavior;
4126
+ }
4127
+ namespace AmendmentEnd {
4128
+ interface DiscountEnd {
4129
+ /**
4130
+ * The ID of a specific discount.
4131
+ */
4132
+ discount: string;
4133
+ }
4134
+ interface Duration {
4135
+ /**
4136
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4137
+ */
4138
+ interval: Duration.Interval;
4139
+ /**
4140
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4141
+ */
4142
+ interval_count: number;
4143
+ }
4144
+ type Type = 'discount_end' | 'duration' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice' | OtherString;
4145
+ namespace Duration {
4146
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
4147
+ }
4148
+ }
4149
+ namespace AmendmentStart {
4150
+ interface AmendmentEnd {
4151
+ /**
4152
+ * 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.
4153
+ */
4154
+ index: number;
4155
+ }
4156
+ interface DiscountEnd {
4157
+ /**
4158
+ * The ID of a specific discount.
4159
+ */
4160
+ discount: string;
4161
+ }
4162
+ type Type = 'amendment_end' | 'discount_end' | 'now' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice' | OtherString;
4163
+ }
4164
+ namespace BillingSchedulesAction {
4165
+ interface AppliesTo {
4166
+ /**
4167
+ * The ID of the price object.
4168
+ */
4169
+ price?: string;
4170
+ /**
4171
+ * Controls which subscription items the billing schedule applies to.
4172
+ */
4173
+ type: 'price';
4174
+ }
4175
+ type Type = 'remove' | 'set' | OtherString;
4176
+ }
4177
+ namespace DiscountAction {
4178
+ interface Add {
4179
+ /**
4180
+ * The coupon code to redeem.
4181
+ */
4182
+ coupon?: string;
4183
+ /**
4184
+ * An ID of an existing discount for a coupon that was already redeemed.
4185
+ */
4186
+ discount?: string;
4187
+ /**
4188
+ * Details to determine how long the discount should be applied for.
4189
+ */
4190
+ discount_end?: Add.DiscountEnd;
4191
+ /**
4192
+ * 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.
4193
+ */
4194
+ index?: number;
4195
+ /**
4196
+ * The promotion code to redeem.
4197
+ */
4198
+ promotion_code?: string;
4199
+ /**
4200
+ * Settings for discount application including service period anchoring.
4201
+ */
4202
+ settings?: Add.Settings;
4203
+ }
4204
+ interface Remove {
4205
+ /**
4206
+ * The coupon code to remove from the `discounts` array.
4207
+ */
4208
+ coupon?: string;
4209
+ /**
4210
+ * The ID of a discount to remove from the `discounts` array.
4211
+ */
4212
+ discount?: string;
4213
+ /**
4214
+ * The ID of a promotion code to remove from the `discounts` array.
4215
+ */
4216
+ promotion_code?: string;
4217
+ }
4218
+ interface Set {
4219
+ /**
4220
+ * The coupon code to replace the `discounts` array with.
4221
+ */
4222
+ coupon?: string;
4223
+ /**
4224
+ * An ID of an existing discount to replace the `discounts` array with.
4225
+ */
4226
+ discount?: string;
4227
+ /**
4228
+ * An ID of an existing promotion code to replace the `discounts` array with.
4229
+ */
4230
+ promotion_code?: string;
4231
+ /**
4232
+ * Settings for discount application including service period anchoring.
4233
+ */
4234
+ settings?: Set.Settings;
4235
+ }
4236
+ type Type = 'add' | 'remove' | 'set' | OtherString;
4237
+ namespace Add {
4238
+ interface DiscountEnd {
4239
+ /**
4240
+ * The type of calculation made to determine when the discount ends.
4241
+ */
4242
+ type: 'amendment_end';
4243
+ }
4244
+ interface Settings {
4245
+ /**
4246
+ * Configures service period cycle anchoring.
4247
+ */
4248
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
4249
+ /**
4250
+ * 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.
4251
+ */
4252
+ start_date?: Settings.StartDate;
4253
+ }
4254
+ namespace Settings {
4255
+ interface ServicePeriodAnchorConfig {
4256
+ /**
4257
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
4258
+ */
4259
+ custom?: ServicePeriodAnchorConfig.Custom;
4260
+ /**
4261
+ * The type of service period anchor config. Defaults to `inherit` if omitted.
4262
+ */
4263
+ type?: ServicePeriodAnchorConfig.Type;
4264
+ }
4265
+ type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start' | OtherString;
4266
+ namespace ServicePeriodAnchorConfig {
4267
+ interface Custom {
4268
+ /**
4269
+ * The day of the month the anchor should be. Ranges from 1 to 31.
4270
+ */
4271
+ day_of_month: number;
4272
+ /**
4273
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
4274
+ */
4275
+ hour?: number;
4276
+ /**
4277
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
4278
+ */
4279
+ minute?: number;
4280
+ /**
4281
+ * The month to start full cycle periods. Ranges from 1 to 12.
4282
+ */
4283
+ month?: number;
4284
+ /**
4285
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
4286
+ */
4287
+ second?: number;
4288
+ }
4289
+ type Type = 'custom' | 'inherit' | OtherString;
4290
+ }
4291
+ }
4292
+ }
4293
+ namespace Set {
4294
+ interface Settings {
4295
+ /**
4296
+ * Configures service period cycle anchoring.
4297
+ */
4298
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
4299
+ /**
4300
+ * 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.
4301
+ */
4302
+ start_date?: Settings.StartDate;
4303
+ }
4304
+ namespace Settings {
4305
+ interface ServicePeriodAnchorConfig {
4306
+ /**
4307
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
4308
+ */
4309
+ custom?: ServicePeriodAnchorConfig.Custom;
4310
+ /**
4311
+ * The type of service period anchor config. Defaults to `inherit` if omitted.
4312
+ */
4313
+ type?: ServicePeriodAnchorConfig.Type;
4314
+ }
4315
+ type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start' | OtherString;
4316
+ namespace ServicePeriodAnchorConfig {
4317
+ interface Custom {
4318
+ /**
4319
+ * The day of the month the anchor should be. Ranges from 1 to 31.
4320
+ */
4321
+ day_of_month: number;
4322
+ /**
4323
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
4324
+ */
4325
+ hour?: number;
4326
+ /**
4327
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
4328
+ */
4329
+ minute?: number;
4330
+ /**
4331
+ * The month to start full cycle periods. Ranges from 1 to 12.
4332
+ */
4333
+ month?: number;
4334
+ /**
4335
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
4336
+ */
4337
+ second?: number;
4338
+ }
4339
+ type Type = 'custom' | 'inherit' | OtherString;
4340
+ }
4341
+ }
4342
+ }
4343
+ }
4344
+ namespace ItemAction {
4345
+ interface Add {
4346
+ /**
4347
+ * The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
4348
+ */
4349
+ discounts?: Array<Add.Discount>;
4350
+ /**
4351
+ * 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`.
4352
+ */
4353
+ metadata?: MetadataParam;
4354
+ /**
4355
+ * The ID of the price object.
4356
+ */
4357
+ price: string;
4358
+ /**
4359
+ * Quantity for this item.
4360
+ */
4361
+ quantity?: number;
4362
+ /**
4363
+ * 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`.
4364
+ */
4365
+ tax_rates?: Array<string>;
4366
+ /**
4367
+ * Options that configure the trial on the subscription item.
4368
+ */
4369
+ trial?: Add.Trial;
4370
+ /**
4371
+ * The ID of the trial offer to apply to the configuration item.
4372
+ */
4373
+ trial_offer?: string;
4374
+ }
4375
+ interface Remove {
4376
+ /**
4377
+ * ID of a price to remove.
4378
+ */
4379
+ price: string;
4380
+ }
4381
+ interface Set {
4382
+ /**
4383
+ * 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`.
4384
+ */
4385
+ discounts?: Array<Set.Discount>;
4386
+ /**
4387
+ * 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`.
4388
+ */
4389
+ metadata?: MetadataParam;
4390
+ /**
4391
+ * The ID of the price object.
4392
+ */
4393
+ price: string;
4394
+ /**
4395
+ * 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`.
4396
+ */
4397
+ quantity?: number;
4398
+ /**
4399
+ * 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`.
4400
+ */
4401
+ tax_rates?: Array<string>;
4402
+ /**
4403
+ * 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`.
4404
+ */
4405
+ trial?: Set.Trial;
4406
+ /**
4407
+ * The ID of the trial offer to apply to the configuration item.
4408
+ */
4409
+ trial_offer?: string;
4410
+ }
4411
+ type Type = 'add' | 'remove' | 'set' | OtherString;
4412
+ namespace Add {
4413
+ interface Discount {
4414
+ /**
4415
+ * ID of the coupon to create a new discount for.
4416
+ */
4417
+ coupon?: string;
4418
+ /**
4419
+ * ID of an existing discount on the object (or one of its ancestors) to reuse.
4420
+ */
4421
+ discount?: string;
4422
+ /**
4423
+ * Details to determine how long the discount should be applied for.
4424
+ */
4425
+ discount_end?: Discount.DiscountEnd;
4426
+ /**
4427
+ * ID of the promotion code to create a new discount for.
4428
+ */
4429
+ promotion_code?: string;
4430
+ /**
4431
+ * Settings for discount application including service period anchoring.
4432
+ */
4433
+ settings?: Discount.Settings;
4434
+ }
4435
+ interface Trial {
4436
+ /**
4437
+ * 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.
4438
+ */
4439
+ converts_to?: Array<string>;
4440
+ /**
4441
+ * Determines the type of trial for this item.
4442
+ */
4443
+ type: Trial.Type;
4444
+ }
4445
+ namespace Discount {
4446
+ interface DiscountEnd {
4447
+ /**
4448
+ * Time span for the redeemed discount.
4449
+ */
4450
+ duration?: DiscountEnd.Duration;
4451
+ /**
4452
+ * A precise Unix timestamp for the discount to end. Must be in the future.
4453
+ */
4454
+ timestamp?: number;
4455
+ /**
4456
+ * The type of calculation made to determine when the discount ends.
4457
+ */
4458
+ type: DiscountEnd.Type;
4459
+ }
4460
+ interface Settings {
4461
+ /**
4462
+ * Configures service period cycle anchoring.
4463
+ */
4464
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
4465
+ /**
4466
+ * 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.
4467
+ */
4468
+ start_date?: Settings.StartDate;
4469
+ }
4470
+ namespace DiscountEnd {
4471
+ interface Duration {
4472
+ /**
4473
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4474
+ */
4475
+ interval: Duration.Interval;
4476
+ /**
4477
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4478
+ */
4479
+ interval_count: number;
4480
+ }
4481
+ type Type = 'duration' | 'timestamp' | OtherString;
4482
+ namespace Duration {
4483
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
4484
+ }
4485
+ }
4486
+ namespace Settings {
4487
+ interface ServicePeriodAnchorConfig {
4488
+ /**
4489
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
4490
+ */
4491
+ custom?: ServicePeriodAnchorConfig.Custom;
4492
+ /**
4493
+ * The type of service period anchor config. Defaults to `inherit` if omitted.
4494
+ */
4495
+ type?: ServicePeriodAnchorConfig.Type;
4496
+ }
4497
+ type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start' | OtherString;
4498
+ namespace ServicePeriodAnchorConfig {
4499
+ interface Custom {
4500
+ /**
4501
+ * The day of the month the anchor should be. Ranges from 1 to 31.
4502
+ */
4503
+ day_of_month: number;
4504
+ /**
4505
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
4506
+ */
4507
+ hour?: number;
4508
+ /**
4509
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
4510
+ */
4511
+ minute?: number;
4512
+ /**
4513
+ * The month to start full cycle periods. Ranges from 1 to 12.
4514
+ */
4515
+ month?: number;
4516
+ /**
4517
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
4518
+ */
4519
+ second?: number;
4520
+ }
4521
+ type Type = 'custom' | 'inherit' | OtherString;
4522
+ }
4523
+ }
4524
+ }
4525
+ namespace Trial {
4526
+ type Type = 'free' | 'paid' | OtherString;
4527
+ }
4528
+ }
4529
+ namespace Set {
4530
+ interface Discount {
4531
+ /**
4532
+ * ID of the coupon to create a new discount for.
4533
+ */
4534
+ coupon?: string;
4535
+ /**
4536
+ * ID of an existing discount on the object (or one of its ancestors) to reuse.
4537
+ */
4538
+ discount?: string;
4539
+ /**
4540
+ * Details to determine how long the discount should be applied for.
4541
+ */
4542
+ discount_end?: Discount.DiscountEnd;
4543
+ /**
4544
+ * ID of the promotion code to create a new discount for.
4545
+ */
4546
+ promotion_code?: string;
4547
+ /**
4548
+ * Settings for discount application including service period anchoring.
4549
+ */
4550
+ settings?: Discount.Settings;
4551
+ }
4552
+ interface Trial {
4553
+ /**
4554
+ * 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.
4555
+ */
4556
+ converts_to?: Array<string>;
4557
+ /**
4558
+ * Determines the type of trial for this item.
4559
+ */
4560
+ type: Trial.Type;
4561
+ }
4562
+ namespace Discount {
4563
+ interface DiscountEnd {
4564
+ /**
4565
+ * Time span for the redeemed discount.
4566
+ */
4567
+ duration?: DiscountEnd.Duration;
4568
+ /**
4569
+ * A precise Unix timestamp for the discount to end. Must be in the future.
4570
+ */
4571
+ timestamp?: number;
4572
+ /**
4573
+ * The type of calculation made to determine when the discount ends.
4574
+ */
4575
+ type: DiscountEnd.Type;
4576
+ }
4577
+ interface Settings {
4578
+ /**
4579
+ * Configures service period cycle anchoring.
4580
+ */
4581
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
4582
+ /**
4583
+ * 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.
4584
+ */
4585
+ start_date?: Settings.StartDate;
4586
+ }
4587
+ namespace DiscountEnd {
4588
+ interface Duration {
4589
+ /**
4590
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4591
+ */
4592
+ interval: Duration.Interval;
4593
+ /**
4594
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4595
+ */
4596
+ interval_count: number;
4597
+ }
4598
+ type Type = 'duration' | 'timestamp' | OtherString;
4599
+ namespace Duration {
4600
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
4601
+ }
4602
+ }
4603
+ namespace Settings {
4604
+ interface ServicePeriodAnchorConfig {
4605
+ /**
4606
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
4607
+ */
4608
+ custom?: ServicePeriodAnchorConfig.Custom;
4609
+ /**
4610
+ * The type of service period anchor config. Defaults to `inherit` if omitted.
4611
+ */
4612
+ type?: ServicePeriodAnchorConfig.Type;
4613
+ }
4614
+ type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start' | OtherString;
4615
+ namespace ServicePeriodAnchorConfig {
4616
+ interface Custom {
4617
+ /**
4618
+ * The day of the month the anchor should be. Ranges from 1 to 31.
4619
+ */
4620
+ day_of_month: number;
4621
+ /**
4622
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
4623
+ */
4624
+ hour?: number;
4625
+ /**
4626
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
4627
+ */
4628
+ minute?: number;
4629
+ /**
4630
+ * The month to start full cycle periods. Ranges from 1 to 12.
4631
+ */
4632
+ month?: number;
4633
+ /**
4634
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
4635
+ */
4636
+ second?: number;
4637
+ }
4638
+ type Type = 'custom' | 'inherit' | OtherString;
4639
+ }
4640
+ }
4641
+ }
4642
+ namespace Trial {
4643
+ type Type = 'free' | 'paid' | OtherString;
4644
+ }
4645
+ }
4646
+ }
4647
+ namespace MetadataAction {
4648
+ type Type = 'add' | 'remove' | 'set' | OtherString;
4649
+ }
4650
+ namespace SetPauseCollection {
4651
+ interface Set {
4652
+ /**
4653
+ * The payment collection behavior for this subscription while paused.
4654
+ */
4655
+ behavior: Set.Behavior;
4656
+ }
4657
+ type Type = 'remove' | 'set' | OtherString;
4658
+ namespace Set {
4659
+ type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void' | OtherString;
4660
+ }
4661
+ }
4662
+ namespace TrialSettings {
4663
+ interface EndBehavior {
4664
+ /**
4665
+ * Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
4666
+ */
4667
+ prorate_up_front?: EndBehavior.ProrateUpFront;
4668
+ }
4669
+ namespace EndBehavior {
4670
+ type ProrateUpFront = 'defer' | 'include' | OtherString;
4671
+ }
4672
+ }
4673
+ }
3175
4674
  namespace BillingMode {
3176
4675
  interface Flexible {
3177
4676
  /**
@@ -3181,8 +4680,53 @@ export declare namespace InvoiceCreatePreviewParams {
3181
4680
  }
3182
4681
  type Type = 'classic' | 'flexible' | OtherString;
3183
4682
  namespace Flexible {
3184
- type ProrationDiscounts = 'included' | 'itemized';
4683
+ type ProrationDiscounts = 'included' | 'itemized' | OtherString;
4684
+ }
4685
+ }
4686
+ namespace BillingSchedule {
4687
+ interface AppliesTo {
4688
+ /**
4689
+ * The ID of the price object.
4690
+ */
4691
+ price?: string;
4692
+ /**
4693
+ * Controls which subscription items the billing schedule applies to.
4694
+ */
4695
+ type: 'price';
4696
+ }
4697
+ interface BillUntil {
4698
+ /**
4699
+ * Specifies the billing period.
4700
+ */
4701
+ duration?: BillUntil.Duration;
4702
+ /**
4703
+ * The end date of the billing schedule.
4704
+ */
4705
+ timestamp?: number;
4706
+ /**
4707
+ * Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
4708
+ */
4709
+ type: BillUntil.Type;
3185
4710
  }
4711
+ namespace BillUntil {
4712
+ interface Duration {
4713
+ /**
4714
+ * Specifies billing duration. Either `day`, `week`, `month` or `year`.
4715
+ */
4716
+ interval: Duration.Interval;
4717
+ /**
4718
+ * The multiplier applied to the interval.
4719
+ */
4720
+ interval_count?: number;
4721
+ }
4722
+ type Type = 'duration' | 'timestamp' | OtherString;
4723
+ namespace Duration {
4724
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
4725
+ }
4726
+ }
4727
+ }
4728
+ namespace DefaultSettings {
4729
+ type PhaseEffectiveAt = 'billing_period_start' | 'phase_start' | OtherString;
3186
4730
  }
3187
4731
  namespace Phase {
3188
4732
  interface AddInvoiceItem {
@@ -3229,7 +4773,7 @@ export declare namespace InvoiceCreatePreviewParams {
3229
4773
  */
3230
4774
  liability?: AutomaticTax.Liability;
3231
4775
  }
3232
- type BillingCycleAnchor = 'automatic' | 'phase_start';
4776
+ type BillingCycleAnchor = 'automatic' | 'phase_start' | OtherString;
3233
4777
  interface BillingThresholds {
3234
4778
  /**
3235
4779
  * Monetary threshold that triggers the subscription to advance to a new billing period
@@ -3240,7 +4784,7 @@ export declare namespace InvoiceCreatePreviewParams {
3240
4784
  */
3241
4785
  reset_billing_cycle_anchor?: boolean;
3242
4786
  }
3243
- type CollectionMethod = 'charge_automatically' | 'send_invoice';
4787
+ type CollectionMethod = 'charge_automatically' | 'send_invoice' | OtherString;
3244
4788
  interface Discount {
3245
4789
  /**
3246
4790
  * ID of the coupon to create a new discount for.
@@ -3250,10 +4794,18 @@ export declare namespace InvoiceCreatePreviewParams {
3250
4794
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3251
4795
  */
3252
4796
  discount?: string;
4797
+ /**
4798
+ * Details to determine how long the discount should be applied for.
4799
+ */
4800
+ discount_end?: Discount.DiscountEnd;
3253
4801
  /**
3254
4802
  * ID of the promotion code to create a new discount for.
3255
4803
  */
3256
4804
  promotion_code?: string;
4805
+ /**
4806
+ * Settings for discount application including service period anchoring.
4807
+ */
4808
+ settings?: Discount.Settings;
3257
4809
  }
3258
4810
  interface Duration {
3259
4811
  /**
@@ -3265,6 +4817,7 @@ export declare namespace InvoiceCreatePreviewParams {
3265
4817
  */
3266
4818
  interval_count?: number;
3267
4819
  }
4820
+ type EffectiveAt = 'billing_period_start' | 'phase_start' | OtherString;
3268
4821
  interface InvoiceSettings {
3269
4822
  /**
3270
4823
  * 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.
@@ -3312,6 +4865,20 @@ export declare namespace InvoiceCreatePreviewParams {
3312
4865
  * 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.
3313
4866
  */
3314
4867
  tax_rates?: Emptyable<Array<string>>;
4868
+ /**
4869
+ * Options that configure the trial on the subscription item.
4870
+ */
4871
+ trial?: Item.Trial;
4872
+ /**
4873
+ * The ID of the trial offer to apply to the configuration item.
4874
+ */
4875
+ trial_offer?: string;
4876
+ }
4877
+ interface PauseCollection {
4878
+ /**
4879
+ * The payment collection behavior for this subscription while paused.
4880
+ */
4881
+ behavior: PauseCollection.Behavior;
3315
4882
  }
3316
4883
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
3317
4884
  interface TransferData {
@@ -3324,6 +4891,13 @@ export declare namespace InvoiceCreatePreviewParams {
3324
4891
  */
3325
4892
  destination: string;
3326
4893
  }
4894
+ type TrialContinuation = 'continue' | 'none' | OtherString;
4895
+ interface TrialSettings {
4896
+ /**
4897
+ * Defines how the subscription should behave when a trial ends.
4898
+ */
4899
+ end_behavior?: TrialSettings.EndBehavior;
4900
+ }
3327
4901
  namespace AddInvoiceItem {
3328
4902
  interface Discount {
3329
4903
  /**
@@ -3334,6 +4908,10 @@ export declare namespace InvoiceCreatePreviewParams {
3334
4908
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3335
4909
  */
3336
4910
  discount?: string;
4911
+ /**
4912
+ * Details to determine how long the discount should be applied for.
4913
+ */
4914
+ discount_end?: Discount.DiscountEnd;
3337
4915
  /**
3338
4916
  * ID of the promotion code to create a new discount for.
3339
4917
  */
@@ -3371,6 +4949,38 @@ export declare namespace InvoiceCreatePreviewParams {
3371
4949
  */
3372
4950
  unit_amount_decimal?: Decimal;
3373
4951
  }
4952
+ namespace Discount {
4953
+ interface DiscountEnd {
4954
+ /**
4955
+ * Time span for the redeemed discount.
4956
+ */
4957
+ duration?: DiscountEnd.Duration;
4958
+ /**
4959
+ * A precise Unix timestamp for the discount to end. Must be in the future.
4960
+ */
4961
+ timestamp?: number;
4962
+ /**
4963
+ * The type of calculation made to determine when the discount ends.
4964
+ */
4965
+ type: DiscountEnd.Type;
4966
+ }
4967
+ namespace DiscountEnd {
4968
+ interface Duration {
4969
+ /**
4970
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4971
+ */
4972
+ interval: Duration.Interval;
4973
+ /**
4974
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4975
+ */
4976
+ interval_count: number;
4977
+ }
4978
+ type Type = 'duration' | 'timestamp' | OtherString;
4979
+ namespace Duration {
4980
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
4981
+ }
4982
+ }
4983
+ }
3374
4984
  namespace Period {
3375
4985
  interface End {
3376
4986
  /**
@@ -3400,7 +5010,7 @@ export declare namespace InvoiceCreatePreviewParams {
3400
5010
  }
3401
5011
  }
3402
5012
  namespace PriceData {
3403
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
5013
+ type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
3404
5014
  }
3405
5015
  }
3406
5016
  namespace AutomaticTax {
@@ -3415,11 +5025,91 @@ export declare namespace InvoiceCreatePreviewParams {
3415
5025
  type: Liability.Type;
3416
5026
  }
3417
5027
  namespace Liability {
3418
- type Type = 'account' | 'self' | OtherString;
5028
+ type Type = 'account' | 'application' | 'self' | OtherString;
5029
+ }
5030
+ }
5031
+ namespace Discount {
5032
+ interface DiscountEnd {
5033
+ /**
5034
+ * Time span for the redeemed discount.
5035
+ */
5036
+ duration?: DiscountEnd.Duration;
5037
+ /**
5038
+ * A precise Unix timestamp for the discount to end. Must be in the future.
5039
+ */
5040
+ timestamp?: number;
5041
+ /**
5042
+ * The type of calculation made to determine when the discount ends.
5043
+ */
5044
+ type: DiscountEnd.Type;
5045
+ }
5046
+ interface Settings {
5047
+ /**
5048
+ * Configures service period cycle anchoring.
5049
+ */
5050
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
5051
+ /**
5052
+ * 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.
5053
+ */
5054
+ start_date?: Settings.StartDate;
5055
+ }
5056
+ namespace DiscountEnd {
5057
+ interface Duration {
5058
+ /**
5059
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
5060
+ */
5061
+ interval: Duration.Interval;
5062
+ /**
5063
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
5064
+ */
5065
+ interval_count: number;
5066
+ }
5067
+ type Type = 'duration' | 'timestamp' | OtherString;
5068
+ namespace Duration {
5069
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
5070
+ }
5071
+ }
5072
+ namespace Settings {
5073
+ interface ServicePeriodAnchorConfig {
5074
+ /**
5075
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
5076
+ */
5077
+ custom?: ServicePeriodAnchorConfig.Custom;
5078
+ /**
5079
+ * The type of service period anchor config. Defaults to `inherit` if omitted.
5080
+ */
5081
+ type?: ServicePeriodAnchorConfig.Type;
5082
+ }
5083
+ type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start' | OtherString;
5084
+ namespace ServicePeriodAnchorConfig {
5085
+ interface Custom {
5086
+ /**
5087
+ * The day of the month the anchor should be. Ranges from 1 to 31.
5088
+ */
5089
+ day_of_month: number;
5090
+ /**
5091
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
5092
+ */
5093
+ hour?: number;
5094
+ /**
5095
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
5096
+ */
5097
+ minute?: number;
5098
+ /**
5099
+ * The month to start full cycle periods. Ranges from 1 to 12.
5100
+ */
5101
+ month?: number;
5102
+ /**
5103
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
5104
+ */
5105
+ second?: number;
5106
+ }
5107
+ type Type = 'custom' | 'inherit' | OtherString;
5108
+ }
3419
5109
  }
3420
5110
  }
3421
5111
  namespace Duration {
3422
- type Interval = 'day' | 'month' | 'week' | 'year';
5112
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
3423
5113
  }
3424
5114
  namespace InvoiceSettings {
3425
5115
  interface Issuer {
@@ -3433,7 +5123,7 @@ export declare namespace InvoiceCreatePreviewParams {
3433
5123
  type: Issuer.Type;
3434
5124
  }
3435
5125
  namespace Issuer {
3436
- type Type = 'account' | 'self' | OtherString;
5126
+ type Type = 'account' | 'application' | 'self' | OtherString;
3437
5127
  }
3438
5128
  }
3439
5129
  namespace Item {
@@ -3452,10 +5142,18 @@ export declare namespace InvoiceCreatePreviewParams {
3452
5142
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3453
5143
  */
3454
5144
  discount?: string;
5145
+ /**
5146
+ * Details to determine how long the discount should be applied for.
5147
+ */
5148
+ discount_end?: Discount.DiscountEnd;
3455
5149
  /**
3456
5150
  * ID of the promotion code to create a new discount for.
3457
5151
  */
3458
5152
  promotion_code?: string;
5153
+ /**
5154
+ * Settings for discount application including service period anchoring.
5155
+ */
5156
+ settings?: Discount.Settings;
3459
5157
  }
3460
5158
  interface PriceData {
3461
5159
  /**
@@ -3483,6 +5181,96 @@ export declare namespace InvoiceCreatePreviewParams {
3483
5181
  */
3484
5182
  unit_amount_decimal?: Decimal;
3485
5183
  }
5184
+ interface Trial {
5185
+ /**
5186
+ * 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.
5187
+ */
5188
+ converts_to?: Array<string>;
5189
+ /**
5190
+ * Determines the type of trial for this item.
5191
+ */
5192
+ type: Trial.Type;
5193
+ }
5194
+ namespace Discount {
5195
+ interface DiscountEnd {
5196
+ /**
5197
+ * Time span for the redeemed discount.
5198
+ */
5199
+ duration?: DiscountEnd.Duration;
5200
+ /**
5201
+ * A precise Unix timestamp for the discount to end. Must be in the future.
5202
+ */
5203
+ timestamp?: number;
5204
+ /**
5205
+ * The type of calculation made to determine when the discount ends.
5206
+ */
5207
+ type: DiscountEnd.Type;
5208
+ }
5209
+ interface Settings {
5210
+ /**
5211
+ * Configures service period cycle anchoring.
5212
+ */
5213
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
5214
+ /**
5215
+ * 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.
5216
+ */
5217
+ start_date?: Settings.StartDate;
5218
+ }
5219
+ namespace DiscountEnd {
5220
+ interface Duration {
5221
+ /**
5222
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
5223
+ */
5224
+ interval: Duration.Interval;
5225
+ /**
5226
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
5227
+ */
5228
+ interval_count: number;
5229
+ }
5230
+ type Type = 'duration' | 'timestamp' | OtherString;
5231
+ namespace Duration {
5232
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
5233
+ }
5234
+ }
5235
+ namespace Settings {
5236
+ interface ServicePeriodAnchorConfig {
5237
+ /**
5238
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
5239
+ */
5240
+ custom?: ServicePeriodAnchorConfig.Custom;
5241
+ /**
5242
+ * The type of service period anchor config. Defaults to `inherit` if omitted.
5243
+ */
5244
+ type?: ServicePeriodAnchorConfig.Type;
5245
+ }
5246
+ type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start' | OtherString;
5247
+ namespace ServicePeriodAnchorConfig {
5248
+ interface Custom {
5249
+ /**
5250
+ * The day of the month the anchor should be. Ranges from 1 to 31.
5251
+ */
5252
+ day_of_month: number;
5253
+ /**
5254
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
5255
+ */
5256
+ hour?: number;
5257
+ /**
5258
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
5259
+ */
5260
+ minute?: number;
5261
+ /**
5262
+ * The month to start full cycle periods. Ranges from 1 to 12.
5263
+ */
5264
+ month?: number;
5265
+ /**
5266
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
5267
+ */
5268
+ second?: number;
5269
+ }
5270
+ type Type = 'custom' | 'inherit' | OtherString;
5271
+ }
5272
+ }
5273
+ }
3486
5274
  namespace PriceData {
3487
5275
  interface Recurring {
3488
5276
  /**
@@ -3494,16 +5282,75 @@ export declare namespace InvoiceCreatePreviewParams {
3494
5282
  */
3495
5283
  interval_count?: number;
3496
5284
  }
3497
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
5285
+ type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
3498
5286
  namespace Recurring {
3499
- type Interval = 'day' | 'month' | 'week' | 'year';
5287
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
3500
5288
  }
3501
5289
  }
5290
+ namespace Trial {
5291
+ type Type = 'free' | 'paid' | OtherString;
5292
+ }
5293
+ }
5294
+ namespace PauseCollection {
5295
+ type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void' | OtherString;
5296
+ }
5297
+ namespace TrialSettings {
5298
+ interface EndBehavior {
5299
+ /**
5300
+ * Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
5301
+ */
5302
+ prorate_up_front?: EndBehavior.ProrateUpFront;
5303
+ }
5304
+ namespace EndBehavior {
5305
+ type ProrateUpFront = 'defer' | 'include' | OtherString;
5306
+ }
5307
+ }
5308
+ }
5309
+ namespace Prebilling {
5310
+ interface BillUntil {
5311
+ /**
5312
+ * End the prebilled period when a specified amendment ends.
5313
+ */
5314
+ amendment_end?: BillUntil.AmendmentEnd;
5315
+ /**
5316
+ * Time span for prebilling, starting from `bill_from`.
5317
+ */
5318
+ duration?: BillUntil.Duration;
5319
+ /**
5320
+ * End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
5321
+ */
5322
+ timestamp?: number;
5323
+ /**
5324
+ * Select one of several ways to pass the `bill_until` value.
5325
+ */
5326
+ type: BillUntil.Type;
5327
+ }
5328
+ namespace BillUntil {
5329
+ interface AmendmentEnd {
5330
+ /**
5331
+ * 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.
5332
+ */
5333
+ index: number;
5334
+ }
5335
+ interface Duration {
5336
+ /**
5337
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
5338
+ */
5339
+ interval: Duration.Interval;
5340
+ /**
5341
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
5342
+ */
5343
+ interval_count: number;
5344
+ }
5345
+ type Type = 'amendment_end' | 'duration' | 'schedule_end' | 'timestamp' | OtherString;
5346
+ namespace Duration {
5347
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
5348
+ }
3502
5349
  }
3503
5350
  }
3504
5351
  }
3505
5352
  namespace SubscriptionDetails {
3506
- type BillingCycleAnchor = 'now' | 'unchanged';
5353
+ type BillingCycleAnchor = 'now' | 'unchanged' | OtherString;
3507
5354
  interface BillingMode {
3508
5355
  /**
3509
5356
  * Configure behavior for flexible billing mode.
@@ -3538,6 +5385,10 @@ export declare namespace InvoiceCreatePreviewParams {
3538
5385
  * 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.
3539
5386
  */
3540
5387
  clear_usage?: boolean;
5388
+ /**
5389
+ * The trial offer to apply to this subscription item.
5390
+ */
5391
+ current_trial?: Item.CurrentTrial;
3541
5392
  /**
3542
5393
  * A flag that, if set to `true`, will delete the specified item.
3543
5394
  */
@@ -3575,6 +5426,26 @@ export declare namespace InvoiceCreatePreviewParams {
3575
5426
  */
3576
5427
  tax_rates?: Emptyable<Array<string>>;
3577
5428
  }
5429
+ interface Pause {
5430
+ /**
5431
+ * Controls what to bill for when pausing the subscription.
5432
+ */
5433
+ bill_for?: Pause.BillFor;
5434
+ /**
5435
+ * Determines how to handle debits and credits when pausing. Defaults to `pending_invoice_item`.
5436
+ */
5437
+ invoicing_behavior?: Pause.InvoicingBehavior;
5438
+ /**
5439
+ * The type of pause to apply. Defaults to `subscription`.
5440
+ */
5441
+ type?: 'subscription';
5442
+ }
5443
+ interface Prebilling {
5444
+ /**
5445
+ * This is used to determine the number of billing cycles to prebill.
5446
+ */
5447
+ iterations: number;
5448
+ }
3578
5449
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
3579
5450
  namespace BillingMode {
3580
5451
  interface Flexible {
@@ -3585,7 +5456,7 @@ export declare namespace InvoiceCreatePreviewParams {
3585
5456
  }
3586
5457
  type Type = 'classic' | 'flexible' | OtherString;
3587
5458
  namespace Flexible {
3588
- type ProrationDiscounts = 'included' | 'itemized';
5459
+ type ProrationDiscounts = 'included' | 'itemized' | OtherString;
3589
5460
  }
3590
5461
  }
3591
5462
  namespace BillingSchedule {
@@ -3626,7 +5497,7 @@ export declare namespace InvoiceCreatePreviewParams {
3626
5497
  }
3627
5498
  type Type = 'duration' | 'timestamp' | OtherString;
3628
5499
  namespace Duration {
3629
- type Interval = 'day' | 'month' | 'week' | 'year';
5500
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
3630
5501
  }
3631
5502
  }
3632
5503
  }
@@ -3637,6 +5508,16 @@ export declare namespace InvoiceCreatePreviewParams {
3637
5508
  */
3638
5509
  usage_gte: number;
3639
5510
  }
5511
+ interface CurrentTrial {
5512
+ /**
5513
+ * 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`.
5514
+ */
5515
+ trial_end?: number;
5516
+ /**
5517
+ * The ID of the trial offer to apply to the subscription item.
5518
+ */
5519
+ trial_offer: string;
5520
+ }
3640
5521
  interface Discount {
3641
5522
  /**
3642
5523
  * ID of the coupon to create a new discount for.
@@ -3646,10 +5527,18 @@ export declare namespace InvoiceCreatePreviewParams {
3646
5527
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3647
5528
  */
3648
5529
  discount?: string;
5530
+ /**
5531
+ * Details to determine how long the discount should be applied for.
5532
+ */
5533
+ discount_end?: Discount.DiscountEnd;
3649
5534
  /**
3650
5535
  * ID of the promotion code to create a new discount for.
3651
5536
  */
3652
5537
  promotion_code?: string;
5538
+ /**
5539
+ * Settings for discount application including service period anchoring.
5540
+ */
5541
+ settings?: Discount.Settings;
3653
5542
  }
3654
5543
  interface PriceData {
3655
5544
  /**
@@ -3677,6 +5566,86 @@ export declare namespace InvoiceCreatePreviewParams {
3677
5566
  */
3678
5567
  unit_amount_decimal?: Decimal;
3679
5568
  }
5569
+ namespace Discount {
5570
+ interface DiscountEnd {
5571
+ /**
5572
+ * Time span for the redeemed discount.
5573
+ */
5574
+ duration?: DiscountEnd.Duration;
5575
+ /**
5576
+ * A precise Unix timestamp for the discount to end. Must be in the future.
5577
+ */
5578
+ timestamp?: number;
5579
+ /**
5580
+ * The type of calculation made to determine when the discount ends.
5581
+ */
5582
+ type: DiscountEnd.Type;
5583
+ }
5584
+ interface Settings {
5585
+ /**
5586
+ * Configures service period cycle anchoring.
5587
+ */
5588
+ service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
5589
+ /**
5590
+ * 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.
5591
+ */
5592
+ start_date?: Settings.StartDate;
5593
+ }
5594
+ namespace DiscountEnd {
5595
+ interface Duration {
5596
+ /**
5597
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
5598
+ */
5599
+ interval: Duration.Interval;
5600
+ /**
5601
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
5602
+ */
5603
+ interval_count: number;
5604
+ }
5605
+ type Type = 'duration' | 'timestamp' | OtherString;
5606
+ namespace Duration {
5607
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
5608
+ }
5609
+ }
5610
+ namespace Settings {
5611
+ interface ServicePeriodAnchorConfig {
5612
+ /**
5613
+ * Anchor the service period to a custom date. Type must be `custom` to specify.
5614
+ */
5615
+ custom?: ServicePeriodAnchorConfig.Custom;
5616
+ /**
5617
+ * The type of service period anchor config. Defaults to `subscription_service_cycle_anchor` if omitted.
5618
+ */
5619
+ type?: ServicePeriodAnchorConfig.Type;
5620
+ }
5621
+ type StartDate = 'current_period_end' | 'current_period_start' | 'now' | OtherString;
5622
+ namespace ServicePeriodAnchorConfig {
5623
+ interface Custom {
5624
+ /**
5625
+ * The day of the month the anchor should be. Ranges from 1 to 31.
5626
+ */
5627
+ day_of_month: number;
5628
+ /**
5629
+ * The hour of the day the anchor should be. Ranges from 0 to 23.
5630
+ */
5631
+ hour?: number;
5632
+ /**
5633
+ * The minute of the hour the anchor should be. Ranges from 0 to 59.
5634
+ */
5635
+ minute?: number;
5636
+ /**
5637
+ * The month to start full cycle periods. Ranges from 1 to 12.
5638
+ */
5639
+ month?: number;
5640
+ /**
5641
+ * The second of the minute the anchor should be. Ranges from 0 to 59.
5642
+ */
5643
+ second?: number;
5644
+ }
5645
+ type Type = 'custom' | 'subscription_service_cycle_anchor' | OtherString;
5646
+ }
5647
+ }
5648
+ }
3680
5649
  namespace PriceData {
3681
5650
  interface Recurring {
3682
5651
  /**
@@ -3688,14 +5657,57 @@ export declare namespace InvoiceCreatePreviewParams {
3688
5657
  */
3689
5658
  interval_count?: number;
3690
5659
  }
3691
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
5660
+ type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
3692
5661
  namespace Recurring {
3693
- type Interval = 'day' | 'month' | 'week' | 'year';
5662
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
5663
+ }
5664
+ }
5665
+ }
5666
+ namespace Pause {
5667
+ interface BillFor {
5668
+ /**
5669
+ * Controls when to bill for metered usage in the current period. Defaults to `{ type: "now" }`.
5670
+ */
5671
+ outstanding_usage_through?: BillFor.OutstandingUsageThrough;
5672
+ /**
5673
+ * Controls when to credit for unused time on licensed items. Defaults to `{ type: "now" }`.
5674
+ */
5675
+ unused_time_from?: BillFor.UnusedTimeFrom;
5676
+ }
5677
+ type InvoicingBehavior = 'invoice' | 'pending_invoice_item' | OtherString;
5678
+ namespace BillFor {
5679
+ interface OutstandingUsageThrough {
5680
+ /**
5681
+ * When to bill metered usage in the current period.
5682
+ */
5683
+ type: OutstandingUsageThrough.Type;
5684
+ }
5685
+ interface UnusedTimeFrom {
5686
+ /**
5687
+ * When to credit for unused time.
5688
+ */
5689
+ type: UnusedTimeFrom.Type;
5690
+ }
5691
+ namespace OutstandingUsageThrough {
5692
+ type Type = 'none' | 'now' | OtherString;
5693
+ }
5694
+ namespace UnusedTimeFrom {
5695
+ type Type = 'item_current_period_start' | 'none' | 'now' | OtherString;
3694
5696
  }
3695
5697
  }
3696
5698
  }
3697
5699
  }
3698
5700
  }
5701
+ export interface InvoiceDetachPaymentParams {
5702
+ /**
5703
+ * Specifies which fields in the response should be expanded.
5704
+ */
5705
+ expand?: Array<string>;
5706
+ /**
5707
+ * The ID of the PaymentIntent to detach from the invoice.
5708
+ */
5709
+ payment_intent?: string;
5710
+ }
3699
5711
  export interface InvoiceFinalizeInvoiceParams {
3700
5712
  /**
3701
5713
  * 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.
@@ -3805,6 +5817,32 @@ export interface InvoiceSendInvoiceParams {
3805
5817
  */
3806
5818
  expand?: Array<string>;
3807
5819
  }
5820
+ export interface InvoiceSerializeBatchAddLinesParams {
5821
+ }
5822
+ export interface InvoiceSerializeBatchCreateParams {
5823
+ }
5824
+ export interface InvoiceSerializeBatchCreatePreviewParams {
5825
+ }
5826
+ export interface InvoiceSerializeBatchDeleteParams {
5827
+ }
5828
+ export interface InvoiceSerializeBatchFinalizeInvoiceParams {
5829
+ }
5830
+ export interface InvoiceSerializeBatchMarkUncollectibleParams {
5831
+ }
5832
+ export interface InvoiceSerializeBatchPayParams {
5833
+ }
5834
+ export interface InvoiceSerializeBatchRemoveLinesParams {
5835
+ }
5836
+ export interface InvoiceSerializeBatchSendInvoiceParams {
5837
+ }
5838
+ export interface InvoiceSerializeBatchUpdateParams {
5839
+ }
5840
+ export interface InvoiceSerializeBatchUpdateLineItemParams {
5841
+ }
5842
+ export interface InvoiceSerializeBatchUpdateLinesParams {
5843
+ }
5844
+ export interface InvoiceSerializeBatchVoidInvoiceParams {
5845
+ }
3808
5846
  export interface InvoiceUpdateLinesParams {
3809
5847
  /**
3810
5848
  * The line items to update.
@@ -3843,6 +5881,10 @@ export declare namespace InvoiceUpdateLinesParams {
3843
5881
  * ID of an existing line item on the invoice.
3844
5882
  */
3845
5883
  id: string;
5884
+ /**
5885
+ * 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.
5886
+ */
5887
+ margins?: Emptyable<Array<string>>;
3846
5888
  /**
3847
5889
  * 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.
3848
5890
  */
@@ -3886,6 +5928,10 @@ export declare namespace InvoiceUpdateLinesParams {
3886
5928
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3887
5929
  */
3888
5930
  discount?: string;
5931
+ /**
5932
+ * Details to determine how long the discount should be applied for.
5933
+ */
5934
+ discount_end?: Discount.DiscountEnd;
3889
5935
  /**
3890
5936
  * ID of the promotion code to create a new discount for.
3891
5937
  */
@@ -3953,6 +5999,38 @@ export declare namespace InvoiceUpdateLinesParams {
3953
5999
  */
3954
6000
  taxable_amount: number;
3955
6001
  }
6002
+ namespace Discount {
6003
+ interface DiscountEnd {
6004
+ /**
6005
+ * Time span for the redeemed discount.
6006
+ */
6007
+ duration?: DiscountEnd.Duration;
6008
+ /**
6009
+ * A precise Unix timestamp for the discount to end. Must be in the future.
6010
+ */
6011
+ timestamp?: number;
6012
+ /**
6013
+ * The type of calculation made to determine when the discount ends.
6014
+ */
6015
+ type: DiscountEnd.Type;
6016
+ }
6017
+ namespace DiscountEnd {
6018
+ interface Duration {
6019
+ /**
6020
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
6021
+ */
6022
+ interval: Duration.Interval;
6023
+ /**
6024
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
6025
+ */
6026
+ interval_count: number;
6027
+ }
6028
+ type Type = 'duration' | 'timestamp' | OtherString;
6029
+ namespace Duration {
6030
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
6031
+ }
6032
+ }
6033
+ }
3956
6034
  namespace PriceData {
3957
6035
  interface ProductData {
3958
6036
  /**
@@ -3975,12 +6053,28 @@ export declare namespace InvoiceUpdateLinesParams {
3975
6053
  * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
3976
6054
  */
3977
6055
  tax_code?: string;
6056
+ /**
6057
+ * Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
6058
+ */
6059
+ tax_details?: ProductData.TaxDetails;
3978
6060
  /**
3979
6061
  * A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
3980
6062
  */
3981
6063
  unit_label?: string;
3982
6064
  }
3983
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
6065
+ type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
6066
+ namespace ProductData {
6067
+ interface TaxDetails {
6068
+ /**
6069
+ * 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.
6070
+ */
6071
+ performance_location?: string;
6072
+ /**
6073
+ * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
6074
+ */
6075
+ tax_code?: Emptyable<string>;
6076
+ }
6077
+ }
3984
6078
  }
3985
6079
  namespace TaxAmount {
3986
6080
  interface TaxRateData {
@@ -4050,6 +6144,10 @@ export interface InvoiceUpdateLineItemParams {
4050
6144
  * Specifies which fields in the response should be expanded.
4051
6145
  */
4052
6146
  expand?: Array<string>;
6147
+ /**
6148
+ * 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.
6149
+ */
6150
+ margins?: Emptyable<Array<string>>;
4053
6151
  /**
4054
6152
  * 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.
4055
6153
  */
@@ -4093,6 +6191,10 @@ export declare namespace InvoiceUpdateLineItemParams {
4093
6191
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
4094
6192
  */
4095
6193
  discount?: string;
6194
+ /**
6195
+ * Details to determine how long the discount should be applied for.
6196
+ */
6197
+ discount_end?: Discount.DiscountEnd;
4096
6198
  /**
4097
6199
  * ID of the promotion code to create a new discount for.
4098
6200
  */
@@ -4160,6 +6262,38 @@ export declare namespace InvoiceUpdateLineItemParams {
4160
6262
  */
4161
6263
  taxable_amount: number;
4162
6264
  }
6265
+ namespace Discount {
6266
+ interface DiscountEnd {
6267
+ /**
6268
+ * Time span for the redeemed discount.
6269
+ */
6270
+ duration?: DiscountEnd.Duration;
6271
+ /**
6272
+ * A precise Unix timestamp for the discount to end. Must be in the future.
6273
+ */
6274
+ timestamp?: number;
6275
+ /**
6276
+ * The type of calculation made to determine when the discount ends.
6277
+ */
6278
+ type: DiscountEnd.Type;
6279
+ }
6280
+ namespace DiscountEnd {
6281
+ interface Duration {
6282
+ /**
6283
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
6284
+ */
6285
+ interval: Duration.Interval;
6286
+ /**
6287
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
6288
+ */
6289
+ interval_count: number;
6290
+ }
6291
+ type Type = 'duration' | 'timestamp' | OtherString;
6292
+ namespace Duration {
6293
+ type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
6294
+ }
6295
+ }
6296
+ }
4163
6297
  namespace PriceData {
4164
6298
  interface ProductData {
4165
6299
  /**
@@ -4182,12 +6316,28 @@ export declare namespace InvoiceUpdateLineItemParams {
4182
6316
  * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
4183
6317
  */
4184
6318
  tax_code?: string;
6319
+ /**
6320
+ * Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
6321
+ */
6322
+ tax_details?: ProductData.TaxDetails;
4185
6323
  /**
4186
6324
  * A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
4187
6325
  */
4188
6326
  unit_label?: string;
4189
6327
  }
4190
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
6328
+ type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
6329
+ namespace ProductData {
6330
+ interface TaxDetails {
6331
+ /**
6332
+ * 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.
6333
+ */
6334
+ performance_location?: string;
6335
+ /**
6336
+ * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
6337
+ */
6338
+ tax_code?: Emptyable<string>;
6339
+ }
6340
+ }
4191
6341
  }
4192
6342
  namespace TaxAmount {
4193
6343
  interface TaxRateData {