stripe 18.5.0 → 18.6.0-alpha.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 (419) hide show
  1. package/CHANGELOG.md +1413 -11
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +1 -0
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +115 -1
  6. package/cjs/RequestSender.js +7 -4
  7. package/cjs/apiVersion.js +2 -3
  8. package/cjs/resources/AccountNotices.js +21 -0
  9. package/cjs/resources/BalanceSettings.js +10 -0
  10. package/cjs/resources/Billing/MeterUsage.js +12 -0
  11. package/cjs/resources/Capital/FinancingOffers.js +21 -0
  12. package/cjs/resources/Capital/FinancingSummary.js +12 -0
  13. package/cjs/resources/Capital/FinancingTransactions.js +17 -0
  14. package/cjs/resources/ExternalAccounts.js +23 -0
  15. package/cjs/resources/FinancialConnections/Accounts.js +5 -0
  16. package/cjs/resources/FinancialConnections/Institutions.js +17 -0
  17. package/cjs/resources/FxQuotes.js +15 -0
  18. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
  19. package/cjs/resources/Issuing/DisputeSettlementDetails.js +17 -0
  20. package/cjs/resources/Issuing/FraudLiabilityDebits.js +17 -0
  21. package/cjs/resources/Mandates.js +5 -0
  22. package/cjs/resources/Margins.js +22 -0
  23. package/cjs/resources/Orders.js +24 -0
  24. package/cjs/resources/PaymentAttemptRecords.js +17 -0
  25. package/cjs/resources/PaymentIntents.js +13 -0
  26. package/cjs/resources/PaymentRecords.js +29 -0
  27. package/cjs/resources/Privacy/RedactionJobs.js +42 -0
  28. package/cjs/resources/Quotes.js +32 -0
  29. package/cjs/resources/SubscriptionSchedules.js +4 -0
  30. package/cjs/resources/Subscriptions.js +4 -0
  31. package/cjs/resources/Tax/Associations.js +9 -0
  32. package/cjs/resources/Tax/Forms.js +20 -0
  33. package/cjs/resources/Terminal/OnboardingLinks.js +12 -0
  34. package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
  35. package/cjs/resources/V2/Billing/BillSettings/Versions.js +17 -0
  36. package/cjs/resources/V2/Billing/BillSettings.js +27 -0
  37. package/cjs/resources/V2/Billing/Cadences.js +23 -0
  38. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +17 -0
  39. package/cjs/resources/V2/Billing/CollectionSettings.js +30 -0
  40. package/cjs/resources/V2/Billing/CustomPricingUnits.js +25 -0
  41. package/cjs/resources/V2/Billing/Intents/Actions.js +17 -0
  42. package/cjs/resources/V2/Billing/Intents.js +36 -0
  43. package/cjs/resources/V2/Billing/LicenseFeeSubscriptions.js +12 -0
  44. package/cjs/resources/V2/Billing/LicenseFees/Versions.js +17 -0
  45. package/cjs/resources/V2/Billing/LicenseFees.js +27 -0
  46. package/cjs/resources/V2/Billing/LicensedItems.js +25 -0
  47. package/cjs/resources/V2/Billing/MeteredItems.js +22 -0
  48. package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +17 -0
  49. package/cjs/resources/V2/Billing/PricingPlans/Components.js +29 -0
  50. package/cjs/resources/V2/Billing/PricingPlans/Versions.js +17 -0
  51. package/cjs/resources/V2/Billing/PricingPlans.js +29 -0
  52. package/cjs/resources/V2/Billing/Profiles.js +19 -0
  53. package/cjs/resources/V2/Billing/RateCardSubscriptions.js +29 -0
  54. package/cjs/resources/V2/Billing/RateCards/Rates.js +25 -0
  55. package/cjs/resources/V2/Billing/RateCards/Versions.js +17 -0
  56. package/cjs/resources/V2/Billing/RateCards.js +29 -0
  57. package/cjs/resources/V2/Billing/ServiceActions.js +16 -0
  58. package/cjs/resources/V2/Core/AccountLinks.js +9 -0
  59. package/cjs/resources/V2/Core/Accounts/Persons.js +29 -0
  60. package/cjs/resources/V2/Core/Accounts.js +25 -0
  61. package/cjs/resources/V2/Core/ClaimableSandboxes.js +12 -0
  62. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +28 -0
  63. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +24 -0
  64. package/cjs/resources/V2/MoneyManagement/Adjustments.js +17 -0
  65. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +25 -0
  66. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +21 -0
  67. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +21 -0
  68. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +16 -0
  69. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +25 -0
  70. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +29 -0
  71. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +25 -0
  72. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +25 -0
  73. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +12 -0
  74. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +17 -0
  75. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +17 -0
  76. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +17 -0
  77. package/cjs/resources/V2/MoneyManagement/Transactions.js +17 -0
  78. package/cjs/resources/V2/Payments/OffSessionPayments.js +25 -0
  79. package/cjs/resources/V2/Reporting/ReportRuns.js +13 -0
  80. package/cjs/resources/V2/Reporting/Reports.js +12 -0
  81. package/cjs/resources/V2/Tax/AutomaticRules.js +22 -0
  82. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +16 -0
  83. package/cjs/resources.js +142 -8
  84. package/cjs/stripe.core.js +27 -1
  85. package/esm/Error.js +100 -0
  86. package/esm/RequestSender.js +7 -4
  87. package/esm/apiVersion.js +1 -2
  88. package/esm/resources/AccountNotices.js +18 -0
  89. package/esm/resources/BalanceSettings.js +7 -0
  90. package/esm/resources/Billing/MeterUsage.js +9 -0
  91. package/esm/resources/Capital/FinancingOffers.js +18 -0
  92. package/esm/resources/Capital/FinancingSummary.js +9 -0
  93. package/esm/resources/Capital/FinancingTransactions.js +14 -0
  94. package/esm/resources/ExternalAccounts.js +20 -0
  95. package/esm/resources/FinancialConnections/Accounts.js +5 -0
  96. package/esm/resources/FinancialConnections/Institutions.js +14 -0
  97. package/esm/resources/FxQuotes.js +12 -0
  98. package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
  99. package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
  100. package/esm/resources/Issuing/FraudLiabilityDebits.js +14 -0
  101. package/esm/resources/Mandates.js +5 -0
  102. package/esm/resources/Margins.js +19 -0
  103. package/esm/resources/Orders.js +21 -0
  104. package/esm/resources/PaymentAttemptRecords.js +14 -0
  105. package/esm/resources/PaymentIntents.js +13 -0
  106. package/esm/resources/PaymentRecords.js +26 -0
  107. package/esm/resources/Privacy/RedactionJobs.js +39 -0
  108. package/esm/resources/Quotes.js +32 -0
  109. package/esm/resources/SubscriptionSchedules.js +4 -0
  110. package/esm/resources/Subscriptions.js +4 -0
  111. package/esm/resources/Tax/Associations.js +6 -0
  112. package/esm/resources/Tax/Forms.js +17 -0
  113. package/esm/resources/Terminal/OnboardingLinks.js +9 -0
  114. package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
  115. package/esm/resources/V2/Billing/BillSettings/Versions.js +14 -0
  116. package/esm/resources/V2/Billing/BillSettings.js +24 -0
  117. package/esm/resources/V2/Billing/Cadences.js +20 -0
  118. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +14 -0
  119. package/esm/resources/V2/Billing/CollectionSettings.js +27 -0
  120. package/esm/resources/V2/Billing/CustomPricingUnits.js +22 -0
  121. package/esm/resources/V2/Billing/Intents/Actions.js +14 -0
  122. package/esm/resources/V2/Billing/Intents.js +33 -0
  123. package/esm/resources/V2/Billing/LicenseFeeSubscriptions.js +9 -0
  124. package/esm/resources/V2/Billing/LicenseFees/Versions.js +14 -0
  125. package/esm/resources/V2/Billing/LicenseFees.js +24 -0
  126. package/esm/resources/V2/Billing/LicensedItems.js +22 -0
  127. package/esm/resources/V2/Billing/MeteredItems.js +19 -0
  128. package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +14 -0
  129. package/esm/resources/V2/Billing/PricingPlans/Components.js +26 -0
  130. package/esm/resources/V2/Billing/PricingPlans/Versions.js +14 -0
  131. package/esm/resources/V2/Billing/PricingPlans.js +26 -0
  132. package/esm/resources/V2/Billing/Profiles.js +16 -0
  133. package/esm/resources/V2/Billing/RateCardSubscriptions.js +26 -0
  134. package/esm/resources/V2/Billing/RateCards/Rates.js +22 -0
  135. package/esm/resources/V2/Billing/RateCards/Versions.js +14 -0
  136. package/esm/resources/V2/Billing/RateCards.js +26 -0
  137. package/esm/resources/V2/Billing/ServiceActions.js +13 -0
  138. package/esm/resources/V2/Core/AccountLinks.js +6 -0
  139. package/esm/resources/V2/Core/Accounts/Persons.js +26 -0
  140. package/esm/resources/V2/Core/Accounts.js +22 -0
  141. package/esm/resources/V2/Core/ClaimableSandboxes.js +9 -0
  142. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +25 -0
  143. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +21 -0
  144. package/esm/resources/V2/MoneyManagement/Adjustments.js +14 -0
  145. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +22 -0
  146. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +18 -0
  147. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +18 -0
  148. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +13 -0
  149. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +22 -0
  150. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +26 -0
  151. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +22 -0
  152. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +22 -0
  153. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +9 -0
  154. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +14 -0
  155. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +14 -0
  156. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +14 -0
  157. package/esm/resources/V2/MoneyManagement/Transactions.js +14 -0
  158. package/esm/resources/V2/Payments/OffSessionPayments.js +22 -0
  159. package/esm/resources/V2/Reporting/ReportRuns.js +10 -0
  160. package/esm/resources/V2/Reporting/Reports.js +9 -0
  161. package/esm/resources/V2/Tax/AutomaticRules.js +19 -0
  162. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +13 -0
  163. package/esm/resources.js +126 -0
  164. package/esm/stripe.core.js +27 -1
  165. package/package.json +1 -1
  166. package/types/AccountLinksResource.d.ts +5 -1
  167. package/types/AccountNotices.d.ts +113 -0
  168. package/types/AccountNoticesResource.d.ts +98 -0
  169. package/types/AccountSessions.d.ts +45 -0
  170. package/types/AccountSessionsResource.d.ts +264 -0
  171. package/types/Accounts.d.ts +212 -1
  172. package/types/AccountsResource.d.ts +544 -0
  173. package/types/BalanceSettings.d.ts +97 -0
  174. package/types/BalanceSettingsResource.d.ts +119 -0
  175. package/types/Billing/AlertTriggereds.d.ts +16 -1
  176. package/types/Billing/Alerts.d.ts +116 -1
  177. package/types/Billing/AlertsResource.d.ts +93 -2
  178. package/types/Billing/CreditBalanceSummary.d.ts +123 -2
  179. package/types/Billing/CreditBalanceSummaryResource.d.ts +20 -3
  180. package/types/Billing/CreditBalanceTransactions.d.ts +118 -2
  181. package/types/Billing/CreditBalanceTransactionsResource.d.ts +12 -4
  182. package/types/Billing/CreditGrants.d.ts +76 -1
  183. package/types/Billing/CreditGrantsResource.d.ts +43 -2
  184. package/types/Billing/MeterUsage.d.ts +32 -0
  185. package/types/Billing/MeterUsageResource.d.ts +685 -0
  186. package/types/Billing/MeterUsageRows.d.ts +49 -0
  187. package/types/BillingPortal/Sessions.d.ts +5 -0
  188. package/types/BillingPortal/SessionsResource.d.ts +12 -4
  189. package/types/Capital/FinancingOffers.d.ts +188 -0
  190. package/types/Capital/FinancingOffersResource.d.ts +97 -0
  191. package/types/Capital/FinancingSummary.d.ts +106 -0
  192. package/types/Capital/FinancingSummaryResource.d.ts +27 -0
  193. package/types/Capital/FinancingTransactions.d.ts +135 -0
  194. package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
  195. package/types/Cards.d.ts +5 -0
  196. package/types/CashBalances.d.ts +5 -0
  197. package/types/Charges.d.ts +171 -10
  198. package/types/ChargesResource.d.ts +1406 -0
  199. package/types/Checkout/Sessions.d.ts +432 -2
  200. package/types/Checkout/SessionsResource.d.ts +570 -2
  201. package/types/ConfirmationTokens.d.ts +125 -0
  202. package/types/Coupons.d.ts +33 -0
  203. package/types/CouponsResource.d.ts +21 -0
  204. package/types/CreditNoteLineItems.d.ts +17 -0
  205. package/types/CreditNotes.d.ts +5 -0
  206. package/types/CreditNotesResource.d.ts +5 -0
  207. package/types/CustomerBalanceTransactions.d.ts +2 -0
  208. package/types/CustomerCashBalanceTransactions.d.ts +2 -0
  209. package/types/CustomerSessions.d.ts +5 -0
  210. package/types/CustomerSessionsResource.d.ts +6 -1
  211. package/types/Customers.d.ts +2 -0
  212. package/types/CustomersResource.d.ts +8 -0
  213. package/types/Discounts.d.ts +10 -0
  214. package/types/Disputes.d.ts +29 -0
  215. package/types/Errors.d.ts +85 -0
  216. package/types/EventTypes.d.ts +664 -0
  217. package/types/Events.d.ts +97 -0
  218. package/types/ExternalAccountsResource.d.ts +304 -0
  219. package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
  220. package/types/FinancialConnections/Accounts.d.ts +36 -1
  221. package/types/FinancialConnections/AccountsResource.d.ts +40 -3
  222. package/types/FinancialConnections/Institutions.d.ts +98 -0
  223. package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
  224. package/types/FinancialConnections/Sessions.d.ts +51 -1
  225. package/types/FinancialConnections/SessionsResource.d.ts +43 -1
  226. package/types/FxQuotes.d.ts +155 -0
  227. package/types/FxQuotesResource.d.ts +130 -0
  228. package/types/Identity/VerificationSessions.d.ts +5 -0
  229. package/types/Identity/VerificationSessionsResource.d.ts +7 -0
  230. package/types/InvoiceItems.d.ts +114 -2
  231. package/types/InvoiceItemsResource.d.ts +117 -6
  232. package/types/InvoiceLineItems.d.ts +158 -3
  233. package/types/InvoicePayments.d.ts +5 -0
  234. package/types/InvoicePaymentsResource.d.ts +10 -1
  235. package/types/Invoices.d.ts +187 -4
  236. package/types/InvoicesResource.d.ts +1535 -19
  237. package/types/Issuing/CardholdersResource.d.ts +2 -1
  238. package/types/Issuing/CardsResource.d.ts +0 -10
  239. package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
  240. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
  241. package/types/Issuing/DisputeSettlementDetails.d.ts +85 -0
  242. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
  243. package/types/Issuing/FraudLiabilityDebits.d.ts +52 -0
  244. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +52 -0
  245. package/types/Issuing/Settlements.d.ts +113 -0
  246. package/types/Issuing/Transactions.d.ts +5 -0
  247. package/types/Issuing/TransactionsResource.d.ts +5 -0
  248. package/types/LineItems.d.ts +49 -0
  249. package/types/Mandates.d.ts +135 -1
  250. package/types/MandatesResource.d.ts +31 -0
  251. package/types/Margins.d.ts +56 -0
  252. package/types/MarginsResource.d.ts +114 -0
  253. package/types/Orders.d.ts +1163 -0
  254. package/types/OrdersResource.d.ts +3139 -0
  255. package/types/PaymentAttemptRecords.d.ts +2311 -0
  256. package/types/PaymentAttemptRecordsResource.d.ts +52 -0
  257. package/types/PaymentIntentAmountDetailsLineItems.d.ts +116 -0
  258. package/types/PaymentIntents.d.ts +836 -3
  259. package/types/PaymentIntentsResource.d.ts +11610 -5775
  260. package/types/PaymentLinks.d.ts +6 -0
  261. package/types/PaymentLinksResource.d.ts +12 -0
  262. package/types/PaymentMethodConfigurations.d.ts +180 -0
  263. package/types/PaymentMethodConfigurationsResource.d.ts +250 -0
  264. package/types/PaymentMethods.d.ts +130 -0
  265. package/types/PaymentMethodsResource.d.ts +167 -2
  266. package/types/PaymentRecords.d.ts +2304 -0
  267. package/types/PaymentRecordsResource.d.ts +476 -0
  268. package/types/Prices.d.ts +22 -0
  269. package/types/PricesResource.d.ts +22 -0
  270. package/types/Privacy/RedactionJobValidationErrors.d.ts +60 -0
  271. package/types/Privacy/RedactionJobs.d.ts +111 -0
  272. package/types/Privacy/RedactionJobsResource.d.ts +230 -0
  273. package/types/PromotionCodes.d.ts +5 -0
  274. package/types/PromotionCodesResource.d.ts +10 -0
  275. package/types/QuoteLines.d.ts +634 -0
  276. package/types/QuotePreviewInvoices.d.ts +1751 -0
  277. package/types/QuotePreviewSubscriptionSchedules.d.ts +892 -0
  278. package/types/Quotes.d.ts +594 -1
  279. package/types/QuotesResource.d.ts +2577 -232
  280. package/types/Refunds.d.ts +14 -0
  281. package/types/SetupAttempts.d.ts +51 -1
  282. package/types/SetupIntents.d.ts +210 -2
  283. package/types/SetupIntentsResource.d.ts +938 -4
  284. package/types/Sources.d.ts +29 -0
  285. package/types/SubscriptionItems.d.ts +21 -0
  286. package/types/SubscriptionItemsResource.d.ts +109 -0
  287. package/types/SubscriptionSchedules.d.ts +205 -0
  288. package/types/SubscriptionSchedulesResource.d.ts +1233 -5
  289. package/types/Subscriptions.d.ts +140 -1
  290. package/types/SubscriptionsResource.d.ts +498 -8
  291. package/types/Tax/Associations.d.ts +82 -0
  292. package/types/Tax/AssociationsResource.d.ts +29 -0
  293. package/types/Tax/Forms.d.ts +220 -0
  294. package/types/Tax/FormsResource.d.ts +107 -0
  295. package/types/TaxIds.d.ts +10 -0
  296. package/types/TaxIdsResource.d.ts +10 -0
  297. package/types/Terminal/Configurations.d.ts +9 -0
  298. package/types/Terminal/ConfigurationsResource.d.ts +28 -0
  299. package/types/Terminal/OnboardingLinks.d.ts +57 -0
  300. package/types/Terminal/OnboardingLinksResource.d.ts +62 -0
  301. package/types/Terminal/ReaderCollectedData.d.ts +51 -0
  302. package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
  303. package/types/Terminal/Readers.d.ts +20 -0
  304. package/types/TestHelpers/ConfirmationTokensResource.d.ts +126 -0
  305. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
  306. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
  307. package/types/Transfers.d.ts +5 -0
  308. package/types/TransfersResource.d.ts +5 -0
  309. package/types/Treasury/FinancialAccountFeatures.d.ts +7 -0
  310. package/types/Treasury/FinancialAccounts.d.ts +5 -0
  311. package/types/Treasury/FinancialAccountsResource.d.ts +37 -0
  312. package/types/Treasury/OutboundTransfers.d.ts +26 -0
  313. package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
  314. package/types/Treasury/ReceivedCredits.d.ts +26 -0
  315. package/types/Treasury/ReceivedDebits.d.ts +31 -0
  316. package/types/V2/Billing/BillSettingVersions.d.ts +97 -0
  317. package/types/V2/Billing/BillSettings/VersionsResource.d.ts +58 -0
  318. package/types/V2/Billing/BillSettings.d.ts +120 -0
  319. package/types/V2/Billing/BillSettingsResource.d.ts +241 -0
  320. package/types/V2/Billing/Cadences.d.ts +354 -0
  321. package/types/V2/Billing/CadencesResource.d.ts +489 -0
  322. package/types/V2/Billing/CollectionSettingVersions.d.ts +314 -0
  323. package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +62 -0
  324. package/types/V2/Billing/CollectionSettings.d.ts +337 -0
  325. package/types/V2/Billing/CollectionSettingsResource.d.ts +675 -0
  326. package/types/V2/Billing/CustomPricingUnits.d.ts +56 -0
  327. package/types/V2/Billing/CustomPricingUnitsResource.d.ts +122 -0
  328. package/types/V2/Billing/IntentActions.d.ts +458 -0
  329. package/types/V2/Billing/Intents/ActionsResource.d.ts +58 -0
  330. package/types/V2/Billing/Intents.d.ts +117 -0
  331. package/types/V2/Billing/IntentsResource.d.ts +574 -0
  332. package/types/V2/Billing/LicenseFeeSubscriptions.d.ts +64 -0
  333. package/types/V2/Billing/LicenseFeeSubscriptionsResource.d.ts +28 -0
  334. package/types/V2/Billing/LicenseFeeVersions.d.ts +106 -0
  335. package/types/V2/Billing/LicenseFees/VersionsResource.d.ts +58 -0
  336. package/types/V2/Billing/LicenseFees.d.ts +163 -0
  337. package/types/V2/Billing/LicenseFeesResource.d.ts +290 -0
  338. package/types/V2/Billing/LicensedItems.d.ts +73 -0
  339. package/types/V2/Billing/LicensedItemsResource.d.ts +157 -0
  340. package/types/V2/Billing/MeteredItems.d.ts +101 -0
  341. package/types/V2/Billing/MeteredItemsResource.d.ts +189 -0
  342. package/types/V2/Billing/PricingPlanComponents.d.ts +109 -0
  343. package/types/V2/Billing/PricingPlanSubscriptions.d.ts +134 -0
  344. package/types/V2/Billing/PricingPlanSubscriptionsResource.d.ts +93 -0
  345. package/types/V2/Billing/PricingPlanVersions.d.ts +49 -0
  346. package/types/V2/Billing/PricingPlans/ComponentsResource.d.ts +197 -0
  347. package/types/V2/Billing/PricingPlans/VersionsResource.d.ts +58 -0
  348. package/types/V2/Billing/PricingPlans.d.ts +84 -0
  349. package/types/V2/Billing/PricingPlansResource.d.ts +151 -0
  350. package/types/V2/Billing/Profiles.d.ts +70 -0
  351. package/types/V2/Billing/ProfilesResource.d.ts +150 -0
  352. package/types/V2/Billing/RateCardRates.d.ts +138 -0
  353. package/types/V2/Billing/RateCardSubscriptions.d.ts +134 -0
  354. package/types/V2/Billing/RateCardSubscriptionsResource.d.ts +157 -0
  355. package/types/V2/Billing/RateCardVersions.d.ts +39 -0
  356. package/types/V2/Billing/RateCards/RatesResource.d.ts +209 -0
  357. package/types/V2/Billing/RateCards/VersionsResource.d.ts +58 -0
  358. package/types/V2/Billing/RateCards.d.ts +98 -0
  359. package/types/V2/Billing/RateCardsResource.d.ts +162 -0
  360. package/types/V2/Billing/ServiceActions.d.ts +240 -0
  361. package/types/V2/Billing/ServiceActionsResource.d.ts +302 -0
  362. package/types/V2/Core/AccountLinks.d.ts +168 -0
  363. package/types/V2/Core/AccountLinksResource.d.ts +152 -0
  364. package/types/V2/Core/Accounts/PersonsResource.d.ts +3812 -0
  365. package/types/V2/Core/Accounts.d.ts +8862 -0
  366. package/types/V2/Core/AccountsResource.d.ts +10704 -0
  367. package/types/V2/Core/ClaimableSandboxes.d.ts +349 -0
  368. package/types/V2/Core/ClaimableSandboxesResource.d.ts +310 -0
  369. package/types/V2/Core/Persons.d.ts +1888 -0
  370. package/types/V2/Core/Vault/GbBankAccounts.d.ts +160 -0
  371. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +172 -0
  372. package/types/V2/Core/Vault/UsBankAccounts.d.ts +70 -0
  373. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +123 -0
  374. package/types/V2/EventTypes.d.ts +4015 -5
  375. package/types/V2/Events.d.ts +7 -0
  376. package/types/V2/FinancialAddressCreditSimulations.d.ts +27 -0
  377. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +32 -0
  378. package/types/V2/MoneyManagement/Adjustments.d.ts +110 -0
  379. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +83 -0
  380. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +585 -0
  381. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +331 -0
  382. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +314 -0
  383. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +289 -0
  384. package/types/V2/MoneyManagement/InboundTransfers.d.ts +206 -0
  385. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +144 -0
  386. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +168 -0
  387. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +115 -0
  388. package/types/V2/MoneyManagement/OutboundPayments.d.ts +278 -0
  389. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +242 -0
  390. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +97 -0
  391. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +296 -0
  392. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +251 -0
  393. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +208 -0
  394. package/types/V2/MoneyManagement/PayoutMethods.d.ts +160 -0
  395. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +41 -0
  396. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +87 -0
  397. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +113 -0
  398. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +262 -0
  399. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +78 -0
  400. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +176 -0
  401. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +48 -0
  402. package/types/V2/MoneyManagement/TransactionEntries.d.ts +162 -0
  403. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +82 -0
  404. package/types/V2/MoneyManagement/Transactions.d.ts +177 -0
  405. package/types/V2/MoneyManagement/TransactionsResource.d.ts +83 -0
  406. package/types/V2/Payments/OffSessionPayments.d.ts +179 -0
  407. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +174 -0
  408. package/types/V2/Reporting/ReportRuns.d.ts +178 -0
  409. package/types/V2/Reporting/ReportRunsResource.d.ts +99 -0
  410. package/types/V2/Reporting/Reports.d.ts +120 -0
  411. package/types/V2/Reporting/ReportsResource.d.ts +30 -0
  412. package/types/V2/Tax/AutomaticRules.d.ts +53 -0
  413. package/types/V2/Tax/AutomaticRulesResource.d.ts +102 -0
  414. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +68 -0
  415. package/types/WebhookEndpointsResource.d.ts +78 -0
  416. package/types/Webhooks.d.ts +2 -0
  417. package/types/index.d.ts +265 -0
  418. package/types/lib.d.ts +11 -1
  419. package/types/test/typescriptTest.ts +3 -3
