stripe 14.1.0.pre.beta.1 → 15.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (574) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +689 -1512
  3. data/OPENAPI_VERSION +1 -1
  4. data/README.md +3 -3
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_operations/save.rb +2 -1
  7. data/lib/stripe/api_operations/singleton_save.rb +2 -1
  8. data/lib/stripe/api_requestor.rb +3 -29
  9. data/lib/stripe/api_resource.rb +10 -3
  10. data/lib/stripe/api_version.rb +1 -1
  11. data/lib/stripe/errors.rb +0 -54
  12. data/lib/stripe/event_types.rb +0 -75
  13. data/lib/stripe/object_types.rb +0 -48
  14. data/lib/stripe/request_options.rb +2 -1
  15. data/lib/stripe/resources/account.rb +1 -653
  16. data/lib/stripe/resources/account_session.rb +1 -247
  17. data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -2
  18. data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -4
  19. data/lib/stripe/resources/billing/credit_grant.rb +0 -10
  20. data/lib/stripe/resources/billing_portal/session.rb +0 -6
  21. data/lib/stripe/resources/card.rb +0 -2
  22. data/lib/stripe/resources/cash_balance.rb +0 -2
  23. data/lib/stripe/resources/charge.rb +0 -1454
  24. data/lib/stripe/resources/checkout/session.rb +4 -260
  25. data/lib/stripe/resources/confirmation_token.rb +0 -234
  26. data/lib/stripe/resources/coupon.rb +1 -1
  27. data/lib/stripe/resources/credit_note.rb +0 -10
  28. data/lib/stripe/resources/credit_note_line_item.rb +0 -9
  29. data/lib/stripe/resources/customer.rb +0 -2
  30. data/lib/stripe/resources/customer_balance_transaction.rb +0 -2
  31. data/lib/stripe/resources/customer_cash_balance_transaction.rb +0 -2
  32. data/lib/stripe/resources/customer_session.rb +1 -6
  33. data/lib/stripe/resources/discount.rb +0 -2
  34. data/lib/stripe/resources/event.rb +0 -33
  35. data/lib/stripe/resources/financial_connections/account.rb +1 -20
  36. data/lib/stripe/resources/financial_connections/session.rb +2 -62
  37. data/lib/stripe/resources/identity/verification_session.rb +0 -10
  38. data/lib/stripe/resources/invoice.rb +16 -1176
  39. data/lib/stripe/resources/invoice_item.rb +2 -78
  40. data/lib/stripe/resources/invoice_line_item.rb +1 -55
  41. data/lib/stripe/resources/invoice_payment.rb +53 -2
  42. data/lib/stripe/resources/issuing/cardholder.rb +1 -2
  43. data/lib/stripe/resources/issuing/transaction.rb +0 -6
  44. data/lib/stripe/resources/line_item.rb +0 -37
  45. data/lib/stripe/resources/mandate.rb +0 -24
  46. data/lib/stripe/resources/payment_intent.rb +307 -5109
  47. data/lib/stripe/resources/payment_method.rb +1 -196
  48. data/lib/stripe/resources/payment_method_configuration.rb +0 -295
  49. data/lib/stripe/resources/payout.rb +0 -6
  50. data/lib/stripe/resources/price.rb +0 -30
  51. data/lib/stripe/resources/product.rb +0 -59
  52. data/lib/stripe/resources/promotion_code.rb +0 -10
  53. data/lib/stripe/resources/quote.rb +6 -2042
  54. data/lib/stripe/resources/refund.rb +0 -9
  55. data/lib/stripe/resources/setup_attempt.rb +0 -21
  56. data/lib/stripe/resources/setup_intent.rb +9 -596
  57. data/lib/stripe/resources/source.rb +1 -30
  58. data/lib/stripe/resources/subscription.rb +9 -292
  59. data/lib/stripe/resources/subscription_item.rb +3 -84
  60. data/lib/stripe/resources/subscription_schedule.rb +10 -1007
  61. data/lib/stripe/resources/tax_id.rb +2 -12
  62. data/lib/stripe/resources/terminal/reader.rb +0 -406
  63. data/lib/stripe/resources/treasury/financial_account.rb +3 -22
  64. data/lib/stripe/resources/treasury/financial_account_features.rb +0 -2
  65. data/lib/stripe/resources/treasury/outbound_transfer.rb +0 -37
  66. data/lib/stripe/resources/treasury/received_credit.rb +1 -38
  67. data/lib/stripe/resources/treasury/received_debit.rb +1 -40
  68. data/lib/stripe/resources.rb +0 -85
  69. data/lib/stripe/services/account_service.rb +1 -562
  70. data/lib/stripe/services/account_session_service.rb +1 -217
  71. data/lib/stripe/services/billing/credit_balance_summary_service.rb +1 -4
  72. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -4
  73. data/lib/stripe/services/billing/credit_grant_service.rb +0 -8
  74. data/lib/stripe/services/billing_portal/session_service.rb +0 -4
  75. data/lib/stripe/services/charge_service.rb +0 -1334
  76. data/lib/stripe/services/checkout/session_service.rb +2 -172
  77. data/lib/stripe/services/credit_note_service.rb +0 -4
  78. data/lib/stripe/services/customer_session_service.rb +1 -4
  79. data/lib/stripe/services/financial_connections/account_service.rb +2 -7
  80. data/lib/stripe/services/financial_connections/session_service.rb +2 -34
  81. data/lib/stripe/services/financial_connections_service.rb +1 -2
  82. data/lib/stripe/services/identity/verification_session_service.rb +0 -8
  83. data/lib/stripe/services/invoice_item_service.rb +2 -74
  84. data/lib/stripe/services/invoice_line_item_service.rb +1 -33
  85. data/lib/stripe/services/invoice_payment_service.rb +33 -5
  86. data/lib/stripe/services/invoice_service.rb +17 -1088
  87. data/lib/stripe/services/issuing/cardholder_service.rb +1 -2
  88. data/lib/stripe/services/issuing/transaction_service.rb +0 -4
  89. data/lib/stripe/services/issuing_service.rb +1 -5
  90. data/lib/stripe/services/payment_intent_service.rb +264 -4637
  91. data/lib/stripe/services/payment_method_configuration_service.rb +0 -210
  92. data/lib/stripe/services/payment_method_service.rb +1 -126
  93. data/lib/stripe/services/payout_service.rb +0 -4
  94. data/lib/stripe/services/price_service.rb +0 -19
  95. data/lib/stripe/services/product_service.rb +0 -38
  96. data/lib/stripe/services/promotion_code_service.rb +0 -8
  97. data/lib/stripe/services/quote_service.rb +7 -1726
  98. data/lib/stripe/services/setup_intent_service.rb +9 -556
  99. data/lib/stripe/services/subscription_item_service.rb +3 -75
  100. data/lib/stripe/services/subscription_schedule_service.rb +10 -911
  101. data/lib/stripe/services/subscription_service.rb +9 -253
  102. data/lib/stripe/services/tax_id_service.rb +2 -8
  103. data/lib/stripe/services/tax_service.rb +1 -3
  104. data/lib/stripe/services/terminal/reader_service.rb +0 -180
  105. data/lib/stripe/services/terminal_service.rb +1 -2
  106. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +0 -148
  107. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -43
  108. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +1 -25
  109. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +1 -25
  110. data/lib/stripe/services/treasury/financial_account_features_service.rb +1 -4
  111. data/lib/stripe/services/treasury/financial_account_service.rb +2 -16
  112. data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -24
  113. data/lib/stripe/services/v1_services.rb +2 -10
  114. data/lib/stripe/services/v2/core/event_service.rb +5 -3
  115. data/lib/stripe/services/v2/core_service.rb +1 -4
  116. data/lib/stripe/services/v2_services.rb +2 -4
  117. data/lib/stripe/services.rb +0 -49
  118. data/lib/stripe/stripe_configuration.rb +1 -3
  119. data/lib/stripe/stripe_object.rb +14 -4
  120. data/lib/stripe/util.rb +12 -7
  121. data/lib/stripe/version.rb +1 -1
  122. data/lib/stripe.rb +0 -55
  123. data/rbi/stripe/resources/account.rbi +4840 -0
  124. data/rbi/stripe/resources/account_link.rbi +74 -0
  125. data/rbi/stripe/resources/account_session.rbi +894 -0
  126. data/rbi/stripe/resources/apple_pay_domain.rbi +90 -0
  127. data/rbi/stripe/resources/application.rbi +20 -0
  128. data/rbi/stripe/resources/application_fee.rbi +118 -0
  129. data/rbi/stripe/resources/application_fee_refund.rbi +37 -0
  130. data/rbi/stripe/resources/apps/secret.rbi +195 -0
  131. data/rbi/stripe/resources/balance.rbi +180 -0
  132. data/rbi/stripe/resources/balance_transaction.rbi +144 -0
  133. data/rbi/stripe/resources/bank_account.rbi +127 -0
  134. data/rbi/stripe/resources/billing/alert.rbi +201 -0
  135. data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
  136. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +63 -0
  137. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +147 -0
  138. data/rbi/stripe/resources/billing/credit_grant.rbi +291 -0
  139. data/rbi/stripe/resources/billing/meter.rbi +226 -0
  140. data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
  141. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
  142. data/rbi/stripe/resources/billing/meter_event_summary.rbi +35 -0
  143. data/rbi/stripe/resources/billing_portal/configuration.rbi +645 -0
  144. data/rbi/stripe/resources/billing_portal/session.rbi +345 -0
  145. data/rbi/stripe/resources/capability.rbi +125 -0
  146. data/rbi/stripe/resources/card.rbi +125 -0
  147. data/rbi/stripe/resources/cash_balance.rbi +32 -0
  148. data/rbi/stripe/resources/charge.rbi +2054 -0
  149. data/rbi/stripe/resources/checkout/session.rbi +3951 -0
  150. data/rbi/stripe/resources/climate/order.rbi +245 -0
  151. data/rbi/stripe/resources/climate/product.rbi +75 -0
  152. data/rbi/stripe/resources/climate/supplier.rbi +72 -0
  153. data/rbi/stripe/resources/confirmation_token.rbi +1793 -0
  154. data/rbi/stripe/resources/connect_collection_transfer.rbi +26 -0
  155. data/rbi/stripe/resources/country_spec.rbi +85 -0
  156. data/rbi/stripe/resources/coupon.rbi +252 -0
  157. data/rbi/stripe/resources/credit_note.rbi +747 -0
  158. data/rbi/stripe/resources/credit_note_line_item.rbi +101 -0
  159. data/rbi/stripe/resources/customer.rbi +1009 -0
  160. data/rbi/stripe/resources/customer_balance_transaction.rbi +56 -0
  161. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
  162. data/rbi/stripe/resources/customer_session.rbi +200 -0
  163. data/rbi/stripe/resources/discount.rbi +53 -0
  164. data/rbi/stripe/resources/dispute.rbi +761 -0
  165. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +58 -0
  166. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
  167. data/rbi/stripe/resources/entitlements/feature.rbi +117 -0
  168. data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
  169. data/rbi/stripe/resources/event.rbi +146 -0
  170. data/rbi/stripe/resources/exchange_rate.rbi +66 -0
  171. data/rbi/stripe/resources/file.rbi +143 -0
  172. data/rbi/stripe/resources/file_link.rbi +141 -0
  173. data/rbi/stripe/resources/financial_connections/account.rbi +339 -0
  174. data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
  175. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
  176. data/rbi/stripe/resources/financial_connections/session.rbi +123 -0
  177. data/rbi/stripe/resources/financial_connections/transaction.rbi +124 -0
  178. data/rbi/stripe/resources/forwarding/request.rbi +216 -0
  179. data/rbi/stripe/resources/funding_instructions.rbi +437 -0
  180. data/rbi/stripe/resources/identity/verification_report.rbi +351 -0
  181. data/rbi/stripe/resources/identity/verification_session.rbi +517 -0
  182. data/rbi/stripe/resources/invoice.rbi +3733 -0
  183. data/rbi/stripe/resources/invoice_item.rbi +475 -0
  184. data/rbi/stripe/resources/invoice_line_item.rbi +432 -0
  185. data/rbi/stripe/resources/invoice_payment.rbi +114 -0
  186. data/rbi/stripe/resources/invoice_rendering_template.rbi +104 -0
  187. data/rbi/stripe/resources/issuing/authorization.rbi +1283 -0
  188. data/rbi/stripe/resources/issuing/card.rbi +741 -0
  189. data/rbi/stripe/resources/issuing/cardholder.rbi +744 -0
  190. data/rbi/stripe/resources/issuing/dispute.rbi +913 -0
  191. data/rbi/stripe/resources/issuing/personalization_design.rbi +338 -0
  192. data/rbi/stripe/resources/issuing/physical_bundle.rbi +79 -0
  193. data/rbi/stripe/resources/issuing/token.rbi +226 -0
  194. data/rbi/stripe/resources/issuing/transaction.rbi +1061 -0
  195. data/rbi/stripe/resources/line_item.rbi +72 -0
  196. data/rbi/stripe/resources/login_link.rbi +18 -0
  197. data/rbi/stripe/resources/mandate.rbi +187 -0
  198. data/rbi/stripe/resources/payment_intent.rbi +9731 -0
  199. data/rbi/stripe/resources/payment_link.rbi +1801 -0
  200. data/rbi/stripe/resources/payment_method.rbi +1822 -0
  201. data/rbi/stripe/resources/payment_method_configuration.rbi +3154 -0
  202. data/rbi/stripe/resources/payment_method_domain.rbi +212 -0
  203. data/rbi/stripe/resources/payout.rbi +300 -0
  204. data/rbi/stripe/resources/person.rbi +371 -0
  205. data/rbi/stripe/resources/plan.rbi +373 -0
  206. data/rbi/stripe/resources/price.rbi +694 -0
  207. data/rbi/stripe/resources/product.rbi +557 -0
  208. data/rbi/stripe/resources/product_feature.rbi +26 -0
  209. data/rbi/stripe/resources/promotion_code.rbi +261 -0
  210. data/rbi/stripe/resources/quote.rbi +1123 -0
  211. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +98 -0
  212. data/rbi/stripe/resources/radar/value_list.rbi +170 -0
  213. data/rbi/stripe/resources/radar/value_list_item.rbi +131 -0
  214. data/rbi/stripe/resources/refund.rbi +516 -0
  215. data/rbi/stripe/resources/reporting/report_run.rbi +191 -0
  216. data/rbi/stripe/resources/reporting/report_type.rbi +57 -0
  217. data/rbi/stripe/resources/reserve_transaction.rbi +23 -0
  218. data/rbi/stripe/resources/reversal.rbi +51 -0
  219. data/rbi/stripe/resources/review.rbi +154 -0
  220. data/rbi/stripe/resources/setup_attempt.rbi +477 -0
  221. data/rbi/stripe/resources/setup_intent.rbi +3860 -0
  222. data/rbi/stripe/resources/shipping_rate.rbi +305 -0
  223. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +75 -0
  224. data/rbi/stripe/resources/source.rbi +1496 -0
  225. data/rbi/stripe/resources/source_mandate_notification.rbi +77 -0
  226. data/rbi/stripe/resources/source_transaction.rbi +127 -0
  227. data/rbi/stripe/resources/subscription.rbi +1964 -0
  228. data/rbi/stripe/resources/subscription_item.rbi +370 -0
  229. data/rbi/stripe/resources/subscription_schedule.rbi +1495 -0
  230. data/rbi/stripe/resources/tax/calculation.rbi +474 -0
  231. data/rbi/stripe/resources/tax/calculation_line_item.rbi +88 -0
  232. data/rbi/stripe/resources/tax/registration.rbi +2485 -0
  233. data/rbi/stripe/resources/tax/settings.rbi +141 -0
  234. data/rbi/stripe/resources/tax/transaction.rbi +351 -0
  235. data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
  236. data/rbi/stripe/resources/tax_code.rbi +44 -0
  237. data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
  238. data/rbi/stripe/resources/tax_id.rbi +167 -0
  239. data/rbi/stripe/resources/tax_rate.rbi +239 -0
  240. data/rbi/stripe/resources/terminal/configuration.rbi +1388 -0
  241. data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
  242. data/rbi/stripe/resources/terminal/location.rbi +224 -0
  243. data/rbi/stripe/resources/terminal/reader.rbi +587 -0
  244. data/rbi/stripe/resources/test_helpers/test_clock.rbi +134 -0
  245. data/rbi/stripe/resources/token.rbi +1217 -0
  246. data/rbi/stripe/resources/topup.rbi +222 -0
  247. data/rbi/stripe/resources/transfer.rbi +199 -0
  248. data/rbi/stripe/resources/treasury/credit_reversal.rbi +119 -0
  249. data/rbi/stripe/resources/treasury/debit_reversal.rbi +131 -0
  250. data/rbi/stripe/resources/treasury/financial_account.rbi +865 -0
  251. data/rbi/stripe/resources/treasury/financial_account_features.rbi +260 -0
  252. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +295 -0
  253. data/rbi/stripe/resources/treasury/outbound_payment.rbi +592 -0
  254. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +431 -0
  255. data/rbi/stripe/resources/treasury/received_credit.rbi +302 -0
  256. data/rbi/stripe/resources/treasury/received_debit.rbi +256 -0
  257. data/rbi/stripe/resources/treasury/transaction.rbi +215 -0
  258. data/rbi/stripe/resources/treasury/transaction_entry.rbi +192 -0
  259. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  260. data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
  261. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
  262. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
  263. data/rbi/stripe/resources/v2/event.rbi +48 -0
  264. data/rbi/stripe/resources/v2/event_destination.rbi +91 -0
  265. data/rbi/stripe/resources/webhook_endpoint.rbi +170 -0
  266. data/rbi/stripe/services/account_capability_service.rbi +51 -0
  267. data/rbi/stripe/services/account_external_account_service.rbi +306 -0
  268. data/rbi/stripe/services/account_link_service.rbi +58 -0
  269. data/rbi/stripe/services/account_login_link_service.rbi +22 -0
  270. data/rbi/stripe/services/account_person_service.rbi +923 -0
  271. data/rbi/stripe/services/account_service.rbi +4143 -0
  272. data/rbi/stripe/services/account_session_service.rbi +572 -0
  273. data/rbi/stripe/services/apple_pay_domain_service.rbi +78 -0
  274. data/rbi/stripe/services/application_fee_refund_service.rbi +93 -0
  275. data/rbi/stripe/services/application_fee_service.rbi +78 -0
  276. data/rbi/stripe/services/apps/secret_service.rbi +151 -0
  277. data/rbi/stripe/services/apps_service.rbi +9 -0
  278. data/rbi/stripe/services/balance_service.rbi +21 -0
  279. data/rbi/stripe/services/balance_transaction_service.rbi +93 -0
  280. data/rbi/stripe/services/billing/alert_service.rbi +152 -0
  281. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +68 -0
  282. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
  283. data/rbi/stripe/services/billing/credit_grant_service.rbi +211 -0
  284. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +42 -0
  285. data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
  286. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
  287. data/rbi/stripe/services/billing/meter_service.rbi +163 -0
  288. data/rbi/stripe/services/billing_portal/configuration_service.rbi +511 -0
  289. data/rbi/stripe/services/billing_portal/session_service.rbi +204 -0
  290. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  291. data/rbi/stripe/services/billing_service.rbi +15 -0
  292. data/rbi/stripe/services/charge_service.rbi +448 -0
  293. data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
  294. data/rbi/stripe/services/checkout/session_service.rbi +2585 -0
  295. data/rbi/stripe/services/checkout_service.rbi +9 -0
  296. data/rbi/stripe/services/climate/order_service.rbi +142 -0
  297. data/rbi/stripe/services/climate/product_service.rbi +46 -0
  298. data/{lib/stripe/services/financial_connections/institution_service.rb → rbi/stripe/services/climate/supplier_service.rbi} +25 -36
  299. data/rbi/stripe/services/climate_service.rbi +11 -0
  300. data/rbi/stripe/services/confirmation_token_service.rbi +20 -0
  301. data/rbi/stripe/services/country_spec_service.rbi +44 -0
  302. data/rbi/stripe/services/coupon_service.rbi +196 -0
  303. data/{lib/stripe/services/quote_preview_subscription_schedule_service.rb → rbi/stripe/services/credit_note_line_item_service.rbi} +16 -20
  304. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +167 -0
  305. data/rbi/stripe/services/credit_note_service.rbi +416 -0
  306. data/rbi/stripe/services/customer_balance_transaction_service.rbi +92 -0
  307. data/rbi/stripe/services/customer_cash_balance_service.rbi +45 -0
  308. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +44 -0
  309. data/rbi/stripe/services/customer_funding_instructions_service.rbi +59 -0
  310. data/rbi/stripe/services/customer_payment_method_service.rbi +57 -0
  311. data/rbi/stripe/services/customer_payment_source_service.rbi +232 -0
  312. data/rbi/stripe/services/customer_service.rbi +651 -0
  313. data/rbi/stripe/services/customer_session_service.rbi +116 -0
  314. data/rbi/stripe/services/customer_tax_id_service.rbi +72 -0
  315. data/rbi/stripe/services/dispute_service.rbi +424 -0
  316. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
  317. data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
  318. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  319. data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
  320. data/rbi/stripe/services/event_service.rbi +83 -0
  321. data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
  322. data/rbi/stripe/services/file_link_service.rbi +124 -0
  323. data/rbi/stripe/services/file_service.rbi +116 -0
  324. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
  325. data/rbi/stripe/services/financial_connections/account_service.rbi +133 -0
  326. data/rbi/stripe/services/financial_connections/session_service.rbi +88 -0
  327. data/rbi/stripe/services/financial_connections/transaction_service.rbi +92 -0
  328. data/rbi/stripe/services/financial_connections_service.rbi +11 -0
  329. data/rbi/stripe/services/forwarding/request_service.rbi +134 -0
  330. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  331. data/rbi/stripe/services/identity/verification_report_service.rbi +87 -0
  332. data/rbi/stripe/services/identity/verification_session_service.rbi +323 -0
  333. data/rbi/stripe/services/identity_service.rbi +10 -0
  334. data/rbi/stripe/services/invoice_item_service.rbi +368 -0
  335. data/rbi/stripe/services/invoice_line_item_service.rbi +259 -0
  336. data/rbi/stripe/services/invoice_payment_service.rbi +71 -0
  337. data/rbi/stripe/services/invoice_rendering_template_service.rbi +82 -0
  338. data/rbi/stripe/services/invoice_service.rbi +2920 -0
  339. data/rbi/stripe/services/issuing/authorization_service.rbi +146 -0
  340. data/rbi/stripe/services/issuing/card_service.rbi +495 -0
  341. data/rbi/stripe/services/issuing/cardholder_service.rbi +587 -0
  342. data/rbi/stripe/services/issuing/dispute_service.rbi +707 -0
  343. data/rbi/stripe/services/issuing/personalization_design_service.rbi +243 -0
  344. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
  345. data/rbi/stripe/services/issuing/token_service.rbi +99 -0
  346. data/rbi/stripe/services/issuing/transaction_service.rbi +105 -0
  347. data/rbi/stripe/services/issuing_service.rbi +16 -0
  348. data/rbi/stripe/services/mandate_service.rbi +20 -0
  349. data/rbi/stripe/services/payment_intent_service.rbi +7759 -0
  350. data/{lib/stripe/services/quote_line_service.rb → rbi/stripe/services/payment_link_line_item_service.rbi} +16 -20
  351. data/rbi/stripe/services/payment_link_service.rbi +1352 -0
  352. data/rbi/stripe/services/payment_method_configuration_service.rbi +2211 -0
  353. data/rbi/stripe/services/payment_method_domain_service.rbi +112 -0
  354. data/rbi/stripe/services/payment_method_service.rbi +840 -0
  355. data/rbi/stripe/services/payout_service.rbi +205 -0
  356. data/rbi/stripe/services/plan_service.rbi +284 -0
  357. data/rbi/stripe/services/price_service.rbi +546 -0
  358. data/rbi/stripe/services/product_feature_service.rbi +69 -0
  359. data/rbi/stripe/services/product_service.rbi +479 -0
  360. data/rbi/stripe/services/promotion_code_service.rbi +214 -0
  361. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
  362. data/{lib/stripe/services/order_line_item_service.rb → rbi/stripe/services/quote_line_item_service.rbi} +16 -20
  363. data/rbi/stripe/services/quote_service.rbi +686 -0
  364. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +85 -0
  365. data/rbi/stripe/services/radar/value_list_item_service.rbi +111 -0
  366. data/rbi/stripe/services/radar/value_list_service.rbi +143 -0
  367. data/rbi/stripe/services/radar_service.rbi +11 -0
  368. data/rbi/stripe/services/refund_service.rbi +185 -0
  369. data/rbi/stripe/services/reporting/report_run_service.rbi +135 -0
  370. data/rbi/stripe/services/reporting/report_type_service.rbi +35 -0
  371. data/rbi/stripe/services/reporting_service.rbi +10 -0
  372. data/rbi/stripe/services/review_service.rbi +84 -0
  373. data/rbi/stripe/services/setup_attempt_service.rbi +65 -0
  374. data/rbi/stripe/services/setup_intent_service.rbi +3596 -0
  375. data/rbi/stripe/services/shipping_rate_service.rbi +241 -0
  376. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +46 -0
  377. data/rbi/stripe/services/sigma_service.rbi +9 -0
  378. data/rbi/stripe/services/source_service.rbi +663 -0
  379. data/{lib/stripe/services/quote_preview_invoice_service.rb → rbi/stripe/services/source_transaction_service.rbi} +16 -20
  380. data/rbi/stripe/services/subscription_item_service.rbi +324 -0
  381. data/rbi/stripe/services/subscription_schedule_service.rbi +1192 -0
  382. data/rbi/stripe/services/subscription_service.rbi +1596 -0
  383. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +33 -0
  384. data/rbi/stripe/services/tax/calculation_service.rbi +230 -0
  385. data/rbi/stripe/services/tax/registration_service.rbi +1689 -0
  386. data/rbi/stripe/services/tax/settings_service.rbi +93 -0
  387. data/{lib/stripe/services/financial_connections/account_inferred_balance_service.rb → rbi/stripe/services/tax/transaction_line_item_service.rbi} +17 -21
  388. data/rbi/stripe/services/tax/transaction_service.rbi +146 -0
  389. data/rbi/stripe/services/tax_code_service.rbi +44 -0
  390. data/rbi/stripe/services/tax_id_service.rbi +112 -0
  391. data/rbi/stripe/services/tax_rate_service.rbi +185 -0
  392. data/rbi/stripe/services/tax_service.rbi +12 -0
  393. data/rbi/stripe/services/terminal/configuration_service.rbi +1120 -0
  394. data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
  395. data/rbi/stripe/services/terminal/location_service.rbi +184 -0
  396. data/rbi/stripe/services/terminal/reader_service.rbi +344 -0
  397. data/rbi/stripe/services/terminal_service.rbi +12 -0
  398. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +746 -0
  399. data/rbi/stripe/services/test_helpers/customer_service.rbi +33 -0
  400. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +848 -0
  401. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +76 -0
  402. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +69 -0
  403. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +711 -0
  404. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  405. data/rbi/stripe/services/test_helpers/refund_service.rbi +22 -0
  406. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +62 -0
  407. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  408. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +92 -0
  409. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
  410. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +125 -0
  411. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +125 -0
  412. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +87 -0
  413. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +87 -0
  414. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  415. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  416. data/rbi/stripe/services/token_service.rbi +1189 -0
  417. data/rbi/stripe/services/topup_service.rbi +176 -0
  418. data/rbi/stripe/services/transfer_reversal_service.rbi +101 -0
  419. data/rbi/stripe/services/transfer_service.rbi +152 -0
  420. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
  421. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
  422. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +198 -0
  423. data/rbi/stripe/services/treasury/financial_account_service.rbi +562 -0
  424. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
  425. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +304 -0
  426. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +157 -0
  427. data/rbi/stripe/services/treasury/received_credit_service.rbi +72 -0
  428. data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
  429. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +111 -0
  430. data/rbi/stripe/services/treasury/transaction_service.rbi +122 -0
  431. data/rbi/stripe/services/treasury_service.rbi +18 -0
  432. data/rbi/stripe/services/v1_services.rbi +77 -0
  433. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
  434. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
  435. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +20 -0
  436. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +55 -0
  437. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  438. data/rbi/stripe/services/v2/core/event_destination_service.rbi +200 -0
  439. data/rbi/stripe/services/v2/core/event_service.rbi +38 -0
  440. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  441. data/rbi/stripe/services/v2_services.rbi +10 -0
  442. data/rbi/stripe/services/webhook_endpoint_service.rbi +131 -0
  443. data/stripe.gemspec +1 -4
  444. metadata +324 -140
  445. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +0 -23
  446. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +0 -21
  447. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +0 -23
  448. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +0 -21
  449. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +0 -23
  450. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +0 -21
  451. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +0 -21
  452. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +0 -21
  453. data/lib/stripe/events/v2_core_account_link_completed_event.rb +0 -13
  454. data/lib/stripe/events/v2_core_account_person_created_event.rb +0 -23
  455. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +0 -23
  456. data/lib/stripe/events/v2_core_account_person_updated_event.rb +0 -23
  457. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +0 -21
  458. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +0 -21
  459. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +0 -21
  460. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +0 -23
  461. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +0 -21
  462. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +0 -21
  463. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +0 -21
  464. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +0 -21
  465. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +0 -21
  466. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +0 -21
  467. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +0 -21
  468. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +0 -21
  469. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +0 -21
  470. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +0 -21
  471. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +0 -21
  472. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +0 -21
  473. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +0 -21
  474. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +0 -21
  475. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +0 -21
  476. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +0 -23
  477. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +0 -21
  478. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +0 -21
  479. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +0 -21
  480. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +0 -21
  481. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +0 -21
  482. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +0 -21
  483. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +0 -21
  484. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +0 -21
  485. data/lib/stripe/request_signing_authenticator.rb +0 -79
  486. data/lib/stripe/resources/account_notice.rb +0 -123
  487. data/lib/stripe/resources/balance_settings.rb +0 -101
  488. data/lib/stripe/resources/billing/meter_error_report.rb +0 -59
  489. data/lib/stripe/resources/capital/financing_offer.rb +0 -179
  490. data/lib/stripe/resources/capital/financing_summary.rb +0 -55
  491. data/lib/stripe/resources/capital/financing_transaction.rb +0 -114
  492. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
  493. data/lib/stripe/resources/financial_connections/institution.rb +0 -90
  494. data/lib/stripe/resources/gift_cards/card.rb +0 -208
  495. data/lib/stripe/resources/gift_cards/transaction.rb +0 -272
  496. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -602
  497. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -82
  498. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -86
  499. data/lib/stripe/resources/issuing/settlement.rb +0 -53
  500. data/lib/stripe/resources/margin.rb +0 -115
  501. data/lib/stripe/resources/order.rb +0 -2859
  502. data/lib/stripe/resources/payment_attempt_record.rb +0 -1078
  503. data/lib/stripe/resources/payment_record.rb +0 -1607
  504. data/lib/stripe/resources/quote_line.rb +0 -274
  505. data/lib/stripe/resources/quote_preview_invoice.rb +0 -663
  506. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -337
  507. data/lib/stripe/resources/tax/association.rb +0 -89
  508. data/lib/stripe/resources/tax/form.rb +0 -211
  509. data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -31
  510. data/lib/stripe/resources/v2/core/account.rb +0 -1715
  511. data/lib/stripe/resources/v2/core/account_link.rb +0 -54
  512. data/lib/stripe/resources/v2/core/person.rb +0 -272
  513. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +0 -72
  514. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +0 -37
  515. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +0 -18
  516. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +0 -20
  517. data/lib/stripe/resources/v2/money_management/adjustment.rb +0 -49
  518. data/lib/stripe/resources/v2/money_management/financial_account.rb +0 -56
  519. data/lib/stripe/resources/v2/money_management/financial_address.rb +0 -66
  520. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +0 -92
  521. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +0 -127
  522. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +0 -74
  523. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +0 -43
  524. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +0 -115
  525. data/lib/stripe/resources/v2/money_management/payout_method.rb +0 -73
  526. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +0 -47
  527. data/lib/stripe/resources/v2/money_management/received_credit.rb +0 -134
  528. data/lib/stripe/resources/v2/money_management/received_debit.rb +0 -106
  529. data/lib/stripe/resources/v2/money_management/transaction.rb +0 -76
  530. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +0 -66
  531. data/lib/stripe/services/account_notice_service.rb +0 -101
  532. data/lib/stripe/services/balance_settings_service.rb +0 -96
  533. data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
  534. data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
  535. data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
  536. data/lib/stripe/services/capital_service.rb +0 -15
  537. data/lib/stripe/services/external_account_service.rb +0 -206
  538. data/lib/stripe/services/gift_cards/card_service.rb +0 -170
  539. data/lib/stripe/services/gift_cards/transaction_service.rb +0 -209
  540. data/lib/stripe/services/gift_cards_service.rb +0 -14
  541. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
  542. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
  543. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
  544. data/lib/stripe/services/margin_service.rb +0 -119
  545. data/lib/stripe/services/order_service.rb +0 -2268
  546. data/lib/stripe/services/payment_attempt_record_service.rb +0 -49
  547. data/lib/stripe/services/payment_record_service.rb +0 -542
  548. data/lib/stripe/services/tax/association_service.rb +0 -31
  549. data/lib/stripe/services/tax/form_service.rb +0 -100
  550. data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
  551. data/lib/stripe/services/v2/core/account_link_service.rb +0 -76
  552. data/lib/stripe/services/v2/core/account_service.rb +0 -4130
  553. data/lib/stripe/services/v2/core/accounts/person_service.rb +0 -1040
  554. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +0 -135
  555. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +0 -109
  556. data/lib/stripe/services/v2/core/vault_service.rb +0 -18
  557. data/lib/stripe/services/v2/money_management/adjustment_service.rb +0 -75
  558. data/lib/stripe/services/v2/money_management/financial_account_service.rb +0 -44
  559. data/lib/stripe/services/v2/money_management/financial_address_service.rb +0 -81
  560. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +0 -126
  561. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +0 -80
  562. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +0 -202
  563. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +0 -237
  564. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +0 -174
  565. data/lib/stripe/services/v2/money_management/payout_method_service.rb +0 -95
  566. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +0 -32
  567. data/lib/stripe/services/v2/money_management/received_credit_service.rb +0 -71
  568. data/lib/stripe/services/v2/money_management/received_debit_service.rb +0 -44
  569. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +0 -70
  570. data/lib/stripe/services/v2/money_management/transaction_service.rb +0 -74
  571. data/lib/stripe/services/v2/money_management_service.rb +0 -31
  572. data/lib/stripe/services/v2/test_helper_service.rb +0 -15
  573. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +0 -50
  574. data/rbi/stripe.rbi +0 -189274
