stripe 22.3.0 → 22.4.0-beta.1

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 (797) hide show
  1. package/CHANGELOG.md +1798 -54
  2. package/README.md +42 -58
  3. package/VERSION +1 -1
  4. package/cjs/Error.d.ts +50 -0
  5. package/cjs/Error.js +125 -1
  6. package/cjs/Error.js.map +1 -1
  7. package/cjs/StripeEventNotificationHandler.d.ts +19 -0
  8. package/cjs/StripeEventNotificationHandler.js +150 -0
  9. package/cjs/StripeEventNotificationHandler.js.map +1 -0
  10. package/cjs/Types.d.ts +4 -2
  11. package/cjs/Types.js.map +1 -1
  12. package/cjs/apiVersion.d.ts +1 -2
  13. package/cjs/apiVersion.js +2 -3
  14. package/cjs/apiVersion.js.map +1 -1
  15. package/cjs/resources/AccountLinks.d.ts +1 -1
  16. package/cjs/resources/AccountNotices.d.ts +140 -0
  17. package/cjs/resources/AccountNotices.js +29 -0
  18. package/cjs/resources/AccountNotices.js.map +1 -0
  19. package/cjs/resources/AccountSessions.d.ts +262 -0
  20. package/cjs/resources/AccountSessions.js.map +1 -1
  21. package/cjs/resources/Accounts.d.ts +827 -3
  22. package/cjs/resources/Accounts.js +14 -0
  23. package/cjs/resources/Accounts.js.map +1 -1
  24. package/cjs/resources/Balance.d.ts +67 -0
  25. package/cjs/resources/BankAccounts.d.ts +2 -2
  26. package/cjs/resources/Billing/AlertTriggereds.d.ts +2 -1
  27. package/cjs/resources/Billing/Analytics/MeterUsage.d.ts +84 -0
  28. package/cjs/resources/Billing/Analytics/MeterUsage.js +15 -0
  29. package/cjs/resources/Billing/Analytics/MeterUsage.js.map +1 -0
  30. package/cjs/resources/Billing/Analytics/MeterUsageRows.d.ts +32 -0
  31. package/cjs/resources/Billing/Analytics/MeterUsageRows.js +4 -0
  32. package/cjs/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
  33. package/cjs/resources/Billing/Analytics/index.d.ts +15 -0
  34. package/cjs/resources/Billing/Analytics/index.js +13 -0
  35. package/cjs/resources/Billing/Analytics/index.js.map +1 -0
  36. package/cjs/resources/Billing/index.d.ts +3 -0
  37. package/cjs/resources/Billing/index.js +2 -0
  38. package/cjs/resources/Billing/index.js.map +1 -1
  39. package/cjs/resources/Capabilities.d.ts +2 -2
  40. package/cjs/resources/Capital/FinancingOffers.d.ts +194 -0
  41. package/cjs/resources/Capital/FinancingOffers.js +30 -0
  42. package/cjs/resources/Capital/FinancingOffers.js.map +1 -0
  43. package/cjs/resources/Capital/FinancingSummary.d.ts +101 -0
  44. package/cjs/resources/Capital/FinancingSummary.js +15 -0
  45. package/cjs/resources/Capital/FinancingSummary.js.map +1 -0
  46. package/cjs/resources/Capital/FinancingTransactions.d.ts +141 -0
  47. package/cjs/resources/Capital/FinancingTransactions.js +24 -0
  48. package/cjs/resources/Capital/FinancingTransactions.js.map +1 -0
  49. package/cjs/resources/Capital/index.d.ts +25 -0
  50. package/cjs/resources/Capital/index.js +17 -0
  51. package/cjs/resources/Capital/index.js.map +1 -0
  52. package/cjs/resources/Cards.d.ts +17 -0
  53. package/cjs/resources/Charges.d.ts +3077 -70
  54. package/cjs/resources/Checkout/Sessions.d.ts +403 -4
  55. package/cjs/resources/ConfirmationTokens.d.ts +67 -1
  56. package/cjs/resources/Coupons.d.ts +53 -0
  57. package/cjs/resources/Coupons.js +13 -0
  58. package/cjs/resources/Coupons.js.map +1 -1
  59. package/cjs/resources/CreditNoteLineItems.d.ts +15 -1
  60. package/cjs/resources/CreditNotes.d.ts +1 -1
  61. package/cjs/resources/CustomerSessions.d.ts +68 -0
  62. package/cjs/resources/Customers.d.ts +20 -1
  63. package/cjs/resources/Customers.js +14 -0
  64. package/cjs/resources/Customers.js.map +1 -1
  65. package/cjs/resources/Disputes.d.ts +29 -0
  66. package/cjs/resources/Events.d.ts +547 -2
  67. package/cjs/resources/ExternalAccounts.d.ts +212 -1
  68. package/cjs/resources/ExternalAccounts.js +44 -0
  69. package/cjs/resources/ExternalAccounts.js.map +1 -1
  70. package/cjs/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
  71. package/cjs/resources/FinancialConnections/AccountInferredBalances.js +4 -0
  72. package/cjs/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
  73. package/cjs/resources/FinancialConnections/Accounts.d.ts +69 -4
  74. package/cjs/resources/FinancialConnections/Accounts.js +8 -0
  75. package/cjs/resources/FinancialConnections/Accounts.js.map +1 -1
  76. package/cjs/resources/FinancialConnections/Authorizations.d.ts +99 -0
  77. package/cjs/resources/FinancialConnections/Authorizations.js +15 -0
  78. package/cjs/resources/FinancialConnections/Authorizations.js.map +1 -0
  79. package/cjs/resources/FinancialConnections/Institutions.d.ts +99 -0
  80. package/cjs/resources/FinancialConnections/Institutions.js +23 -0
  81. package/cjs/resources/FinancialConnections/Institutions.js.map +1 -0
  82. package/cjs/resources/FinancialConnections/Sessions.d.ts +156 -7
  83. package/cjs/resources/FinancialConnections/Sessions.js.map +1 -1
  84. package/cjs/resources/FinancialConnections/index.d.ts +21 -6
  85. package/cjs/resources/FinancialConnections/index.js +4 -0
  86. package/cjs/resources/FinancialConnections/index.js.map +1 -1
  87. package/cjs/resources/FxQuotes.d.ts +212 -0
  88. package/cjs/resources/FxQuotes.js +29 -0
  89. package/cjs/resources/FxQuotes.js.map +1 -0
  90. package/cjs/resources/InvoiceItems.d.ts +85 -0
  91. package/cjs/resources/InvoiceItems.js.map +1 -1
  92. package/cjs/resources/InvoiceLineItems.d.ts +40 -2
  93. package/cjs/resources/Invoices.d.ts +1388 -15
  94. package/cjs/resources/Invoices.js +41 -0
  95. package/cjs/resources/Invoices.js.map +1 -1
  96. package/cjs/resources/Issuing/Authorizations.d.ts +13 -0
  97. package/cjs/resources/Issuing/Cardholders.d.ts +15 -1
  98. package/cjs/resources/Issuing/Cards.d.ts +13 -0
  99. package/cjs/resources/Issuing/CreditUnderwritingRecords.d.ts +638 -0
  100. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +47 -0
  101. package/cjs/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
  102. package/cjs/resources/Issuing/DisputeSettlementDetails.d.ts +93 -0
  103. package/cjs/resources/Issuing/DisputeSettlementDetails.js +23 -0
  104. package/cjs/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
  105. package/cjs/resources/Issuing/Disputes.d.ts +13 -0
  106. package/cjs/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
  107. package/cjs/resources/Issuing/FraudLiabilityDebits.js +23 -0
  108. package/cjs/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
  109. package/cjs/resources/Issuing/Settlements.d.ts +83 -0
  110. package/cjs/resources/Issuing/Settlements.js +4 -0
  111. package/cjs/resources/Issuing/Settlements.js.map +1 -0
  112. package/cjs/resources/Issuing/Transactions.d.ts +22 -0
  113. package/cjs/resources/Issuing/Transactions.js.map +1 -1
  114. package/cjs/resources/Issuing/index.d.ts +47 -22
  115. package/cjs/resources/Issuing/index.js +6 -0
  116. package/cjs/resources/Issuing/index.js.map +1 -1
  117. package/cjs/resources/LineItems.d.ts +29 -2
  118. package/cjs/resources/Mandates.d.ts +33 -1
  119. package/cjs/resources/Mandates.js +8 -0
  120. package/cjs/resources/Mandates.js.map +1 -1
  121. package/cjs/resources/Margins.d.ts +115 -0
  122. package/cjs/resources/Margins.js +35 -0
  123. package/cjs/resources/Margins.js.map +1 -0
  124. package/cjs/resources/Orders.d.ts +4693 -0
  125. package/cjs/resources/Orders.js +457 -0
  126. package/cjs/resources/Orders.js.map +1 -0
  127. package/cjs/resources/PaymentAttemptRecords.d.ts +82 -0
  128. package/cjs/resources/PaymentIntents.d.ts +13283 -2352
  129. package/cjs/resources/PaymentIntents.js +27 -0
  130. package/cjs/resources/PaymentIntents.js.map +1 -1
  131. package/cjs/resources/PaymentLinks.d.ts +19 -3
  132. package/cjs/resources/PaymentMethodConfigurations.d.ts +350 -0
  133. package/cjs/resources/PaymentMethods.d.ts +164 -3
  134. package/cjs/resources/PaymentMethods.js.map +1 -1
  135. package/cjs/resources/PaymentRecords.d.ts +82 -0
  136. package/cjs/resources/Persons.d.ts +2 -2
  137. package/cjs/resources/Plans.d.ts +16 -0
  138. package/cjs/resources/Prices.d.ts +52 -0
  139. package/cjs/resources/Privacy/RedactionJobValidationErrors.d.ts +35 -0
  140. package/cjs/resources/Privacy/RedactionJobValidationErrors.js +4 -0
  141. package/cjs/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
  142. package/cjs/resources/Privacy/RedactionJobs.d.ts +227 -0
  143. package/cjs/resources/Privacy/RedactionJobs.js +73 -0
  144. package/cjs/resources/Privacy/RedactionJobs.js.map +1 -0
  145. package/cjs/resources/Privacy/index.d.ts +22 -0
  146. package/cjs/resources/Privacy/index.js +13 -0
  147. package/cjs/resources/Privacy/index.js.map +1 -0
  148. package/cjs/resources/ProductCatalog/TrialOffers.d.ts +125 -0
  149. package/cjs/resources/ProductCatalog/TrialOffers.js +15 -0
  150. package/cjs/resources/ProductCatalog/TrialOffers.js.map +1 -0
  151. package/cjs/resources/ProductCatalog/index.d.ts +12 -0
  152. package/cjs/resources/ProductCatalog/index.js +13 -0
  153. package/cjs/resources/ProductCatalog/index.js.map +1 -0
  154. package/cjs/resources/Products.d.ts +42 -0
  155. package/cjs/resources/PromotionCodes.d.ts +12 -0
  156. package/cjs/resources/PromotionCodes.js +27 -0
  157. package/cjs/resources/PromotionCodes.js.map +1 -1
  158. package/cjs/resources/QuoteLines.d.ts +507 -0
  159. package/cjs/resources/QuoteLines.js +4 -0
  160. package/cjs/resources/QuoteLines.js.map +1 -0
  161. package/cjs/resources/QuotePreviewInvoices.d.ts +1120 -0
  162. package/cjs/resources/QuotePreviewInvoices.js +4 -0
  163. package/cjs/resources/QuotePreviewInvoices.js.map +1 -0
  164. package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +738 -0
  165. package/cjs/resources/QuotePreviewSubscriptionSchedules.js +4 -0
  166. package/cjs/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
  167. package/cjs/resources/Quotes.d.ts +2266 -57
  168. package/cjs/resources/Quotes.js +1184 -16
  169. package/cjs/resources/Quotes.js.map +1 -1
  170. package/cjs/resources/Radar/PaymentEvaluations.d.ts +1 -1
  171. package/cjs/resources/Radar/ValueListItems.d.ts +30 -0
  172. package/cjs/resources/Refunds.d.ts +11 -0
  173. package/cjs/resources/Reserve/Holds.d.ts +53 -1
  174. package/cjs/resources/Reserve/Holds.js +19 -0
  175. package/cjs/resources/Reserve/Holds.js.map +1 -1
  176. package/cjs/resources/Reserve/Plans.d.ts +16 -0
  177. package/cjs/resources/Reserve/Plans.js +11 -0
  178. package/cjs/resources/Reserve/Plans.js.map +1 -1
  179. package/cjs/resources/Reserve/Releases.d.ts +41 -1
  180. package/cjs/resources/Reserve/Releases.js +19 -0
  181. package/cjs/resources/Reserve/Releases.js.map +1 -1
  182. package/cjs/resources/Reserve/index.d.ts +17 -6
  183. package/cjs/resources/Reserve/index.js +9 -0
  184. package/cjs/resources/Reserve/index.js.map +1 -1
  185. package/cjs/resources/SetupAttempts.d.ts +26 -1
  186. package/cjs/resources/SetupIntents.d.ts +343 -11
  187. package/cjs/resources/SharedPayment/GrantedTokens.d.ts +1105 -0
  188. package/cjs/resources/SharedPayment/GrantedTokens.js +15 -0
  189. package/cjs/resources/SharedPayment/GrantedTokens.js.map +1 -0
  190. package/cjs/resources/SharedPayment/IssuedTokens.d.ts +306 -0
  191. package/cjs/resources/SharedPayment/IssuedTokens.js +27 -0
  192. package/cjs/resources/SharedPayment/IssuedTokens.js.map +1 -0
  193. package/cjs/resources/SharedPayment/index.d.ts +19 -0
  194. package/cjs/resources/SharedPayment/index.js +15 -0
  195. package/cjs/resources/SharedPayment/index.js.map +1 -0
  196. package/cjs/resources/Sources.d.ts +29 -1
  197. package/cjs/resources/SubscriptionItems.d.ts +143 -0
  198. package/cjs/resources/SubscriptionSchedules.d.ts +1152 -0
  199. package/cjs/resources/SubscriptionSchedules.js +6 -0
  200. package/cjs/resources/SubscriptionSchedules.js.map +1 -1
  201. package/cjs/resources/Subscriptions.d.ts +571 -6
  202. package/cjs/resources/Subscriptions.js +145 -0
  203. package/cjs/resources/Subscriptions.js.map +1 -1
  204. package/cjs/resources/Tax/CalculationLineItems.d.ts +6 -2
  205. package/cjs/resources/Tax/Calculations.d.ts +7 -3
  206. package/cjs/resources/Tax/Forms.d.ts +228 -0
  207. package/cjs/resources/Tax/Forms.js +32 -0
  208. package/cjs/resources/Tax/Forms.js.map +1 -0
  209. package/cjs/resources/Tax/Locations.d.ts +108 -0
  210. package/cjs/resources/Tax/Locations.js +33 -0
  211. package/cjs/resources/Tax/Locations.js.map +1 -0
  212. package/cjs/resources/Tax/Registrations.d.ts +138 -2
  213. package/cjs/resources/Tax/Transactions.d.ts +2 -2
  214. package/cjs/resources/Tax/index.d.ts +27 -13
  215. package/cjs/resources/Tax/index.js +4 -0
  216. package/cjs/resources/Tax/index.js.map +1 -1
  217. package/cjs/resources/TaxCodes.d.ts +15 -0
  218. package/cjs/resources/Terminal/Configurations.d.ts +27 -0
  219. package/cjs/resources/Terminal/ReaderCollectedData.d.ts +50 -0
  220. package/cjs/resources/Terminal/ReaderCollectedData.js +15 -0
  221. package/cjs/resources/Terminal/ReaderCollectedData.js.map +1 -0
  222. package/cjs/resources/Terminal/Readers.d.ts +17 -1
  223. package/cjs/resources/Terminal/index.d.ts +5 -0
  224. package/cjs/resources/Terminal/index.js +2 -0
  225. package/cjs/resources/Terminal/index.js.map +1 -1
  226. package/cjs/resources/TestHelpers/ConfirmationTokens.d.ts +78 -1
  227. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +68 -0
  228. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +21 -0
  229. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
  230. package/cjs/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
  231. package/cjs/resources/TestHelpers/SharedPayment/index.js +13 -0
  232. package/cjs/resources/TestHelpers/SharedPayment/index.js.map +1 -0
  233. package/cjs/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
  234. package/cjs/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
  235. package/cjs/resources/TestHelpers/index.d.ts +3 -0
  236. package/cjs/resources/TestHelpers/index.js +6 -4
  237. package/cjs/resources/TestHelpers/index.js.map +1 -1
  238. package/cjs/resources/Tokens.d.ts +15 -0
  239. package/cjs/resources/Transfers.d.ts +8 -0
  240. package/cjs/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
  241. package/cjs/resources/Treasury/FinancialAccounts.d.ts +34 -1
  242. package/cjs/resources/Treasury/OutboundPayments.d.ts +8 -0
  243. package/cjs/resources/Treasury/OutboundTransfers.d.ts +44 -0
  244. package/cjs/resources/Treasury/ReceivedCredits.d.ts +22 -0
  245. package/cjs/resources/Treasury/ReceivedDebits.d.ts +26 -0
  246. package/cjs/resources/V2/Billing/BillSettingVersions.d.ts +71 -0
  247. package/cjs/resources/V2/Billing/BillSettingVersions.js +4 -0
  248. package/cjs/resources/V2/Billing/BillSettingVersions.js.map +1 -0
  249. package/cjs/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
  250. package/cjs/resources/V2/Billing/BillSettings/Versions.js +23 -0
  251. package/cjs/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
  252. package/cjs/resources/V2/Billing/BillSettings.d.ts +280 -0
  253. package/cjs/resources/V2/Billing/BillSettings.js +41 -0
  254. package/cjs/resources/V2/Billing/BillSettings.js.map +1 -0
  255. package/cjs/resources/V2/Billing/Cadences.d.ts +947 -0
  256. package/cjs/resources/V2/Billing/Cadences.js +198 -0
  257. package/cjs/resources/V2/Billing/Cadences.js.map +1 -0
  258. package/cjs/resources/V2/Billing/CollectionSettingVersions.d.ts +236 -0
  259. package/cjs/resources/V2/Billing/CollectionSettingVersions.js +4 -0
  260. package/cjs/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
  261. package/cjs/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
  262. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +70 -0
  263. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
  264. package/cjs/resources/V2/Billing/CollectionSettings.d.ts +775 -0
  265. package/cjs/resources/V2/Billing/CollectionSettings.js +166 -0
  266. package/cjs/resources/V2/Billing/CollectionSettings.js.map +1 -0
  267. package/cjs/resources/V2/Billing/Profiles.d.ts +162 -0
  268. package/cjs/resources/V2/Billing/Profiles.js +35 -0
  269. package/cjs/resources/V2/Billing/Profiles.js.map +1 -0
  270. package/cjs/resources/V2/Billing/index.d.ts +45 -6
  271. package/cjs/resources/V2/Billing/index.js +8 -0
  272. package/cjs/resources/V2/Billing/index.js.map +1 -1
  273. package/cjs/resources/V2/Core/AccountLinks.d.ts +4 -4
  274. package/cjs/resources/V2/Core/AccountTokens.d.ts +10 -0
  275. package/cjs/resources/V2/Core/Accounts.d.ts +1565 -75
  276. package/cjs/resources/V2/Core/BatchJobs.d.ts +360 -0
  277. package/cjs/resources/V2/Core/BatchJobs.js +225 -0
  278. package/cjs/resources/V2/Core/BatchJobs.js.map +1 -0
  279. package/cjs/resources/V2/Core/Events.d.ts +1151 -4
  280. package/cjs/resources/V2/Core/Vault/GbBankAccounts.d.ts +279 -0
  281. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +54 -0
  282. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
  283. package/cjs/resources/V2/Core/Vault/UsBankAccounts.d.ts +249 -0
  284. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +63 -0
  285. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
  286. package/cjs/resources/V2/Core/Vault/index.d.ts +28 -0
  287. package/cjs/resources/V2/Core/Vault/index.js +15 -0
  288. package/cjs/resources/V2/Core/Vault/index.js.map +1 -0
  289. package/cjs/resources/V2/Core/index.d.ts +19 -9
  290. package/cjs/resources/V2/Core/index.js +4 -0
  291. package/cjs/resources/V2/Core/index.js.map +1 -1
  292. package/cjs/resources/V2/Data/Reporting/QueryRuns.d.ts +150 -0
  293. package/cjs/resources/V2/Data/Reporting/QueryRuns.js +46 -0
  294. package/cjs/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
  295. package/cjs/resources/V2/Data/Reporting/index.d.ts +13 -0
  296. package/cjs/resources/V2/Data/Reporting/index.js +13 -0
  297. package/cjs/resources/V2/Data/Reporting/index.js.map +1 -0
  298. package/cjs/resources/V2/Data/index.d.ts +10 -0
  299. package/cjs/resources/V2/Data/index.js +13 -0
  300. package/cjs/resources/V2/Data/index.js.map +1 -0
  301. package/cjs/resources/V2/EventMisc.d.ts +0 -0
  302. package/cjs/resources/V2/EventMisc.js +2 -0
  303. package/cjs/resources/V2/EventMisc.js.map +1 -0
  304. package/cjs/resources/V2/Extend/WorkflowRuns.d.ts +162 -0
  305. package/cjs/resources/V2/Extend/WorkflowRuns.js +23 -0
  306. package/cjs/resources/V2/Extend/WorkflowRuns.js.map +1 -0
  307. package/cjs/resources/V2/Extend/Workflows.d.ts +119 -0
  308. package/cjs/resources/V2/Extend/Workflows.js +30 -0
  309. package/cjs/resources/V2/Extend/Workflows.js.map +1 -0
  310. package/cjs/resources/V2/Extend/index.d.ts +20 -0
  311. package/cjs/resources/V2/Extend/index.js +15 -0
  312. package/cjs/resources/V2/Extend/index.js.map +1 -0
  313. package/cjs/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
  314. package/cjs/resources/V2/FinancialAddressCreditSimulations.js +4 -0
  315. package/cjs/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
  316. package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
  317. package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js +4 -0
  318. package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
  319. package/cjs/resources/V2/Iam/ActivityLogs.d.ts +210 -0
  320. package/cjs/resources/V2/Iam/ActivityLogs.js +23 -0
  321. package/cjs/resources/V2/Iam/ActivityLogs.js.map +1 -0
  322. package/cjs/resources/V2/Iam/index.d.ts +13 -0
  323. package/cjs/resources/V2/Iam/index.js +13 -0
  324. package/cjs/resources/V2/Iam/index.js.map +1 -0
  325. package/cjs/resources/V2/MoneyManagement/Adjustments.d.ts +131 -0
  326. package/cjs/resources/V2/MoneyManagement/Adjustments.js +23 -0
  327. package/cjs/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
  328. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.d.ts +240 -0
  329. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +44 -0
  330. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
  331. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.d.ts +211 -0
  332. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +31 -0
  333. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
  334. package/cjs/resources/V2/MoneyManagement/InboundTransfers.d.ts +250 -0
  335. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +30 -0
  336. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
  337. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +208 -0
  338. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +22 -0
  339. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
  340. package/cjs/resources/V2/MoneyManagement/OutboundPayments.d.ts +394 -0
  341. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +41 -0
  342. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
  343. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +296 -0
  344. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +49 -0
  345. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
  346. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.d.ts +336 -0
  347. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +39 -0
  348. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
  349. package/cjs/resources/V2/MoneyManagement/PayoutMethods.d.ts +239 -0
  350. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +44 -0
  351. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
  352. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +92 -0
  353. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +17 -0
  354. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
  355. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.d.ts +295 -0
  356. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +23 -0
  357. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
  358. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.d.ts +157 -0
  359. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +23 -0
  360. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
  361. package/cjs/resources/V2/MoneyManagement/TransactionEntries.d.ts +161 -0
  362. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +23 -0
  363. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
  364. package/cjs/resources/V2/MoneyManagement/Transactions.d.ts +192 -0
  365. package/cjs/resources/V2/MoneyManagement/Transactions.js +23 -0
  366. package/cjs/resources/V2/MoneyManagement/Transactions.js.map +1 -0
  367. package/cjs/resources/V2/MoneyManagement/index.d.ts +104 -0
  368. package/cjs/resources/V2/MoneyManagement/index.js +39 -0
  369. package/cjs/resources/V2/MoneyManagement/index.js.map +1 -0
  370. package/cjs/resources/V2/Network/BusinessProfiles.d.ts +92 -0
  371. package/cjs/resources/V2/Network/BusinessProfiles.js +21 -0
  372. package/cjs/resources/V2/Network/BusinessProfiles.js.map +1 -0
  373. package/cjs/resources/V2/Network/index.d.ts +13 -0
  374. package/cjs/resources/V2/Network/index.js +13 -0
  375. package/cjs/resources/V2/Network/index.js.map +1 -0
  376. package/cjs/resources/V2/OrchestratedCommerce/Agreements.d.ts +143 -0
  377. package/cjs/resources/V2/OrchestratedCommerce/Agreements.js +41 -0
  378. package/cjs/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
  379. package/cjs/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
  380. package/cjs/resources/V2/OrchestratedCommerce/index.js +13 -0
  381. package/cjs/resources/V2/OrchestratedCommerce/index.js.map +1 -0
  382. package/cjs/resources/V2/TestHelpers/FinancialAddresses.d.ts +44 -0
  383. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +23 -0
  384. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
  385. package/cjs/resources/V2/TestHelpers/index.d.ts +8 -0
  386. package/cjs/resources/V2/TestHelpers/index.js +13 -0
  387. package/cjs/resources/V2/TestHelpers/index.js.map +1 -0
  388. package/cjs/resources/V2/index.d.ts +27 -0
  389. package/cjs/resources/V2/index.js +14 -0
  390. package/cjs/resources/V2/index.js.map +1 -1
  391. package/cjs/resources/WebhookEndpoints.d.ts +2 -2
  392. package/cjs/resources.d.ts +10 -0
  393. package/cjs/resources.js +146 -10
  394. package/cjs/resources.js.map +1 -1
  395. package/cjs/stripe.cjs.node.d.ts +6536 -109
  396. package/cjs/stripe.cjs.node.js.map +1 -1
  397. package/cjs/stripe.core.d.ts +91 -26
  398. package/cjs/stripe.core.js +55 -32
  399. package/cjs/stripe.core.js.map +1 -1
  400. package/esm/Error.d.ts +50 -0
  401. package/esm/Error.js +109 -0
  402. package/esm/Error.js.map +1 -1
  403. package/esm/StripeEventNotificationHandler.d.ts +19 -0
  404. package/esm/StripeEventNotificationHandler.js +146 -0
  405. package/esm/StripeEventNotificationHandler.js.map +1 -0
  406. package/esm/Types.d.ts +4 -2
  407. package/esm/Types.js.map +1 -1
  408. package/esm/apiVersion.d.ts +1 -2
  409. package/esm/apiVersion.js +1 -2
  410. package/esm/apiVersion.js.map +1 -1
  411. package/esm/resources/AccountLinks.d.ts +1 -1
  412. package/esm/resources/AccountNotices.d.ts +140 -0
  413. package/esm/resources/AccountNotices.js +25 -0
  414. package/esm/resources/AccountNotices.js.map +1 -0
  415. package/esm/resources/AccountSessions.d.ts +262 -0
  416. package/esm/resources/AccountSessions.js.map +1 -1
  417. package/esm/resources/Accounts.d.ts +827 -3
  418. package/esm/resources/Accounts.js +14 -0
  419. package/esm/resources/Accounts.js.map +1 -1
  420. package/esm/resources/Balance.d.ts +67 -0
  421. package/esm/resources/BankAccounts.d.ts +2 -2
  422. package/esm/resources/Billing/AlertTriggereds.d.ts +2 -1
  423. package/esm/resources/Billing/Analytics/MeterUsage.d.ts +84 -0
  424. package/esm/resources/Billing/Analytics/MeterUsage.js +11 -0
  425. package/esm/resources/Billing/Analytics/MeterUsage.js.map +1 -0
  426. package/esm/resources/Billing/Analytics/MeterUsageRows.d.ts +32 -0
  427. package/esm/resources/Billing/Analytics/MeterUsageRows.js +3 -0
  428. package/esm/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
  429. package/esm/resources/Billing/Analytics/index.d.ts +15 -0
  430. package/esm/resources/Billing/Analytics/index.js +9 -0
  431. package/esm/resources/Billing/Analytics/index.js.map +1 -0
  432. package/esm/resources/Billing/index.d.ts +3 -0
  433. package/esm/resources/Billing/index.js +2 -0
  434. package/esm/resources/Billing/index.js.map +1 -1
  435. package/esm/resources/Capabilities.d.ts +2 -2
  436. package/esm/resources/Capital/FinancingOffers.d.ts +194 -0
  437. package/esm/resources/Capital/FinancingOffers.js +26 -0
  438. package/esm/resources/Capital/FinancingOffers.js.map +1 -0
  439. package/esm/resources/Capital/FinancingSummary.d.ts +101 -0
  440. package/esm/resources/Capital/FinancingSummary.js +11 -0
  441. package/esm/resources/Capital/FinancingSummary.js.map +1 -0
  442. package/esm/resources/Capital/FinancingTransactions.d.ts +141 -0
  443. package/esm/resources/Capital/FinancingTransactions.js +20 -0
  444. package/esm/resources/Capital/FinancingTransactions.js.map +1 -0
  445. package/esm/resources/Capital/index.d.ts +25 -0
  446. package/esm/resources/Capital/index.js +13 -0
  447. package/esm/resources/Capital/index.js.map +1 -0
  448. package/esm/resources/Cards.d.ts +17 -0
  449. package/esm/resources/Charges.d.ts +3077 -70
  450. package/esm/resources/Checkout/Sessions.d.ts +403 -4
  451. package/esm/resources/ConfirmationTokens.d.ts +67 -1
  452. package/esm/resources/Coupons.d.ts +53 -0
  453. package/esm/resources/Coupons.js +13 -0
  454. package/esm/resources/Coupons.js.map +1 -1
  455. package/esm/resources/CreditNoteLineItems.d.ts +15 -1
  456. package/esm/resources/CreditNotes.d.ts +1 -1
  457. package/esm/resources/CustomerSessions.d.ts +68 -0
  458. package/esm/resources/Customers.d.ts +20 -1
  459. package/esm/resources/Customers.js +14 -0
  460. package/esm/resources/Customers.js.map +1 -1
  461. package/esm/resources/Disputes.d.ts +29 -0
  462. package/esm/resources/Events.d.ts +547 -2
  463. package/esm/resources/ExternalAccounts.d.ts +212 -1
  464. package/esm/resources/ExternalAccounts.js +42 -1
  465. package/esm/resources/ExternalAccounts.js.map +1 -1
  466. package/esm/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
  467. package/esm/resources/FinancialConnections/AccountInferredBalances.js +3 -0
  468. package/esm/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
  469. package/esm/resources/FinancialConnections/Accounts.d.ts +69 -4
  470. package/esm/resources/FinancialConnections/Accounts.js +8 -0
  471. package/esm/resources/FinancialConnections/Accounts.js.map +1 -1
  472. package/esm/resources/FinancialConnections/Authorizations.d.ts +99 -0
  473. package/esm/resources/FinancialConnections/Authorizations.js +11 -0
  474. package/esm/resources/FinancialConnections/Authorizations.js.map +1 -0
  475. package/esm/resources/FinancialConnections/Institutions.d.ts +99 -0
  476. package/esm/resources/FinancialConnections/Institutions.js +19 -0
  477. package/esm/resources/FinancialConnections/Institutions.js.map +1 -0
  478. package/esm/resources/FinancialConnections/Sessions.d.ts +156 -7
  479. package/esm/resources/FinancialConnections/Sessions.js.map +1 -1
  480. package/esm/resources/FinancialConnections/index.d.ts +21 -6
  481. package/esm/resources/FinancialConnections/index.js +4 -0
  482. package/esm/resources/FinancialConnections/index.js.map +1 -1
  483. package/esm/resources/FxQuotes.d.ts +212 -0
  484. package/esm/resources/FxQuotes.js +25 -0
  485. package/esm/resources/FxQuotes.js.map +1 -0
  486. package/esm/resources/InvoiceItems.d.ts +85 -0
  487. package/esm/resources/InvoiceItems.js.map +1 -1
  488. package/esm/resources/InvoiceLineItems.d.ts +40 -2
  489. package/esm/resources/Invoices.d.ts +1388 -15
  490. package/esm/resources/Invoices.js +41 -0
  491. package/esm/resources/Invoices.js.map +1 -1
  492. package/esm/resources/Issuing/Authorizations.d.ts +13 -0
  493. package/esm/resources/Issuing/Cardholders.d.ts +15 -1
  494. package/esm/resources/Issuing/Cards.d.ts +13 -0
  495. package/esm/resources/Issuing/CreditUnderwritingRecords.d.ts +638 -0
  496. package/esm/resources/Issuing/CreditUnderwritingRecords.js +43 -0
  497. package/esm/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
  498. package/esm/resources/Issuing/DisputeSettlementDetails.d.ts +93 -0
  499. package/esm/resources/Issuing/DisputeSettlementDetails.js +19 -0
  500. package/esm/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
  501. package/esm/resources/Issuing/Disputes.d.ts +13 -0
  502. package/esm/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
  503. package/esm/resources/Issuing/FraudLiabilityDebits.js +19 -0
  504. package/esm/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
  505. package/esm/resources/Issuing/Settlements.d.ts +83 -0
  506. package/esm/resources/Issuing/Settlements.js +3 -0
  507. package/esm/resources/Issuing/Settlements.js.map +1 -0
  508. package/esm/resources/Issuing/Transactions.d.ts +22 -0
  509. package/esm/resources/Issuing/Transactions.js.map +1 -1
  510. package/esm/resources/Issuing/index.d.ts +47 -22
  511. package/esm/resources/Issuing/index.js +6 -0
  512. package/esm/resources/Issuing/index.js.map +1 -1
  513. package/esm/resources/LineItems.d.ts +29 -2
  514. package/esm/resources/Mandates.d.ts +33 -1
  515. package/esm/resources/Mandates.js +8 -0
  516. package/esm/resources/Mandates.js.map +1 -1
  517. package/esm/resources/Margins.d.ts +115 -0
  518. package/esm/resources/Margins.js +31 -0
  519. package/esm/resources/Margins.js.map +1 -0
  520. package/esm/resources/Orders.d.ts +4693 -0
  521. package/esm/resources/Orders.js +453 -0
  522. package/esm/resources/Orders.js.map +1 -0
  523. package/esm/resources/PaymentAttemptRecords.d.ts +82 -0
  524. package/esm/resources/PaymentIntents.d.ts +13283 -2352
  525. package/esm/resources/PaymentIntents.js +27 -0
  526. package/esm/resources/PaymentIntents.js.map +1 -1
  527. package/esm/resources/PaymentLinks.d.ts +19 -3
  528. package/esm/resources/PaymentMethodConfigurations.d.ts +350 -0
  529. package/esm/resources/PaymentMethods.d.ts +164 -3
  530. package/esm/resources/PaymentMethods.js.map +1 -1
  531. package/esm/resources/PaymentRecords.d.ts +82 -0
  532. package/esm/resources/Persons.d.ts +2 -2
  533. package/esm/resources/Plans.d.ts +16 -0
  534. package/esm/resources/Prices.d.ts +52 -0
  535. package/esm/resources/Privacy/RedactionJobValidationErrors.d.ts +35 -0
  536. package/esm/resources/Privacy/RedactionJobValidationErrors.js +3 -0
  537. package/esm/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
  538. package/esm/resources/Privacy/RedactionJobs.d.ts +227 -0
  539. package/esm/resources/Privacy/RedactionJobs.js +69 -0
  540. package/esm/resources/Privacy/RedactionJobs.js.map +1 -0
  541. package/esm/resources/Privacy/index.d.ts +22 -0
  542. package/esm/resources/Privacy/index.js +9 -0
  543. package/esm/resources/Privacy/index.js.map +1 -0
  544. package/esm/resources/ProductCatalog/TrialOffers.d.ts +125 -0
  545. package/esm/resources/ProductCatalog/TrialOffers.js +11 -0
  546. package/esm/resources/ProductCatalog/TrialOffers.js.map +1 -0
  547. package/esm/resources/ProductCatalog/index.d.ts +12 -0
  548. package/esm/resources/ProductCatalog/index.js +9 -0
  549. package/esm/resources/ProductCatalog/index.js.map +1 -0
  550. package/esm/resources/Products.d.ts +42 -0
  551. package/esm/resources/PromotionCodes.d.ts +12 -0
  552. package/esm/resources/PromotionCodes.js +27 -0
  553. package/esm/resources/PromotionCodes.js.map +1 -1
  554. package/esm/resources/QuoteLines.d.ts +507 -0
  555. package/esm/resources/QuoteLines.js +3 -0
  556. package/esm/resources/QuoteLines.js.map +1 -0
  557. package/esm/resources/QuotePreviewInvoices.d.ts +1120 -0
  558. package/esm/resources/QuotePreviewInvoices.js +3 -0
  559. package/esm/resources/QuotePreviewInvoices.js.map +1 -0
  560. package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +738 -0
  561. package/esm/resources/QuotePreviewSubscriptionSchedules.js +3 -0
  562. package/esm/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
  563. package/esm/resources/Quotes.d.ts +2266 -57
  564. package/esm/resources/Quotes.js +1184 -16
  565. package/esm/resources/Quotes.js.map +1 -1
  566. package/esm/resources/Radar/PaymentEvaluations.d.ts +1 -1
  567. package/esm/resources/Radar/ValueListItems.d.ts +30 -0
  568. package/esm/resources/Refunds.d.ts +11 -0
  569. package/esm/resources/Reserve/Holds.d.ts +53 -1
  570. package/esm/resources/Reserve/Holds.js +17 -1
  571. package/esm/resources/Reserve/Holds.js.map +1 -1
  572. package/esm/resources/Reserve/Plans.d.ts +16 -0
  573. package/esm/resources/Reserve/Plans.js +9 -1
  574. package/esm/resources/Reserve/Plans.js.map +1 -1
  575. package/esm/resources/Reserve/Releases.d.ts +41 -1
  576. package/esm/resources/Reserve/Releases.js +17 -1
  577. package/esm/resources/Reserve/Releases.js.map +1 -1
  578. package/esm/resources/Reserve/index.d.ts +17 -6
  579. package/esm/resources/Reserve/index.js +9 -0
  580. package/esm/resources/Reserve/index.js.map +1 -1
  581. package/esm/resources/SetupAttempts.d.ts +26 -1
  582. package/esm/resources/SetupIntents.d.ts +343 -11
  583. package/esm/resources/SharedPayment/GrantedTokens.d.ts +1105 -0
  584. package/esm/resources/SharedPayment/GrantedTokens.js +11 -0
  585. package/esm/resources/SharedPayment/GrantedTokens.js.map +1 -0
  586. package/esm/resources/SharedPayment/IssuedTokens.d.ts +306 -0
  587. package/esm/resources/SharedPayment/IssuedTokens.js +23 -0
  588. package/esm/resources/SharedPayment/IssuedTokens.js.map +1 -0
  589. package/esm/resources/SharedPayment/index.d.ts +19 -0
  590. package/esm/resources/SharedPayment/index.js +11 -0
  591. package/esm/resources/SharedPayment/index.js.map +1 -0
  592. package/esm/resources/Sources.d.ts +29 -1
  593. package/esm/resources/SubscriptionItems.d.ts +143 -0
  594. package/esm/resources/SubscriptionSchedules.d.ts +1152 -0
  595. package/esm/resources/SubscriptionSchedules.js +6 -0
  596. package/esm/resources/SubscriptionSchedules.js.map +1 -1
  597. package/esm/resources/Subscriptions.d.ts +571 -6
  598. package/esm/resources/Subscriptions.js +145 -0
  599. package/esm/resources/Subscriptions.js.map +1 -1
  600. package/esm/resources/Tax/CalculationLineItems.d.ts +6 -2
  601. package/esm/resources/Tax/Calculations.d.ts +7 -3
  602. package/esm/resources/Tax/Forms.d.ts +228 -0
  603. package/esm/resources/Tax/Forms.js +28 -0
  604. package/esm/resources/Tax/Forms.js.map +1 -0
  605. package/esm/resources/Tax/Locations.d.ts +108 -0
  606. package/esm/resources/Tax/Locations.js +29 -0
  607. package/esm/resources/Tax/Locations.js.map +1 -0
  608. package/esm/resources/Tax/Registrations.d.ts +138 -2
  609. package/esm/resources/Tax/Transactions.d.ts +2 -2
  610. package/esm/resources/Tax/index.d.ts +27 -13
  611. package/esm/resources/Tax/index.js +4 -0
  612. package/esm/resources/Tax/index.js.map +1 -1
  613. package/esm/resources/TaxCodes.d.ts +15 -0
  614. package/esm/resources/Terminal/Configurations.d.ts +27 -0
  615. package/esm/resources/Terminal/ReaderCollectedData.d.ts +50 -0
  616. package/esm/resources/Terminal/ReaderCollectedData.js +11 -0
  617. package/esm/resources/Terminal/ReaderCollectedData.js.map +1 -0
  618. package/esm/resources/Terminal/Readers.d.ts +17 -1
  619. package/esm/resources/Terminal/index.d.ts +5 -0
  620. package/esm/resources/Terminal/index.js +2 -0
  621. package/esm/resources/Terminal/index.js.map +1 -1
  622. package/esm/resources/TestHelpers/ConfirmationTokens.d.ts +78 -1
  623. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +68 -0
  624. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +17 -0
  625. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
  626. package/esm/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
  627. package/esm/resources/TestHelpers/SharedPayment/index.js +9 -0
  628. package/esm/resources/TestHelpers/SharedPayment/index.js.map +1 -0
  629. package/esm/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
  630. package/esm/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
  631. package/esm/resources/TestHelpers/index.d.ts +3 -0
  632. package/esm/resources/TestHelpers/index.js +2 -0
  633. package/esm/resources/TestHelpers/index.js.map +1 -1
  634. package/esm/resources/Tokens.d.ts +15 -0
  635. package/esm/resources/Transfers.d.ts +8 -0
  636. package/esm/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
  637. package/esm/resources/Treasury/FinancialAccounts.d.ts +34 -1
  638. package/esm/resources/Treasury/OutboundPayments.d.ts +8 -0
  639. package/esm/resources/Treasury/OutboundTransfers.d.ts +44 -0
  640. package/esm/resources/Treasury/ReceivedCredits.d.ts +22 -0
  641. package/esm/resources/Treasury/ReceivedDebits.d.ts +26 -0
  642. package/esm/resources/V2/Billing/BillSettingVersions.d.ts +71 -0
  643. package/esm/resources/V2/Billing/BillSettingVersions.js +3 -0
  644. package/esm/resources/V2/Billing/BillSettingVersions.js.map +1 -0
  645. package/esm/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
  646. package/esm/resources/V2/Billing/BillSettings/Versions.js +19 -0
  647. package/esm/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
  648. package/esm/resources/V2/Billing/BillSettings.d.ts +280 -0
  649. package/esm/resources/V2/Billing/BillSettings.js +37 -0
  650. package/esm/resources/V2/Billing/BillSettings.js.map +1 -0
  651. package/esm/resources/V2/Billing/Cadences.d.ts +947 -0
  652. package/esm/resources/V2/Billing/Cadences.js +194 -0
  653. package/esm/resources/V2/Billing/Cadences.js.map +1 -0
  654. package/esm/resources/V2/Billing/CollectionSettingVersions.d.ts +236 -0
  655. package/esm/resources/V2/Billing/CollectionSettingVersions.js +3 -0
  656. package/esm/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
  657. package/esm/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
  658. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +66 -0
  659. package/esm/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
  660. package/esm/resources/V2/Billing/CollectionSettings.d.ts +775 -0
  661. package/esm/resources/V2/Billing/CollectionSettings.js +162 -0
  662. package/esm/resources/V2/Billing/CollectionSettings.js.map +1 -0
  663. package/esm/resources/V2/Billing/Profiles.d.ts +162 -0
  664. package/esm/resources/V2/Billing/Profiles.js +31 -0
  665. package/esm/resources/V2/Billing/Profiles.js.map +1 -0
  666. package/esm/resources/V2/Billing/index.d.ts +45 -6
  667. package/esm/resources/V2/Billing/index.js +8 -0
  668. package/esm/resources/V2/Billing/index.js.map +1 -1
  669. package/esm/resources/V2/Core/AccountLinks.d.ts +4 -4
  670. package/esm/resources/V2/Core/AccountTokens.d.ts +10 -0
  671. package/esm/resources/V2/Core/Accounts.d.ts +1565 -75
  672. package/esm/resources/V2/Core/BatchJobs.d.ts +360 -0
  673. package/esm/resources/V2/Core/BatchJobs.js +221 -0
  674. package/esm/resources/V2/Core/BatchJobs.js.map +1 -0
  675. package/esm/resources/V2/Core/Events.d.ts +1151 -4
  676. package/esm/resources/V2/Core/Vault/GbBankAccounts.d.ts +279 -0
  677. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +50 -0
  678. package/esm/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
  679. package/esm/resources/V2/Core/Vault/UsBankAccounts.d.ts +249 -0
  680. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +59 -0
  681. package/esm/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
  682. package/esm/resources/V2/Core/Vault/index.d.ts +28 -0
  683. package/esm/resources/V2/Core/Vault/index.js +11 -0
  684. package/esm/resources/V2/Core/Vault/index.js.map +1 -0
  685. package/esm/resources/V2/Core/index.d.ts +19 -9
  686. package/esm/resources/V2/Core/index.js +4 -0
  687. package/esm/resources/V2/Core/index.js.map +1 -1
  688. package/esm/resources/V2/Data/Reporting/QueryRuns.d.ts +150 -0
  689. package/esm/resources/V2/Data/Reporting/QueryRuns.js +42 -0
  690. package/esm/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
  691. package/esm/resources/V2/Data/Reporting/index.d.ts +13 -0
  692. package/esm/resources/V2/Data/Reporting/index.js +9 -0
  693. package/esm/resources/V2/Data/Reporting/index.js.map +1 -0
  694. package/esm/resources/V2/Data/index.d.ts +10 -0
  695. package/esm/resources/V2/Data/index.js +9 -0
  696. package/esm/resources/V2/Data/index.js.map +1 -0
  697. package/esm/resources/V2/EventMisc.d.ts +0 -0
  698. package/esm/resources/V2/EventMisc.js +2 -0
  699. package/esm/resources/V2/EventMisc.js.map +1 -0
  700. package/esm/resources/V2/Extend/WorkflowRuns.d.ts +162 -0
  701. package/esm/resources/V2/Extend/WorkflowRuns.js +19 -0
  702. package/esm/resources/V2/Extend/WorkflowRuns.js.map +1 -0
  703. package/esm/resources/V2/Extend/Workflows.d.ts +119 -0
  704. package/esm/resources/V2/Extend/Workflows.js +26 -0
  705. package/esm/resources/V2/Extend/Workflows.js.map +1 -0
  706. package/esm/resources/V2/Extend/index.d.ts +20 -0
  707. package/esm/resources/V2/Extend/index.js +11 -0
  708. package/esm/resources/V2/Extend/index.js.map +1 -0
  709. package/esm/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
  710. package/esm/resources/V2/FinancialAddressCreditSimulations.js +3 -0
  711. package/esm/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
  712. package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
  713. package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js +3 -0
  714. package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
  715. package/esm/resources/V2/Iam/ActivityLogs.d.ts +210 -0
  716. package/esm/resources/V2/Iam/ActivityLogs.js +19 -0
  717. package/esm/resources/V2/Iam/ActivityLogs.js.map +1 -0
  718. package/esm/resources/V2/Iam/index.d.ts +13 -0
  719. package/esm/resources/V2/Iam/index.js +9 -0
  720. package/esm/resources/V2/Iam/index.js.map +1 -0
  721. package/esm/resources/V2/MoneyManagement/Adjustments.d.ts +131 -0
  722. package/esm/resources/V2/MoneyManagement/Adjustments.js +19 -0
  723. package/esm/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
  724. package/esm/resources/V2/MoneyManagement/FinancialAccounts.d.ts +240 -0
  725. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +40 -0
  726. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
  727. package/esm/resources/V2/MoneyManagement/FinancialAddresses.d.ts +211 -0
  728. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +27 -0
  729. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
  730. package/esm/resources/V2/MoneyManagement/InboundTransfers.d.ts +250 -0
  731. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +26 -0
  732. package/esm/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
  733. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +208 -0
  734. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +18 -0
  735. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
  736. package/esm/resources/V2/MoneyManagement/OutboundPayments.d.ts +394 -0
  737. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +37 -0
  738. package/esm/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
  739. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +296 -0
  740. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +45 -0
  741. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
  742. package/esm/resources/V2/MoneyManagement/OutboundTransfers.d.ts +336 -0
  743. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +35 -0
  744. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
  745. package/esm/resources/V2/MoneyManagement/PayoutMethods.d.ts +239 -0
  746. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +40 -0
  747. package/esm/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
  748. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +92 -0
  749. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +13 -0
  750. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
  751. package/esm/resources/V2/MoneyManagement/ReceivedCredits.d.ts +295 -0
  752. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +19 -0
  753. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
  754. package/esm/resources/V2/MoneyManagement/ReceivedDebits.d.ts +157 -0
  755. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +19 -0
  756. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
  757. package/esm/resources/V2/MoneyManagement/TransactionEntries.d.ts +161 -0
  758. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +19 -0
  759. package/esm/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
  760. package/esm/resources/V2/MoneyManagement/Transactions.d.ts +192 -0
  761. package/esm/resources/V2/MoneyManagement/Transactions.js +19 -0
  762. package/esm/resources/V2/MoneyManagement/Transactions.js.map +1 -0
  763. package/esm/resources/V2/MoneyManagement/index.d.ts +104 -0
  764. package/esm/resources/V2/MoneyManagement/index.js +35 -0
  765. package/esm/resources/V2/MoneyManagement/index.js.map +1 -0
  766. package/esm/resources/V2/Network/BusinessProfiles.d.ts +92 -0
  767. package/esm/resources/V2/Network/BusinessProfiles.js +17 -0
  768. package/esm/resources/V2/Network/BusinessProfiles.js.map +1 -0
  769. package/esm/resources/V2/Network/index.d.ts +13 -0
  770. package/esm/resources/V2/Network/index.js +9 -0
  771. package/esm/resources/V2/Network/index.js.map +1 -0
  772. package/esm/resources/V2/OrchestratedCommerce/Agreements.d.ts +143 -0
  773. package/esm/resources/V2/OrchestratedCommerce/Agreements.js +37 -0
  774. package/esm/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
  775. package/esm/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
  776. package/esm/resources/V2/OrchestratedCommerce/index.js +9 -0
  777. package/esm/resources/V2/OrchestratedCommerce/index.js.map +1 -0
  778. package/esm/resources/V2/TestHelpers/FinancialAddresses.d.ts +44 -0
  779. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +19 -0
  780. package/esm/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
  781. package/esm/resources/V2/TestHelpers/index.d.ts +8 -0
  782. package/esm/resources/V2/TestHelpers/index.js +9 -0
  783. package/esm/resources/V2/TestHelpers/index.js.map +1 -0
  784. package/esm/resources/V2/index.d.ts +27 -0
  785. package/esm/resources/V2/index.js +14 -0
  786. package/esm/resources/V2/index.js.map +1 -1
  787. package/esm/resources/WebhookEndpoints.d.ts +2 -2
  788. package/esm/resources.d.ts +10 -0
  789. package/esm/resources.js +131 -0
  790. package/esm/resources.js.map +1 -1
  791. package/esm/stripe.core.d.ts +91 -26
  792. package/esm/stripe.core.js +25 -2
  793. package/esm/stripe.core.js.map +1 -1
  794. package/esm/stripe.esm.node.d.ts +93 -27
  795. package/esm/stripe.esm.node.js +25 -2
  796. package/esm/stripe.esm.node.js.map +1 -1
  797. package/package.json +1 -1