@@ -3,6 +3,11 @@
3
3
  declare module 'stripe' {
4
4
  namespace Stripe {
5
5
  interface QuoteCreateParams {
6
+ /**
7
+ * Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
8
+ */
9
+ allow_backdated_lines?: boolean;
10
+
6
11
  /**
7
12
  * The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
8
13
  */
@@ -28,6 +33,11 @@ declare module 'stripe' {
28
33
  */
29
34
  customer?: string;
30
35
 
36
+ /**
37
+ * The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.
38
+ */
39
+ customer_account?: string;
40
+
31
41
  /**
32
42
  * The tax rates that will apply to any line item that does not have `tax_rates` set.
33
43
  */
@@ -78,6 +88,11 @@ declare module 'stripe' {
78
88
  */
79
89
  line_items?: Array<QuoteCreateParams.LineItem>;
80
90
 
91
+ /**
92
+ * A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
93
+ */
94
+ lines?: Array<QuoteCreateParams.Line>;
95
+
81
96
  /**
82
97
  * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
83
98
  */
@@ -93,6 +108,13 @@ declare module 'stripe' {
93
108
  */
94
109
  subscription_data?: QuoteCreateParams.SubscriptionData;
95
110
 
111
+ /**
112
+ * List representing overrides for `subscription_data` configurations for specific subscription schedules.
113
+ */
114
+ subscription_data_overrides?: Array<
115
+ QuoteCreateParams.SubscriptionDataOverride
116
+ >;
117
+
96
118
  /**
97
119
  * ID of the test clock to attach to the quote.
98
120
  */
@@ -148,12 +170,56 @@ declare module 'stripe' {
148
170
  */
149
171
  discount?: string;
150
172
 
173
+ /**
174
+ * Details to determine how long the discount should be applied for.
175
+ */
176
+ discount_end?: Discount.DiscountEnd;
177
+
151
178
  /**
152
179
  * ID of the promotion code to create a new discount for.
153
180
  */
154
181
  promotion_code?: string;
155
182
  }
156
183
 
184
+ namespace Discount {
185
+ interface DiscountEnd {
186
+ /**
187
+ * Time span for the redeemed discount.
188
+ */
189
+ duration?: DiscountEnd.Duration;
190
+
191
+ /**
192
+ * A precise Unix timestamp for the discount to end. Must be in the future.
193
+ */
194
+ timestamp?: number;
195
+
196
+ /**
197
+ * The type of calculation made to determine when the discount ends.
198
+ */
199
+ type: DiscountEnd.Type;
200
+ }
201
+
202
+ namespace DiscountEnd {
203
+ interface Duration {
204
+ /**
205
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
206
+ */
207
+ interval: Duration.Interval;
208
+
209
+ /**
210
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
211
+ */
212
+ interval_count: number;
213
+ }
214
+
215
+ namespace Duration {
216
+ type Interval = 'day' | 'month' | 'week' | 'year';
217
+ }
218
+
219
+ type Type = 'duration' | 'timestamp';
220
+ }
221
+ }
222
+
157
223
  interface FromQuote {
158
224
  /**
159
225
  * Whether this quote is a revision of the previous quote.
@@ -196,338 +262,2054 @@ declare module 'stripe' {
196
262
  }
197
263
  }
198
264
 
199
- interface LineItem {
265
+ interface Line {
200
266
  /**
201
- * The discounts applied to this line item.
267
+ * An array of operations the quote line performs.
202
268
  */
203
- discounts?: Stripe.Emptyable<Array<LineItem.Discount>>;
269
+ actions?: Array<Line.Action>;
204
270
 
205
271
  /**
206
- * The ID of the price object. One of `price` or `price_data` is required.
272
+ * Details to identify the subscription schedule the quote line applies to.
207
273
  */
208
- price?: string;
274
+ applies_to?: Line.AppliesTo;
209
275
 
210
276
  /**
211
- * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
277
+ * For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
212
278
  */
213
- price_data?: LineItem.PriceData;
279
+ billing_cycle_anchor?: Line.BillingCycleAnchor;
214
280
 
215
281
  /**
216
- * The quantity of the line item.
282
+ * A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
217
283
  */
218
- quantity?: number;
284
+ cancel_subscription_schedule?: Line.CancelSubscriptionSchedule;
219
285
 
220
286
  /**
221
- * The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item.
287
+ * Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
222
288
  */
223
- tax_rates?: Stripe.Emptyable<Array<string>>;
289
+ ends_at?: Line.EndsAt;
290
+
291
+ /**
292
+ * Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
293
+ */
294
+ proration_behavior?: Line.ProrationBehavior;
295
+
296
+ /**
297
+ * Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
298
+ */
299
+ set_pause_collection?: Line.SetPauseCollection;
300
+
301
+ /**
302
+ * Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
303
+ */
304
+ set_schedule_end?: Line.SetScheduleEnd;
305
+
306
+ /**
307
+ * Details to identify the earliest timestamp where the proposed change should take effect.
308
+ */
309
+ starts_at?: Line.StartsAt;
310
+
311
+ /**
312
+ * Settings related to subscription trials.
313
+ */
314
+ trial_settings?: Line.TrialSettings;
224
315
  }
225
316
 
226
- namespace LineItem {
227
- interface Discount {
317
+ namespace Line {
318
+ interface Action {
228
319
  /**
229
- * ID of the coupon to create a new discount for.
320
+ * Details for the `add_discount` type.
230
321
  */
231
- coupon?: string;
322
+ add_discount?: Action.AddDiscount;
232
323
 
233
324
  /**
234
- * ID of an existing discount on the object (or one of its ancestors) to reuse.
325
+ * Details for the `add_item` type.
235
326
  */
236
- discount?: string;
327
+ add_item?: Action.AddItem;
237
328
 
238
329
  /**
239
- * ID of the promotion code to create a new discount for.
330
+ * Details for the `add_metadata` type: specify a hash of key-value pairs.
240
331
  */
241
- promotion_code?: string;
242
- }
332
+ add_metadata?: {
333
+ [key: string]: string;
334
+ };
243
335
 
244
- interface PriceData {
245
336
  /**
246
- * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
337
+ * Details for the `remove_discount` type.
247
338
  */
248
- currency: string;
339
+ remove_discount?: Action.RemoveDiscount;
249
340
 
250
341
  /**
251
- * The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
342
+ * Details for the `remove_item` type.
252
343
  */
253
- product: string;
344
+ remove_item?: Action.RemoveItem;
254
345
 
255
346
  /**
256
- * The recurring components of a price such as `interval` and `interval_count`.
347
+ * Details for the `remove_metadata` type: specify an array of metadata keys.
257
348
  */
258
- recurring?: PriceData.Recurring;
349
+ remove_metadata?: Array<string>;
259
350
 
260
351
  /**
261
- * Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
352
+ * Details for the `set_discounts` type.
262
353
  */
263
- tax_behavior?: PriceData.TaxBehavior;
354
+ set_discounts?: Array<Action.SetDiscount>;
264
355
 
265
356
  /**
266
- * A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
357
+ * Details for the `set_items` type.
267
358
  */
268
- unit_amount?: number;
359
+ set_items?: Array<Action.SetItem>;
269
360
 
270
361
  /**
271
- * Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
362
+ * Details for the `set_metadata` type: specify an array of key-value pairs.
272
363
  */
273
- unit_amount_decimal?: string;
364
+ set_metadata?: Stripe.Emptyable<{
365
+ [key: string]: string;
366
+ }>;
367
+
368
+ /**
369
+ * The type of action the quote line performs.
370
+ */
371
+ type: Action.Type;
274
372
  }
275
373
 
276
- namespace PriceData {
277
- interface Recurring {
374
+ namespace Action {
375
+ interface AddDiscount {
278
376
  /**
279
- * Specifies billing frequency. Either `day`, `week`, `month` or `year`.
377
+ * The coupon code to redeem.
280
378
  */
281
- interval: Recurring.Interval;
379
+ coupon?: string;
282
380
 
283
381
  /**
284
- * The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
382
+ * An ID of an existing discount for a coupon that was already redeemed.
285
383
  */
286
- interval_count?: number;
384
+ discount?: string;
385
+
386
+ /**
387
+ * Details to determine how long the discount should be applied for.
388
+ */
389
+ discount_end?: AddDiscount.DiscountEnd;
390
+
391
+ /**
392
+ * 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.
393
+ */
394
+ index?: number;
395
+
396
+ /**
397
+ * The promotion code to redeem.
398
+ */
399
+ promotion_code?: string;
287
400
  }
288
401
 
289
- namespace Recurring {
290
- type Interval = 'day' | 'month' | 'week' | 'year';
402
+ namespace AddDiscount {
403
+ interface DiscountEnd {
404
+ /**
405
+ * The type of calculation made to determine when the discount ends.
406
+ */
407
+ type: 'line_ends_at';
408
+ }
291
409
  }
292
410
 
293
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
294
- }
295
- }
411
+ interface AddItem {
412
+ /**
413
+ * The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
414
+ */
415
+ discounts?: Array<AddItem.Discount>;
296
416
 
297
- interface SubscriptionData {
298
- /**
299
- * Controls how prorations and invoices for subscriptions are calculated and orchestrated.
300
- */
301
- billing_mode?: SubscriptionData.BillingMode;
417
+ /**
418
+ * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
419
+ */
420
+ metadata?: Stripe.MetadataParam;
302
421
 
303
- /**
304
- * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
305
- */
306
- description?: string;
422
+ /**
423
+ * The ID of the price object.
424
+ */
425
+ price: string;
307
426
 
308
- /**
309
- * When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. The `effective_date` is ignored if it is in the past when the quote is accepted.
310
- */
311
- effective_date?: Stripe.Emptyable<'current_period_end' | number>;
427
+ /**
428
+ * Quantity for this item.
429
+ */
430
+ quantity?: number;
312
431
 
313
- /**
314
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
315
- */
316
- metadata?: Stripe.MetadataParam;
432
+ /**
433
+ * 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`.
434
+ */
435
+ tax_rates?: Array<string>;
317
436
 
318
- /**
319
- * Integer representing the number of trial period days before the customer is charged for the first time.
320
- */
321
- trial_period_days?: Stripe.Emptyable<number>;
322
- }
437
+ /**
438
+ * Options that configure the trial on the subscription item.
439
+ */
440
+ trial?: AddItem.Trial;
441
+ }
323
442
 
324
- namespace SubscriptionData {
325
- interface BillingMode {
326
- /**
327
- * Controls the calculation and orchestration of prorations and invoices for subscriptions.
328
- */
329
- type: BillingMode.Type;
330
- }
443
+ namespace AddItem {
444
+ interface Discount {
445
+ /**
446
+ * ID of the coupon to create a new discount for.
447
+ */
448
+ coupon?: string;
449
+
450
+ /**
451
+ * ID of an existing discount on the object (or one of its ancestors) to reuse.
452
+ */
453
+ discount?: string;
454
+
455
+ /**
456
+ * Details to determine how long the discount should be applied for.
457
+ */
458
+ discount_end?: Discount.DiscountEnd;
459
+
460
+ /**
461
+ * ID of the promotion code to create a new discount for.
462
+ */
463
+ promotion_code?: string;
464
+ }
465
+
466
+ namespace Discount {
467
+ interface DiscountEnd {
468
+ /**
469
+ * Time span for the redeemed discount.
470
+ */
471
+ duration?: DiscountEnd.Duration;
472
+
473
+ /**
474
+ * A precise Unix timestamp for the discount to end. Must be in the future.
475
+ */
476
+ timestamp?: number;
477
+
478
+ /**
479
+ * The type of calculation made to determine when the discount ends.
480
+ */
481
+ type: DiscountEnd.Type;
482
+ }
483
+
484
+ namespace DiscountEnd {
485
+ interface Duration {
486
+ /**
487
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
488
+ */
489
+ interval: Duration.Interval;
490
+
491
+ /**
492
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
493
+ */
494
+ interval_count: number;
495
+ }
496
+
497
+ namespace Duration {
498
+ type Interval = 'day' | 'month' | 'week' | 'year';
499
+ }
500
+
501
+ type Type = 'duration' | 'timestamp';
502
+ }
503
+ }
504
+
505
+ interface Trial {
506
+ /**
507
+ * 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.
508
+ */
509
+ converts_to?: Array<string>;
510
+
511
+ /**
512
+ * Determines the type of trial for this item.
513
+ */
514
+ type: Trial.Type;
515
+ }
516
+
517
+ namespace Trial {
518
+ type Type = 'free' | 'paid';
519
+ }
520
+ }
331
521
 
332
- namespace BillingMode {
333
- type Type = 'classic' | 'flexible';
334
- }
335
- }
522
+ interface RemoveDiscount {
523
+ /**
524
+ * The coupon code to remove from the `discounts` array.
525
+ */
526
+ coupon?: string;
336
527
 
337
- interface TransferData {
338
- /**
339
- * The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
340
- */
341
- amount?: number;
528
+ /**
529
+ * The ID of a discount to remove from the `discounts` array.
530
+ */
531
+ discount?: string;
342
532
 
343
- /**
344
- * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field.
345
- */
346
- amount_percent?: number;
533
+ /**
534
+ * The ID of a promotion code to remove from the `discounts` array.
535
+ */
536
+ promotion_code?: string;
537
+ }
347
538
 
348
- /**
349
- * ID of an existing, connected Stripe account.
350
- */
351
- destination: string;
352
- }
353
- }
539
+ interface RemoveItem {
540
+ /**
541
+ * ID of a price to remove.
542
+ */
543
+ price: string;
544
+ }
354
545
 
355
- interface QuoteRetrieveParams {
356
- /**
357
- * Specifies which fields in the response should be expanded.
358
- */
359
- expand?: Array<string>;
360
- }
546
+ interface SetDiscount {
547
+ /**
548
+ * The coupon code to replace the `discounts` array with.
549
+ */
550
+ coupon?: string;
361
551
 
362
- interface QuoteUpdateParams {
363
- /**
364
- * The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
365
- */
366
- application_fee_amount?: Stripe.Emptyable<number>;
552
+ /**
553
+ * An ID of an existing discount to replace the `discounts` array with.
554
+ */
555
+ discount?: string;
367
556
 
368
- /**
369
- * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.
370
- */
371
- application_fee_percent?: Stripe.Emptyable<number>;
557
+ /**
558
+ * An ID of an existing promotion code to replace the `discounts` array with.
559
+ */
560
+ promotion_code?: string;
561
+ }
372
562
 
373
- /**
374
- * Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.
375
- */
376
- automatic_tax?: QuoteUpdateParams.AutomaticTax;
563
+ interface SetItem {
564
+ /**
565
+ * 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`.
566
+ */
567
+ discounts?: Array<SetItem.Discount>;
377
568
 
378
- /**
379
- * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
380
- */
381
- collection_method?: QuoteUpdateParams.CollectionMethod;
569
+ /**
570
+ * 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`.
571
+ */
572
+ metadata?: Stripe.MetadataParam;
382
573
 
383
- /**
384
- * The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
385
- */
386
- customer?: string;
574
+ /**
575
+ * The ID of the price object.
576
+ */
577
+ price: string;
387
578
 
388
- /**
389
- * The tax rates that will apply to any line item that does not have `tax_rates` set.
390
- */
391
- default_tax_rates?: Stripe.Emptyable<Array<string>>;
579
+ /**
580
+ * 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`.
581
+ */
582
+ quantity?: number;
392
583
 
393
- /**
394
- * A description that will be displayed on the quote PDF.
395
- */
396
- description?: Stripe.Emptyable<string>;
584
+ /**
585
+ * 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`.
586
+ */
587
+ tax_rates?: Array<string>;
397
588
 
398
- /**
399
- * The discounts applied to the quote.
400
- */
401
- discounts?: Stripe.Emptyable<Array<QuoteUpdateParams.Discount>>;
589
+ /**
590
+ * 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`.
591
+ */
592
+ trial?: SetItem.Trial;
593
+ }
402
594
 
403
- /**
404
- * Specifies which fields in the response should be expanded.
405
- */
406
- expand?: Array<string>;
595
+ namespace SetItem {
596
+ interface Discount {
597
+ /**
598
+ * ID of the coupon to create a new discount for.
599
+ */
600
+ coupon?: string;
601
+
602
+ /**
603
+ * ID of an existing discount on the object (or one of its ancestors) to reuse.
604
+ */
605
+ discount?: string;
606
+
607
+ /**
608
+ * Details to determine how long the discount should be applied for.
609
+ */
610
+ discount_end?: Discount.DiscountEnd;
611
+
612
+ /**
613
+ * ID of the promotion code to create a new discount for.
614
+ */
615
+ promotion_code?: string;
616
+ }
617
+
618
+ namespace Discount {
619
+ interface DiscountEnd {
620
+ /**
621
+ * Time span for the redeemed discount.
622
+ */
623
+ duration?: DiscountEnd.Duration;
624
+
625
+ /**
626
+ * A precise Unix timestamp for the discount to end. Must be in the future.
627
+ */
628
+ timestamp?: number;
629
+
630
+ /**
631
+ * The type of calculation made to determine when the discount ends.
632
+ */
633
+ type: DiscountEnd.Type;
634
+ }
635
+
636
+ namespace DiscountEnd {
637
+ interface Duration {
638
+ /**
639
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
640
+ */
641
+ interval: Duration.Interval;
642
+
643
+ /**
644
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
645
+ */
646
+ interval_count: number;
647
+ }
648
+
649
+ namespace Duration {
650
+ type Interval = 'day' | 'month' | 'week' | 'year';
651
+ }
652
+
653
+ type Type = 'duration' | 'timestamp';
654
+ }
655
+ }
656
+
657
+ interface Trial {
658
+ /**
659
+ * 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.
660
+ */
661
+ converts_to?: Array<string>;
662
+
663
+ /**
664
+ * Determines the type of trial for this item.
665
+ */
666
+ type: Trial.Type;
667
+ }
668
+
669
+ namespace Trial {
670
+ type Type = 'free' | 'paid';
671
+ }
672
+ }
407
673
 
408
- /**
409
- * A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
410
- */
411
- expires_at?: number;
674
+ type Type =
675
+ | 'add_discount'
676
+ | 'add_item'
677
+ | 'add_metadata'
678
+ | 'clear_discounts'
679
+ | 'clear_metadata'
680
+ | 'remove_discount'
681
+ | 'remove_item'
682
+ | 'remove_metadata'
683
+ | 'set_discounts'
684
+ | 'set_items'
685
+ | 'set_metadata';
686
+ }
412
687
 
413
- /**
414
- * A footer that will be displayed on the quote PDF.
415
- */
416
- footer?: Stripe.Emptyable<string>;
688
+ interface AppliesTo {
689
+ /**
690
+ * A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
691
+ */
692
+ new_reference?: string;
417
693
 
418
- /**
694
+ /**
695
+ * The ID of the schedule the line applies to.
696
+ */
697
+ subscription_schedule?: string;
698
+
699
+ /**
700
+ * Describes whether the quote line is affecting a new schedule or an existing schedule.
701
+ */
702
+ type: AppliesTo.Type;
703
+ }
704
+
705
+ namespace AppliesTo {
706
+ type Type = 'new_reference' | 'subscription_schedule';
707
+ }
708
+
709
+ type BillingCycleAnchor = 'automatic' | 'line_starts_at';
710
+
711
+ interface CancelSubscriptionSchedule {
712
+ /**
713
+ * Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
714
+ */
715
+ cancel_at: 'line_starts_at';
716
+
717
+ /**
718
+ * If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.
719
+ */
720
+ invoice_now?: boolean;
721
+
722
+ /**
723
+ * If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
724
+ */
725
+ prorate?: boolean;
726
+ }
727
+
728
+ interface EndsAt {
729
+ /**
730
+ * Use the `end` time of a given discount.
731
+ */
732
+ discount_end?: EndsAt.DiscountEnd;
733
+
734
+ /**
735
+ * Time span for the quote line starting from the `starts_at` date.
736
+ */
737
+ duration?: EndsAt.Duration;
738
+
739
+ /**
740
+ * A precise Unix timestamp.
741
+ */
742
+ timestamp?: number;
743
+
744
+ /**
745
+ * Select a way to pass in `ends_at`.
746
+ */
747
+ type: EndsAt.Type;
748
+ }
749
+
750
+ namespace EndsAt {
751
+ interface DiscountEnd {
752
+ /**
753
+ * The ID of a specific discount.
754
+ */
755
+ discount: string;
756
+ }
757
+
758
+ interface Duration {
759
+ /**
760
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
761
+ */
762
+ interval: Duration.Interval;
763
+
764
+ /**
765
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
766
+ */
767
+ interval_count: number;
768
+ }
769
+
770
+ namespace Duration {
771
+ type Interval = 'day' | 'month' | 'week' | 'year';
772
+ }
773
+
774
+ type Type =
775
+ | 'billing_period_end'
776
+ | 'discount_end'
777
+ | 'duration'
778
+ | 'quote_acceptance_date'
779
+ | 'schedule_end'
780
+ | 'timestamp'
781
+ | 'upcoming_invoice';
782
+ }
783
+
784
+ type ProrationBehavior =
785
+ | 'always_invoice'
786
+ | 'create_prorations'
787
+ | 'none';
788
+
789
+ interface SetPauseCollection {
790
+ /**
791
+ * Details of the pause_collection behavior to apply to the amendment.
792
+ */
793
+ set?: SetPauseCollection.Set;
794
+
795
+ /**
796
+ * Determines the type of the pause_collection amendment.
797
+ */
798
+ type: SetPauseCollection.Type;
799
+ }
800
+
801
+ namespace SetPauseCollection {
802
+ interface Set {
803
+ /**
804
+ * The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
805
+ */
806
+ behavior: Set.Behavior;
807
+ }
808
+
809
+ namespace Set {
810
+ type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
811
+ }
812
+
813
+ type Type = 'remove' | 'set';
814
+ }
815
+
816
+ type SetScheduleEnd = 'line_ends_at' | 'line_starts_at';
817
+
818
+ interface StartsAt {
819
+ /**
820
+ * Use the `end` time of a given discount.
821
+ */
822
+ discount_end?: StartsAt.DiscountEnd;
823
+
824
+ /**
825
+ * The timestamp the given line ends at.
826
+ */
827
+ line_ends_at?: StartsAt.LineEndsAt;
828
+
829
+ /**
830
+ * A precise Unix timestamp.
831
+ */
832
+ timestamp?: number;
833
+
834
+ /**
835
+ * Select a way to pass in `starts_at`.
836
+ */
837
+ type: StartsAt.Type;
838
+ }
839
+
840
+ namespace StartsAt {
841
+ interface DiscountEnd {
842
+ /**
843
+ * The ID of a specific discount.
844
+ */
845
+ discount: string;
846
+ }
847
+
848
+ interface LineEndsAt {
849
+ /**
850
+ * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
851
+ */
852
+ index?: number;
853
+ }
854
+
855
+ type Type =
856
+ | 'discount_end'
857
+ | 'line_ends_at'
858
+ | 'now'
859
+ | 'quote_acceptance_date'
860
+ | 'schedule_end'
861
+ | 'timestamp'
862
+ | 'upcoming_invoice';
863
+ }
864
+
865
+ interface TrialSettings {
866
+ /**
867
+ * Defines how the subscription should behave when a trial ends.
868
+ */
869
+ end_behavior?: TrialSettings.EndBehavior;
870
+ }
871
+
872
+ namespace TrialSettings {
873
+ interface EndBehavior {
874
+ /**
875
+ * Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
876
+ */
877
+ prorate_up_front?: EndBehavior.ProrateUpFront;
878
+ }
879
+
880
+ namespace EndBehavior {
881
+ type ProrateUpFront = 'defer' | 'include';
882
+ }
883
+ }
884
+ }
885
+
886
+ interface LineItem {
887
+ /**
888
+ * The discounts applied to this line item.
889
+ */
890
+ discounts?: Stripe.Emptyable<Array<LineItem.Discount>>;
891
+
892
+ /**
893
+ * The ID of the price object. One of `price` or `price_data` is required.
894
+ */
895
+ price?: string;
896
+
897
+ /**
898
+ * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
899
+ */
900
+ price_data?: LineItem.PriceData;
901
+
902
+ /**
903
+ * The quantity of the line item.
904
+ */
905
+ quantity?: number;
906
+
907
+ /**
908
+ * The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item.
909
+ */
910
+ tax_rates?: Stripe.Emptyable<Array<string>>;
911
+ }
912
+
913
+ namespace LineItem {
914
+ interface Discount {
915
+ /**
916
+ * ID of the coupon to create a new discount for.
917
+ */
918
+ coupon?: string;
919
+
920
+ /**
921
+ * ID of an existing discount on the object (or one of its ancestors) to reuse.
922
+ */
923
+ discount?: string;
924
+
925
+ /**
926
+ * Details to determine how long the discount should be applied for.
927
+ */
928
+ discount_end?: Discount.DiscountEnd;
929
+
930
+ /**
931
+ * ID of the promotion code to create a new discount for.
932
+ */
933
+ promotion_code?: string;
934
+ }
935
+
936
+ namespace Discount {
937
+ interface DiscountEnd {
938
+ /**
939
+ * Time span for the redeemed discount.
940
+ */
941
+ duration?: DiscountEnd.Duration;
942
+
943
+ /**
944
+ * A precise Unix timestamp for the discount to end. Must be in the future.
945
+ */
946
+ timestamp?: number;
947
+
948
+ /**
949
+ * The type of calculation made to determine when the discount ends.
950
+ */
951
+ type: DiscountEnd.Type;
952
+ }
953
+
954
+ namespace DiscountEnd {
955
+ interface Duration {
956
+ /**
957
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
958
+ */
959
+ interval: Duration.Interval;
960
+
961
+ /**
962
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
963
+ */
964
+ interval_count: number;
965
+ }
966
+
967
+ namespace Duration {
968
+ type Interval = 'day' | 'month' | 'week' | 'year';
969
+ }
970
+
971
+ type Type = 'duration' | 'timestamp';
972
+ }
973
+ }
974
+
975
+ interface PriceData {
976
+ /**
977
+ * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
978
+ */
979
+ currency: string;
980
+
981
+ /**
982
+ * The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
983
+ */
984
+ product: string;
985
+
986
+ /**
987
+ * The recurring components of a price such as `interval` and `interval_count`.
988
+ */
989
+ recurring?: PriceData.Recurring;
990
+
991
+ /**
992
+ * Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
993
+ */
994
+ tax_behavior?: PriceData.TaxBehavior;
995
+
996
+ /**
997
+ * A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
998
+ */
999
+ unit_amount?: number;
1000
+
1001
+ /**
1002
+ * Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
1003
+ */
1004
+ unit_amount_decimal?: string;
1005
+ }
1006
+
1007
+ namespace PriceData {
1008
+ interface Recurring {
1009
+ /**
1010
+ * Specifies billing frequency. Either `day`, `week`, `month` or `year`.
1011
+ */
1012
+ interval: Recurring.Interval;
1013
+
1014
+ /**
1015
+ * The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
1016
+ */
1017
+ interval_count?: number;
1018
+ }
1019
+
1020
+ namespace Recurring {
1021
+ type Interval = 'day' | 'month' | 'week' | 'year';
1022
+ }
1023
+
1024
+ type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
1025
+ }
1026
+ }
1027
+
1028
+ interface SubscriptionData {
1029
+ /**
1030
+ * Describes the period to bill for upon accepting the quote.
1031
+ */
1032
+ bill_on_acceptance?: SubscriptionData.BillOnAcceptance;
1033
+
1034
+ /**
1035
+ * 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.
1036
+ */
1037
+ billing_behavior?: SubscriptionData.BillingBehavior;
1038
+
1039
+ /**
1040
+ * When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
1041
+ */
1042
+ billing_cycle_anchor?: Stripe.Emptyable<'reset'>;
1043
+
1044
+ /**
1045
+ * Controls how prorations and invoices for subscriptions are calculated and orchestrated.
1046
+ */
1047
+ billing_mode?: SubscriptionData.BillingMode;
1048
+
1049
+ /**
1050
+ * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
1051
+ */
1052
+ description?: string;
1053
+
1054
+ /**
1055
+ * When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
1056
+ */
1057
+ effective_date?: Stripe.Emptyable<'current_period_end' | number>;
1058
+
1059
+ /**
1060
+ * Behavior of the subscription schedule and underlying subscription when it ends.
1061
+ */
1062
+ end_behavior?: SubscriptionData.EndBehavior;
1063
+
1064
+ /**
1065
+ * The id of a subscription that the quote will update. By default, the quote will contain the state of the subscription (such as line items, collection method and billing thresholds) unless overridden.
1066
+ */
1067
+ from_subscription?: string;
1068
+
1069
+ /**
1070
+ * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
1071
+ */
1072
+ metadata?: Stripe.MetadataParam;
1073
+
1074
+ /**
1075
+ * If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
1076
+ */
1077
+ prebilling?: Stripe.Emptyable<SubscriptionData.Prebilling>;
1078
+
1079
+ /**
1080
+ * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
1081
+ *
1082
+ * When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
1083
+ *
1084
+ * Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
1085
+ *
1086
+ * Prorations can be disabled by passing `none`.
1087
+ */
1088
+ proration_behavior?: SubscriptionData.ProrationBehavior;
1089
+
1090
+ /**
1091
+ * Integer representing the number of trial period days before the customer is charged for the first time.
1092
+ */
1093
+ trial_period_days?: Stripe.Emptyable<number>;
1094
+ }
1095
+
1096
+ namespace SubscriptionData {
1097
+ type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
1098
+
1099
+ interface BillingMode {
1100
+ /**
1101
+ * Controls the calculation and orchestration of prorations and invoices for subscriptions.
1102
+ */
1103
+ type: BillingMode.Type;
1104
+ }
1105
+
1106
+ namespace BillingMode {
1107
+ type Type = 'classic' | 'flexible';
1108
+ }
1109
+
1110
+ interface BillOnAcceptance {
1111
+ /**
1112
+ * The start of the period to bill from when the Quote is accepted.
1113
+ */
1114
+ bill_from?: BillOnAcceptance.BillFrom;
1115
+
1116
+ /**
1117
+ * The end of the period to bill until when the Quote is accepted.
1118
+ */
1119
+ bill_until?: BillOnAcceptance.BillUntil;
1120
+ }
1121
+
1122
+ namespace BillOnAcceptance {
1123
+ interface BillFrom {
1124
+ /**
1125
+ * Details of a Quote line to start the bill period from.
1126
+ */
1127
+ line_starts_at?: BillFrom.LineStartsAt;
1128
+
1129
+ /**
1130
+ * A precise Unix timestamp.
1131
+ */
1132
+ timestamp?: number;
1133
+
1134
+ /**
1135
+ * The type of method to specify the `bill_from` time.
1136
+ */
1137
+ type: BillFrom.Type;
1138
+ }
1139
+
1140
+ namespace BillFrom {
1141
+ interface LineStartsAt {
1142
+ /**
1143
+ * The ID of a quote line.
1144
+ */
1145
+ id?: string;
1146
+
1147
+ /**
1148
+ * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
1149
+ */
1150
+ index?: number;
1151
+ }
1152
+
1153
+ type Type =
1154
+ | 'line_starts_at'
1155
+ | 'now'
1156
+ | 'pause_collection_start'
1157
+ | 'quote_acceptance_date'
1158
+ | 'timestamp';
1159
+ }
1160
+
1161
+ interface BillUntil {
1162
+ /**
1163
+ * Details of the duration over which to bill.
1164
+ */
1165
+ duration?: BillUntil.Duration;
1166
+
1167
+ /**
1168
+ * Details of a Quote line item from which to bill until.
1169
+ */
1170
+ line_ends_at?: BillUntil.LineEndsAt;
1171
+
1172
+ /**
1173
+ * A precise Unix timestamp.
1174
+ */
1175
+ timestamp?: number;
1176
+
1177
+ /**
1178
+ * The type of method to specify the `bill_until` time.
1179
+ */
1180
+ type: BillUntil.Type;
1181
+ }
1182
+
1183
+ namespace BillUntil {
1184
+ interface Duration {
1185
+ /**
1186
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1187
+ */
1188
+ interval: Duration.Interval;
1189
+
1190
+ /**
1191
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1192
+ */
1193
+ interval_count: number;
1194
+ }
1195
+
1196
+ namespace Duration {
1197
+ type Interval = 'day' | 'month' | 'week' | 'year';
1198
+ }
1199
+
1200
+ interface LineEndsAt {
1201
+ /**
1202
+ * The ID of a quote line.
1203
+ */
1204
+ id?: string;
1205
+
1206
+ /**
1207
+ * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
1208
+ */
1209
+ index?: number;
1210
+ }
1211
+
1212
+ type Type =
1213
+ | 'duration'
1214
+ | 'line_ends_at'
1215
+ | 'schedule_end'
1216
+ | 'timestamp'
1217
+ | 'upcoming_invoice';
1218
+ }
1219
+ }
1220
+
1221
+ type EndBehavior = 'cancel' | 'release';
1222
+
1223
+ interface Prebilling {
1224
+ /**
1225
+ * This is used to determine the number of billing cycles to prebill.
1226
+ */
1227
+ iterations: number;
1228
+ }
1229
+
1230
+ type ProrationBehavior =
1231
+ | 'always_invoice'
1232
+ | 'create_prorations'
1233
+ | 'none';
1234
+ }
1235
+
1236
+ interface SubscriptionDataOverride {
1237
+ /**
1238
+ * Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
1239
+ */
1240
+ applies_to: SubscriptionDataOverride.AppliesTo;
1241
+
1242
+ /**
1243
+ * Describes the period to bill for upon accepting the quote.
1244
+ */
1245
+ bill_on_acceptance?: SubscriptionDataOverride.BillOnAcceptance;
1246
+
1247
+ /**
1248
+ * 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.
1249
+ */
1250
+ billing_behavior?: SubscriptionDataOverride.BillingBehavior;
1251
+
1252
+ /**
1253
+ * The customer the Subscription Data override applies to. This is only relevant when `applies_to.type=new_reference`.
1254
+ */
1255
+ customer?: string;
1256
+
1257
+ /**
1258
+ * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
1259
+ */
1260
+ description?: string;
1261
+
1262
+ /**
1263
+ * Behavior of the subscription schedule and underlying subscription when it ends.
1264
+ */
1265
+ end_behavior?: SubscriptionDataOverride.EndBehavior;
1266
+
1267
+ /**
1268
+ * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
1269
+ *
1270
+ * When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
1271
+ *
1272
+ * Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
1273
+ *
1274
+ * Prorations can be disabled by passing `none`.
1275
+ */
1276
+ proration_behavior?: SubscriptionDataOverride.ProrationBehavior;
1277
+ }
1278
+
1279
+ namespace SubscriptionDataOverride {
1280
+ interface AppliesTo {
1281
+ /**
1282
+ * A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
1283
+ */
1284
+ new_reference?: string;
1285
+
1286
+ /**
1287
+ * The ID of the schedule the line applies to.
1288
+ */
1289
+ subscription_schedule?: string;
1290
+
1291
+ /**
1292
+ * Describes whether the quote line is affecting a new schedule or an existing schedule.
1293
+ */
1294
+ type: AppliesTo.Type;
1295
+ }
1296
+
1297
+ namespace AppliesTo {
1298
+ type Type = 'new_reference' | 'subscription_schedule';
1299
+ }
1300
+
1301
+ type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
1302
+
1303
+ interface BillOnAcceptance {
1304
+ /**
1305
+ * The start of the period to bill from when the Quote is accepted.
1306
+ */
1307
+ bill_from?: BillOnAcceptance.BillFrom;
1308
+
1309
+ /**
1310
+ * The end of the period to bill until when the Quote is accepted.
1311
+ */
1312
+ bill_until?: BillOnAcceptance.BillUntil;
1313
+ }
1314
+
1315
+ namespace BillOnAcceptance {
1316
+ interface BillFrom {
1317
+ /**
1318
+ * Details of a Quote line to start the bill period from.
1319
+ */
1320
+ line_starts_at?: BillFrom.LineStartsAt;
1321
+
1322
+ /**
1323
+ * A precise Unix timestamp.
1324
+ */
1325
+ timestamp?: number;
1326
+
1327
+ /**
1328
+ * The type of method to specify the `bill_from` time.
1329
+ */
1330
+ type: BillFrom.Type;
1331
+ }
1332
+
1333
+ namespace BillFrom {
1334
+ interface LineStartsAt {
1335
+ /**
1336
+ * The ID of a quote line.
1337
+ */
1338
+ id?: string;
1339
+
1340
+ /**
1341
+ * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
1342
+ */
1343
+ index?: number;
1344
+ }
1345
+
1346
+ type Type =
1347
+ | 'line_starts_at'
1348
+ | 'now'
1349
+ | 'pause_collection_start'
1350
+ | 'quote_acceptance_date'
1351
+ | 'timestamp';
1352
+ }
1353
+
1354
+ interface BillUntil {
1355
+ /**
1356
+ * Details of the duration over which to bill.
1357
+ */
1358
+ duration?: BillUntil.Duration;
1359
+
1360
+ /**
1361
+ * Details of a Quote line item from which to bill until.
1362
+ */
1363
+ line_ends_at?: BillUntil.LineEndsAt;
1364
+
1365
+ /**
1366
+ * A precise Unix timestamp.
1367
+ */
1368
+ timestamp?: number;
1369
+
1370
+ /**
1371
+ * The type of method to specify the `bill_until` time.
1372
+ */
1373
+ type: BillUntil.Type;
1374
+ }
1375
+
1376
+ namespace BillUntil {
1377
+ interface Duration {
1378
+ /**
1379
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1380
+ */
1381
+ interval: Duration.Interval;
1382
+
1383
+ /**
1384
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1385
+ */
1386
+ interval_count: number;
1387
+ }
1388
+
1389
+ namespace Duration {
1390
+ type Interval = 'day' | 'month' | 'week' | 'year';
1391
+ }
1392
+
1393
+ interface LineEndsAt {
1394
+ /**
1395
+ * The ID of a quote line.
1396
+ */
1397
+ id?: string;
1398
+
1399
+ /**
1400
+ * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
1401
+ */
1402
+ index?: number;
1403
+ }
1404
+
1405
+ type Type =
1406
+ | 'duration'
1407
+ | 'line_ends_at'
1408
+ | 'schedule_end'
1409
+ | 'timestamp'
1410
+ | 'upcoming_invoice';
1411
+ }
1412
+ }
1413
+
1414
+ type EndBehavior = 'cancel' | 'release';
1415
+
1416
+ type ProrationBehavior =
1417
+ | 'always_invoice'
1418
+ | 'create_prorations'
1419
+ | 'none';
1420
+ }
1421
+
1422
+ interface TransferData {
1423
+ /**
1424
+ * The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
1425
+ */
1426
+ amount?: number;
1427
+
1428
+ /**
1429
+ * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field.
1430
+ */
1431
+ amount_percent?: number;
1432
+
1433
+ /**
1434
+ * ID of an existing, connected Stripe account.
1435
+ */
1436
+ destination: string;
1437
+ }
1438
+ }
1439
+
1440
+ interface QuoteRetrieveParams {
1441
+ /**
1442
+ * Specifies which fields in the response should be expanded.
1443
+ */
1444
+ expand?: Array<string>;
1445
+ }
1446
+
1447
+ interface QuoteUpdateParams {
1448
+ /**
1449
+ * Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
1450
+ */
1451
+ allow_backdated_lines?: boolean;
1452
+
1453
+ /**
1454
+ * The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
1455
+ */
1456
+ application_fee_amount?: Stripe.Emptyable<number>;
1457
+
1458
+ /**
1459
+ * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.
1460
+ */
1461
+ application_fee_percent?: Stripe.Emptyable<number>;
1462
+
1463
+ /**
1464
+ * Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.
1465
+ */
1466
+ automatic_tax?: QuoteUpdateParams.AutomaticTax;
1467
+
1468
+ /**
1469
+ * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
1470
+ */
1471
+ collection_method?: QuoteUpdateParams.CollectionMethod;
1472
+
1473
+ /**
1474
+ * The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
1475
+ */
1476
+ customer?: string;
1477
+
1478
+ /**
1479
+ * The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.
1480
+ */
1481
+ customer_account?: string;
1482
+
1483
+ /**
1484
+ * The tax rates that will apply to any line item that does not have `tax_rates` set.
1485
+ */
1486
+ default_tax_rates?: Stripe.Emptyable<Array<string>>;
1487
+
1488
+ /**
1489
+ * A description that will be displayed on the quote PDF.
1490
+ */
1491
+ description?: Stripe.Emptyable<string>;
1492
+
1493
+ /**
1494
+ * The discounts applied to the quote.
1495
+ */
1496
+ discounts?: Stripe.Emptyable<Array<QuoteUpdateParams.Discount>>;
1497
+
1498
+ /**
1499
+ * Specifies which fields in the response should be expanded.
1500
+ */
1501
+ expand?: Array<string>;
1502
+
1503
+ /**
1504
+ * A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
1505
+ */
1506
+ expires_at?: number;
1507
+
1508
+ /**
1509
+ * A footer that will be displayed on the quote PDF.
1510
+ */
1511
+ footer?: Stripe.Emptyable<string>;
1512
+
1513
+ /**
419
1514
  * A header that will be displayed on the quote PDF.
420
1515
  */
421
1516
  header?: Stripe.Emptyable<string>;
422
1517
 
423
- /**
424
- * All invoices will be billed using the specified settings.
425
- */
426
- invoice_settings?: QuoteUpdateParams.InvoiceSettings;
1518
+ /**
1519
+ * All invoices will be billed using the specified settings.
1520
+ */
1521
+ invoice_settings?: QuoteUpdateParams.InvoiceSettings;
1522
+
1523
+ /**
1524
+ * A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
1525
+ */
1526
+ line_items?: Array<QuoteUpdateParams.LineItem>;
1527
+
1528
+ /**
1529
+ * A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
1530
+ */
1531
+ lines?: Array<QuoteUpdateParams.Line>;
1532
+
1533
+ /**
1534
+ * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1535
+ */
1536
+ metadata?: Stripe.MetadataParam;
1537
+
1538
+ /**
1539
+ * The account on behalf of which to charge.
1540
+ */
1541
+ on_behalf_of?: Stripe.Emptyable<string>;
1542
+
1543
+ /**
1544
+ * When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.
1545
+ */
1546
+ subscription_data?: QuoteUpdateParams.SubscriptionData;
1547
+
1548
+ /**
1549
+ * List representing overrides for `subscription_data` configurations for specific subscription schedules.
1550
+ */
1551
+ subscription_data_overrides?: Stripe.Emptyable<
1552
+ Array<QuoteUpdateParams.SubscriptionDataOverride>
1553
+ >;
1554
+
1555
+ /**
1556
+ * The data with which to automatically create a Transfer for each of the invoices.
1557
+ */
1558
+ transfer_data?: Stripe.Emptyable<QuoteUpdateParams.TransferData>;
1559
+ }
1560
+
1561
+ namespace QuoteUpdateParams {
1562
+ interface AutomaticTax {
1563
+ /**
1564
+ * Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.
1565
+ */
1566
+ enabled: boolean;
1567
+
1568
+ /**
1569
+ * The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
1570
+ */
1571
+ liability?: AutomaticTax.Liability;
1572
+ }
1573
+
1574
+ namespace AutomaticTax {
1575
+ interface Liability {
1576
+ /**
1577
+ * The connected account being referenced when `type` is `account`.
1578
+ */
1579
+ account?: string;
1580
+
1581
+ /**
1582
+ * Type of the account referenced in the request.
1583
+ */
1584
+ type: Liability.Type;
1585
+ }
1586
+
1587
+ namespace Liability {
1588
+ type Type = 'account' | 'self';
1589
+ }
1590
+ }
1591
+
1592
+ type CollectionMethod = 'charge_automatically' | 'send_invoice';
1593
+
1594
+ interface Discount {
1595
+ /**
1596
+ * ID of the coupon to create a new discount for.
1597
+ */
1598
+ coupon?: string;
1599
+
1600
+ /**
1601
+ * ID of an existing discount on the object (or one of its ancestors) to reuse.
1602
+ */
1603
+ discount?: string;
1604
+
1605
+ /**
1606
+ * Details to determine how long the discount should be applied for.
1607
+ */
1608
+ discount_end?: Discount.DiscountEnd;
1609
+
1610
+ /**
1611
+ * ID of the promotion code to create a new discount for.
1612
+ */
1613
+ promotion_code?: string;
1614
+ }
1615
+
1616
+ namespace Discount {
1617
+ interface DiscountEnd {
1618
+ /**
1619
+ * Time span for the redeemed discount.
1620
+ */
1621
+ duration?: DiscountEnd.Duration;
1622
+
1623
+ /**
1624
+ * A precise Unix timestamp for the discount to end. Must be in the future.
1625
+ */
1626
+ timestamp?: number;
1627
+
1628
+ /**
1629
+ * The type of calculation made to determine when the discount ends.
1630
+ */
1631
+ type: DiscountEnd.Type;
1632
+ }
1633
+
1634
+ namespace DiscountEnd {
1635
+ interface Duration {
1636
+ /**
1637
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1638
+ */
1639
+ interval: Duration.Interval;
1640
+
1641
+ /**
1642
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1643
+ */
1644
+ interval_count: number;
1645
+ }
1646
+
1647
+ namespace Duration {
1648
+ type Interval = 'day' | 'month' | 'week' | 'year';
1649
+ }
1650
+
1651
+ type Type = 'duration' | 'timestamp';
1652
+ }
1653
+ }
1654
+
1655
+ interface InvoiceSettings {
1656
+ /**
1657
+ * Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
1658
+ */
1659
+ days_until_due?: number;
1660
+
1661
+ /**
1662
+ * The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1663
+ */
1664
+ issuer?: InvoiceSettings.Issuer;
1665
+ }
1666
+
1667
+ namespace InvoiceSettings {
1668
+ interface Issuer {
1669
+ /**
1670
+ * The connected account being referenced when `type` is `account`.
1671
+ */
1672
+ account?: string;
1673
+
1674
+ /**
1675
+ * Type of the account referenced in the request.
1676
+ */
1677
+ type: Issuer.Type;
1678
+ }
1679
+
1680
+ namespace Issuer {
1681
+ type Type = 'account' | 'self';
1682
+ }
1683
+ }
1684
+
1685
+ interface Line {
1686
+ /**
1687
+ * An array of operations the quote line performs.
1688
+ */
1689
+ actions?: Array<Line.Action>;
1690
+
1691
+ /**
1692
+ * Details to identify the subscription schedule the quote line applies to.
1693
+ */
1694
+ applies_to?: Line.AppliesTo;
1695
+
1696
+ /**
1697
+ * For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
1698
+ */
1699
+ billing_cycle_anchor?: Line.BillingCycleAnchor;
1700
+
1701
+ /**
1702
+ * A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
1703
+ */
1704
+ cancel_subscription_schedule?: Line.CancelSubscriptionSchedule;
1705
+
1706
+ /**
1707
+ * Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
1708
+ */
1709
+ ends_at?: Line.EndsAt;
1710
+
1711
+ /**
1712
+ * The ID of an existing line on the quote.
1713
+ */
1714
+ id?: string;
1715
+
1716
+ /**
1717
+ * Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
1718
+ */
1719
+ proration_behavior?: Line.ProrationBehavior;
1720
+
1721
+ /**
1722
+ * Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
1723
+ */
1724
+ set_pause_collection?: Line.SetPauseCollection;
1725
+
1726
+ /**
1727
+ * Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
1728
+ */
1729
+ set_schedule_end?: Line.SetScheduleEnd;
1730
+
1731
+ /**
1732
+ * Details to identify the earliest timestamp where the proposed change should take effect.
1733
+ */
1734
+ starts_at?: Line.StartsAt;
1735
+
1736
+ /**
1737
+ * Settings related to subscription trials.
1738
+ */
1739
+ trial_settings?: Line.TrialSettings;
1740
+ }
1741
+
1742
+ namespace Line {
1743
+ interface Action {
1744
+ /**
1745
+ * Details for the `add_discount` type.
1746
+ */
1747
+ add_discount?: Action.AddDiscount;
1748
+
1749
+ /**
1750
+ * Details for the `add_item` type.
1751
+ */
1752
+ add_item?: Action.AddItem;
1753
+
1754
+ /**
1755
+ * Details for the `add_metadata` type: specify a hash of key-value pairs.
1756
+ */
1757
+ add_metadata?: {
1758
+ [key: string]: string;
1759
+ };
1760
+
1761
+ /**
1762
+ * Details for the `remove_discount` type.
1763
+ */
1764
+ remove_discount?: Action.RemoveDiscount;
1765
+
1766
+ /**
1767
+ * Details for the `remove_item` type.
1768
+ */
1769
+ remove_item?: Action.RemoveItem;
1770
+
1771
+ /**
1772
+ * Details for the `remove_metadata` type: specify an array of metadata keys.
1773
+ */
1774
+ remove_metadata?: Array<string>;
1775
+
1776
+ /**
1777
+ * Details for the `set_discounts` type.
1778
+ */
1779
+ set_discounts?: Array<Action.SetDiscount>;
1780
+
1781
+ /**
1782
+ * Details for the `set_items` type.
1783
+ */
1784
+ set_items?: Array<Action.SetItem>;
1785
+
1786
+ /**
1787
+ * Details for the `set_metadata` type: specify an array of key-value pairs.
1788
+ */
1789
+ set_metadata?: Stripe.Emptyable<{
1790
+ [key: string]: string;
1791
+ }>;
1792
+
1793
+ /**
1794
+ * The type of action the quote line performs.
1795
+ */
1796
+ type: Action.Type;
1797
+ }
1798
+
1799
+ namespace Action {
1800
+ interface AddDiscount {
1801
+ /**
1802
+ * The coupon code to redeem.
1803
+ */
1804
+ coupon?: string;
1805
+
1806
+ /**
1807
+ * An ID of an existing discount for a coupon that was already redeemed.
1808
+ */
1809
+ discount?: string;
1810
+
1811
+ /**
1812
+ * Details to determine how long the discount should be applied for.
1813
+ */
1814
+ discount_end?: AddDiscount.DiscountEnd;
427
1815
 
428
- /**
429
- * A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
430
- */
431
- line_items?: Array<QuoteUpdateParams.LineItem>;
1816
+ /**
1817
+ * 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.
1818
+ */
1819
+ index?: number;
432
1820
 
433
- /**
434
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
435
- */
436
- metadata?: Stripe.MetadataParam;
1821
+ /**
1822
+ * The promotion code to redeem.
1823
+ */
1824
+ promotion_code?: string;
1825
+ }
437
1826
 
438
- /**
439
- * The account on behalf of which to charge.
440
- */
441
- on_behalf_of?: Stripe.Emptyable<string>;
1827
+ namespace AddDiscount {
1828
+ interface DiscountEnd {
1829
+ /**
1830
+ * The type of calculation made to determine when the discount ends.
1831
+ */
1832
+ type: 'line_ends_at';
1833
+ }
1834
+ }
442
1835
 
443
- /**
444
- * When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.
445
- */
446
- subscription_data?: QuoteUpdateParams.SubscriptionData;
1836
+ interface AddItem {
1837
+ /**
1838
+ * The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
1839
+ */
1840
+ discounts?: Array<AddItem.Discount>;
447
1841
 
448
- /**
449
- * The data with which to automatically create a Transfer for each of the invoices.
450
- */
451
- transfer_data?: Stripe.Emptyable<QuoteUpdateParams.TransferData>;
452
- }
1842
+ /**
1843
+ * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1844
+ */
1845
+ metadata?: Stripe.MetadataParam;
453
1846
 
454
- namespace QuoteUpdateParams {
455
- interface AutomaticTax {
456
- /**
457
- * Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.
458
- */
459
- enabled: boolean;
1847
+ /**
1848
+ * The ID of the price object.
1849
+ */
1850
+ price: string;
460
1851
 
461
- /**
462
- * The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
463
- */
464
- liability?: AutomaticTax.Liability;
465
- }
1852
+ /**
1853
+ * Quantity for this item.
1854
+ */
1855
+ quantity?: number;
466
1856
 
467
- namespace AutomaticTax {
468
- interface Liability {
1857
+ /**
1858
+ * 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`.
1859
+ */
1860
+ tax_rates?: Array<string>;
1861
+
1862
+ /**
1863
+ * Options that configure the trial on the subscription item.
1864
+ */
1865
+ trial?: AddItem.Trial;
1866
+ }
1867
+
1868
+ namespace AddItem {
1869
+ interface Discount {
1870
+ /**
1871
+ * ID of the coupon to create a new discount for.
1872
+ */
1873
+ coupon?: string;
1874
+
1875
+ /**
1876
+ * ID of an existing discount on the object (or one of its ancestors) to reuse.
1877
+ */
1878
+ discount?: string;
1879
+
1880
+ /**
1881
+ * Details to determine how long the discount should be applied for.
1882
+ */
1883
+ discount_end?: Discount.DiscountEnd;
1884
+
1885
+ /**
1886
+ * ID of the promotion code to create a new discount for.
1887
+ */
1888
+ promotion_code?: string;
1889
+ }
1890
+
1891
+ namespace Discount {
1892
+ interface DiscountEnd {
1893
+ /**
1894
+ * Time span for the redeemed discount.
1895
+ */
1896
+ duration?: DiscountEnd.Duration;
1897
+
1898
+ /**
1899
+ * A precise Unix timestamp for the discount to end. Must be in the future.
1900
+ */
1901
+ timestamp?: number;
1902
+
1903
+ /**
1904
+ * The type of calculation made to determine when the discount ends.
1905
+ */
1906
+ type: DiscountEnd.Type;
1907
+ }
1908
+
1909
+ namespace DiscountEnd {
1910
+ interface Duration {
1911
+ /**
1912
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1913
+ */
1914
+ interval: Duration.Interval;
1915
+
1916
+ /**
1917
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1918
+ */
1919
+ interval_count: number;
1920
+ }
1921
+
1922
+ namespace Duration {
1923
+ type Interval = 'day' | 'month' | 'week' | 'year';
1924
+ }
1925
+
1926
+ type Type = 'duration' | 'timestamp';
1927
+ }
1928
+ }
1929
+
1930
+ interface Trial {
1931
+ /**
1932
+ * 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.
1933
+ */
1934
+ converts_to?: Array<string>;
1935
+
1936
+ /**
1937
+ * Determines the type of trial for this item.
1938
+ */
1939
+ type: Trial.Type;
1940
+ }
1941
+
1942
+ namespace Trial {
1943
+ type Type = 'free' | 'paid';
1944
+ }
1945
+ }
1946
+
1947
+ interface RemoveDiscount {
1948
+ /**
1949
+ * The coupon code to remove from the `discounts` array.
1950
+ */
1951
+ coupon?: string;
1952
+
1953
+ /**
1954
+ * The ID of a discount to remove from the `discounts` array.
1955
+ */
1956
+ discount?: string;
1957
+
1958
+ /**
1959
+ * The ID of a promotion code to remove from the `discounts` array.
1960
+ */
1961
+ promotion_code?: string;
1962
+ }
1963
+
1964
+ interface RemoveItem {
1965
+ /**
1966
+ * ID of a price to remove.
1967
+ */
1968
+ price: string;
1969
+ }
1970
+
1971
+ interface SetDiscount {
1972
+ /**
1973
+ * The coupon code to replace the `discounts` array with.
1974
+ */
1975
+ coupon?: string;
1976
+
1977
+ /**
1978
+ * An ID of an existing discount to replace the `discounts` array with.
1979
+ */
1980
+ discount?: string;
1981
+
1982
+ /**
1983
+ * An ID of an existing promotion code to replace the `discounts` array with.
1984
+ */
1985
+ promotion_code?: string;
1986
+ }
1987
+
1988
+ interface SetItem {
1989
+ /**
1990
+ * 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`.
1991
+ */
1992
+ discounts?: Array<SetItem.Discount>;
1993
+
1994
+ /**
1995
+ * 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`.
1996
+ */
1997
+ metadata?: Stripe.MetadataParam;
1998
+
1999
+ /**
2000
+ * The ID of the price object.
2001
+ */
2002
+ price: string;
2003
+
2004
+ /**
2005
+ * 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`.
2006
+ */
2007
+ quantity?: number;
2008
+
2009
+ /**
2010
+ * 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`.
2011
+ */
2012
+ tax_rates?: Array<string>;
2013
+
2014
+ /**
2015
+ * 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`.
2016
+ */
2017
+ trial?: SetItem.Trial;
2018
+ }
2019
+
2020
+ namespace SetItem {
2021
+ interface Discount {
2022
+ /**
2023
+ * ID of the coupon to create a new discount for.
2024
+ */
2025
+ coupon?: string;
2026
+
2027
+ /**
2028
+ * ID of an existing discount on the object (or one of its ancestors) to reuse.
2029
+ */
2030
+ discount?: string;
2031
+
2032
+ /**
2033
+ * Details to determine how long the discount should be applied for.
2034
+ */
2035
+ discount_end?: Discount.DiscountEnd;
2036
+
2037
+ /**
2038
+ * ID of the promotion code to create a new discount for.
2039
+ */
2040
+ promotion_code?: string;
2041
+ }
2042
+
2043
+ namespace Discount {
2044
+ interface DiscountEnd {
2045
+ /**
2046
+ * Time span for the redeemed discount.
2047
+ */
2048
+ duration?: DiscountEnd.Duration;
2049
+
2050
+ /**
2051
+ * A precise Unix timestamp for the discount to end. Must be in the future.
2052
+ */
2053
+ timestamp?: number;
2054
+
2055
+ /**
2056
+ * The type of calculation made to determine when the discount ends.
2057
+ */
2058
+ type: DiscountEnd.Type;
2059
+ }
2060
+
2061
+ namespace DiscountEnd {
2062
+ interface Duration {
2063
+ /**
2064
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2065
+ */
2066
+ interval: Duration.Interval;
2067
+
2068
+ /**
2069
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2070
+ */
2071
+ interval_count: number;
2072
+ }
2073
+
2074
+ namespace Duration {
2075
+ type Interval = 'day' | 'month' | 'week' | 'year';
2076
+ }
2077
+
2078
+ type Type = 'duration' | 'timestamp';
2079
+ }
2080
+ }
2081
+
2082
+ interface Trial {
2083
+ /**
2084
+ * 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.
2085
+ */
2086
+ converts_to?: Array<string>;
2087
+
2088
+ /**
2089
+ * Determines the type of trial for this item.
2090
+ */
2091
+ type: Trial.Type;
2092
+ }
2093
+
2094
+ namespace Trial {
2095
+ type Type = 'free' | 'paid';
2096
+ }
2097
+ }
2098
+
2099
+ type Type =
2100
+ | 'add_discount'
2101
+ | 'add_item'
2102
+ | 'add_metadata'
2103
+ | 'clear_discounts'
2104
+ | 'clear_metadata'
2105
+ | 'remove_discount'
2106
+ | 'remove_item'
2107
+ | 'remove_metadata'
2108
+ | 'set_discounts'
2109
+ | 'set_items'
2110
+ | 'set_metadata';
2111
+ }
2112
+
2113
+ interface AppliesTo {
469
2114
  /**
470
- * The connected account being referenced when `type` is `account`.
2115
+ * A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
471
2116
  */
472
- account?: string;
2117
+ new_reference?: string;
473
2118
 
474
2119
  /**
475
- * Type of the account referenced in the request.
2120
+ * The ID of the schedule the line applies to.
476
2121
  */
477
- type: Liability.Type;
2122
+ subscription_schedule?: string;
2123
+
2124
+ /**
2125
+ * Describes whether the quote line is affecting a new schedule or an existing schedule.
2126
+ */
2127
+ type: AppliesTo.Type;
478
2128
  }
479
2129
 
480
- namespace Liability {
481
- type Type = 'account' | 'self';
2130
+ namespace AppliesTo {
2131
+ type Type = 'new_reference' | 'subscription_schedule';
482
2132
  }
483
- }
484
2133
 
485
- type CollectionMethod = 'charge_automatically' | 'send_invoice';
2134
+ type BillingCycleAnchor = 'automatic' | 'line_starts_at';
486
2135
 
487
- interface Discount {
488
- /**
489
- * ID of the coupon to create a new discount for.
490
- */
491
- coupon?: string;
2136
+ interface CancelSubscriptionSchedule {
2137
+ /**
2138
+ * Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
2139
+ */
2140
+ cancel_at: 'line_starts_at';
492
2141
 
493
- /**
494
- * ID of an existing discount on the object (or one of its ancestors) to reuse.
495
- */
496
- discount?: string;
2142
+ /**
2143
+ * If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.
2144
+ */
2145
+ invoice_now?: boolean;
497
2146
 
498
- /**
499
- * ID of the promotion code to create a new discount for.
500
- */
501
- promotion_code?: string;
502
- }
2147
+ /**
2148
+ * If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
2149
+ */
2150
+ prorate?: boolean;
2151
+ }
503
2152
 
504
- interface InvoiceSettings {
505
- /**
506
- * Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
507
- */
508
- days_until_due?: number;
2153
+ interface EndsAt {
2154
+ /**
2155
+ * Use the `end` time of a given discount.
2156
+ */
2157
+ discount_end?: EndsAt.DiscountEnd;
509
2158
 
510
- /**
511
- * The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
512
- */
513
- issuer?: InvoiceSettings.Issuer;
514
- }
2159
+ /**
2160
+ * Time span for the quote line starting from the `starts_at` date.
2161
+ */
2162
+ duration?: EndsAt.Duration;
515
2163
 
516
- namespace InvoiceSettings {
517
- interface Issuer {
518
2164
  /**
519
- * The connected account being referenced when `type` is `account`.
2165
+ * A precise Unix timestamp.
520
2166
  */
521
- account?: string;
2167
+ timestamp?: number;
522
2168
 
523
2169
  /**
524
- * Type of the account referenced in the request.
2170
+ * Select a way to pass in `ends_at`.
525
2171
  */
526
- type: Issuer.Type;
2172
+ type: EndsAt.Type;
527
2173
  }
528
2174
 
529
- namespace Issuer {
530
- type Type = 'account' | 'self';
2175
+ namespace EndsAt {
2176
+ interface DiscountEnd {
2177
+ /**
2178
+ * The ID of a specific discount.
2179
+ */
2180
+ discount: string;
2181
+ }
2182
+
2183
+ interface Duration {
2184
+ /**
2185
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2186
+ */
2187
+ interval: Duration.Interval;
2188
+
2189
+ /**
2190
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2191
+ */
2192
+ interval_count: number;
2193
+ }
2194
+
2195
+ namespace Duration {
2196
+ type Interval = 'day' | 'month' | 'week' | 'year';
2197
+ }
2198
+
2199
+ type Type =
2200
+ | 'billing_period_end'
2201
+ | 'discount_end'
2202
+ | 'duration'
2203
+ | 'quote_acceptance_date'
2204
+ | 'schedule_end'
2205
+ | 'timestamp'
2206
+ | 'upcoming_invoice';
2207
+ }
2208
+
2209
+ type ProrationBehavior =
2210
+ | 'always_invoice'
2211
+ | 'create_prorations'
2212
+ | 'none';
2213
+
2214
+ interface SetPauseCollection {
2215
+ /**
2216
+ * Details of the pause_collection behavior to apply to the amendment.
2217
+ */
2218
+ set?: SetPauseCollection.Set;
2219
+
2220
+ /**
2221
+ * Determines the type of the pause_collection amendment.
2222
+ */
2223
+ type: SetPauseCollection.Type;
2224
+ }
2225
+
2226
+ namespace SetPauseCollection {
2227
+ interface Set {
2228
+ /**
2229
+ * The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
2230
+ */
2231
+ behavior: Set.Behavior;
2232
+ }
2233
+
2234
+ namespace Set {
2235
+ type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
2236
+ }
2237
+
2238
+ type Type = 'remove' | 'set';
2239
+ }
2240
+
2241
+ type SetScheduleEnd = 'line_ends_at' | 'line_starts_at';
2242
+
2243
+ interface StartsAt {
2244
+ /**
2245
+ * Use the `end` time of a given discount.
2246
+ */
2247
+ discount_end?: StartsAt.DiscountEnd;
2248
+
2249
+ /**
2250
+ * The timestamp the given line ends at.
2251
+ */
2252
+ line_ends_at?: StartsAt.LineEndsAt;
2253
+
2254
+ /**
2255
+ * A precise Unix timestamp.
2256
+ */
2257
+ timestamp?: number;
2258
+
2259
+ /**
2260
+ * Select a way to pass in `starts_at`.
2261
+ */
2262
+ type: StartsAt.Type;
2263
+ }
2264
+
2265
+ namespace StartsAt {
2266
+ interface DiscountEnd {
2267
+ /**
2268
+ * The ID of a specific discount.
2269
+ */
2270
+ discount: string;
2271
+ }
2272
+
2273
+ interface LineEndsAt {
2274
+ /**
2275
+ * The ID of a quote line.
2276
+ */
2277
+ id?: string;
2278
+
2279
+ /**
2280
+ * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
2281
+ */
2282
+ index?: number;
2283
+ }
2284
+
2285
+ type Type =
2286
+ | 'discount_end'
2287
+ | 'line_ends_at'
2288
+ | 'now'
2289
+ | 'quote_acceptance_date'
2290
+ | 'schedule_end'
2291
+ | 'timestamp'
2292
+ | 'upcoming_invoice';
2293
+ }
2294
+
2295
+ interface TrialSettings {
2296
+ /**
2297
+ * Defines how the subscription should behave when a trial ends.
2298
+ */
2299
+ end_behavior?: TrialSettings.EndBehavior;
2300
+ }
2301
+
2302
+ namespace TrialSettings {
2303
+ interface EndBehavior {
2304
+ /**
2305
+ * Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
2306
+ */
2307
+ prorate_up_front?: EndBehavior.ProrateUpFront;
2308
+ }
2309
+
2310
+ namespace EndBehavior {
2311
+ type ProrateUpFront = 'defer' | 'include';
2312
+ }
531
2313
  }
532
2314
  }
533
2315
 
@@ -570,15 +2352,59 @@ declare module 'stripe' {
570
2352
  */
571
2353
  coupon?: string;
572
2354
 
573
- /**
574
- * ID of an existing discount on the object (or one of its ancestors) to reuse.
575
- */
576
- discount?: string;
2355
+ /**
2356
+ * ID of an existing discount on the object (or one of its ancestors) to reuse.
2357
+ */
2358
+ discount?: string;
2359
+
2360
+ /**
2361
+ * Details to determine how long the discount should be applied for.
2362
+ */
2363
+ discount_end?: Discount.DiscountEnd;
2364
+
2365
+ /**
2366
+ * ID of the promotion code to create a new discount for.
2367
+ */
2368
+ promotion_code?: string;
2369
+ }
2370
+
2371
+ namespace Discount {
2372
+ interface DiscountEnd {
2373
+ /**
2374
+ * Time span for the redeemed discount.
2375
+ */
2376
+ duration?: DiscountEnd.Duration;
2377
+
2378
+ /**
2379
+ * A precise Unix timestamp for the discount to end. Must be in the future.
2380
+ */
2381
+ timestamp?: number;
2382
+
2383
+ /**
2384
+ * The type of calculation made to determine when the discount ends.
2385
+ */
2386
+ type: DiscountEnd.Type;
2387
+ }
2388
+
2389
+ namespace DiscountEnd {
2390
+ interface Duration {
2391
+ /**
2392
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2393
+ */
2394
+ interval: Duration.Interval;
577
2395
 
578
- /**
579
- * ID of the promotion code to create a new discount for.
580
- */
581
- promotion_code?: string;
2396
+ /**
2397
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2398
+ */
2399
+ interval_count: number;
2400
+ }
2401
+
2402
+ namespace Duration {
2403
+ type Interval = 'day' | 'month' | 'week' | 'year';
2404
+ }
2405
+
2406
+ type Type = 'duration' | 'timestamp';
2407
+ }
582
2408
  }
583
2409
 
584
2410
  interface PriceData {
@@ -635,27 +2461,382 @@ declare module 'stripe' {
635
2461
  }
636
2462
 
637
2463
  interface SubscriptionData {
2464
+ /**
2465
+ * Describes the period to bill for upon accepting the quote.
2466
+ */
2467
+ bill_on_acceptance?: Stripe.Emptyable<
2468
+ SubscriptionData.BillOnAcceptance
2469
+ >;
2470
+
2471
+ /**
2472
+ * 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.
2473
+ */
2474
+ billing_behavior?: SubscriptionData.BillingBehavior;
2475
+
2476
+ /**
2477
+ * When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
2478
+ */
2479
+ billing_cycle_anchor?: Stripe.Emptyable<'reset'>;
2480
+
638
2481
  /**
639
2482
  * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
640
2483
  */
641
2484
  description?: Stripe.Emptyable<string>;
642
2485
 
643
2486
  /**
644
- * When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. The `effective_date` is ignored if it is in the past when the quote is accepted.
2487
+ * When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
645
2488
  */
646
2489
  effective_date?: Stripe.Emptyable<'current_period_end' | number>;
647
2490
 
2491
+ /**
2492
+ * Behavior of the subscription schedule and underlying subscription when it ends.
2493
+ */
2494
+ end_behavior?: SubscriptionData.EndBehavior;
2495
+
648
2496
  /**
649
2497
  * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
650
2498
  */
651
2499
  metadata?: Stripe.MetadataParam;
652
2500
 
2501
+ /**
2502
+ * If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
2503
+ */
2504
+ prebilling?: Stripe.Emptyable<SubscriptionData.Prebilling>;
2505
+
2506
+ /**
2507
+ * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
2508
+ *
2509
+ * When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
2510
+ *
2511
+ * Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
2512
+ *
2513
+ * Prorations can be disabled by passing `none`.
2514
+ */
2515
+ proration_behavior?: SubscriptionData.ProrationBehavior;
2516
+
653
2517
  /**
654
2518
  * Integer representing the number of trial period days before the customer is charged for the first time.
655
2519
  */
656
2520
  trial_period_days?: Stripe.Emptyable<number>;
657
2521
  }
658
2522
 
2523
+ namespace SubscriptionData {
2524
+ type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
2525
+
2526
+ interface BillOnAcceptance {
2527
+ /**
2528
+ * The start of the period to bill from when the Quote is accepted.
2529
+ */
2530
+ bill_from?: BillOnAcceptance.BillFrom;
2531
+
2532
+ /**
2533
+ * The end of the period to bill until when the Quote is accepted.
2534
+ */
2535
+ bill_until?: BillOnAcceptance.BillUntil;
2536
+ }
2537
+
2538
+ namespace BillOnAcceptance {
2539
+ interface BillFrom {
2540
+ /**
2541
+ * Details of a Quote line to start the bill period from.
2542
+ */
2543
+ line_starts_at?: BillFrom.LineStartsAt;
2544
+
2545
+ /**
2546
+ * A precise Unix timestamp.
2547
+ */
2548
+ timestamp?: number;
2549
+
2550
+ /**
2551
+ * The type of method to specify the `bill_from` time.
2552
+ */
2553
+ type: BillFrom.Type;
2554
+ }
2555
+
2556
+ namespace BillFrom {
2557
+ interface LineStartsAt {
2558
+ /**
2559
+ * The ID of a quote line.
2560
+ */
2561
+ id?: string;
2562
+
2563
+ /**
2564
+ * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
2565
+ */
2566
+ index?: number;
2567
+ }
2568
+
2569
+ type Type =
2570
+ | 'line_starts_at'
2571
+ | 'now'
2572
+ | 'pause_collection_start'
2573
+ | 'quote_acceptance_date'
2574
+ | 'timestamp';
2575
+ }
2576
+
2577
+ interface BillUntil {
2578
+ /**
2579
+ * Details of the duration over which to bill.
2580
+ */
2581
+ duration?: BillUntil.Duration;
2582
+
2583
+ /**
2584
+ * Details of a Quote line item from which to bill until.
2585
+ */
2586
+ line_ends_at?: BillUntil.LineEndsAt;
2587
+
2588
+ /**
2589
+ * A precise Unix timestamp.
2590
+ */
2591
+ timestamp?: number;
2592
+
2593
+ /**
2594
+ * The type of method to specify the `bill_until` time.
2595
+ */
2596
+ type: BillUntil.Type;
2597
+ }
2598
+
2599
+ namespace BillUntil {
2600
+ interface Duration {
2601
+ /**
2602
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2603
+ */
2604
+ interval: Duration.Interval;
2605
+
2606
+ /**
2607
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2608
+ */
2609
+ interval_count: number;
2610
+ }
2611
+
2612
+ namespace Duration {
2613
+ type Interval = 'day' | 'month' | 'week' | 'year';
2614
+ }
2615
+
2616
+ interface LineEndsAt {
2617
+ /**
2618
+ * The ID of a quote line.
2619
+ */
2620
+ id?: string;
2621
+
2622
+ /**
2623
+ * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
2624
+ */
2625
+ index?: number;
2626
+ }
2627
+
2628
+ type Type =
2629
+ | 'duration'
2630
+ | 'line_ends_at'
2631
+ | 'schedule_end'
2632
+ | 'timestamp'
2633
+ | 'upcoming_invoice';
2634
+ }
2635
+ }
2636
+
2637
+ type EndBehavior = 'cancel' | 'release';
2638
+
2639
+ interface Prebilling {
2640
+ /**
2641
+ * This is used to determine the number of billing cycles to prebill.
2642
+ */
2643
+ iterations: number;
2644
+ }
2645
+
2646
+ type ProrationBehavior =
2647
+ | 'always_invoice'
2648
+ | 'create_prorations'
2649
+ | 'none';
2650
+ }
2651
+
2652
+ interface SubscriptionDataOverride {
2653
+ /**
2654
+ * Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
2655
+ */
2656
+ applies_to: SubscriptionDataOverride.AppliesTo;
2657
+
2658
+ /**
2659
+ * Describes the period to bill for upon accepting the quote.
2660
+ */
2661
+ bill_on_acceptance?: Stripe.Emptyable<
2662
+ SubscriptionDataOverride.BillOnAcceptance
2663
+ >;
2664
+
2665
+ /**
2666
+ * 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.
2667
+ */
2668
+ billing_behavior?: SubscriptionDataOverride.BillingBehavior;
2669
+
2670
+ /**
2671
+ * The customer the Subscription Data override applies to.
2672
+ */
2673
+ customer?: string;
2674
+
2675
+ /**
2676
+ * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
2677
+ */
2678
+ description?: Stripe.Emptyable<string>;
2679
+
2680
+ /**
2681
+ * Behavior of the subscription schedule and underlying subscription when it ends.
2682
+ */
2683
+ end_behavior?: SubscriptionDataOverride.EndBehavior;
2684
+
2685
+ /**
2686
+ * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
2687
+ *
2688
+ * When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
2689
+ *
2690
+ * Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
2691
+ *
2692
+ * Prorations can be disabled by passing `none`.
2693
+ */
2694
+ proration_behavior?: SubscriptionDataOverride.ProrationBehavior;
2695
+ }
2696
+
2697
+ namespace SubscriptionDataOverride {
2698
+ interface AppliesTo {
2699
+ /**
2700
+ * A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
2701
+ */
2702
+ new_reference?: string;
2703
+
2704
+ /**
2705
+ * The ID of the schedule the line applies to.
2706
+ */
2707
+ subscription_schedule?: string;
2708
+
2709
+ /**
2710
+ * Describes whether the quote line is affecting a new schedule or an existing schedule.
2711
+ */
2712
+ type: AppliesTo.Type;
2713
+ }
2714
+
2715
+ namespace AppliesTo {
2716
+ type Type = 'new_reference' | 'subscription_schedule';
2717
+ }
2718
+
2719
+ type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
2720
+
2721
+ interface BillOnAcceptance {
2722
+ /**
2723
+ * The start of the period to bill from when the Quote is accepted.
2724
+ */
2725
+ bill_from?: BillOnAcceptance.BillFrom;
2726
+
2727
+ /**
2728
+ * The end of the period to bill until when the Quote is accepted.
2729
+ */
2730
+ bill_until?: BillOnAcceptance.BillUntil;
2731
+ }
2732
+
2733
+ namespace BillOnAcceptance {
2734
+ interface BillFrom {
2735
+ /**
2736
+ * Details of a Quote line to start the bill period from.
2737
+ */
2738
+ line_starts_at?: BillFrom.LineStartsAt;
2739
+
2740
+ /**
2741
+ * A precise Unix timestamp.
2742
+ */
2743
+ timestamp?: number;
2744
+
2745
+ /**
2746
+ * The type of method to specify the `bill_from` time.
2747
+ */
2748
+ type: BillFrom.Type;
2749
+ }
2750
+
2751
+ namespace BillFrom {
2752
+ interface LineStartsAt {
2753
+ /**
2754
+ * The ID of a quote line.
2755
+ */
2756
+ id?: string;
2757
+
2758
+ /**
2759
+ * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
2760
+ */
2761
+ index?: number;
2762
+ }
2763
+
2764
+ type Type =
2765
+ | 'line_starts_at'
2766
+ | 'now'
2767
+ | 'pause_collection_start'
2768
+ | 'quote_acceptance_date'
2769
+ | 'timestamp';
2770
+ }
2771
+
2772
+ interface BillUntil {
2773
+ /**
2774
+ * Details of the duration over which to bill.
2775
+ */
2776
+ duration?: BillUntil.Duration;
2777
+
2778
+ /**
2779
+ * Details of a Quote line item from which to bill until.
2780
+ */
2781
+ line_ends_at?: BillUntil.LineEndsAt;
2782
+
2783
+ /**
2784
+ * A precise Unix timestamp.
2785
+ */
2786
+ timestamp?: number;
2787
+
2788
+ /**
2789
+ * The type of method to specify the `bill_until` time.
2790
+ */
2791
+ type: BillUntil.Type;
2792
+ }
2793
+
2794
+ namespace BillUntil {
2795
+ interface Duration {
2796
+ /**
2797
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2798
+ */
2799
+ interval: Duration.Interval;
2800
+
2801
+ /**
2802
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2803
+ */
2804
+ interval_count: number;
2805
+ }
2806
+
2807
+ namespace Duration {
2808
+ type Interval = 'day' | 'month' | 'week' | 'year';
2809
+ }
2810
+
2811
+ interface LineEndsAt {
2812
+ /**
2813
+ * The ID of a quote line.
2814
+ */
2815
+ id?: string;
2816
+
2817
+ /**
2818
+ * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
2819
+ */
2820
+ index?: number;
2821
+ }
2822
+
2823
+ type Type =
2824
+ | 'duration'
2825
+ | 'line_ends_at'
2826
+ | 'schedule_end'
2827
+ | 'timestamp'
2828
+ | 'upcoming_invoice';
2829
+ }
2830
+ }
2831
+
2832
+ type EndBehavior = 'cancel' | 'release';
2833
+
2834
+ type ProrationBehavior =
2835
+ | 'always_invoice'
2836
+ | 'create_prorations'
2837
+ | 'none';
2838
+ }
2839
+
659
2840
  interface TransferData {
660
2841
  /**
661
2842
  * The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
@@ -680,11 +2861,21 @@ declare module 'stripe' {
680
2861
  */
681
2862
  customer?: string;
682
2863
 
2864
+ /**
2865
+ * The ID of the account whose quotes will be retrieved.
2866
+ */
2867
+ customer_account?: string;
2868
+
683
2869
  /**
684
2870
  * Specifies which fields in the response should be expanded.
685
2871
  */
686
2872
  expand?: Array<string>;
687
2873
 
2874
+ /**
2875
+ * The subscription which the quote updates.
2876
+ */
2877
+ from_subscription?: string;
2878
+
688
2879
  /**
689
2880
  * The status of the quote.
690
2881
  */
@@ -697,7 +2888,13 @@ declare module 'stripe' {
697
2888
  }
698
2889
 
699
2890
  namespace QuoteListParams {
700
- type Status = 'accepted' | 'canceled' | 'draft' | 'open';
2891
+ type Status =
2892
+ | 'accepted'
2893
+ | 'accepting'
2894
+ | 'canceled'
2895
+ | 'draft'
2896
+ | 'open'
2897
+ | 'stale';
701
2898
  }
702
2899
 
703
2900
  interface QuoteAcceptParams {
@@ -726,6 +2923,13 @@ declare module 'stripe' {
726
2923
  expires_at?: number;
727
2924
  }
728
2925
 
2926
+ interface QuoteListPreviewInvoiceLinesParams extends PaginationParams {
2927
+ /**
2928
+ * Specifies which fields in the response should be expanded.
2929
+ */
2930
+ expand?: Array<string>;
2931
+ }
2932
+
729
2933
  interface QuoteListComputedUpfrontLineItemsParams extends PaginationParams {
730
2934
  /**
731
2935
  * Specifies which fields in the response should be expanded.
@@ -740,6 +2944,47 @@ declare module 'stripe' {
740
2944
  expand?: Array<string>;
741
2945
  }
742
2946
 
2947
+ interface QuoteListLinesParams extends PaginationParams {
2948
+ /**
2949
+ * Specifies which fields in the response should be expanded.
2950
+ */
2951
+ expand?: Array<string>;
2952
+ }
2953
+
2954
+ interface QuoteListPreviewInvoicesParams extends PaginationParams {
2955
+ /**
2956
+ * Specifies which fields in the response should be expanded.
2957
+ */
2958
+ expand?: Array<string>;
2959
+ }
2960
+
2961
+ interface QuoteListPreviewSubscriptionSchedulesParams
2962
+ extends PaginationParams {
2963
+ /**
2964
+ * Specifies which fields in the response should be expanded.
2965
+ */
2966
+ expand?: Array<string>;
2967
+ }
2968
+
2969
+ interface QuoteMarkDraftParams {
2970
+ /**
2971
+ * Specifies which fields in the response should be expanded.
2972
+ */
2973
+ expand?: Array<string>;
2974
+ }
2975
+
2976
+ interface QuoteMarkStaleParams {
2977
+ /**
2978
+ * Specifies which fields in the response should be expanded.
2979
+ */
2980
+ expand?: Array<string>;
2981
+
2982
+ /**
2983
+ * Reason the Quote is being marked stale.
2984
+ */
2985
+ reason?: string;
2986
+ }
2987
+
743
2988
  interface QuotePdfParams {
744
2989
  /**
745
2990
  * Specifies which fields in the response should be expanded.
@@ -747,6 +2992,13 @@ declare module 'stripe' {
747
2992
  expand?: Array<string>;
748
2993
  }
749
2994
 
2995
+ interface QuoteReestimateParams {
2996
+ /**
2997
+ * Specifies which fields in the response should be expanded.
2998
+ */
2999
+ expand?: Array<string>;
3000
+ }
3001
+
750
3002
  class QuotesResource {
751
3003
  /**
752
3004
  * A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the [quote template](https://dashboard.stripe.com/settings/billing/quote).
@@ -827,6 +3079,21 @@ declare module 'stripe' {
827
3079
  options?: RequestOptions
828
3080
  ): Promise<Stripe.Response<Stripe.Quote>>;
829
3081
 
3082
+ /**
3083
+ * Preview the invoice line items that would be generated by accepting the quote.
3084
+ */
3085
+ listPreviewInvoiceLines(
3086
+ quoteId: string,
3087
+ id: string,
3088
+ params?: QuoteListPreviewInvoiceLinesParams,
3089
+ options?: RequestOptions
3090
+ ): ApiListPromise<Stripe.InvoiceLineItem>;
3091
+ listPreviewInvoiceLines(
3092
+ quoteId: string,
3093
+ id: string,
3094
+ options?: RequestOptions
3095
+ ): ApiListPromise<Stripe.InvoiceLineItem>;
3096
+
830
3097
  /**
831
3098
  * When retrieving a quote, there is an includable [computed.upfront.line_items](https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items) property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.
832
3099
  */
@@ -853,6 +3120,71 @@ declare module 'stripe' {
853
3120
  options?: RequestOptions
854
3121
  ): ApiListPromise<Stripe.LineItem>;
855
3122
 
3123
+ /**
3124
+ * Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
3125
+ */
3126
+ listLines(
3127
+ id: string,
3128
+ params?: QuoteListLinesParams,
3129
+ options?: RequestOptions
3130
+ ): ApiListPromise<Stripe.QuoteLine>;
3131
+ listLines(
3132
+ id: string,
3133
+ options?: RequestOptions
3134
+ ): ApiListPromise<Stripe.QuoteLine>;
3135
+
3136
+ /**
3137
+ * Preview the invoices that would be generated by accepting the quote.
3138
+ */
3139
+ listPreviewInvoices(
3140
+ id: string,
3141
+ params?: QuoteListPreviewInvoicesParams,
3142
+ options?: RequestOptions
3143
+ ): ApiListPromise<Stripe.QuotePreviewInvoice>;
3144
+ listPreviewInvoices(
3145
+ id: string,
3146
+ options?: RequestOptions
3147
+ ): ApiListPromise<Stripe.QuotePreviewInvoice>;
3148
+
3149
+ /**
3150
+ * Preview the schedules that would be generated by accepting the quote
3151
+ */
3152
+ listPreviewSubscriptionSchedules(
3153
+ id: string,
3154
+ params?: QuoteListPreviewSubscriptionSchedulesParams,
3155
+ options?: RequestOptions
3156
+ ): ApiListPromise<Stripe.QuotePreviewSubscriptionSchedule>;
3157
+ listPreviewSubscriptionSchedules(
3158
+ id: string,
3159
+ options?: RequestOptions
3160
+ ): ApiListPromise<Stripe.QuotePreviewSubscriptionSchedule>;
3161
+
3162
+ /**
3163
+ * Converts a stale quote to draft.
3164
+ */
3165
+ markDraft(
3166
+ id: string,
3167
+ params?: QuoteMarkDraftParams,
3168
+ options?: RequestOptions
3169
+ ): Promise<Stripe.Response<Stripe.Quote>>;
3170
+ markDraft(
3171
+ id: string,
3172
+ options?: RequestOptions
3173
+ ): Promise<Stripe.Response<Stripe.Quote>>;
3174
+
3175
+ /**
3176
+ * Converts a draft or open quote to stale.
3177
+ */
3178
+ markStale(
3179
+ id: string,
3180
+ params?: QuoteMarkStaleParams,
3181
+ options?: RequestOptions
3182
+ ): Promise<Stripe.Response<Stripe.Quote>>;
3183
+ markStale(
3184
+ id: string,
3185
+ options?: RequestOptions
3186
+ ): Promise<Stripe.Response<Stripe.Quote>>;
3187
+
856
3188
  /**
857
3189
  * Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
858
3190
  */
@@ -862,6 +3194,19 @@ declare module 'stripe' {
862
3194
  options?: RequestOptions
863
3195
  ): Promise<StripeStreamResponse>;
864
3196
  pdf(id: string, options?: RequestOptions): Promise<StripeStreamResponse>;
3197
+
3198
+ /**
3199
+ * Recompute the upcoming invoice estimate for the quote.
3200
+ */
3201
+ reestimate(
3202
+ id: string,
3203
+ params?: QuoteReestimateParams,
3204
+ options?: RequestOptions
3205
+ ): Promise<Stripe.Response<Stripe.Quote>>;
3206
+ reestimate(
3207
+ id: string,
3208
+ options?: RequestOptions
3209
+ ): Promise<Stripe.Response<Stripe.Quote>>;
865
3210
  }
866
3211
  }
867
3212
  }