@@ -83,8 +83,6 @@ module Stripe
83
83
  attr_accessor :created
84
84
  # Only return subscription schedules for the given customer.
85
85
  attr_accessor :customer
86
- # Only return subscription schedules for the given account.
87
- attr_accessor :customer_account
88
86
  # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
89
87
  attr_accessor :ending_before
90
88
  # Specifies which fields in the response should be expanded.
@@ -103,7 +101,6 @@ module Stripe
103
101
  completed_at: nil,
104
102
  created: nil,
105
103
  customer: nil,
106
- customer_account: nil,
107
104
  ending_before: nil,
108
105
  expand: nil,
109
106
  limit: nil,
@@ -115,7 +112,6 @@ module Stripe
115
112
  @completed_at = completed_at
116
113
  @created = created
117
114
  @customer = customer
118
- @customer_account = customer_account
119
115
  @ending_before = ending_before
120
116
  @expand = expand
121
117
  @limit = limit
@@ -232,44 +228,16 @@ module Stripe
232
228
  class Phase < Stripe::RequestParams
233
229
  class AddInvoiceItem < Stripe::RequestParams
234
230
  class Discount < Stripe::RequestParams
235
- class DiscountEnd < Stripe::RequestParams
236
- class Duration < Stripe::RequestParams
237
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
238
- attr_accessor :interval
239
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
240
- attr_accessor :interval_count
241
-
242
- def initialize(interval: nil, interval_count: nil)
243
- @interval = interval
244
- @interval_count = interval_count
245
- end
246
- end
247
- # Time span for the redeemed discount.
248
- attr_accessor :duration
249
- # A precise Unix timestamp for the discount to end. Must be in the future.
250
- attr_accessor :timestamp
251
- # The type of calculation made to determine when the discount ends.
252
- attr_accessor :type
253
-
254
- def initialize(duration: nil, timestamp: nil, type: nil)
255
- @duration = duration
256
- @timestamp = timestamp
257
- @type = type
258
- end
259
- end
260
231
  # ID of the coupon to create a new discount for.