@@ -4,6 +4,7 @@ import { Discount, DeletedDiscount } from './Discounts.js';
4
4
  import { TaxId, DeletedTaxId } from './TaxIds.js';
5
5
  import { Application, DeletedApplication } from './Applications.js';
6
6
  import { Customer, DeletedCustomer } from './Customers.js';
7
+ import { Margin } from './Margins.js';
7
8
  import { PaymentMethod } from './PaymentMethods.js';
8
9
  import { CustomerSource } from './CustomerSources.js';
9
10
  import { TaxRate } from './TaxRates.js';
@@ -67,6 +68,10 @@ export declare class InvoiceResource extends StripeResource {
67
68
  * See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more.
68
69
  */
69
70
  attachPayment(id: string, params?: InvoiceAttachPaymentParams, options?: RequestOptions): Promise<Response<Invoice>>;
71
+ /**
72
+ * Detaches a payment from the invoice, removing it from the list of payments
73
+ */
74
+ detachPayment(id: string, params?: InvoiceDetachPaymentParams, options?: RequestOptions): Promise<Response<Invoice>>;
70
75
  /**
71
76
  * Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method.
72
77
  */
@@ -168,6 +173,10 @@ export interface Invoice {
168
173
  * This is the sum of all the shipping amounts.
169
174
  */
170
175
  amount_shipping: number;
176
+ /**
177
+ * List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
178
+ */
179
+ amounts_due?: Array<Invoice.AmountsDue> | null;
171
180
  /**
172
181
  * ID of the Connect Application that created the invoice.
173
182
  */
@@ -257,6 +266,10 @@ export interface Invoice {
257
266
  * 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
267
  */
259
268
  customer_tax_ids?: Array<Invoice.CustomerTaxId> | null;
269
+ /**
270
+ * The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
271
+ */
272
+ default_margins?: Array<string | Margin> | null;
260
273
  /**
261
274
  * 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
275
  */
@@ -421,6 +434,10 @@ export interface Invoice {
421
434
  * The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
422
435
  */
423
436
  total_excluding_tax: number | null;
437
+ /**
438
+ * The aggregate amounts calculated per margin across all line items.
439
+ */
440
+ total_margin_amounts?: Array<Invoice.TotalMarginAmount> | null;
424
441
  /**
425
442
  * 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
443
  */
@@ -449,6 +466,40 @@ export interface DeletedInvoice {
449
466
  deleted: true;
450
467
  }
451
468
  export declare namespace Invoice {
469
+ interface AmountsDue {
470
+ /**
471
+ * Incremental amount due for this payment in cents (or local equivalent).
472
+ */
473
+ amount: number;
474
+ /**
475
+ * The amount in cents (or local equivalent) that was paid for this payment.
476
+ */
477
+ amount_paid: number;
478
+ /**
479
+ * The difference between the payment's amount and amount_paid, in cents (or local equivalent).
480
+ */
481
+ amount_remaining: number;
482
+ /**
483
+ * Number of days from when invoice is finalized until the payment is due.
484
+ */
485
+ days_until_due: number | null;
486
+ /**
487
+ * An arbitrary string attached to the object. Often useful for displaying to users.
488
+ */
489
+ description: string | null;
490
+ /**
491
+ * Date on which a payment plan's payment is due.
492
+ */
493
+ due_date: number | null;
494
+ /**
495
+ * Timestamp when the payment was paid.
496
+ */
497
+ paid_at: number | null;
498
+ /**
499
+ * The status of the payment, one of `open`, `paid`, or `past_due`
500
+ */
501
+ status: AmountsDue.Status;
502
+ }
452
503
  interface AutomaticTax {
453
504
  /**
454
505
  * If Stripe disabled automatic tax, this enum describes why.
@@ -766,6 +817,16 @@ export declare namespace Invoice {
766
817
  */
767
818
  discount: string | Discount | DeletedDiscount;
768
819
  }
820
+ interface TotalMarginAmount {
821
+ /**
822
+ * The amount, in cents (or local equivalent), of the reduction in line item amount.
823
+ */
824
+ amount: number;
825
+ /**
826
+ * The margin that was applied to get this margin amount.
827
+ */
828
+ margin: string | Margin;
829
+ }
769
830
  interface TotalPretaxCreditAmount {
770
831
  /**
771
832
  * The amount, in cents (or local equivalent), of the pretax credit amount.
@@ -779,6 +840,10 @@ export declare namespace Invoice {
779
840
  * The discount that was applied to get this pretax credit amount.
780
841
  */
781
842
  discount?: string | Discount | DeletedDiscount;
843
+ /**
844
+ * The margin that was applied to get this pretax credit amount.
845
+ */
846
+ margin?: string | Margin;
782
847
  /**
783
848
  * Type of the pretax credit amount referenced.
784
849
  */
@@ -810,6 +875,9 @@ export declare namespace Invoice {
810
875
  */
811
876
  type: 'tax_rate_details';
812
877
  }
878
+ namespace AmountsDue {
879
+ type Status = 'open' | 'paid' | 'past_due';
880
+ }
813
881
  namespace AutomaticTax {
814
882
  type DisabledReason = 'finalization_requires_location_inputs' | 'finalization_system_error';
815
883
  interface Liability {
@@ -834,7 +902,7 @@ export declare namespace Invoice {
834
902
  type Type = 'account' | 'self';
835
903
  }
836
904
  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';
905
+ 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';
838
906
  type Type = 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error';
839
907
  }
840
908
  namespace Parent {
@@ -850,6 +918,10 @@ export declare namespace Invoice {
850
918
  * *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
851
919
  */
852
920
  metadata: Metadata | null;
921
+ /**
922
+ * 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).
923
+ */
924
+ pause_collection?: SubscriptionDetails.PauseCollection | null;
853
925
  /**
854
926
  * The subscription that generated this invoice
855
927
  */
@@ -860,6 +932,21 @@ export declare namespace Invoice {
860
932
  subscription_proration_date?: number;
861
933
  }
862
934
  type Type = 'quote_details' | 'subscription_details';
935
+ namespace SubscriptionDetails {
936
+ interface PauseCollection {
937
+ /**
938
+ * The payment collection behavior for this subscription while paused.
939
+ */
940
+ behavior: PauseCollection.Behavior | null;
941
+ /**
942
+ * The time after which the subscription will resume collecting payments.
943
+ */
944
+ resumes_at: number | null;
945
+ }
946
+ namespace PauseCollection {
947
+ type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
948
+ }
949
+ }
863
950
  }
864
951
  namespace PaymentSettings {
865
952
  interface PaymentMethodOptions {
@@ -871,6 +958,10 @@ export declare namespace Invoice {
871
958
  * If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
872
959
  */
873
960
  bancontact: PaymentMethodOptions.Bancontact | null;
961
+ /**
962
+ * If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
963
+ */
964
+ blik?: PaymentMethodOptions.Blik | null;
874
965
  /**
875
966
  * If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
876
967
  */
@@ -879,6 +970,10 @@ export declare namespace Invoice {
879
970
  * 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
971
  */
881
972
  customer_balance: PaymentMethodOptions.CustomerBalance | null;
973
+ /**
974
+ * 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.
975
+ */
976
+ id_bank_transfer?: PaymentMethodOptions.IdBankTransfer | null;
882
977
  /**
883
978
  * If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
884
979
  */
@@ -904,7 +999,7 @@ export declare namespace Invoice {
904
999
  */
905
1000
  us_bank_account: PaymentMethodOptions.UsBankAccount | null;
906
1001
  }
907
- type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
1002
+ type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'stripe_balance' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
908
1003
  namespace PaymentMethodOptions {
909
1004
  interface AcssDebit {
910
1005
  mandate_options?: AcssDebit.MandateOptions;
@@ -919,6 +1014,8 @@ export declare namespace Invoice {
919
1014
  */
920
1015
  preferred_language: Bancontact.PreferredLanguage;
921
1016
  }
1017
+ interface Blik {
1018
+ }
922
1019
  interface Card {
923
1020
  installments?: Card.Installments;
924
1021
  /**
@@ -933,6 +1030,8 @@ export declare namespace Invoice {
933
1030
  */
934
1031
  funding_type: 'bank_transfer' | null;
935
1032
  }
1033
+ interface IdBankTransfer {
1034
+ }
936
1035
  interface Konbini {
937
1036
  }
938
1037
  interface Payto {
@@ -1069,9 +1168,13 @@ export declare namespace Invoice {
1069
1168
  * The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
1070
1169
  */
1071
1170
  account_subcategories?: Array<Filters.AccountSubcategory>;
1171
+ /**
1172
+ * The institution to use to filter for possible accounts to link.
1173
+ */
1174
+ institution?: string;
1072
1175
  }
1073
1176
  type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
1074
- type Prefetch = 'balances' | 'ownership' | 'transactions';
1177
+ type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions';
1075
1178
  namespace Filters {
1076
1179
  type AccountSubcategory = 'checking' | 'savings';
1077
1180
  }
@@ -1128,7 +1231,7 @@ export declare namespace Invoice {
1128
1231
  }
1129
1232
  }
1130
1233
  namespace TotalPretaxCreditAmount {
1131
- type Type = 'credit_balance_transaction' | 'discount';
1234
+ type Type = 'credit_balance_transaction' | 'discount' | 'margin';
1132
1235
  }
1133
1236
  namespace TotalTax {
1134
1237
  type TaxBehavior = 'exclusive' | 'inclusive';
@@ -1136,7 +1239,7 @@ export declare namespace Invoice {
1136
1239
  /**
1137
1240
  * ID of the tax rate
1138
1241
  */
1139
- tax_rate: string;
1242
+ tax_rate: string | TaxRate;
1140
1243
  }
1141
1244
  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';
1142
1245
  }
@@ -1146,6 +1249,10 @@ export interface InvoiceCreateParams {
1146
1249
  * The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
1147
1250
  */
1148
1251
  account_tax_ids?: Emptyable<Array<string>>;
1252
+ /**
1253
+ * List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
1254
+ */
1255
+ amounts_due?: Emptyable<Array<InvoiceCreateParams.AmountsDue>>;
1149
1256
  /**
1150
1257
  * 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
1258
  */
@@ -1186,6 +1293,10 @@ export interface InvoiceCreateParams {
1186
1293
  * The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
1187
1294
  */
1188
1295
  days_until_due?: number;
1296
+ /**
1297
+ * The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
1298
+ */
1299
+ default_margins?: Array<string>;
1189
1300
  /**
1190
1301
  * 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
1302
  */
@@ -1276,6 +1387,24 @@ export interface InvoiceCreateParams {
1276
1387
  transfer_data?: InvoiceCreateParams.TransferData;
1277
1388
  }
1278
1389
  export declare namespace InvoiceCreateParams {
1390
+ interface AmountsDue {
1391
+ /**
1392
+ * The amount in cents (or local equivalent).
1393
+ */
1394
+ amount: number;
1395
+ /**
1396
+ * Number of days from when invoice is finalized until the payment is due.
1397
+ */
1398
+ days_until_due?: number;
1399
+ /**
1400
+ * An arbitrary string attached to the object. Often useful for displaying to users.
1401
+ */
1402
+ description: string;
1403
+ /**
1404
+ * Date on which a payment plan's payment is due.
1405
+ */
1406
+ due_date?: number;
1407
+ }
1279
1408
  interface AutomaticTax {
1280
1409
  /**
1281
1410
  * 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.
@@ -1306,6 +1435,10 @@ export declare namespace InvoiceCreateParams {
1306
1435
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
1307
1436
  */
1308
1437
  discount?: string;
1438
+ /**
1439
+ * Details to determine how long the discount should be applied for.
1440
+ */
1441
+ discount_end?: Discount.DiscountEnd;
1309
1442
  /**
1310
1443
  * ID of the promotion code to create a new discount for.
1311
1444
  */
@@ -1413,6 +1546,38 @@ export declare namespace InvoiceCreateParams {
1413
1546
  type Type = 'account' | 'self';
1414
1547
  }
1415
1548
  }
1549
+ namespace Discount {
1550
+ interface DiscountEnd {
1551
+ /**
1552
+ * Time span for the redeemed discount.
1553
+ */
1554
+ duration?: DiscountEnd.Duration;
1555
+ /**
1556
+ * A precise Unix timestamp for the discount to end. Must be in the future.
1557
+ */
1558
+ timestamp?: number;
1559
+ /**
1560
+ * The type of calculation made to determine when the discount ends.
1561
+ */
1562
+ type: DiscountEnd.Type;
1563
+ }
1564
+ namespace DiscountEnd {
1565
+ interface Duration {
1566
+ /**
1567
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1568
+ */
1569
+ interval: Duration.Interval;
1570
+ /**
1571
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1572
+ */
1573
+ interval_count: number;
1574
+ }
1575
+ type Type = 'duration' | 'timestamp';
1576
+ namespace Duration {
1577
+ type Interval = 'day' | 'month' | 'week' | 'year';
1578
+ }
1579
+ }
1580
+ }
1416
1581
  namespace Issuer {
1417
1582
  type Type = 'account' | 'self';
1418
1583
  }
@@ -1426,6 +1591,10 @@ export declare namespace InvoiceCreateParams {
1426
1591
  * If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
1427
1592
  */
1428
1593
  bancontact?: Emptyable<PaymentMethodOptions.Bancontact>;
1594
+ /**
1595
+ * If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
1596
+ */
1597
+ blik?: Emptyable<PaymentMethodOptions.Blik>;
1429
1598
  /**
1430
1599
  * If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
1431
1600
  */
@@ -1434,6 +1603,10 @@ export declare namespace InvoiceCreateParams {
1434
1603
  * 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
1604
  */
1436
1605
  customer_balance?: Emptyable<PaymentMethodOptions.CustomerBalance>;
1606
+ /**
1607
+ * 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.
1608
+ */
1609
+ id_bank_transfer?: Emptyable<PaymentMethodOptions.IdBankTransfer>;
1437
1610
  /**
1438
1611
  * If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
1439
1612
  */
@@ -1459,7 +1632,7 @@ export declare namespace InvoiceCreateParams {
1459
1632
  */
1460
1633
  us_bank_account?: Emptyable<PaymentMethodOptions.UsBankAccount>;
1461
1634
  }
1462
- type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
1635
+ type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'stripe_balance' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
1463
1636
  namespace PaymentMethodOptions {
1464
1637
  interface AcssDebit {
1465
1638
  /**
@@ -1477,6 +1650,8 @@ export declare namespace InvoiceCreateParams {
1477
1650
  */
1478
1651
  preferred_language?: Bancontact.PreferredLanguage;
1479
1652
  }
1653
+ interface Blik {
1654
+ }
1480
1655
  interface Card {
1481
1656
  /**
1482
1657
  * Installment configuration for payments attempted on this invoice.
@@ -1499,6 +1674,8 @@ export declare namespace InvoiceCreateParams {
1499
1674
  */
1500
1675
  funding_type?: string;
1501
1676
  }
1677
+ interface IdBankTransfer {
1678
+ }
1502
1679
  interface Konbini {
1503
1680
  }
1504
1681
  interface Payto {
@@ -1667,9 +1844,13 @@ export declare namespace InvoiceCreateParams {
1667
1844
  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
1668
1845
  */
1669
1846
  account_subcategories?: Array<Filters.AccountSubcategory>;
1847
+ /**
1848
+ * ID of the institution to use to filter for selectable accounts.
1849
+ */
1850
+ institution?: string;
1670
1851
  }
1671
1852
  type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
1672
- type Prefetch = 'balances' | 'ownership' | 'transactions';
1853
+ type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions';
1673
1854
  namespace Filters {
1674
1855
  type AccountSubcategory = 'checking' | 'savings';
1675
1856
  }
@@ -1807,6 +1988,10 @@ export interface InvoiceUpdateParams {
1807
1988
  * The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
1808
1989
  */
1809
1990
  account_tax_ids?: Emptyable<Array<string>>;
1991
+ /**
1992
+ * List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
1993
+ */
1994
+ amounts_due?: Emptyable<Array<InvoiceUpdateParams.AmountsDue>>;
1810
1995
  /**
1811
1996
  * 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
1997
  */
@@ -1835,6 +2020,10 @@ export interface InvoiceUpdateParams {
1835
2020
  * 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
2021
  */
1837
2022
  days_until_due?: number;
2023
+ /**
2024
+ * The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
2025
+ */
2026
+ default_margins?: Emptyable<Array<string>>;
1838
2027
  /**
1839
2028
  * 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
2029
  */
@@ -1913,6 +2102,24 @@ export interface InvoiceUpdateParams {
1913
2102
  transfer_data?: Emptyable<InvoiceUpdateParams.TransferData>;
1914
2103
  }
1915
2104
  export declare namespace InvoiceUpdateParams {
2105
+ interface AmountsDue {
2106
+ /**
2107
+ * The amount in cents (or local equivalent).
2108
+ */
2109
+ amount: number;
2110
+ /**
2111
+ * Number of days from when invoice is finalized until the payment is due.
2112
+ */
2113
+ days_until_due?: number;
2114
+ /**
2115
+ * An arbitrary string attached to the object. Often useful for displaying to users.
2116
+ */
2117
+ description: string;
2118
+ /**
2119
+ * Date on which a payment plan's payment is due.
2120
+ */
2121
+ due_date?: number;
2122
+ }
1916
2123
  interface AutomaticTax {
1917
2124
  /**
1918
2125
  * 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.
@@ -1943,6 +2150,10 @@ export declare namespace InvoiceUpdateParams {
1943
2150
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
1944
2151
  */
1945
2152
  discount?: string;
2153
+ /**
2154
+ * Details to determine how long the discount should be applied for.
2155
+ */
2156
+ discount_end?: Discount.DiscountEnd;
1946
2157
  /**
1947
2158
  * ID of the promotion code to create a new discount for.
1948
2159
  */
@@ -2039,6 +2250,38 @@ export declare namespace InvoiceUpdateParams {
2039
2250
  type Type = 'account' | 'self';
2040
2251
  }
2041
2252
  }
2253
+ namespace Discount {
2254
+ interface DiscountEnd {
2255
+ /**
2256
+ * Time span for the redeemed discount.
2257
+ */
2258
+ duration?: DiscountEnd.Duration;
2259
+ /**
2260
+ * A precise Unix timestamp for the discount to end. Must be in the future.
2261
+ */
2262
+ timestamp?: number;
2263
+ /**
2264
+ * The type of calculation made to determine when the discount ends.
2265
+ */
2266
+ type: DiscountEnd.Type;
2267
+ }
2268
+ namespace DiscountEnd {
2269
+ interface Duration {
2270
+ /**
2271
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2272
+ */
2273
+ interval: Duration.Interval;
2274
+ /**
2275
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2276
+ */
2277
+ interval_count: number;
2278
+ }
2279
+ type Type = 'duration' | 'timestamp';
2280
+ namespace Duration {
2281
+ type Interval = 'day' | 'month' | 'week' | 'year';
2282
+ }
2283
+ }
2284
+ }
2042
2285
  namespace Issuer {
2043
2286
  type Type = 'account' | 'self';
2044
2287
  }
@@ -2052,6 +2295,10 @@ export declare namespace InvoiceUpdateParams {
2052
2295
  * If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
2053
2296
  */
2054
2297
  bancontact?: Emptyable<PaymentMethodOptions.Bancontact>;
2298
+ /**
2299
+ * If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
2300
+ */
2301
+ blik?: Emptyable<PaymentMethodOptions.Blik>;
2055
2302
  /**
2056
2303
  * If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
2057
2304
  */
@@ -2060,6 +2307,10 @@ export declare namespace InvoiceUpdateParams {
2060
2307
  * 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
2308
  */
2062
2309
  customer_balance?: Emptyable<PaymentMethodOptions.CustomerBalance>;
2310
+ /**
2311
+ * 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.
2312
+ */
2313
+ id_bank_transfer?: Emptyable<PaymentMethodOptions.IdBankTransfer>;
2063
2314
  /**
2064
2315
  * If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
2065
2316
  */
@@ -2085,7 +2336,7 @@ export declare namespace InvoiceUpdateParams {
2085
2336
  */
2086
2337
  us_bank_account?: Emptyable<PaymentMethodOptions.UsBankAccount>;
2087
2338
  }
2088
- type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
2339
+ type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'stripe_balance' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
2089
2340
  namespace PaymentMethodOptions {
2090
2341
  interface AcssDebit {
2091
2342
  /**
@@ -2103,6 +2354,8 @@ export declare namespace InvoiceUpdateParams {
2103
2354
  */
2104
2355
  preferred_language?: Bancontact.PreferredLanguage;
2105
2356
  }
2357
+ interface Blik {
2358
+ }
2106
2359
  interface Card {
2107
2360
  /**
2108
2361
  * Installment configuration for payments attempted on this invoice.
@@ -2125,6 +2378,8 @@ export declare namespace InvoiceUpdateParams {
2125
2378
  */
2126
2379
  funding_type?: string;
2127
2380
  }
2381
+ interface IdBankTransfer {
2382
+ }
2128
2383
  interface Konbini {
2129
2384
  }
2130
2385
  interface Payto {
@@ -2293,9 +2548,13 @@ export declare namespace InvoiceUpdateParams {
2293
2548
  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
2294
2549
  */
2295
2550
  account_subcategories?: Array<Filters.AccountSubcategory>;
2551
+ /**
2552
+ * ID of the institution to use to filter for selectable accounts.
2553
+ */
2554
+ institution?: string;
2296
2555
  }
2297
2556
  type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
2298
- type Prefetch = 'balances' | 'ownership' | 'transactions';
2557
+ type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions';
2299
2558
  namespace Filters {
2300
2559
  type AccountSubcategory = 'checking' | 'savings';
2301
2560
  }
@@ -2497,6 +2756,10 @@ export declare namespace InvoiceAddLinesParams {
2497
2756
  * ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.
2498
2757
  */
2499
2758
  invoice_item?: string;
2759
+ /**
2760
+ * 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.
2761
+ */
2762
+ margins?: Emptyable<Array<string>>;
2500
2763
  /**
2501
2764
  * 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
2765
  */
@@ -2540,6 +2803,10 @@ export declare namespace InvoiceAddLinesParams {
2540
2803
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
2541
2804
  */
2542
2805
  discount?: string;
2806
+ /**
2807
+ * Details to determine how long the discount should be applied for.
2808
+ */
2809
+ discount_end?: Discount.DiscountEnd;
2543
2810
  /**
2544
2811
  * ID of the promotion code to create a new discount for.
2545
2812
  */
@@ -2607,6 +2874,38 @@ export declare namespace InvoiceAddLinesParams {
2607
2874
  */
2608
2875
  taxable_amount: number;
2609
2876
  }
2877
+ namespace Discount {
2878
+ interface DiscountEnd {
2879
+ /**
2880
+ * Time span for the redeemed discount.
2881
+ */
2882
+ duration?: DiscountEnd.Duration;
2883
+ /**
2884
+ * A precise Unix timestamp for the discount to end. Must be in the future.
2885
+ */
2886
+ timestamp?: number;
2887
+ /**
2888
+ * The type of calculation made to determine when the discount ends.
2889
+ */
2890
+ type: DiscountEnd.Type;
2891
+ }
2892
+ namespace DiscountEnd {
2893
+ interface Duration {
2894
+ /**
2895
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2896
+ */
2897
+ interval: Duration.Interval;
2898
+ /**
2899
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2900
+ */
2901
+ interval_count: number;
2902
+ }
2903
+ type Type = 'duration' | 'timestamp';
2904
+ namespace Duration {
2905
+ type Interval = 'day' | 'month' | 'week' | 'year';
2906
+ }
2907
+ }
2908
+ }
2610
2909
  namespace PriceData {
2611
2910
  interface ProductData {
2612
2911
  /**
@@ -2629,12 +2928,28 @@ export declare namespace InvoiceAddLinesParams {
2629
2928
  * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
2630
2929
  */
2631
2930
  tax_code?: string;
2931
+ /**
2932
+ * Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
2933
+ */
2934
+ tax_details?: ProductData.TaxDetails;
2632
2935
  /**
2633
2936
  * A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
2634
2937
  */
2635
2938
  unit_label?: string;
2636
2939
  }
2637
2940
  type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
2941
+ namespace ProductData {
2942
+ interface TaxDetails {
2943
+ /**
2944
+ * 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.
2945
+ */
2946
+ performance_location?: string;
2947
+ /**
2948
+ * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
2949
+ */
2950
+ tax_code?: Emptyable<string>;
2951
+ }
2952
+ }
2638
2953
  }
2639
2954
  namespace TaxAmount {
2640
2955
  interface TaxRateData {
@@ -2684,6 +2999,10 @@ export declare namespace InvoiceAddLinesParams {
2684
2999
  }
2685
3000
  }
2686
3001
  export interface InvoiceAttachPaymentParams {
3002
+ /**
3003
+ * The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.
3004
+ */
3005
+ amount_requested?: number;
2687
3006
  /**
2688
3007
  * Specifies which fields in the response should be expanded.
2689
3008
  */
@@ -2696,6 +3015,38 @@ export interface InvoiceAttachPaymentParams {
2696
3015
  * The ID of the PaymentRecord to attach to the invoice.
2697
3016
  */
2698
3017
  payment_record?: string;
3018
+ /**
3019
+ * The PaymentRecord data for attaching an out of band payment to the invoice.
3020
+ */
3021
+ payment_record_data?: InvoiceAttachPaymentParams.PaymentRecordData;
3022
+ }
3023
+ export declare namespace InvoiceAttachPaymentParams {
3024
+ interface PaymentRecordData {
3025
+ /**
3026
+ * The amount that was paid out of band.
3027
+ */
3028
+ amount: number;
3029
+ /**
3030
+ * The currency that was paid out of band.
3031
+ */
3032
+ currency: string;
3033
+ /**
3034
+ * 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`.
3035
+ */
3036
+ metadata?: Emptyable<MetadataParam>;
3037
+ /**
3038
+ * The type of money movement for this out of band payment record.
3039
+ */
3040
+ money_movement_type: string;
3041
+ /**
3042
+ * The timestamp when this out of band payment was paid.
3043
+ */
3044
+ paid_at?: number;
3045
+ /**
3046
+ * The reference for this out of band payment record.
3047
+ */
3048
+ payment_reference?: string;
3049
+ }
2699
3050
  }
2700
3051
  export interface InvoiceCreatePreviewParams {
2701
3052
  /**
@@ -2801,6 +3152,10 @@ export declare namespace InvoiceCreatePreviewParams {
2801
3152
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
2802
3153
  */
2803
3154
  discount?: string;
3155
+ /**
3156
+ * Details to determine how long the discount should be applied for.
3157
+ */
3158
+ discount_end?: Discount.DiscountEnd;
2804
3159
  /**
2805
3160
  * ID of the promotion code to create a new discount for.
2806
3161
  */
@@ -2888,6 +3243,14 @@ export declare namespace InvoiceCreatePreviewParams {
2888
3243
  }
2889
3244
  type PreviewMode = 'next' | 'recurring';
2890
3245
  interface ScheduleDetails {
3246
+ /**
3247
+ * Changes to apply to the phases of the subscription schedule, in the order provided.
3248
+ */
3249
+ amendments?: Array<ScheduleDetails.Amendment>;
3250
+ /**
3251
+ * 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.
3252
+ */
3253
+ billing_behavior?: ScheduleDetails.BillingBehavior;
2891
3254
  /**
2892
3255
  * Controls how prorations and invoices for subscriptions are calculated and orchestrated.
2893
3256
  */
@@ -2900,6 +3263,10 @@ export declare namespace InvoiceCreatePreviewParams {
2900
3263
  * 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
3264
  */
2902
3265
  phases?: Array<ScheduleDetails.Phase>;
3266
+ /**
3267
+ * Provide any time periods to bill in advance.
3268
+ */
3269
+ prebilling?: Emptyable<Array<ScheduleDetails.Prebilling>>;
2903
3270
  /**
2904
3271
  * 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
3272
  */
@@ -2938,6 +3305,18 @@ export declare namespace InvoiceCreatePreviewParams {
2938
3305
  * A list of up to 20 subscription items, each with an attached price.
2939
3306
  */
2940
3307
  items?: Array<SubscriptionDetails.Item>;
3308
+ /**
3309
+ * 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.
3310
+ *
3311
+ * To receive a preview invoice, set `invoicing_behavior` to `invoice`. A preview isn't available if the `bill_for` options produce no billable amounts.
3312
+ *
3313
+ * `pending_invoice_item` never has a preview available because pausing wouldn't generate an invoice, and paused subscriptions don't generate invoices either.
3314
+ */
3315
+ pause?: SubscriptionDetails.Pause;
3316
+ /**
3317
+ * The pre-billing to apply to the subscription as a preview.
3318
+ */
3319
+ prebilling?: SubscriptionDetails.Prebilling;
2941
3320
  /**
2942
3321
  * 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`.
2943
3322
  */
@@ -3010,6 +3389,38 @@ export declare namespace InvoiceCreatePreviewParams {
3010
3389
  type Type = 'ad_nrt' | 'ae_trn' | 'al_tin' | 'am_tin' | 'ao_tin' | 'ar_cuit' | 'au_abn' | 'au_arn' | 'aw_tin' | 'az_tin' | 'ba_tin' | 'bb_tin' | 'bd_bin' | 'bf_ifu' | 'bg_uic' | 'bh_vat' | 'bj_ifu' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'bs_tin' | 'by_tin' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'cd_nif' | 'ch_uid' | 'ch_vat' | 'cl_tin' | 'cm_niu' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'cv_nif' | 'de_stn' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'et_tin' | 'eu_oss_vat' | 'eu_vat' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_vat' | 'ma_vat' | 'md_vat' | 'me_pib' | 'mk_vat' | 'mr_nif' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'np_pan' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'pl_nip' | 'py_ruc' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sn_ninea' | 'sr_fin' | 'sv_nit' | 'th_vat' | 'tj_tin' | 'tr_tin' | 'tw_vat' | 'tz_vat' | 'ua_vat' | 'ug_tin' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin';
3011
3390
  }
3012
3391
  }
3392
+ namespace Discount {
3393
+ interface DiscountEnd {
3394
+ /**
3395
+ * Time span for the redeemed discount.
3396
+ */
3397
+ duration?: DiscountEnd.Duration;
3398
+ /**
3399
+ * A precise Unix timestamp for the discount to end. Must be in the future.
3400
+ */
3401
+ timestamp?: number;
3402
+ /**
3403
+ * The type of calculation made to determine when the discount ends.
3404
+ */
3405
+ type: DiscountEnd.Type;
3406
+ }
3407
+ namespace DiscountEnd {
3408
+ interface Duration {
3409
+ /**
3410
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
3411
+ */
3412
+ interval: Duration.Interval;
3413
+ /**
3414
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
3415
+ */
3416
+ interval_count: number;
3417
+ }
3418
+ type Type = 'duration' | 'timestamp';
3419
+ namespace Duration {
3420
+ type Interval = 'day' | 'month' | 'week' | 'year';
3421
+ }
3422
+ }
3423
+ }
3013
3424
  namespace InvoiceItem {
3014
3425
  interface Discount {
3015
3426
  /**
@@ -3020,6 +3431,10 @@ export declare namespace InvoiceCreatePreviewParams {
3020
3431
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3021
3432
  */
3022
3433
  discount?: string;
3434
+ /**
3435
+ * Details to determine how long the discount should be applied for.
3436
+ */
3437
+ discount_end?: Discount.DiscountEnd;
3023
3438
  /**
3024
3439
  * ID of the promotion code to create a new discount for.
3025
3440
  */
@@ -3058,6 +3473,38 @@ export declare namespace InvoiceCreatePreviewParams {
3058
3473
  unit_amount_decimal?: Decimal;
3059
3474
  }
3060
3475
  type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
3476
+ namespace Discount {
3477
+ interface DiscountEnd {
3478
+ /**
3479
+ * Time span for the redeemed discount.
3480
+ */
3481
+ duration?: DiscountEnd.Duration;
3482
+ /**
3483
+ * A precise Unix timestamp for the discount to end. Must be in the future.
3484
+ */
3485
+ timestamp?: number;
3486
+ /**
3487
+ * The type of calculation made to determine when the discount ends.
3488
+ */
3489
+ type: DiscountEnd.Type;
3490
+ }
3491
+ namespace DiscountEnd {
3492
+ interface Duration {
3493
+ /**
3494
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
3495
+ */
3496
+ interval: Duration.Interval;
3497
+ /**
3498
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
3499
+ */
3500
+ interval_count: number;
3501
+ }
3502
+ type Type = 'duration' | 'timestamp';
3503
+ namespace Duration {
3504
+ type Interval = 'day' | 'month' | 'week' | 'year';
3505
+ }
3506
+ }
3507
+ }
3061
3508
  namespace PriceData {
3062
3509
  type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
3063
3510
  }
@@ -3066,16 +3513,59 @@ export declare namespace InvoiceCreatePreviewParams {
3066
3513
  type Type = 'account' | 'self';
3067
3514
  }
3068
3515
  namespace ScheduleDetails {
3069
- interface BillingMode {
3516
+ interface Amendment {
3070
3517
  /**
3071
- * Configure behavior for flexible billing mode.
3518
+ * 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.
3072
3519
  */
3073
- flexible?: BillingMode.Flexible;
3520
+ amendment_end?: Amendment.AmendmentEnd;
3074
3521
  /**
3075
- * Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
3522
+ * Details to identify the earliest timestamp where the proposed change should take effect.
3076
3523
  */
3077
- type: BillingMode.Type;
3078
- }
3524
+ amendment_start: Amendment.AmendmentStart;
3525
+ /**
3526
+ * 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.
3527
+ */
3528
+ billing_cycle_anchor?: Amendment.BillingCycleAnchor;
3529
+ /**
3530
+ * Changes to the coupons being redeemed or discounts being applied during the amendment time span.
3531
+ */
3532
+ discount_actions?: Array<Amendment.DiscountAction>;
3533
+ /**
3534
+ * Changes to the subscription items during the amendment time span.
3535
+ */
3536
+ item_actions?: Array<Amendment.ItemAction>;
3537
+ /**
3538
+ * Instructions for how to modify phase metadata
3539
+ */
3540
+ metadata_actions?: Array<Amendment.MetadataAction>;
3541
+ /**
3542
+ * 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`.
3543
+ */
3544
+ proration_behavior?: Amendment.ProrationBehavior;
3545
+ /**
3546
+ * Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
3547
+ */
3548
+ set_pause_collection?: Amendment.SetPauseCollection;
3549
+ /**
3550
+ * Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
3551
+ */
3552
+ set_schedule_end?: Amendment.SetScheduleEnd;
3553
+ /**
3554
+ * Settings related to subscription trials.
3555
+ */
3556
+ trial_settings?: Amendment.TrialSettings;
3557
+ }
3558
+ type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
3559
+ interface BillingMode {
3560
+ /**
3561
+ * Configure behavior for flexible billing mode.
3562
+ */
3563
+ flexible?: BillingMode.Flexible;
3564
+ /**
3565
+ * Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
3566
+ */
3567
+ type: BillingMode.Type;
3568
+ }
3079
3569
  type EndBehavior = 'cancel' | 'release';
3080
3570
  interface Phase {
3081
3571
  /**
@@ -3146,6 +3636,10 @@ export declare namespace InvoiceCreatePreviewParams {
3146
3636
  * The account on behalf of which to charge, for each of the associated subscription's invoices.
3147
3637
  */
3148
3638
  on_behalf_of?: string;
3639
+ /**
3640
+ * 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).
3641
+ */
3642
+ pause_collection?: Phase.PauseCollection;
3149
3643
  /**
3150
3644
  * 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.
3151
3645
  */
@@ -3162,12 +3656,468 @@ export declare namespace InvoiceCreatePreviewParams {
3162
3656
  * If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
3163
3657
  */
3164
3658
  trial?: boolean;
3659
+ /**
3660
+ * Specify trial behavior when crossing phase boundaries
3661
+ */
3662
+ trial_continuation?: Phase.TrialContinuation;
3165
3663
  /**
3166
3664
  * Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
3167
3665
  */
3168
3666
  trial_end?: number | 'now';
3667
+ /**
3668
+ * Settings related to subscription trials.
3669
+ */
3670
+ trial_settings?: Phase.TrialSettings;
3671
+ }
3672
+ interface Prebilling {
3673
+ /**
3674
+ * The end of the prebilled time period.
3675
+ */
3676
+ bill_until?: Prebilling.BillUntil;
3677
+ /**
3678
+ * This is used to determine the number of billing cycles to prebill.
3679
+ */
3680
+ iterations?: number;
3169
3681
  }
3170
3682
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
3683
+ namespace Amendment {
3684
+ interface AmendmentEnd {
3685
+ /**
3686
+ * Use the `end` time of a given discount.
3687
+ */
3688
+ discount_end?: AmendmentEnd.DiscountEnd;
3689
+ /**
3690
+ * Time span for the amendment starting from the `amendment_start`.
3691
+ */
3692
+ duration?: AmendmentEnd.Duration;
3693
+ /**
3694
+ * A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
3695
+ */
3696
+ timestamp?: number;
3697
+ /**
3698
+ * Select one of three ways to pass the `amendment_end`.
3699
+ */
3700
+ type: AmendmentEnd.Type;
3701
+ }
3702
+ interface AmendmentStart {
3703
+ /**
3704
+ * Details of another amendment in the same array, immediately after which this amendment should begin.
3705
+ */
3706
+ amendment_end?: AmendmentStart.AmendmentEnd;
3707
+ /**
3708
+ * Use the `end` time of a given discount.
3709
+ */
3710
+ discount_end?: AmendmentStart.DiscountEnd;
3711
+ /**
3712
+ * A precise Unix timestamp for the amendment to start.
3713
+ */
3714
+ timestamp?: number;
3715
+ /**
3716
+ * Select one of three ways to pass the `amendment_start`.
3717
+ */
3718
+ type: AmendmentStart.Type;
3719
+ }
3720
+ type BillingCycleAnchor = 'amendment_start' | 'automatic';
3721
+ interface DiscountAction {
3722
+ /**
3723
+ * Details of the discount to add.
3724
+ */
3725
+ add?: DiscountAction.Add;
3726
+ /**
3727
+ * Details of the discount to remove.
3728
+ */
3729
+ remove?: DiscountAction.Remove;
3730
+ /**
3731
+ * Details of the discount to replace the existing discounts with.
3732
+ */
3733
+ set?: DiscountAction.Set;
3734
+ /**
3735
+ * Determines the type of discount action.
3736
+ */
3737
+ type: DiscountAction.Type;
3738
+ }
3739
+ interface ItemAction {
3740
+ /**
3741
+ * 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.
3742
+ */
3743
+ add?: ItemAction.Add;
3744
+ /**
3745
+ * Details of the subscription item to remove.
3746
+ */
3747
+ remove?: ItemAction.Remove;
3748
+ /**
3749
+ * 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.
3750
+ */
3751
+ set?: ItemAction.Set;
3752
+ /**
3753
+ * Determines the type of item action.
3754
+ */
3755
+ type: ItemAction.Type;
3756
+ }
3757
+ interface MetadataAction {
3758
+ /**
3759
+ * Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
3760
+ */
3761
+ add?: {
3762
+ [key: string]: string;
3763
+ };
3764
+ /**
3765
+ * Keys to remove from schedule phase metadata.
3766
+ */
3767
+ remove?: Array<string>;
3768
+ /**
3769
+ * Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
3770
+ */
3771
+ set?: Emptyable<{
3772
+ [key: string]: string;
3773
+ }>;
3774
+ /**
3775
+ * Select one of three ways to update phase-level `metadata` on subscription schedules.
3776
+ */
3777
+ type: MetadataAction.Type;
3778
+ }
3779
+ type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
3780
+ interface SetPauseCollection {
3781
+ /**
3782
+ * Details of the pause_collection behavior to apply to the amendment.
3783
+ */
3784
+ set?: SetPauseCollection.Set;
3785
+ /**
3786
+ * Determines the type of the pause_collection amendment.
3787
+ */
3788
+ type: SetPauseCollection.Type;
3789
+ }
3790
+ type SetScheduleEnd = 'amendment_end' | 'amendment_start';
3791
+ interface TrialSettings {
3792
+ /**
3793
+ * Defines how the subscription should behave when a trial ends.
3794
+ */
3795
+ end_behavior?: TrialSettings.EndBehavior;
3796
+ }
3797
+ namespace AmendmentEnd {
3798
+ interface DiscountEnd {
3799
+ /**
3800
+ * The ID of a specific discount.
3801
+ */
3802
+ discount: string;
3803
+ }
3804
+ interface Duration {
3805
+ /**
3806
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
3807
+ */
3808
+ interval: Duration.Interval;
3809
+ /**
3810
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
3811
+ */
3812
+ interval_count: number;
3813
+ }
3814
+ type Type = 'discount_end' | 'duration' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
3815
+ namespace Duration {
3816
+ type Interval = 'day' | 'month' | 'week' | 'year';
3817
+ }
3818
+ }
3819
+ namespace AmendmentStart {
3820
+ interface AmendmentEnd {
3821
+ /**
3822
+ * 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.
3823
+ */
3824
+ index: number;
3825
+ }
3826
+ interface DiscountEnd {
3827
+ /**
3828
+ * The ID of a specific discount.
3829
+ */
3830
+ discount: string;
3831
+ }
3832
+ type Type = 'amendment_end' | 'discount_end' | 'now' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
3833
+ }
3834
+ namespace DiscountAction {
3835
+ interface Add {
3836
+ /**
3837
+ * The coupon code to redeem.
3838
+ */
3839
+ coupon?: string;
3840
+ /**
3841
+ * An ID of an existing discount for a coupon that was already redeemed.
3842
+ */
3843
+ discount?: string;
3844
+ /**
3845
+ * Details to determine how long the discount should be applied for.
3846
+ */
3847
+ discount_end?: Add.DiscountEnd;
3848
+ /**
3849
+ * 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.
3850
+ */
3851
+ index?: number;
3852
+ /**
3853
+ * The promotion code to redeem.
3854
+ */
3855
+ promotion_code?: string;
3856
+ }
3857
+ interface Remove {
3858
+ /**
3859
+ * The coupon code to remove from the `discounts` array.
3860
+ */
3861
+ coupon?: string;
3862
+ /**
3863
+ * The ID of a discount to remove from the `discounts` array.
3864
+ */
3865
+ discount?: string;
3866
+ /**
3867
+ * The ID of a promotion code to remove from the `discounts` array.
3868
+ */
3869
+ promotion_code?: string;
3870
+ }
3871
+ interface Set {
3872
+ /**
3873
+ * The coupon code to replace the `discounts` array with.
3874
+ */
3875
+ coupon?: string;
3876
+ /**
3877
+ * An ID of an existing discount to replace the `discounts` array with.
3878
+ */
3879
+ discount?: string;
3880
+ /**
3881
+ * An ID of an existing promotion code to replace the `discounts` array with.
3882
+ */
3883
+ promotion_code?: string;
3884
+ }
3885
+ type Type = 'add' | 'remove' | 'set';
3886
+ namespace Add {
3887
+ interface DiscountEnd {
3888
+ /**
3889
+ * The type of calculation made to determine when the discount ends.
3890
+ */
3891
+ type: 'amendment_end';
3892
+ }
3893
+ }
3894
+ }
3895
+ namespace ItemAction {
3896
+ interface Add {
3897
+ /**
3898
+ * The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
3899
+ */
3900
+ discounts?: Array<Add.Discount>;
3901
+ /**
3902
+ * 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`.
3903
+ */
3904
+ metadata?: MetadataParam;
3905
+ /**
3906
+ * The ID of the price object.
3907
+ */
3908
+ price: string;
3909
+ /**
3910
+ * Quantity for this item.
3911
+ */
3912
+ quantity?: number;
3913
+ /**
3914
+ * 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`.
3915
+ */
3916
+ tax_rates?: Array<string>;
3917
+ /**
3918
+ * Options that configure the trial on the subscription item.
3919
+ */
3920
+ trial?: Add.Trial;
3921
+ /**
3922
+ * The ID of the trial offer to apply to the configuration item.
3923
+ */
3924
+ trial_offer?: string;
3925
+ }
3926
+ interface Remove {
3927
+ /**
3928
+ * ID of a price to remove.
3929
+ */
3930
+ price: string;
3931
+ }
3932
+ interface Set {
3933
+ /**
3934
+ * 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`.
3935
+ */
3936
+ discounts?: Array<Set.Discount>;
3937
+ /**
3938
+ * 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`.
3939
+ */
3940
+ metadata?: MetadataParam;
3941
+ /**
3942
+ * The ID of the price object.
3943
+ */
3944
+ price: string;
3945
+ /**
3946
+ * 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`.
3947
+ */
3948
+ quantity?: number;
3949
+ /**
3950
+ * 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`.
3951
+ */
3952
+ tax_rates?: Array<string>;
3953
+ /**
3954
+ * 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`.
3955
+ */
3956
+ trial?: Set.Trial;
3957
+ /**
3958
+ * The ID of the trial offer to apply to the configuration item.
3959
+ */
3960
+ trial_offer?: string;
3961
+ }
3962
+ type Type = 'add' | 'remove' | 'set';
3963
+ namespace Add {
3964
+ interface Discount {
3965
+ /**
3966
+ * ID of the coupon to create a new discount for.
3967
+ */
3968
+ coupon?: string;
3969
+ /**
3970
+ * ID of an existing discount on the object (or one of its ancestors) to reuse.
3971
+ */
3972
+ discount?: string;
3973
+ /**
3974
+ * Details to determine how long the discount should be applied for.
3975
+ */
3976
+ discount_end?: Discount.DiscountEnd;
3977
+ /**
3978
+ * ID of the promotion code to create a new discount for.
3979
+ */
3980
+ promotion_code?: string;
3981
+ }
3982
+ interface Trial {
3983
+ /**
3984
+ * 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.
3985
+ */
3986
+ converts_to?: Array<string>;
3987
+ /**
3988
+ * Determines the type of trial for this item.
3989
+ */
3990
+ type: Trial.Type;
3991
+ }
3992
+ namespace Discount {
3993
+ interface DiscountEnd {
3994
+ /**
3995
+ * Time span for the redeemed discount.
3996
+ */
3997
+ duration?: DiscountEnd.Duration;
3998
+ /**
3999
+ * A precise Unix timestamp for the discount to end. Must be in the future.
4000
+ */
4001
+ timestamp?: number;
4002
+ /**
4003
+ * The type of calculation made to determine when the discount ends.
4004
+ */
4005
+ type: DiscountEnd.Type;
4006
+ }
4007
+ namespace DiscountEnd {
4008
+ interface Duration {
4009
+ /**
4010
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4011
+ */
4012
+ interval: Duration.Interval;
4013
+ /**
4014
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4015
+ */
4016
+ interval_count: number;
4017
+ }
4018
+ type Type = 'duration' | 'timestamp';
4019
+ namespace Duration {
4020
+ type Interval = 'day' | 'month' | 'week' | 'year';
4021
+ }
4022
+ }
4023
+ }
4024
+ namespace Trial {
4025
+ type Type = 'free' | 'paid';
4026
+ }
4027
+ }
4028
+ namespace Set {
4029
+ interface Discount {
4030
+ /**
4031
+ * ID of the coupon to create a new discount for.
4032
+ */
4033
+ coupon?: string;
4034
+ /**
4035
+ * ID of an existing discount on the object (or one of its ancestors) to reuse.
4036
+ */
4037
+ discount?: string;
4038
+ /**
4039
+ * Details to determine how long the discount should be applied for.
4040
+ */
4041
+ discount_end?: Discount.DiscountEnd;
4042
+ /**
4043
+ * ID of the promotion code to create a new discount for.
4044
+ */
4045
+ promotion_code?: string;
4046
+ }
4047
+ interface Trial {
4048
+ /**
4049
+ * 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.
4050
+ */
4051
+ converts_to?: Array<string>;
4052
+ /**
4053
+ * Determines the type of trial for this item.
4054
+ */
4055
+ type: Trial.Type;
4056
+ }
4057
+ namespace Discount {
4058
+ interface DiscountEnd {
4059
+ /**
4060
+ * Time span for the redeemed discount.
4061
+ */
4062
+ duration?: DiscountEnd.Duration;
4063
+ /**
4064
+ * A precise Unix timestamp for the discount to end. Must be in the future.
4065
+ */
4066
+ timestamp?: number;
4067
+ /**
4068
+ * The type of calculation made to determine when the discount ends.
4069
+ */
4070
+ type: DiscountEnd.Type;
4071
+ }
4072
+ namespace DiscountEnd {
4073
+ interface Duration {
4074
+ /**
4075
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4076
+ */
4077
+ interval: Duration.Interval;
4078
+ /**
4079
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4080
+ */
4081
+ interval_count: number;
4082
+ }
4083
+ type Type = 'duration' | 'timestamp';
4084
+ namespace Duration {
4085
+ type Interval = 'day' | 'month' | 'week' | 'year';
4086
+ }
4087
+ }
4088
+ }
4089
+ namespace Trial {
4090
+ type Type = 'free' | 'paid';
4091
+ }
4092
+ }
4093
+ }
4094
+ namespace MetadataAction {
4095
+ type Type = 'add' | 'remove' | 'set';
4096
+ }
4097
+ namespace SetPauseCollection {
4098
+ interface Set {
4099
+ /**
4100
+ * The payment collection behavior for this subscription while paused.
4101
+ */
4102
+ behavior: Set.Behavior;
4103
+ }
4104
+ type Type = 'remove' | 'set';
4105
+ namespace Set {
4106
+ type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
4107
+ }
4108
+ }
4109
+ namespace TrialSettings {
4110
+ interface EndBehavior {
4111
+ /**
4112
+ * Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
4113
+ */
4114
+ prorate_up_front?: EndBehavior.ProrateUpFront;
4115
+ }
4116
+ namespace EndBehavior {
4117
+ type ProrateUpFront = 'defer' | 'include';
4118
+ }
4119
+ }
4120
+ }
3171
4121
  namespace BillingMode {
3172
4122
  interface Flexible {
3173
4123
  /**
@@ -3246,6 +4196,10 @@ export declare namespace InvoiceCreatePreviewParams {
3246
4196
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3247
4197
  */
3248
4198
  discount?: string;
4199
+ /**
4200
+ * Details to determine how long the discount should be applied for.
4201
+ */
4202
+ discount_end?: Discount.DiscountEnd;
3249
4203
  /**
3250
4204
  * ID of the promotion code to create a new discount for.
3251
4205
  */
@@ -3308,6 +4262,20 @@ export declare namespace InvoiceCreatePreviewParams {
3308
4262
  * 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.
3309
4263
  */
3310
4264
  tax_rates?: Emptyable<Array<string>>;
4265
+ /**
4266
+ * Options that configure the trial on the subscription item.
4267
+ */
4268
+ trial?: Item.Trial;
4269
+ /**
4270
+ * The ID of the trial offer to apply to the configuration item.
4271
+ */
4272
+ trial_offer?: string;
4273
+ }
4274
+ interface PauseCollection {
4275
+ /**
4276
+ * The payment collection behavior for this subscription while paused.
4277
+ */
4278
+ behavior: PauseCollection.Behavior;
3311
4279
  }
3312
4280
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
3313
4281
  interface TransferData {
@@ -3320,6 +4288,13 @@ export declare namespace InvoiceCreatePreviewParams {
3320
4288
  */
3321
4289
  destination: string;
3322
4290
  }
4291
+ type TrialContinuation = 'continue' | 'none';
4292
+ interface TrialSettings {
4293
+ /**
4294
+ * Defines how the subscription should behave when a trial ends.
4295
+ */
4296
+ end_behavior?: TrialSettings.EndBehavior;
4297
+ }
3323
4298
  namespace AddInvoiceItem {
3324
4299
  interface Discount {
3325
4300
  /**
@@ -3330,6 +4305,10 @@ export declare namespace InvoiceCreatePreviewParams {
3330
4305
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3331
4306
  */
3332
4307
  discount?: string;
4308
+ /**
4309
+ * Details to determine how long the discount should be applied for.
4310
+ */
4311
+ discount_end?: Discount.DiscountEnd;
3333
4312
  /**
3334
4313
  * ID of the promotion code to create a new discount for.
3335
4314
  */
@@ -3367,6 +4346,38 @@ export declare namespace InvoiceCreatePreviewParams {
3367
4346
  */
3368
4347
  unit_amount_decimal?: Decimal;
3369
4348
  }
4349
+ namespace Discount {
4350
+ interface DiscountEnd {
4351
+ /**
4352
+ * Time span for the redeemed discount.
4353
+ */
4354
+ duration?: DiscountEnd.Duration;
4355
+ /**
4356
+ * A precise Unix timestamp for the discount to end. Must be in the future.
4357
+ */
4358
+ timestamp?: number;
4359
+ /**
4360
+ * The type of calculation made to determine when the discount ends.
4361
+ */
4362
+ type: DiscountEnd.Type;
4363
+ }
4364
+ namespace DiscountEnd {
4365
+ interface Duration {
4366
+ /**
4367
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4368
+ */
4369
+ interval: Duration.Interval;
4370
+ /**
4371
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4372
+ */
4373
+ interval_count: number;
4374
+ }
4375
+ type Type = 'duration' | 'timestamp';
4376
+ namespace Duration {
4377
+ type Interval = 'day' | 'month' | 'week' | 'year';
4378
+ }
4379
+ }
4380
+ }
3370
4381
  namespace Period {
3371
4382
  interface End {
3372
4383
  /**
@@ -3414,6 +4425,38 @@ export declare namespace InvoiceCreatePreviewParams {
3414
4425
  type Type = 'account' | 'self';
3415
4426
  }
3416
4427
  }
4428
+ namespace Discount {
4429
+ interface DiscountEnd {
4430
+ /**
4431
+ * Time span for the redeemed discount.
4432
+ */
4433
+ duration?: DiscountEnd.Duration;
4434
+ /**
4435
+ * A precise Unix timestamp for the discount to end. Must be in the future.
4436
+ */
4437
+ timestamp?: number;
4438
+ /**
4439
+ * The type of calculation made to determine when the discount ends.
4440
+ */
4441
+ type: DiscountEnd.Type;
4442
+ }
4443
+ namespace DiscountEnd {
4444
+ interface Duration {
4445
+ /**
4446
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4447
+ */
4448
+ interval: Duration.Interval;
4449
+ /**
4450
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4451
+ */
4452
+ interval_count: number;
4453
+ }
4454
+ type Type = 'duration' | 'timestamp';
4455
+ namespace Duration {
4456
+ type Interval = 'day' | 'month' | 'week' | 'year';
4457
+ }
4458
+ }
4459
+ }
3417
4460
  namespace Duration {
3418
4461
  type Interval = 'day' | 'month' | 'week' | 'year';
3419
4462
  }
@@ -3448,6 +4491,10 @@ export declare namespace InvoiceCreatePreviewParams {
3448
4491
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3449
4492
  */
3450
4493
  discount?: string;
4494
+ /**
4495
+ * Details to determine how long the discount should be applied for.
4496
+ */
4497
+ discount_end?: Discount.DiscountEnd;
3451
4498
  /**
3452
4499
  * ID of the promotion code to create a new discount for.
3453
4500
  */
@@ -3479,6 +4526,48 @@ export declare namespace InvoiceCreatePreviewParams {
3479
4526
  */
3480
4527
  unit_amount_decimal?: Decimal;
3481
4528
  }
4529
+ interface Trial {
4530
+ /**
4531
+ * 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.
4532
+ */
4533
+ converts_to?: Array<string>;
4534
+ /**
4535
+ * Determines the type of trial for this item.
4536
+ */
4537
+ type: Trial.Type;
4538
+ }
4539
+ namespace Discount {
4540
+ interface DiscountEnd {
4541
+ /**
4542
+ * Time span for the redeemed discount.
4543
+ */
4544
+ duration?: DiscountEnd.Duration;
4545
+ /**
4546
+ * A precise Unix timestamp for the discount to end. Must be in the future.
4547
+ */
4548
+ timestamp?: number;
4549
+ /**
4550
+ * The type of calculation made to determine when the discount ends.
4551
+ */
4552
+ type: DiscountEnd.Type;
4553
+ }
4554
+ namespace DiscountEnd {
4555
+ interface Duration {
4556
+ /**
4557
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4558
+ */
4559
+ interval: Duration.Interval;
4560
+ /**
4561
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4562
+ */
4563
+ interval_count: number;
4564
+ }
4565
+ type Type = 'duration' | 'timestamp';
4566
+ namespace Duration {
4567
+ type Interval = 'day' | 'month' | 'week' | 'year';
4568
+ }
4569
+ }
4570
+ }
3482
4571
  namespace PriceData {
3483
4572
  interface Recurring {
3484
4573
  /**
@@ -3495,6 +4584,65 @@ export declare namespace InvoiceCreatePreviewParams {
3495
4584
  type Interval = 'day' | 'month' | 'week' | 'year';
3496
4585
  }
3497
4586
  }
4587
+ namespace Trial {
4588
+ type Type = 'free' | 'paid';
4589
+ }
4590
+ }
4591
+ namespace PauseCollection {
4592
+ type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
4593
+ }
4594
+ namespace TrialSettings {
4595
+ interface EndBehavior {
4596
+ /**
4597
+ * Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
4598
+ */
4599
+ prorate_up_front?: EndBehavior.ProrateUpFront;
4600
+ }
4601
+ namespace EndBehavior {
4602
+ type ProrateUpFront = 'defer' | 'include';
4603
+ }
4604
+ }
4605
+ }
4606
+ namespace Prebilling {
4607
+ interface BillUntil {
4608
+ /**
4609
+ * End the prebilled period when a specified amendment ends.
4610
+ */
4611
+ amendment_end?: BillUntil.AmendmentEnd;
4612
+ /**
4613
+ * Time span for prebilling, starting from `bill_from`.
4614
+ */
4615
+ duration?: BillUntil.Duration;
4616
+ /**
4617
+ * End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
4618
+ */
4619
+ timestamp?: number;
4620
+ /**
4621
+ * Select one of several ways to pass the `bill_until` value.
4622
+ */
4623
+ type: BillUntil.Type;
4624
+ }
4625
+ namespace BillUntil {
4626
+ interface AmendmentEnd {
4627
+ /**
4628
+ * 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.
4629
+ */
4630
+ index: number;
4631
+ }
4632
+ interface Duration {
4633
+ /**
4634
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4635
+ */
4636
+ interval: Duration.Interval;
4637
+ /**
4638
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4639
+ */
4640
+ interval_count: number;
4641
+ }
4642
+ type Type = 'amendment_end' | 'duration' | 'schedule_end' | 'timestamp';
4643
+ namespace Duration {
4644
+ type Interval = 'day' | 'month' | 'week' | 'year';
4645
+ }
3498
4646
  }
3499
4647
  }
3500
4648
  }
@@ -3534,6 +4682,10 @@ export declare namespace InvoiceCreatePreviewParams {
3534
4682
  * 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.
3535
4683
  */
3536
4684
  clear_usage?: boolean;
4685
+ /**
4686
+ * The trial offer to apply to this subscription item.
4687
+ */
4688
+ current_trial?: Item.CurrentTrial;
3537
4689
  /**
3538
4690
  * A flag that, if set to `true`, will delete the specified item.
3539
4691
  */
@@ -3571,6 +4723,26 @@ export declare namespace InvoiceCreatePreviewParams {
3571
4723
  */
3572
4724
  tax_rates?: Emptyable<Array<string>>;
3573
4725
  }
4726
+ interface Pause {
4727
+ /**
4728
+ * Controls what to bill for when pausing the subscription.
4729
+ */
4730
+ bill_for?: Pause.BillFor;
4731
+ /**
4732
+ * Determines how to handle debits and credits when pausing. Defaults to `pending_invoice_item`.
4733
+ */
4734
+ invoicing_behavior?: Pause.InvoicingBehavior;
4735
+ /**
4736
+ * The type of pause to apply. Defaults to `subscription`.
4737
+ */
4738
+ type?: 'subscription';
4739
+ }
4740
+ interface Prebilling {
4741
+ /**
4742
+ * This is used to determine the number of billing cycles to prebill.
4743
+ */
4744
+ iterations: number;
4745
+ }
3574
4746
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
3575
4747
  namespace BillingMode {
3576
4748
  interface Flexible {
@@ -3633,6 +4805,16 @@ export declare namespace InvoiceCreatePreviewParams {
3633
4805
  */
3634
4806
  usage_gte: number;
3635
4807
  }
4808
+ interface CurrentTrial {
4809
+ /**
4810
+ * 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`.
4811
+ */
4812
+ trial_end?: number;
4813
+ /**
4814
+ * The ID of the trial offer to apply to the subscription item.
4815
+ */
4816
+ trial_offer: string;
4817
+ }
3636
4818
  interface Discount {
3637
4819
  /**
3638
4820
  * ID of the coupon to create a new discount for.
@@ -3642,6 +4824,10 @@ export declare namespace InvoiceCreatePreviewParams {
3642
4824
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3643
4825
  */
3644
4826
  discount?: string;
4827
+ /**
4828
+ * Details to determine how long the discount should be applied for.
4829
+ */
4830
+ discount_end?: Discount.DiscountEnd;
3645
4831
  /**
3646
4832
  * ID of the promotion code to create a new discount for.
3647
4833
  */
@@ -3673,6 +4859,38 @@ export declare namespace InvoiceCreatePreviewParams {
3673
4859
  */
3674
4860
  unit_amount_decimal?: Decimal;
3675
4861
  }
4862
+ namespace Discount {
4863
+ interface DiscountEnd {
4864
+ /**
4865
+ * Time span for the redeemed discount.
4866
+ */
4867
+ duration?: DiscountEnd.Duration;
4868
+ /**
4869
+ * A precise Unix timestamp for the discount to end. Must be in the future.
4870
+ */
4871
+ timestamp?: number;
4872
+ /**
4873
+ * The type of calculation made to determine when the discount ends.
4874
+ */
4875
+ type: DiscountEnd.Type;
4876
+ }
4877
+ namespace DiscountEnd {
4878
+ interface Duration {
4879
+ /**
4880
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4881
+ */
4882
+ interval: Duration.Interval;
4883
+ /**
4884
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4885
+ */
4886
+ interval_count: number;
4887
+ }
4888
+ type Type = 'duration' | 'timestamp';
4889
+ namespace Duration {
4890
+ type Interval = 'day' | 'month' | 'week' | 'year';
4891
+ }
4892
+ }
4893
+ }
3676
4894
  namespace PriceData {
3677
4895
  interface Recurring {
3678
4896
  /**
@@ -3690,8 +4908,51 @@ export declare namespace InvoiceCreatePreviewParams {
3690
4908
  }
3691
4909
  }
3692
4910
  }
4911
+ namespace Pause {
4912
+ interface BillFor {
4913
+ /**
4914
+ * Controls when to bill for metered usage in the current period. Defaults to `{ type: "now" }`.
4915
+ */
4916
+ outstanding_usage_through?: BillFor.OutstandingUsageThrough;
4917
+ /**
4918
+ * Controls when to credit for unused time on licensed items. Defaults to `{ type: "now" }`.
4919
+ */
4920
+ unused_time_from?: BillFor.UnusedTimeFrom;
4921
+ }
4922
+ type InvoicingBehavior = 'invoice' | 'pending_invoice_item';
4923
+ namespace BillFor {
4924
+ interface OutstandingUsageThrough {
4925
+ /**
4926
+ * When to bill metered usage in the current period.
4927
+ */
4928
+ type: OutstandingUsageThrough.Type;
4929
+ }
4930
+ interface UnusedTimeFrom {
4931
+ /**
4932
+ * When to credit for unused time.
4933
+ */
4934
+ type: UnusedTimeFrom.Type;
4935
+ }
4936
+ namespace OutstandingUsageThrough {
4937
+ type Type = 'none' | 'now';
4938
+ }
4939
+ namespace UnusedTimeFrom {
4940
+ type Type = 'item_current_period_start' | 'none' | 'now';
4941
+ }
4942
+ }
4943
+ }
3693
4944
  }
3694
4945
  }
4946
+ export interface InvoiceDetachPaymentParams {
4947
+ /**
4948
+ * Specifies which fields in the response should be expanded.
4949
+ */
4950
+ expand?: Array<string>;
4951
+ /**
4952
+ * The ID of the PaymentIntent to detach from the invoice.
4953
+ */
4954
+ payment_intent?: string;
4955
+ }
3695
4956
  export interface InvoiceFinalizeInvoiceParams {
3696
4957
  /**
3697
4958
  * 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.
@@ -3839,6 +5100,10 @@ export declare namespace InvoiceUpdateLinesParams {
3839
5100
  * ID of an existing line item on the invoice.
3840
5101
  */
3841
5102
  id: string;
5103
+ /**
5104
+ * 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.
5105
+ */
5106
+ margins?: Emptyable<Array<string>>;
3842
5107
  /**
3843
5108
  * 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.
3844
5109
  */
@@ -3882,6 +5147,10 @@ export declare namespace InvoiceUpdateLinesParams {
3882
5147
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3883
5148
  */
3884
5149
  discount?: string;
5150
+ /**
5151
+ * Details to determine how long the discount should be applied for.
5152
+ */
5153
+ discount_end?: Discount.DiscountEnd;
3885
5154
  /**
3886
5155
  * ID of the promotion code to create a new discount for.
3887
5156
  */
@@ -3949,6 +5218,38 @@ export declare namespace InvoiceUpdateLinesParams {
3949
5218
  */
3950
5219
  taxable_amount: number;
3951
5220
  }
5221
+ namespace Discount {
5222
+ interface DiscountEnd {
5223
+ /**
5224
+ * Time span for the redeemed discount.
5225
+ */
5226
+ duration?: DiscountEnd.Duration;
5227
+ /**
5228
+ * A precise Unix timestamp for the discount to end. Must be in the future.
5229
+ */
5230
+ timestamp?: number;
5231
+ /**
5232
+ * The type of calculation made to determine when the discount ends.
5233
+ */
5234
+ type: DiscountEnd.Type;
5235
+ }
5236
+ namespace DiscountEnd {
5237
+ interface Duration {
5238
+ /**
5239
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
5240
+ */
5241
+ interval: Duration.Interval;
5242
+ /**
5243
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
5244
+ */
5245
+ interval_count: number;
5246
+ }
5247
+ type Type = 'duration' | 'timestamp';
5248
+ namespace Duration {
5249
+ type Interval = 'day' | 'month' | 'week' | 'year';
5250
+ }
5251
+ }
5252
+ }
3952
5253
  namespace PriceData {
3953
5254
  interface ProductData {
3954
5255
  /**
@@ -3971,12 +5272,28 @@ export declare namespace InvoiceUpdateLinesParams {
3971
5272
  * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
3972
5273
  */
3973
5274
  tax_code?: string;
5275
+ /**
5276
+ * Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
5277
+ */
5278
+ tax_details?: ProductData.TaxDetails;
3974
5279
  /**
3975
5280
  * A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
3976
5281
  */
3977
5282
  unit_label?: string;
3978
5283
  }
3979
5284
  type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
5285
+ namespace ProductData {
5286
+ interface TaxDetails {
5287
+ /**
5288
+ * 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.
5289
+ */
5290
+ performance_location?: string;
5291
+ /**
5292
+ * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
5293
+ */
5294
+ tax_code?: Emptyable<string>;
5295
+ }
5296
+ }
3980
5297
  }
3981
5298
  namespace TaxAmount {
3982
5299
  interface TaxRateData {
@@ -4046,6 +5363,10 @@ export interface InvoiceUpdateLineItemParams {
4046
5363
  * Specifies which fields in the response should be expanded.
4047
5364
  */
4048
5365
  expand?: Array<string>;
5366
+ /**
5367
+ * 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.
5368
+ */
5369
+ margins?: Emptyable<Array<string>>;
4049
5370
  /**
4050
5371
  * 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.
4051
5372
  */
@@ -4089,6 +5410,10 @@ export declare namespace InvoiceUpdateLineItemParams {
4089
5410
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
4090
5411
  */
4091
5412
  discount?: string;
5413
+ /**
5414
+ * Details to determine how long the discount should be applied for.
5415
+ */
5416
+ discount_end?: Discount.DiscountEnd;
4092
5417
  /**
4093
5418
  * ID of the promotion code to create a new discount for.
4094
5419
  */
@@ -4156,6 +5481,38 @@ export declare namespace InvoiceUpdateLineItemParams {
4156
5481
  */
4157
5482
  taxable_amount: number;
4158
5483
  }
5484
+ namespace Discount {
5485
+ interface DiscountEnd {
5486
+ /**
5487
+ * Time span for the redeemed discount.
5488
+ */
5489
+ duration?: DiscountEnd.Duration;
5490
+ /**
5491
+ * A precise Unix timestamp for the discount to end. Must be in the future.
5492
+ */
5493
+ timestamp?: number;
5494
+ /**
5495
+ * The type of calculation made to determine when the discount ends.
5496
+ */
5497
+ type: DiscountEnd.Type;
5498
+ }
5499
+ namespace DiscountEnd {
5500
+ interface Duration {
5501
+ /**
5502
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
5503
+ */
5504
+ interval: Duration.Interval;
5505
+ /**
5506
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
5507
+ */
5508
+ interval_count: number;
5509
+ }
5510
+ type Type = 'duration' | 'timestamp';
5511
+ namespace Duration {
5512
+ type Interval = 'day' | 'month' | 'week' | 'year';
5513
+ }
5514
+ }
5515
+ }
4159
5516
  namespace PriceData {
4160
5517
  interface ProductData {
4161
5518
  /**
@@ -4178,12 +5535,28 @@ export declare namespace InvoiceUpdateLineItemParams {
4178
5535
  * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
4179
5536
  */
4180
5537
  tax_code?: string;
5538
+ /**
5539
+ * Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
5540
+ */
5541
+ tax_details?: ProductData.TaxDetails;
4181
5542
  /**
4182
5543
  * A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
4183
5544
  */
4184
5545
  unit_label?: string;
4185
5546
  }
4186
5547
  type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
5548
+ namespace ProductData {
5549
+ interface TaxDetails {
5550
+ /**
5551
+ * 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.
5552
+ */
5553
+ performance_location?: string;
5554
+ /**
5555
+ * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
5556
+ */
5557
+ tax_code?: Emptyable<string>;
5558
+ }
5559
+ }
4187
5560
  }
4188
5561
  namespace TaxAmount {
4189
5562
  interface TaxRateData {