261
232
  attr_accessor :coupon
262
233
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
263
234
  attr_accessor :discount
264
- # Details to determine how long the discount should be applied for.
265
- attr_accessor :discount_end
266
235
  # ID of the promotion code to create a new discount for.
267
236
  attr_accessor :promotion_code
268
237
 
269
- def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
238
+ def initialize(coupon: nil, discount: nil, promotion_code: nil)
270
239
  @coupon = coupon
271
240
  @discount = discount
272
- @discount_end = discount_end
273
241
  @promotion_code = promotion_code
274
242
  end
275
243
  end
@@ -344,44 +312,16 @@ module Stripe
344
312
  end
345
313
 
346
314
  class Discount < Stripe::RequestParams
347
- class DiscountEnd < Stripe::RequestParams
348
- class Duration < Stripe::RequestParams
349
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
350
- attr_accessor :interval
351
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
352
- attr_accessor :interval_count
353
-
354
- def initialize(interval: nil, interval_count: nil)
355
- @interval = interval
356
- @interval_count = interval_count
357
- end
358
- end
359
- # Time span for the redeemed discount.
360
- attr_accessor :duration
361
- # A precise Unix timestamp for the discount to end. Must be in the future.
362
- attr_accessor :timestamp
363
- # The type of calculation made to determine when the discount ends.
364
- attr_accessor :type
365
-
366
- def initialize(duration: nil, timestamp: nil, type: nil)
367
- @duration = duration
368
- @timestamp = timestamp
369
- @type = type
370
- end
371
- end
372
315
  # ID of the coupon to create a new discount for.
373
316
  attr_accessor :coupon
374
317
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
375
318
  attr_accessor :discount
376
- # Details to determine how long the discount should be applied for.
377
- attr_accessor :discount_end
378
319
  # ID of the promotion code to create a new discount for.
379
320
  attr_accessor :promotion_code
380
321
 
381
- def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
322
+ def initialize(coupon: nil, discount: nil, promotion_code: nil)
382
323
  @coupon = coupon
383
324
  @discount = discount
384
- @discount_end = discount_end
385
325
  @promotion_code = promotion_code
386
326
  end
387
327
  end
@@ -414,44 +354,16 @@ module Stripe
414
354
 
415
355
  class Item < Stripe::RequestParams
416
356
  class Discount < Stripe::RequestParams
417
- class DiscountEnd < Stripe::RequestParams
418
- class Duration < Stripe::RequestParams
419
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
420
- attr_accessor :interval
421
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
422
- attr_accessor :interval_count
423
-
424
- def initialize(interval: nil, interval_count: nil)
425
- @interval = interval
426
- @interval_count = interval_count
427
- end
428
- end
429
- # Time span for the redeemed discount.
430
- attr_accessor :duration
431
- # A precise Unix timestamp for the discount to end. Must be in the future.
432
- attr_accessor :timestamp
433
- # The type of calculation made to determine when the discount ends.
434
- attr_accessor :type
435
-
436
- def initialize(duration: nil, timestamp: nil, type: nil)
437
- @duration = duration
438
- @timestamp = timestamp
439
- @type = type
440
- end
441
- end
442
357
  # ID of the coupon to create a new discount for.
443
358
  attr_accessor :coupon
444
359
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
445
360
  attr_accessor :discount
446
- # Details to determine how long the discount should be applied for.
447
- attr_accessor :discount_end
448
361
  # ID of the promotion code to create a new discount for.
449
362
  attr_accessor :promotion_code
450
363
 
451
- def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
364
+ def initialize(coupon: nil, discount: nil, promotion_code: nil)
452
365
  @coupon = coupon
453
366
  @discount = discount
454
- @discount_end = discount_end
455
367
  @promotion_code = promotion_code
456
368
  end
457
369
  end
@@ -497,18 +409,6 @@ module Stripe
497
409
  @unit_amount_decimal = unit_amount_decimal
498
410
  end
499
411
  end
500
-
501
- class Trial < Stripe::RequestParams
502
- # 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.
503
- attr_accessor :converts_to
504
- # Determines the type of trial for this item.
505
- attr_accessor :type
506
-
507
- def initialize(converts_to: nil, type: nil)
508
- @converts_to = converts_to
509
- @type = type
510
- end
511
- end
512
412
  # The coupons to redeem into discounts for the subscription item.
513
413
  attr_accessor :discounts
514
414
  # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
@@ -523,8 +423,6 @@ module Stripe
523
423
  attr_accessor :quantity
524
424
  # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
525
425
  attr_accessor :tax_rates
526
- # Options that configure the trial on the subscription item.
527
- attr_accessor :trial
528
426
 
529
427
  def initialize(
530
428
  discounts: nil,
@@ -533,8 +431,7 @@ module Stripe
533
431
  price: nil,
534
432
  price_data: nil,
535
433
  quantity: nil,
536
- tax_rates: nil,
537
- trial: nil
434
+ tax_rates: nil
538
435
  )
539
436
  @discounts = discounts
540
437
  @metadata = metadata
@@ -543,16 +440,6 @@ module Stripe
543
440
  @price_data = price_data
544
441
  @quantity = quantity
545
442
  @tax_rates = tax_rates
546
- @trial = trial
547
- end
548
- end
549
-
550
- class PauseCollection < Stripe::RequestParams
551
- # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
552
- attr_accessor :behavior
553
-
554
- def initialize(behavior: nil)
555
- @behavior = behavior
556
443
  end
557
444
  end
558
445
 
@@ -567,23 +454,6 @@ module Stripe
567
454
  @destination = destination
568
455
  end
569
456
  end
570
-
571
- class TrialSettings < Stripe::RequestParams
572
- class EndBehavior < Stripe::RequestParams
573
- # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
574
- attr_accessor :prorate_up_front
575
-
576
- def initialize(prorate_up_front: nil)
577
- @prorate_up_front = prorate_up_front
578
- end
579
- end
580
- # Defines how the subscription should behave when a trial ends.
581
- attr_accessor :end_behavior
582
-
583
- def initialize(end_behavior: nil)
584
- @end_behavior = end_behavior
585
- end
586
- end
587
457
  # A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
588
458
  attr_accessor :add_invoice_items
589
459
  # 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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
@@ -616,20 +486,14 @@ module Stripe
616
486
  attr_accessor :metadata
617
487
  # The account on behalf of which to charge, for each of the associated subscription's invoices.
618
488
  attr_accessor :on_behalf_of
619
- # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
620
- attr_accessor :pause_collection
621
489
  # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.
622
490
  attr_accessor :proration_behavior
623
491
  # The data with which to automatically create a Transfer for each of the associated subscription's invoices.
624
492
  attr_accessor :transfer_data
625
493
  # If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
626
494
  attr_accessor :trial
627
- # Specify trial behavior when crossing phase boundaries
628
- attr_accessor :trial_continuation
629
495
  # Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
630
496
  attr_accessor :trial_end
631
- # Settings related to subscription trials.
632
- attr_accessor :trial_settings
633
497
 
634
498
  def initialize(
635
499
  add_invoice_items: nil,
@@ -648,13 +512,10 @@ module Stripe
648
512
  iterations: nil,
649
513
  metadata: nil,
650
514
  on_behalf_of: nil,
651
- pause_collection: nil,
652
515
  proration_behavior: nil,
653
516
  transfer_data: nil,
654
517
  trial: nil,
655
- trial_continuation: nil,
656
- trial_end: nil,
657
- trial_settings: nil
518
+ trial_end: nil
658
519
  )
659
520
  @add_invoice_items = add_invoice_items
660
521
  @application_fee_percent = application_fee_percent
@@ -672,33 +533,14 @@ module Stripe
672
533
  @iterations = iterations
673
534
  @metadata = metadata
674
535
  @on_behalf_of = on_behalf_of
675
- @pause_collection = pause_collection
676
536
  @proration_behavior = proration_behavior
677
537
  @transfer_data = transfer_data
678
538
  @trial = trial
679
- @trial_continuation = trial_continuation
680
539
  @trial_end = trial_end
681
- @trial_settings = trial_settings
682
- end
683
- end
684
-
685
- class Prebilling < Stripe::RequestParams
686
- # This is used to determine the number of billing cycles to prebill.
687
- attr_accessor :iterations
688
- # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
689
- attr_accessor :update_behavior
690
-
691
- def initialize(iterations: nil, update_behavior: nil)
692
- @iterations = iterations
693
- @update_behavior = update_behavior
694
540
  end
695
541
  end
696
- # 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.
697
- attr_accessor :billing_behavior
698
542
  # The identifier of the customer to create the subscription schedule for.
699
543
  attr_accessor :customer
700
- # The identifier of the account to create the subscription schedule for.
701
- attr_accessor :customer_account
702
544
  # Object representing the subscription schedule's default settings.
703
545
  attr_accessor :default_settings
704
546
  # Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
@@ -711,34 +553,26 @@ module Stripe
711
553
  attr_accessor :metadata
712
554
  # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
713
555
  attr_accessor :phases
714
- # If specified, the invoicing for the given billing cycle iterations will be processed now.
715
- attr_accessor :prebilling
716
556
  # When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
717
557
  attr_accessor :start_date
718
558
 
719
559
  def initialize(
720
- billing_behavior: nil,
721
560
  customer: nil,
722
- customer_account: nil,
723
561
  default_settings: nil,
724
562
  end_behavior: nil,
725
563
  expand: nil,
726
564
  from_subscription: nil,
727
565
  metadata: nil,
728
566
  phases: nil,
729
- prebilling: nil,
730
567
  start_date: nil
731
568
  )
732
- @billing_behavior = billing_behavior
733
569
  @customer = customer
734
- @customer_account = customer_account
735
570
  @default_settings = default_settings
736
571
  @end_behavior = end_behavior
737
572
  @expand = expand
738
573
  @from_subscription = from_subscription
739
574
  @metadata = metadata
740
575
  @phases = phases
741
- @prebilling = prebilling
742
576
  @start_date = start_date
743
577
  end
744
578
  end
@@ -859,44 +693,16 @@ module Stripe
859
693
  class Phase < Stripe::RequestParams
860
694
  class AddInvoiceItem < Stripe::RequestParams
861
695
  class Discount < Stripe::RequestParams
862
- class DiscountEnd < Stripe::RequestParams
863
- class Duration < Stripe::RequestParams
864
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
865
- attr_accessor :interval
866
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
867
- attr_accessor :interval_count
868
-
869
- def initialize(interval: nil, interval_count: nil)
870
- @interval = interval
871
- @interval_count = interval_count
872
- end
873
- end
874
- # Time span for the redeemed discount.
875
- attr_accessor :duration
876
- # A precise Unix timestamp for the discount to end. Must be in the future.
877
- attr_accessor :timestamp
878
- # The type of calculation made to determine when the discount ends.
879
- attr_accessor :type
880
-
881
- def initialize(duration: nil, timestamp: nil, type: nil)
882
- @duration = duration
883
- @timestamp = timestamp
884
- @type = type
885
- end
886
- end
887
696
  # ID of the coupon to create a new discount for.
888
697
  attr_accessor :coupon
889
698
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
890
699
  attr_accessor :discount
891
- # Details to determine how long the discount should be applied for.
892
- attr_accessor :discount_end
893
700
  # ID of the promotion code to create a new discount for.
894
701
  attr_accessor :promotion_code
895
702
 
896
- def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
703
+ def initialize(coupon: nil, discount: nil, promotion_code: nil)
897
704
  @coupon = coupon
898
705
  @discount = discount
899
- @discount_end = discount_end
900
706
  @promotion_code = promotion_code
901
707
  end
902
708
  end
@@ -971,44 +777,16 @@ module Stripe
971
777
  end
972
778
 
973
779
  class Discount < Stripe::RequestParams
974
- class DiscountEnd < Stripe::RequestParams
975
- class Duration < Stripe::RequestParams
976
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
977
- attr_accessor :interval
978
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
979
- attr_accessor :interval_count
980
-
981
- def initialize(interval: nil, interval_count: nil)
982
- @interval = interval
983
- @interval_count = interval_count
984
- end
985
- end
986
- # Time span for the redeemed discount.
987
- attr_accessor :duration
988
- # A precise Unix timestamp for the discount to end. Must be in the future.
989
- attr_accessor :timestamp
990
- # The type of calculation made to determine when the discount ends.
991
- attr_accessor :type
992
-
993
- def initialize(duration: nil, timestamp: nil, type: nil)
994
- @duration = duration
995
- @timestamp = timestamp
996
- @type = type
997
- end
998
- end
999
780
  # ID of the coupon to create a new discount for.
1000
781
  attr_accessor :coupon
1001
782
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
1002
783
  attr_accessor :discount
1003
- # Details to determine how long the discount should be applied for.
1004
- attr_accessor :discount_end
1005
784
  # ID of the promotion code to create a new discount for.
1006
785
  attr_accessor :promotion_code
1007
786
 
1008
- def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
787
+ def initialize(coupon: nil, discount: nil, promotion_code: nil)
1009
788
  @coupon = coupon
1010
789
  @discount = discount
1011
- @discount_end = discount_end
1012
790
  @promotion_code = promotion_code
1013
791
  end
1014
792
  end
@@ -1041,44 +819,16 @@ module Stripe
1041
819
 
1042
820
  class Item < Stripe::RequestParams
1043
821
  class Discount < Stripe::RequestParams
1044
- class DiscountEnd < Stripe::RequestParams
1045
- class Duration < Stripe::RequestParams
1046
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1047
- attr_accessor :interval
1048
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1049
- attr_accessor :interval_count
1050
-
1051
- def initialize(interval: nil, interval_count: nil)
1052
- @interval = interval
1053
- @interval_count = interval_count
1054
- end
1055
- end
1056
- # Time span for the redeemed discount.
1057
- attr_accessor :duration
1058
- # A precise Unix timestamp for the discount to end. Must be in the future.
1059
- attr_accessor :timestamp
1060
- # The type of calculation made to determine when the discount ends.
1061
- attr_accessor :type
1062
-
1063
- def initialize(duration: nil, timestamp: nil, type: nil)
1064
- @duration = duration
1065
- @timestamp = timestamp
1066
- @type = type
1067
- end
1068
- end
1069
822
  # ID of the coupon to create a new discount for.
1070
823
  attr_accessor :coupon
1071
824
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
1072
825
  attr_accessor :discount
1073
- # Details to determine how long the discount should be applied for.
1074
- attr_accessor :discount_end
1075
826
  # ID of the promotion code to create a new discount for.
1076
827
  attr_accessor :promotion_code
1077
828
 
1078
- def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
829
+ def initialize(coupon: nil, discount: nil, promotion_code: nil)
1079
830
  @coupon = coupon
1080
831
  @discount = discount
1081
- @discount_end = discount_end
1082
832
  @promotion_code = promotion_code
1083
833
  end
1084
834
  end
@@ -1124,18 +874,6 @@ module Stripe
1124
874
  @unit_amount_decimal = unit_amount_decimal
1125
875
  end
1126
876
  end
1127
-
1128
- class Trial < Stripe::RequestParams
1129
- # 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.
1130
- attr_accessor :converts_to
1131
- # Determines the type of trial for this item.
1132
- attr_accessor :type
1133
-
1134
- def initialize(converts_to: nil, type: nil)
1135
- @converts_to = converts_to
1136
- @type = type
1137
- end
1138
- end
1139
877
  # The coupons to redeem into discounts for the subscription item.
1140
878
  attr_accessor :discounts
1141
879
  # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
@@ -1150,8 +888,6 @@ module Stripe
1150
888
  attr_accessor :quantity
1151
889
  # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
1152
890
  attr_accessor :tax_rates
1153
- # Options that configure the trial on the subscription item.
1154
- attr_accessor :trial
1155
891
 
1156
892
  def initialize(
1157
893
  discounts: nil,
@@ -1160,8 +896,7 @@ module Stripe
1160
896
  price: nil,
1161
897
  price_data: nil,
1162
898
  quantity: nil,
1163
- tax_rates: nil,
1164
- trial: nil
899
+ tax_rates: nil
1165
900
  )
1166
901
  @discounts = discounts
1167
902
  @metadata = metadata
@@ -1170,16 +905,6 @@ module Stripe
1170
905
  @price_data = price_data
1171
906
  @quantity = quantity
1172
907
  @tax_rates = tax_rates
1173
- @trial = trial
1174
- end
1175
- end
1176
-
1177
- class PauseCollection < Stripe::RequestParams
1178
- # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
1179
- attr_accessor :behavior
1180
-
1181
- def initialize(behavior: nil)
1182
- @behavior = behavior
1183
908
  end
1184
909
  end
1185
910
 
@@ -1194,23 +919,6 @@ module Stripe
1194
919
  @destination = destination
1195
920
  end
1196
921
  end
1197
-
1198
- class TrialSettings < Stripe::RequestParams
1199
- class EndBehavior < Stripe::RequestParams
1200
- # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
1201
- attr_accessor :prorate_up_front
1202
-
1203
- def initialize(prorate_up_front: nil)
1204
- @prorate_up_front = prorate_up_front
1205
- end
1206
- end
1207
- # Defines how the subscription should behave when a trial ends.
1208
- attr_accessor :end_behavior
1209
-
1210
- def initialize(end_behavior: nil)
1211
- @end_behavior = end_behavior
1212
- end
1213
- end
1214
922
  # A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
1215
923
  attr_accessor :add_invoice_items
1216
924
  # 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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
@@ -1243,8 +951,6 @@ module Stripe
1243
951
  attr_accessor :metadata
1244
952
  # The account on behalf of which to charge, for each of the associated subscription's invoices.
1245
953
  attr_accessor :on_behalf_of
1246
- # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
1247
- attr_accessor :pause_collection
1248
954
  # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.
1249
955
  attr_accessor :proration_behavior
1250
956
  # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
@@ -1253,12 +959,8 @@ module Stripe
1253
959
  attr_accessor :transfer_data
1254
960
  # If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
1255
961
  attr_accessor :trial
1256
- # Specify trial behavior when crossing phase boundaries
1257
- attr_accessor :trial_continuation
1258
962
  # Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
1259
963
  attr_accessor :trial_end
1260
- # Settings related to subscription trials.
1261
- attr_accessor :trial_settings
1262
964
 
1263
965
  def initialize(
1264
966
  add_invoice_items: nil,
@@ -1277,14 +979,11 @@ module Stripe
1277
979
  iterations: nil,
1278
980
  metadata: nil,
1279
981
  on_behalf_of: nil,
1280
- pause_collection: nil,
1281
982
  proration_behavior: nil,
1282
983
  start_date: nil,
1283
984
  transfer_data: nil,
1284
985
  trial: nil,
1285
- trial_continuation: nil,
1286
- trial_end: nil,
1287
- trial_settings: nil
986
+ trial_end: nil
1288
987
  )
1289
988
  @add_invoice_items = add_invoice_items
1290
989
  @application_fee_percent = application_fee_percent
@@ -1302,30 +1001,13 @@ module Stripe
1302
1001
  @iterations = iterations
1303
1002
  @metadata = metadata
1304
1003
  @on_behalf_of = on_behalf_of
1305
- @pause_collection = pause_collection
1306
1004
  @proration_behavior = proration_behavior
1307
1005
  @start_date = start_date
1308
1006
  @transfer_data = transfer_data
1309
1007
  @trial = trial
1310
- @trial_continuation = trial_continuation
1311
1008
  @trial_end = trial_end
1312
- @trial_settings = trial_settings
1313
- end
1314
- end
1315
-
1316
- class Prebilling < Stripe::RequestParams
1317
- # This is used to determine the number of billing cycles to prebill.
1318
- attr_accessor :iterations
1319
- # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
1320
- attr_accessor :update_behavior
1321
-
1322
- def initialize(iterations: nil, update_behavior: nil)
1323
- @iterations = iterations
1324
- @update_behavior = update_behavior
1325
1009
  end
1326
1010
  end
1327
- # 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.
1328
- attr_accessor :billing_behavior
1329
1011
  # Object representing the subscription schedule's default settings.
1330
1012
  attr_accessor :default_settings
1331
1013
  # Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
@@ -1336,598 +1018,26 @@ module Stripe
1336
1018
  attr_accessor :metadata
1337
1019
  # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted.
1338
1020
  attr_accessor :phases
1339
- # If specified, the invoicing for the given billing cycle iterations will be processed now.
1340
- attr_accessor :prebilling
1341
1021
  # If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.
1342
1022
  attr_accessor :proration_behavior
1343
1023
 
1344
1024
  def initialize(
1345
- billing_behavior: nil,
1346
1025
  default_settings: nil,
1347
1026
  end_behavior: nil,
1348
1027
  expand: nil,
1349
1028
  metadata: nil,
1350
1029
  phases: nil,
1351
- prebilling: nil,
1352
1030
  proration_behavior: nil
1353
1031
  )
1354
- @billing_behavior = billing_behavior
1355
1032
  @default_settings = default_settings
1356
1033
  @end_behavior = end_behavior
1357
1034
  @expand = expand
1358
1035
  @metadata = metadata
1359
1036
  @phases = phases
1360
- @prebilling = prebilling
1361
1037
  @proration_behavior = proration_behavior
1362
1038
  end
1363
1039
  end
1364
1040
 
1365
- class AmendParams < Stripe::RequestParams
1366
- class Amendment < Stripe::RequestParams
1367
- class AmendmentEnd < Stripe::RequestParams
1368
- class DiscountEnd < Stripe::RequestParams
1369
- # The ID of a specific discount.
1370
- attr_accessor :discount
1371
-
1372
- def initialize(discount: nil)
1373
- @discount = discount
1374
- end
1375
- end
1376
-
1377
- class Duration < Stripe::RequestParams
1378
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1379
- attr_accessor :interval
1380
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1381
- attr_accessor :interval_count
1382
-
1383
- def initialize(interval: nil, interval_count: nil)
1384
- @interval = interval
1385
- @interval_count = interval_count
1386
- end
1387
- end
1388
- # Use the `end` time of a given discount.
1389
- attr_accessor :discount_end
1390
- # Time span for the amendment starting from the `amendment_start`.
1391
- attr_accessor :duration
1392
- # A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
1393
- attr_accessor :timestamp
1394
- # Select one of three ways to pass the `amendment_end`.
1395
- attr_accessor :type
1396
-
1397
- def initialize(discount_end: nil, duration: nil, timestamp: nil, type: nil)
1398
- @discount_end = discount_end
1399
- @duration = duration
1400
- @timestamp = timestamp
1401
- @type = type
1402
- end
1403
- end
1404
-
1405
- class AmendmentStart < Stripe::RequestParams
1406
- class AmendmentEnd < Stripe::RequestParams
1407
- # The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.
1408
- attr_accessor :index
1409
-
1410
- def initialize(index: nil)
1411
- @index = index
1412
- end
1413
- end
1414
-
1415
- class DiscountEnd < Stripe::RequestParams
1416
- # The ID of a specific discount.
1417
- attr_accessor :discount
1418
-
1419
- def initialize(discount: nil)
1420
- @discount = discount
1421
- end
1422
- end
1423
- # Details of another amendment in the same array, immediately after which this amendment should begin.
1424
- attr_accessor :amendment_end
1425
- # Use the `end` time of a given discount.
1426
- attr_accessor :discount_end
1427
- # A precise Unix timestamp for the amendment to start.
1428
- attr_accessor :timestamp
1429
- # Select one of three ways to pass the `amendment_start`.
1430
- attr_accessor :type
1431
-
1432
- def initialize(amendment_end: nil, discount_end: nil, timestamp: nil, type: nil)
1433
- @amendment_end = amendment_end
1434
- @discount_end = discount_end
1435
- @timestamp = timestamp
1436
- @type = type
1437
- end
1438
- end
1439
-
1440
- class DiscountAction < Stripe::RequestParams
1441
- class Add < Stripe::RequestParams
1442
- class DiscountEnd < Stripe::RequestParams
1443
- # The type of calculation made to determine when the discount ends.
1444
- attr_accessor :type
1445
-
1446
- def initialize(type: nil)
1447
- @type = type
1448
- end
1449
- end
1450
- # The coupon code to redeem.
1451
- attr_accessor :coupon
1452
- # An ID of an existing discount for a coupon that was already redeemed.
1453
- attr_accessor :discount
1454
- # Details to determine how long the discount should be applied for.
1455
- attr_accessor :discount_end
1456
- # 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.
1457
- attr_accessor :index
1458
- # The promotion code to redeem.
1459
- attr_accessor :promotion_code
1460
-
1461
- def initialize(
1462
- coupon: nil,
1463
- discount: nil,
1464
- discount_end: nil,
1465
- index: nil,
1466
- promotion_code: nil
1467
- )
1468
- @coupon = coupon
1469
- @discount = discount
1470
- @discount_end = discount_end
1471
- @index = index
1472
- @promotion_code = promotion_code
1473
- end
1474
- end
1475
-
1476
- class Remove < Stripe::RequestParams
1477
- # The coupon code to remove from the `discounts` array.
1478
- attr_accessor :coupon
1479
- # The ID of a discount to remove from the `discounts` array.
1480
- attr_accessor :discount
1481
- # The ID of a promotion code to remove from the `discounts` array.
1482
- attr_accessor :promotion_code
1483
-
1484
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
1485
- @coupon = coupon
1486
- @discount = discount
1487
- @promotion_code = promotion_code
1488
- end
1489
- end
1490
-
1491
- class Set < Stripe::RequestParams
1492
- # The coupon code to replace the `discounts` array with.
1493
- attr_accessor :coupon
1494
- # An ID of an existing discount to replace the `discounts` array with.
1495
- attr_accessor :discount
1496
- # An ID of an existing promotion code to replace the `discounts` array with.
1497
- attr_accessor :promotion_code
1498
-
1499
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
1500
- @coupon = coupon
1501
- @discount = discount
1502
- @promotion_code = promotion_code
1503
- end
1504
- end
1505
- # Details of the discount to add.
1506
- attr_accessor :add
1507
- # Details of the discount to remove.
1508
- attr_accessor :remove
1509
- # Details of the discount to replace the existing discounts with.
1510
- attr_accessor :set
1511
- # Determines the type of discount action.
1512
- attr_accessor :type
1513
-
1514
- def initialize(add: nil, remove: nil, set: nil, type: nil)
1515
- @add = add
1516
- @remove = remove
1517
- @set = set
1518
- @type = type
1519
- end
1520
- end
1521
-
1522
- class ItemAction < Stripe::RequestParams
1523
- class Add < Stripe::RequestParams
1524
- class Discount < Stripe::RequestParams
1525
- class DiscountEnd < Stripe::RequestParams
1526
- class Duration < Stripe::RequestParams
1527
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1528
- attr_accessor :interval
1529
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1530
- attr_accessor :interval_count
1531
-
1532
- def initialize(interval: nil, interval_count: nil)
1533
- @interval = interval
1534
- @interval_count = interval_count
1535
- end
1536
- end
1537
- # Time span for the redeemed discount.
1538
- attr_accessor :duration
1539
- # A precise Unix timestamp for the discount to end. Must be in the future.
1540
- attr_accessor :timestamp
1541
- # The type of calculation made to determine when the discount ends.
1542
- attr_accessor :type
1543
-
1544
- def initialize(duration: nil, timestamp: nil, type: nil)
1545
- @duration = duration
1546
- @timestamp = timestamp
1547
- @type = type
1548
- end
1549
- end
1550
- # ID of the coupon to create a new discount for.
1551
- attr_accessor :coupon
1552
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
1553
- attr_accessor :discount
1554
- # Details to determine how long the discount should be applied for.
1555
- attr_accessor :discount_end
1556
- # ID of the promotion code to create a new discount for.
1557
- attr_accessor :promotion_code
1558
-
1559
- def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
1560
- @coupon = coupon
1561
- @discount = discount
1562
- @discount_end = discount_end
1563
- @promotion_code = promotion_code
1564
- end
1565
- end
1566
-
1567
- class Trial < Stripe::RequestParams
1568
- # 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.
1569
- attr_accessor :converts_to
1570
- # Determines the type of trial for this item.
1571
- attr_accessor :type
1572
-
1573
- def initialize(converts_to: nil, type: nil)
1574
- @converts_to = converts_to
1575
- @type = type
1576
- end
1577
- end
1578
- # The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
1579
- attr_accessor :discounts
1580
- # 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`.
1581
- attr_accessor :metadata
1582
- # The ID of the price object.
1583
- attr_accessor :price
1584
- # Quantity for this item.
1585
- attr_accessor :quantity
1586
- # 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`.
1587
- attr_accessor :tax_rates
1588
- # Options that configure the trial on the subscription item.
1589
- attr_accessor :trial
1590
-
1591
- def initialize(
1592
- discounts: nil,
1593
- metadata: nil,
1594
- price: nil,
1595
- quantity: nil,
1596
- tax_rates: nil,
1597
- trial: nil
1598
- )
1599
- @discounts = discounts
1600
- @metadata = metadata
1601
- @price = price
1602
- @quantity = quantity
1603
- @tax_rates = tax_rates
1604
- @trial = trial
1605
- end
1606
- end
1607
-
1608
- class Remove < Stripe::RequestParams
1609
- # ID of a price to remove.
1610
- attr_accessor :price
1611
-
1612
- def initialize(price: nil)
1613
- @price = price
1614
- end
1615
- end
1616
-
1617
- class Set < Stripe::RequestParams
1618
- class Discount < Stripe::RequestParams
1619
- class DiscountEnd < Stripe::RequestParams
1620
- class Duration < Stripe::RequestParams
1621
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1622
- attr_accessor :interval
1623
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1624
- attr_accessor :interval_count
1625
-
1626
- def initialize(interval: nil, interval_count: nil)
1627
- @interval = interval
1628
- @interval_count = interval_count
1629
- end
1630
- end
1631
- # Time span for the redeemed discount.
1632
- attr_accessor :duration
1633
- # A precise Unix timestamp for the discount to end. Must be in the future.
1634
- attr_accessor :timestamp
1635
- # The type of calculation made to determine when the discount ends.
1636
- attr_accessor :type
1637
-
1638
- def initialize(duration: nil, timestamp: nil, type: nil)
1639
- @duration = duration
1640
- @timestamp = timestamp
1641
- @type = type
1642
- end
1643
- end
1644
- # ID of the coupon to create a new discount for.
1645
- attr_accessor :coupon
1646
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
1647
- attr_accessor :discount
1648
- # Details to determine how long the discount should be applied for.
1649
- attr_accessor :discount_end
1650
- # ID of the promotion code to create a new discount for.
1651
- attr_accessor :promotion_code
1652
-
1653
- def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
1654
- @coupon = coupon
1655
- @discount = discount
1656
- @discount_end = discount_end
1657
- @promotion_code = promotion_code
1658
- end
1659
- end
1660
-
1661
- class Trial < Stripe::RequestParams
1662
- # 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.
1663
- attr_accessor :converts_to
1664
- # Determines the type of trial for this item.
1665
- attr_accessor :type
1666
-
1667
- def initialize(converts_to: nil, type: nil)
1668
- @converts_to = converts_to
1669
- @type = type
1670
- end
1671
- end
1672
- # 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`.
1673
- attr_accessor :discounts
1674
- # 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`.
1675
- attr_accessor :metadata
1676
- # The ID of the price object.
1677
- attr_accessor :price
1678
- # 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`.
1679
- attr_accessor :quantity
1680
- # 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`.
1681
- attr_accessor :tax_rates
1682
- # 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`.
1683
- attr_accessor :trial
1684
-
1685
- def initialize(
1686
- discounts: nil,
1687
- metadata: nil,
1688
- price: nil,
1689
- quantity: nil,
1690
- tax_rates: nil,
1691
- trial: nil
1692
- )
1693
- @discounts = discounts
1694
- @metadata = metadata
1695
- @price = price
1696
- @quantity = quantity
1697
- @tax_rates = tax_rates
1698
- @trial = trial
1699
- end
1700
- end
1701
- # Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.
1702
- attr_accessor :add
1703
- # Details of the subscription item to remove.
1704
- attr_accessor :remove
1705
- # Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.
1706
- attr_accessor :set
1707
- # Determines the type of item action.
1708
- attr_accessor :type
1709
-
1710
- def initialize(add: nil, remove: nil, set: nil, type: nil)
1711
- @add = add
1712
- @remove = remove
1713
- @set = set
1714
- @type = type
1715
- end
1716
- end
1717
-
1718
- class MetadataAction < Stripe::RequestParams
1719
- # Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
1720
- attr_accessor :add
1721
- # Keys to remove from schedule phase metadata.
1722
- attr_accessor :remove
1723
- # Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
1724
- attr_accessor :set
1725
- # Select one of three ways to update phase-level `metadata` on subscription schedules.
1726
- attr_accessor :type
1727
-
1728
- def initialize(add: nil, remove: nil, set: nil, type: nil)
1729
- @add = add
1730
- @remove = remove
1731
- @set = set
1732
- @type = type
1733
- end
1734
- end
1735
-
1736
- class SetPauseCollection < Stripe::RequestParams
1737
- class Set < Stripe::RequestParams
1738
- # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
1739
- attr_accessor :behavior
1740
-
1741
- def initialize(behavior: nil)
1742
- @behavior = behavior
1743
- end
1744
- end
1745
- # Details of the pause_collection behavior to apply to the amendment.
1746
- attr_accessor :set
1747
- # Determines the type of the pause_collection amendment.
1748
- attr_accessor :type
1749
-
1750
- def initialize(set: nil, type: nil)
1751
- @set = set
1752
- @type = type
1753
- end
1754
- end
1755
-
1756
- class TrialSettings < Stripe::RequestParams
1757
- class EndBehavior < Stripe::RequestParams
1758
- # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
1759
- attr_accessor :prorate_up_front
1760
-
1761
- def initialize(prorate_up_front: nil)
1762
- @prorate_up_front = prorate_up_front
1763
- end
1764
- end
1765
- # Defines how the subscription should behave when a trial ends.
1766
- attr_accessor :end_behavior
1767
-
1768
- def initialize(end_behavior: nil)
1769
- @end_behavior = end_behavior
1770
- end
1771
- end
1772
- # Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.
1773
- attr_accessor :amendment_end
1774
- # Details to identify the earliest timestamp where the proposed change should take effect.
1775
- attr_accessor :amendment_start
1776
- # For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
1777
- attr_accessor :billing_cycle_anchor
1778
- # Changes to the coupons being redeemed or discounts being applied during the amendment time span.
1779
- attr_accessor :discount_actions
1780
- # Changes to the subscription items during the amendment time span.
1781
- attr_accessor :item_actions
1782
- # Instructions for how to modify phase metadata
1783
- attr_accessor :metadata_actions
1784
- # Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.
1785
- attr_accessor :proration_behavior
1786
- # Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
1787
- attr_accessor :set_pause_collection
1788
- # Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
1789
- attr_accessor :set_schedule_end
1790
- # Settings related to subscription trials.
1791
- attr_accessor :trial_settings
1792
-
1793
- def initialize(
1794
- amendment_end: nil,
1795
- amendment_start: nil,
1796
- billing_cycle_anchor: nil,
1797
- discount_actions: nil,
1798
- item_actions: nil,
1799
- metadata_actions: nil,
1800
- proration_behavior: nil,
1801
- set_pause_collection: nil,
1802
- set_schedule_end: nil,
1803
- trial_settings: nil
1804
- )
1805
- @amendment_end = amendment_end
1806
- @amendment_start = amendment_start
1807
- @billing_cycle_anchor = billing_cycle_anchor
1808
- @discount_actions = discount_actions
1809
- @item_actions = item_actions
1810
- @metadata_actions = metadata_actions
1811
- @proration_behavior = proration_behavior
1812
- @set_pause_collection = set_pause_collection
1813
- @set_schedule_end = set_schedule_end
1814
- @trial_settings = trial_settings
1815
- end
1816
- end
1817
-
1818
- class Prebilling < Stripe::RequestParams
1819
- class BillFrom < Stripe::RequestParams
1820
- class AmendmentStart < Stripe::RequestParams
1821
- # The position of the amendment in the `amendments` array with which prebilling should begin. Indexes start from 0 and must be less than the total number of supplied amendments.
1822
- attr_accessor :index
1823
-
1824
- def initialize(index: nil)
1825
- @index = index
1826
- end
1827
- end
1828
- # Start the prebilled period when a specified amendment begins.
1829
- attr_accessor :amendment_start
1830
- # Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.
1831
- attr_accessor :timestamp
1832
- # Select one of several ways to pass the `bill_from` value.
1833
- attr_accessor :type
1834
-
1835
- def initialize(amendment_start: nil, timestamp: nil, type: nil)
1836
- @amendment_start = amendment_start
1837
- @timestamp = timestamp
1838
- @type = type
1839
- end
1840
- end
1841
-
1842
- class BillUntil < Stripe::RequestParams
1843
- class AmendmentEnd < Stripe::RequestParams
1844
- # The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.
1845
- attr_accessor :index
1846
-
1847
- def initialize(index: nil)
1848
- @index = index
1849
- end
1850
- end
1851
-
1852
- class Duration < Stripe::RequestParams
1853
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1854
- attr_accessor :interval
1855
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1856
- attr_accessor :interval_count
1857
-
1858
- def initialize(interval: nil, interval_count: nil)
1859
- @interval = interval
1860
- @interval_count = interval_count
1861
- end
1862
- end
1863
- # End the prebilled period when a specified amendment ends.
1864
- attr_accessor :amendment_end
1865
- # Time span for prebilling, starting from `bill_from`.
1866
- attr_accessor :duration
1867
- # End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
1868
- attr_accessor :timestamp
1869
- # Select one of several ways to pass the `bill_until` value.
1870
- attr_accessor :type
1871
-
1872
- def initialize(amendment_end: nil, duration: nil, timestamp: nil, type: nil)
1873
- @amendment_end = amendment_end
1874
- @duration = duration
1875
- @timestamp = timestamp
1876
- @type = type
1877
- end
1878
- end
1879
- # The beginning of the prebilled time period. The default value is `now`.
1880
- attr_accessor :bill_from
1881
- # The end of the prebilled time period.
1882
- attr_accessor :bill_until
1883
- # When the prebilling invoice should be created. The default value is `now`.
1884
- attr_accessor :invoice_at
1885
- # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
1886
- attr_accessor :update_behavior
1887
-
1888
- def initialize(bill_from: nil, bill_until: nil, invoice_at: nil, update_behavior: nil)
1889
- @bill_from = bill_from
1890
- @bill_until = bill_until
1891
- @invoice_at = invoice_at
1892
- @update_behavior = update_behavior
1893
- end
1894
- end
1895
-
1896
- class ScheduleSettings < Stripe::RequestParams
1897
- # Behavior of the subscription schedule and underlying subscription when it ends.
1898
- attr_accessor :end_behavior
1899
-
1900
- def initialize(end_behavior: nil)
1901
- @end_behavior = end_behavior
1902
- end
1903
- end
1904
- # Changes to apply to the phases of the subscription schedule, in the order provided.
1905
- attr_accessor :amendments
1906
- # Specifies which fields in the response should be expanded.
1907
- attr_accessor :expand
1908
- # Provide any time periods to bill in advance.
1909
- attr_accessor :prebilling
1910
- # In cases where the amendment changes the currently active phase,
1911
- # specifies if and how to prorate at the time of the request.
1912
- attr_accessor :proration_behavior
1913
- # Changes to apply to the subscription schedule.
1914
- attr_accessor :schedule_settings
1915
-
1916
- def initialize(
1917
- amendments: nil,
1918
- expand: nil,
1919
- prebilling: nil,
1920
- proration_behavior: nil,
1921
- schedule_settings: nil
1922
- )
1923
- @amendments = amendments
1924
- @expand = expand
1925
- @prebilling = prebilling
1926
- @proration_behavior = proration_behavior
1927
- @schedule_settings = schedule_settings
1928
- end
1929
- end
1930
-
1931
1041
  class CancelParams < Stripe::RequestParams
1932
1042
  # Specifies which fields in the response should be expanded.
1933
1043
  attr_accessor :expand
@@ -1955,17 +1065,6 @@ module Stripe
1955
1065
  end
1956
1066
  end
1957
1067
 
1958
- # Amends an existing subscription schedule.
1959
- def amend(schedule, params = {}, opts = {})
1960
- request(
1961
- method: :post,
1962
- path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(schedule) }),
1963
- params: params,
1964
- opts: opts,
1965
- base_address: :api
1966
- )
1967
- end
1968
-
1969
1068
  # Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
1970
1069
  def cancel(schedule, params = {}, opts = {})
1971
1070
  request(