stripe 21.0.0 → 21.2.0.pre.beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (558) hide show
  1. checksums.yaml +4 -4
  2. data/lib/stripe/api_operations/request.rb +16 -7
  3. data/lib/stripe/api_operations/save.rb +4 -4
  4. data/lib/stripe/api_requestor.rb +58 -34
  5. data/lib/stripe/api_resource.rb +1 -2
  6. data/lib/stripe/api_version.rb +2 -2
  7. data/lib/stripe/connection_manager.rb +3 -0
  8. data/lib/stripe/errors.rb +6 -0
  9. data/lib/stripe/event_types.rb +213 -0
  10. data/lib/stripe/events/unknown_event_notification.rb +1 -0
  11. data/lib/stripe/events/v2_core_account_closed_event.rb +2 -2
  12. data/lib/stripe/events/v2_core_account_including_configuration_money_manager_capability_status_updated_event.rb +63 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_money_manager_updated_event.rb +44 -0
  14. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +2 -2
  15. data/lib/stripe/events/v2_core_approval_request_approved_event.rb +44 -0
  16. data/lib/stripe/events/v2_core_approval_request_canceled_event.rb +44 -0
  17. data/lib/stripe/events/v2_core_approval_request_created_event.rb +44 -0
  18. data/lib/stripe/events/v2_core_approval_request_expired_event.rb +44 -0
  19. data/lib/stripe/events/v2_core_approval_request_failed_event.rb +44 -0
  20. data/lib/stripe/events/v2_core_approval_request_rejected_event.rb +44 -0
  21. data/lib/stripe/events/v2_core_approval_request_succeeded_event.rb +44 -0
  22. data/lib/stripe/events/v2_core_batch_job_batch_failed_event.rb +44 -0
  23. data/lib/stripe/events/v2_core_batch_job_canceled_event.rb +44 -0
  24. data/lib/stripe/events/v2_core_batch_job_completed_event.rb +44 -0
  25. data/lib/stripe/events/v2_core_batch_job_created_event.rb +44 -0
  26. data/lib/stripe/events/v2_core_batch_job_ready_for_upload_event.rb +44 -0
  27. data/lib/stripe/events/v2_core_batch_job_timeout_event.rb +44 -0
  28. data/lib/stripe/events/v2_core_batch_job_updated_event.rb +44 -0
  29. data/lib/stripe/events/v2_core_batch_job_upload_timeout_event.rb +44 -0
  30. data/lib/stripe/events/v2_core_batch_job_validating_event.rb +44 -0
  31. data/lib/stripe/events/v2_core_batch_job_validation_failed_event.rb +44 -0
  32. data/lib/stripe/events/v2_core_claimable_sandbox_claimed_event.rb +44 -0
  33. data/lib/stripe/events/v2_core_claimable_sandbox_created_event.rb +44 -0
  34. data/lib/stripe/events/v2_core_claimable_sandbox_expired_event.rb +44 -0
  35. data/lib/stripe/events/v2_core_claimable_sandbox_expiring_event.rb +44 -0
  36. data/lib/stripe/events/v2_core_claimable_sandbox_updated_event.rb +44 -0
  37. data/lib/stripe/events/v2_core_health_event_generation_failure_resolved_event.rb +80 -0
  38. data/lib/stripe/events/v2_data_query_run_created_event.rb +44 -0
  39. data/lib/stripe/events/v2_data_query_run_failed_event.rb +44 -0
  40. data/lib/stripe/events/v2_data_query_run_succeeded_event.rb +44 -0
  41. data/lib/stripe/events/v2_data_query_run_updated_event.rb +44 -0
  42. data/lib/stripe/events/v2_data_report_run_created_event.rb +44 -0
  43. data/lib/stripe/events/v2_data_report_run_failed_event.rb +44 -0
  44. data/lib/stripe/events/v2_data_report_run_succeeded_event.rb +44 -0
  45. data/lib/stripe/events/v2_data_report_run_updated_event.rb +44 -0
  46. data/lib/stripe/events/v2_data_reporting_query_run_created_event.rb +44 -0
  47. data/lib/stripe/events/v2_data_reporting_query_run_failed_event.rb +44 -0
  48. data/lib/stripe/events/v2_data_reporting_query_run_succeeded_event.rb +44 -0
  49. data/lib/stripe/events/v2_data_reporting_query_run_updated_event.rb +44 -0
  50. data/lib/stripe/events/v2_extend_workflow_run_failed_event.rb +75 -0
  51. data/lib/stripe/events/v2_extend_workflow_run_started_event.rb +44 -0
  52. data/lib/stripe/events/v2_extend_workflow_run_succeeded_event.rb +44 -0
  53. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +44 -0
  54. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +44 -0
  55. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +44 -0
  56. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +44 -0
  57. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +44 -0
  58. data/lib/stripe/events/v2_money_management_outbound_transfer_under_review_event.rb +44 -0
  59. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +44 -0
  60. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +44 -0
  61. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +44 -0
  62. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +44 -0
  63. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +44 -0
  64. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +44 -0
  65. data/lib/stripe/events/v2_orchestrated_commerce_agreement_confirmed_event.rb +97 -0
  66. data/lib/stripe/events/v2_orchestrated_commerce_agreement_created_event.rb +97 -0
  67. data/lib/stripe/events/v2_orchestrated_commerce_agreement_partially_confirmed_event.rb +97 -0
  68. data/lib/stripe/events/v2_orchestrated_commerce_agreement_terminated_event.rb +97 -0
  69. data/lib/stripe/events/v2_signals_account_evaluation_complete_event.rb +44 -0
  70. data/lib/stripe/events/v2_signals_account_signal_fraudulent_merchant_ready_event.rb +44 -0
  71. data/lib/stripe/events/v2_signals_account_signal_fraudulent_website_ready_event.rb +44 -0
  72. data/lib/stripe/object_types.rb +53 -0
  73. data/lib/stripe/params/account_create_params.rb +299 -1
  74. data/lib/stripe/params/account_notice_list_params.rb +25 -0
  75. data/lib/stripe/params/account_notice_retrieve_params.rb +13 -0
  76. data/lib/stripe/params/account_notice_update_params.rb +36 -0
  77. data/lib/stripe/params/account_session_create_params.rb +191 -0
  78. data/lib/stripe/params/account_update_params.rb +261 -0
  79. data/lib/stripe/params/balance_settings_update_params.rb +9 -1
  80. data/lib/stripe/params/billing/analytics/meter_usage_retrieve_params.rb +65 -0
  81. data/lib/stripe/params/billing_portal/configuration_create_params.rb +1 -1
  82. data/lib/stripe/params/billing_portal/configuration_update_params.rb +1 -1
  83. data/lib/stripe/params/capital/financing_offer_create_params.rb +37 -0
  84. data/lib/stripe/params/capital/financing_offer_list_params.rb +58 -0
  85. data/lib/stripe/params/capital/financing_offer_mark_delivered_params.rb +15 -0
  86. data/lib/stripe/params/capital/financing_offer_refill_params.rb +37 -0
  87. data/lib/stripe/params/capital/financing_offer_retrieve_params.rb +15 -0
  88. data/lib/stripe/params/capital/financing_summary_retrieve_params.rb +15 -0
  89. data/lib/stripe/params/capital/financing_transaction_list_params.rb +45 -0
  90. data/lib/stripe/params/capital/financing_transaction_retrieve_params.rb +15 -0
  91. data/lib/stripe/params/charge_capture_params.rb +1646 -0
  92. data/lib/stripe/params/charge_update_params.rb +1646 -0
  93. data/lib/stripe/params/checkout/session_create_params.rb +95 -4
  94. data/lib/stripe/params/checkout/session_update_params.rb +161 -1
  95. data/lib/stripe/params/confirmation_token_create_params.rb +92 -0
  96. data/lib/stripe/params/coupon_create_params.rb +49 -2
  97. data/lib/stripe/params/customer_balance_transaction_create_params.rb +23 -1
  98. data/lib/stripe/params/customer_session_create_params.rb +32 -1
  99. data/lib/stripe/params/external_account_create_params.rb +134 -0
  100. data/lib/stripe/params/external_account_delete_params.rb +6 -0
  101. data/lib/stripe/params/external_account_list_params.rb +25 -0
  102. data/lib/stripe/params/external_account_retrieve_params.rb +13 -0
  103. data/lib/stripe/params/external_account_update_params.rb +91 -0
  104. data/lib/stripe/params/financial_connections/account_inferred_balance_list_params.rb +24 -0
  105. data/lib/stripe/params/financial_connections/authorization_retrieve_params.rb +15 -0
  106. data/lib/stripe/params/financial_connections/institution_list_params.rb +24 -0
  107. data/lib/stripe/params/financial_connections/institution_retrieve_params.rb +15 -0
  108. data/lib/stripe/params/financial_connections/session_create_params.rb +39 -2
  109. data/lib/stripe/params/fx_quote_create_params.rb +71 -0
  110. data/lib/stripe/params/fx_quote_list_params.rb +22 -0
  111. data/lib/stripe/params/fx_quote_retrieve_params.rb +13 -0
  112. data/lib/stripe/params/invoice_add_lines_params.rb +33 -1
  113. data/lib/stripe/params/invoice_attach_payment_params.rb +43 -1
  114. data/lib/stripe/params/invoice_create_params.rb +64 -2
  115. data/lib/stripe/params/invoice_create_preview_params.rb +772 -9
  116. data/lib/stripe/params/invoice_detach_payment_params.rb +16 -0
  117. data/lib/stripe/params/invoice_item_create_params.rb +34 -2
  118. data/lib/stripe/params/invoice_item_update_params.rb +33 -1
  119. data/lib/stripe/params/invoice_line_item_update_params.rb +33 -1
  120. data/lib/stripe/params/invoice_update_lines_params.rb +33 -1
  121. data/lib/stripe/params/invoice_update_params.rb +64 -2
  122. data/lib/stripe/params/issuing/cardholder_create_params.rb +2 -1
  123. data/lib/stripe/params/issuing/cardholder_update_params.rb +4 -0
  124. data/lib/stripe/params/issuing/credit_underwriting_record_correct_params.rb +163 -0
  125. data/lib/stripe/params/issuing/credit_underwriting_record_create_from_application_params.rb +50 -0
  126. data/lib/stripe/params/issuing/credit_underwriting_record_create_from_proactive_review_params.rb +128 -0
  127. data/lib/stripe/params/issuing/credit_underwriting_record_list_params.rb +24 -0
  128. data/lib/stripe/params/issuing/credit_underwriting_record_report_decision_params.rb +86 -0
  129. data/lib/stripe/params/issuing/credit_underwriting_record_retrieve_params.rb +15 -0
  130. data/lib/stripe/params/issuing/dispute_settlement_detail_list_params.rb +33 -0
  131. data/lib/stripe/params/issuing/dispute_settlement_detail_retrieve_params.rb +15 -0
  132. data/lib/stripe/params/issuing/fraud_liability_debit_list_params.rb +44 -0
  133. data/lib/stripe/params/issuing/fraud_liability_debit_retrieve_params.rb +15 -0
  134. data/lib/stripe/params/issuing/transaction_list_params.rb +4 -0
  135. data/lib/stripe/params/mandate_list_params.rb +39 -0
  136. data/lib/stripe/params/margin_create_params.rb +25 -0
  137. data/lib/stripe/params/margin_list_params.rb +25 -0
  138. data/lib/stripe/params/margin_retrieve_params.rb +13 -0
  139. data/lib/stripe/params/margin_update_params.rb +22 -0
  140. data/lib/stripe/params/order_create_params.rb +2083 -0
  141. data/lib/stripe/params/order_list_params.rb +25 -0
  142. data/lib/stripe/params/order_retrieve_params.rb +13 -0
  143. data/lib/stripe/params/order_submit_params.rb +16 -0
  144. data/lib/stripe/params/order_update_params.rb +2087 -0
  145. data/lib/stripe/params/payment_intent_capture_params.rb +1643 -1
  146. data/lib/stripe/params/payment_intent_confirm_params.rb +3038 -85
  147. data/lib/stripe/params/payment_intent_create_params.rb +3051 -98
  148. data/lib/stripe/params/payment_intent_decrement_authorization_params.rb +297 -0
  149. data/lib/stripe/params/payment_intent_increment_authorization_params.rb +37 -0
  150. data/lib/stripe/params/payment_intent_trigger_action_params.rb +27 -0
  151. data/lib/stripe/params/payment_intent_update_params.rb +3040 -56
  152. data/lib/stripe/params/payment_link_update_params.rb +4 -0
  153. data/lib/stripe/params/payment_method_configuration_create_params.rb +105 -0
  154. data/lib/stripe/params/payment_method_configuration_update_params.rb +105 -0
  155. data/lib/stripe/params/payment_method_create_params.rb +88 -0
  156. data/lib/stripe/params/payment_plan_create_params.rb +128 -0
  157. data/lib/stripe/params/payment_plan_list_params.rb +25 -0
  158. data/lib/stripe/params/payment_plan_retrieve_params.rb +13 -0
  159. data/lib/stripe/params/payment_plan_update_params.rb +105 -0
  160. data/lib/stripe/params/price_update_params.rb +19 -0
  161. data/lib/stripe/params/privacy/redaction_job_cancel_params.rb +15 -0
  162. data/lib/stripe/params/privacy/redaction_job_create_params.rb +67 -0
  163. data/lib/stripe/params/privacy/redaction_job_list_params.rb +27 -0
  164. data/lib/stripe/params/privacy/redaction_job_retrieve_params.rb +15 -0
  165. data/lib/stripe/params/privacy/redaction_job_run_params.rb +15 -0
  166. data/lib/stripe/params/privacy/redaction_job_update_params.rb +18 -0
  167. data/lib/stripe/params/privacy/redaction_job_validate_params.rb +15 -0
  168. data/lib/stripe/params/privacy/redaction_job_validation_error_list_params.rb +24 -0
  169. data/lib/stripe/params/product_create_params.rb +4 -1
  170. data/lib/stripe/params/product_update_params.rb +4 -1
  171. data/lib/stripe/params/quote_create_params.rb +810 -4
  172. data/lib/stripe/params/quote_line_list_params.rb +22 -0
  173. data/lib/stripe/params/quote_list_lines_params.rb +22 -0
  174. data/lib/stripe/params/quote_list_params.rb +4 -0
  175. data/lib/stripe/params/quote_list_preview_invoice_lines_params.rb +22 -0
  176. data/lib/stripe/params/quote_mark_draft_params.rb +13 -0
  177. data/lib/stripe/params/quote_mark_stale_params.rb +16 -0
  178. data/lib/stripe/params/quote_preview_invoice_list_params.rb +22 -0
  179. data/lib/stripe/params/quote_preview_subscription_schedule_list_params.rb +22 -0
  180. data/lib/stripe/params/quote_reestimate_params.rb +13 -0
  181. data/lib/stripe/params/quote_update_params.rb +818 -5
  182. data/lib/stripe/params/radar/billing_evaluation_create_params.rb +231 -0
  183. data/lib/stripe/params/reporting/report_run_create_params.rb +4 -0
  184. data/lib/stripe/params/reserve/hold_list_params.rb +53 -0
  185. data/lib/stripe/params/reserve/hold_retrieve_params.rb +15 -0
  186. data/lib/stripe/params/reserve/plan_list_params.rb +37 -0
  187. data/lib/stripe/params/reserve/plan_retrieve_params.rb +15 -0
  188. data/lib/stripe/params/reserve/release_list_params.rb +41 -0
  189. data/lib/stripe/params/reserve/release_retrieve_params.rb +15 -0
  190. data/lib/stripe/params/setup_intent_confirm_params.rb +122 -3
  191. data/lib/stripe/params/setup_intent_create_params.rb +122 -3
  192. data/lib/stripe/params/setup_intent_update_params.rb +122 -3
  193. data/lib/stripe/params/shared_payment/granted_token_create_params.rb +47 -0
  194. data/lib/stripe/params/shared_payment/granted_token_retrieve_params.rb +15 -0
  195. data/lib/stripe/params/shared_payment/granted_token_revoke_params.rb +15 -0
  196. data/lib/stripe/params/shared_payment/issued_token_create_params.rb +71 -0
  197. data/lib/stripe/params/shared_payment/issued_token_retrieve_params.rb +15 -0
  198. data/lib/stripe/params/shared_payment/issued_token_revoke_params.rb +15 -0
  199. data/lib/stripe/params/subscription_create_params.rb +133 -6
  200. data/lib/stripe/params/subscription_item_create_params.rb +50 -3
  201. data/lib/stripe/params/subscription_item_update_params.rb +33 -2
  202. data/lib/stripe/params/subscription_schedule_amend_params.rb +578 -0
  203. data/lib/stripe/params/subscription_schedule_create_params.rb +167 -5
  204. data/lib/stripe/params/subscription_schedule_update_params.rb +167 -5
  205. data/lib/stripe/params/subscription_update_params.rb +116 -5
  206. data/lib/stripe/params/tax/form_list_params.rb +51 -0
  207. data/lib/stripe/params/tax/form_pdf_params.rb +15 -0
  208. data/lib/stripe/params/tax/form_retrieve_params.rb +15 -0
  209. data/lib/stripe/params/tax/registration_create_params.rb +13 -1
  210. data/lib/stripe/params/terminal/reader_collected_data_retrieve_params.rb +15 -0
  211. data/lib/stripe/params/test_helpers/capital/financing_offer_create_params.rb +39 -0
  212. data/lib/stripe/params/test_helpers/capital/financing_offer_refill_params.rb +39 -0
  213. data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +92 -0
  214. data/lib/stripe/params/test_helpers/shared_payment/granted_token_create_params.rb +49 -0
  215. data/lib/stripe/params/test_helpers/shared_payment/granted_token_revoke_params.rb +17 -0
  216. data/lib/stripe/params/test_helpers/treasury/inbound_transfer_fail_params.rb +23 -1
  217. data/lib/stripe/params/test_helpers/treasury/inbound_transfer_return_inbound_transfer_params.rb +34 -1
  218. data/lib/stripe/params/test_helpers/treasury/received_credit_create_params.rb +25 -1
  219. data/lib/stripe/params/test_helpers/treasury/received_debit_create_params.rb +25 -1
  220. data/lib/stripe/params/transfer_create_params.rb +4 -0
  221. data/lib/stripe/params/treasury/financial_account_create_params.rb +8 -1
  222. data/lib/stripe/params/treasury/financial_account_features_update_params.rb +4 -1
  223. data/lib/stripe/params/treasury/financial_account_update_features_params.rb +4 -1
  224. data/lib/stripe/params/treasury/financial_account_update_params.rb +8 -1
  225. data/lib/stripe/params/treasury/inbound_transfer_fail_params.rb +23 -1
  226. data/lib/stripe/params/treasury/inbound_transfer_return_inbound_transfer_params.rb +34 -1
  227. data/lib/stripe/params/treasury/outbound_payment_create_params.rb +19 -0
  228. data/lib/stripe/params/treasury/outbound_transfer_create_params.rb +24 -0
  229. data/lib/stripe/params/treasury/received_credit_create_params.rb +25 -1
  230. data/lib/stripe/params/treasury/received_debit_create_params.rb +25 -1
  231. data/lib/stripe/params/v2/billing/bill_setting_create_params.rb +74 -0
  232. data/lib/stripe/params/v2/billing/bill_setting_list_params.rb +21 -0
  233. data/lib/stripe/params/v2/billing/bill_setting_retrieve_params.rb +10 -0
  234. data/lib/stripe/params/v2/billing/bill_setting_update_params.rb +80 -0
  235. data/lib/stripe/params/v2/billing/bill_settings/version_list_params.rb +19 -0
  236. data/lib/stripe/params/v2/billing/bill_settings/version_retrieve_params.rb +12 -0
  237. data/lib/stripe/params/v2/billing/collection_setting_create_params.rb +257 -0
  238. data/lib/stripe/params/v2/billing/collection_setting_list_params.rb +21 -0
  239. data/lib/stripe/params/v2/billing/collection_setting_retrieve_params.rb +10 -0
  240. data/lib/stripe/params/v2/billing/collection_setting_update_params.rb +263 -0
  241. data/lib/stripe/params/v2/billing/collection_settings/version_list_params.rb +19 -0
  242. data/lib/stripe/params/v2/billing/collection_settings/version_retrieve_params.rb +12 -0
  243. data/lib/stripe/params/v2/billing/profile_create_params.rb +37 -0
  244. data/lib/stripe/params/v2/billing/profile_list_params.rb +40 -0
  245. data/lib/stripe/params/v2/billing/profile_retrieve_params.rb +10 -0
  246. data/lib/stripe/params/v2/billing/profile_update_params.rb +35 -0
  247. data/lib/stripe/params/v2/core/account_create_params.rb +530 -9
  248. data/lib/stripe/params/v2/core/account_link_create_params.rb +19 -1
  249. data/lib/stripe/params/v2/core/account_token_create_params.rb +29 -1
  250. data/lib/stripe/params/v2/core/account_update_params.rb +514 -8
  251. data/lib/stripe/params/v2/core/approval_request_cancel_params.rb +10 -0
  252. data/lib/stripe/params/v2/core/approval_request_list_params.rb +47 -0
  253. data/lib/stripe/params/v2/core/approval_request_retrieve_params.rb +10 -0
  254. data/lib/stripe/params/v2/core/approval_request_update_params.rb +17 -0
  255. data/lib/stripe/params/v2/core/batch_job_cancel_params.rb +10 -0
  256. data/lib/stripe/params/v2/core/batch_job_create_params.rb +53 -0
  257. data/lib/stripe/params/v2/core/batch_job_retrieve_params.rb +10 -0
  258. data/lib/stripe/params/v2/core/claimable_sandbox_create_params.rb +63 -0
  259. data/lib/stripe/params/v2/core/claimable_sandbox_renew_onboarding_link_params.rb +32 -0
  260. data/lib/stripe/params/v2/core/claimable_sandbox_retrieve_params.rb +17 -0
  261. data/lib/stripe/params/v2/core/vault/gb_bank_account_create_params.rb +21 -0
  262. data/lib/stripe/params/v2/data/query_run_create_params.rb +50 -0
  263. data/lib/stripe/params/v2/data/query_run_retrieve_params.rb +23 -0
  264. data/lib/stripe/params/v2/data/report_list_params.rb +23 -0
  265. data/lib/stripe/params/v2/data/report_retrieve_params.rb +17 -0
  266. data/lib/stripe/params/v2/data/report_run_create_params.rb +48 -0
  267. data/lib/stripe/params/v2/data/report_run_retrieve_params.rb +23 -0
  268. data/lib/stripe/params/v2/data/reporting/query_run_create_params.rb +31 -0
  269. data/lib/stripe/params/v2/data/reporting/query_run_retrieve_params.rb +12 -0
  270. data/lib/stripe/params/v2/data/schema_list_params.rb +26 -0
  271. data/lib/stripe/params/v2/data/schema_retrieve_params.rb +10 -0
  272. data/lib/stripe/params/v2/extend/workflow_invoke_params.rb +17 -0
  273. data/lib/stripe/params/v2/extend/workflow_list_params.rb +21 -0
  274. data/lib/stripe/params/v2/extend/workflow_retrieve_params.rb +10 -0
  275. data/lib/stripe/params/v2/extend/workflow_run_list_params.rb +23 -0
  276. data/lib/stripe/params/v2/extend/workflow_run_retrieve_params.rb +10 -0
  277. data/lib/stripe/params/v2/iam/activity_log_list_params.rb +26 -0
  278. data/lib/stripe/params/v2/iam/activity_log_retrieve_params.rb +10 -0
  279. data/lib/stripe/params/v2/money_management/financial_account_close_params.rb +30 -0
  280. data/lib/stripe/params/v2/money_management/financial_account_create_params.rb +35 -0
  281. data/lib/stripe/params/v2/money_management/financial_account_list_params.rb +1 -1
  282. data/lib/stripe/params/v2/money_management/financial_address_create_params.rb +2 -2
  283. data/lib/stripe/params/v2/money_management/outbound_payment_create_params.rb +21 -0
  284. data/lib/stripe/params/v2/money_management/outbound_payment_quote_create_params.rb +113 -0
  285. data/lib/stripe/params/v2/money_management/outbound_payment_quote_retrieve_params.rb +10 -0
  286. data/lib/stripe/params/v2/money_management/outbound_setup_intent_create_params.rb +61 -1
  287. data/lib/stripe/params/v2/money_management/outbound_setup_intent_update_params.rb +22 -1
  288. data/lib/stripe/params/v2/money_management/outbound_transfer_cancel_params.rb +10 -0
  289. data/lib/stripe/params/v2/money_management/outbound_transfer_create_params.rb +112 -0
  290. data/lib/stripe/params/v2/money_management/outbound_transfer_list_params.rb +48 -0
  291. data/lib/stripe/params/v2/money_management/outbound_transfer_retrieve_params.rb +10 -0
  292. data/lib/stripe/params/v2/money_management/payout_method_disable_params.rb +10 -0
  293. data/lib/stripe/params/v2/money_management/received_debit_list_params.rb +37 -0
  294. data/lib/stripe/params/v2/money_management/received_debit_retrieve_params.rb +10 -0
  295. data/lib/stripe/params/v2/money_management/test_helpers/financial_address_generate_microdeposits_params.rb +12 -0
  296. data/lib/stripe/params/v2/network/business_profile_me_params.rb +10 -0
  297. data/lib/stripe/params/v2/network/business_profile_retrieve_params.rb +10 -0
  298. data/lib/stripe/params/v2/orchestrated_commerce/agreement_confirm_params.rb +10 -0
  299. data/lib/stripe/params/v2/orchestrated_commerce/agreement_create_params.rb +17 -0
  300. data/lib/stripe/params/v2/orchestrated_commerce/agreement_list_params.rb +20 -0
  301. data/lib/stripe/params/v2/orchestrated_commerce/agreement_retrieve_params.rb +10 -0
  302. data/lib/stripe/params/v2/orchestrated_commerce/agreement_terminate_params.rb +10 -0
  303. data/lib/stripe/params/v2/signals/account_activity_create_params.rb +200 -0
  304. data/lib/stripe/params/v2/signals/account_activity_delete_params.rb +10 -0
  305. data/lib/stripe/params/v2/signals/account_activity_retrieve_params.rb +10 -0
  306. data/lib/stripe/params/v2/signals/account_evaluation_create_params.rb +192 -0
  307. data/lib/stripe/params/v2/signals/account_evaluation_retrieve_params.rb +10 -0
  308. data/lib/stripe/params/v2/signals/account_signal_list_params.rb +35 -0
  309. data/lib/stripe/params/v2/signals/account_signal_retrieve_params.rb +10 -0
  310. data/lib/stripe/params.rb +372 -0
  311. data/lib/stripe/request_options.rb +19 -2
  312. data/lib/stripe/resources/account.rb +176 -1
  313. data/lib/stripe/resources/account_notice.rb +94 -0
  314. data/lib/stripe/resources/account_session.rb +162 -0
  315. data/lib/stripe/resources/apps/install.rb +2 -2
  316. data/lib/stripe/resources/balance.rb +83 -0
  317. data/lib/stripe/resources/balance_settings.rb +4 -0
  318. data/lib/stripe/resources/balance_transaction.rb +1 -1
  319. data/lib/stripe/resources/billing/alert_triggered.rb +4 -0
  320. data/lib/stripe/resources/billing/analytics/meter_usage.rb +33 -0
  321. data/lib/stripe/resources/billing/analytics/meter_usage_row.rb +38 -0
  322. data/lib/stripe/resources/capital/financing_offer.rb +185 -0
  323. data/lib/stripe/resources/capital/financing_summary.rb +82 -0
  324. data/lib/stripe/resources/capital/financing_transaction.rb +99 -0
  325. data/lib/stripe/resources/card.rb +18 -1
  326. data/lib/stripe/resources/charge.rb +501 -6
  327. data/lib/stripe/resources/checkout/session.rb +95 -3
  328. data/lib/stripe/resources/confirmation_token.rb +133 -2
  329. data/lib/stripe/resources/coupon.rb +64 -4
  330. data/lib/stripe/resources/credit_note_line_item.rb +18 -0
  331. data/lib/stripe/resources/customer.rb +16 -0
  332. data/lib/stripe/resources/customer_session.rb +36 -0
  333. data/lib/stripe/resources/dispute.rb +19 -1
  334. data/lib/stripe/resources/event.rb +66 -3
  335. data/lib/stripe/resources/financial_connections/account.rb +45 -1
  336. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +35 -0
  337. data/lib/stripe/resources/financial_connections/authorization.rb +24 -1
  338. data/lib/stripe/resources/financial_connections/institution.rb +127 -0
  339. data/lib/stripe/resources/financial_connections/session.rb +92 -0
  340. data/lib/stripe/resources/fx_quote.rb +147 -0
  341. data/lib/stripe/resources/invoice.rb +126 -1
  342. data/lib/stripe/resources/invoice_item.rb +2 -0
  343. data/lib/stripe/resources/invoice_line_item.rb +40 -0
  344. data/lib/stripe/resources/issuing/authorization.rb +16 -0
  345. data/lib/stripe/resources/issuing/card.rb +17 -1
  346. data/lib/stripe/resources/issuing/cardholder.rb +16 -0
  347. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +263 -0
  348. data/lib/stripe/resources/issuing/dispute.rb +16 -1
  349. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +71 -0
  350. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +51 -0
  351. data/lib/stripe/resources/issuing/settlement.rb +61 -0
  352. data/lib/stripe/resources/issuing/transaction.rb +18 -0
  353. data/lib/stripe/resources/line_item.rb +42 -0
  354. data/lib/stripe/resources/mandate.rb +12 -0
  355. data/lib/stripe/resources/margin.rb +64 -0
  356. data/lib/stripe/resources/order.rb +927 -0
  357. data/lib/stripe/resources/payment_attempt_record.rb +181 -2
  358. data/lib/stripe/resources/payment_intent.rb +1589 -11
  359. data/lib/stripe/resources/payment_method.rb +153 -2
  360. data/lib/stripe/resources/payment_method_configuration.rb +170 -0
  361. data/lib/stripe/resources/payment_plan.rb +213 -0
  362. data/lib/stripe/resources/payment_record.rb +181 -2
  363. data/lib/stripe/resources/price.rb +20 -0
  364. data/lib/stripe/resources/privacy/redaction_job.rb +189 -0
  365. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +49 -0
  366. data/lib/stripe/resources/product.rb +2 -0
  367. data/lib/stripe/resources/quote.rb +569 -2
  368. data/lib/stripe/resources/quote_line.rb +525 -0
  369. data/lib/stripe/resources/quote_preview_invoice.rb +1261 -0
  370. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +968 -0
  371. data/lib/stripe/resources/radar/billing_evaluation.rb +281 -0
  372. data/lib/stripe/resources/radar/payment_evaluation.rb +1 -1
  373. data/lib/stripe/resources/radar/value_list_item.rb +15 -1
  374. data/lib/stripe/resources/refund.rb +56 -0
  375. data/lib/stripe/resources/reporting/report_run.rb +2 -0
  376. data/lib/stripe/resources/reserve/hold.rb +8 -1
  377. data/lib/stripe/resources/reserve/plan.rb +7 -0
  378. data/lib/stripe/resources/reserve/release.rb +12 -0
  379. data/lib/stripe/resources/setup_attempt.rb +37 -2
  380. data/lib/stripe/resources/setup_intent.rb +39 -2
  381. data/lib/stripe/resources/shared_payment/granted_token.rb +681 -0
  382. data/lib/stripe/resources/shared_payment/issued_token.rb +310 -0
  383. data/lib/stripe/resources/source.rb +54 -0
  384. data/lib/stripe/resources/subscription.rb +73 -0
  385. data/lib/stripe/resources/subscription_item.rb +22 -1
  386. data/lib/stripe/resources/subscription_schedule.rb +198 -3
  387. data/lib/stripe/resources/tax/form.rb +264 -0
  388. data/lib/stripe/resources/tax/registration.rb +16 -1
  389. data/lib/stripe/resources/terminal/reader.rb +8 -0
  390. data/lib/stripe/resources/terminal/reader_collected_data.rb +47 -0
  391. data/lib/stripe/resources/token.rb +15 -1
  392. data/lib/stripe/resources/transfer.rb +2 -0
  393. data/lib/stripe/resources/treasury/financial_account.rb +2 -0
  394. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  395. data/lib/stripe/resources/treasury/inbound_transfer.rb +35 -7
  396. data/lib/stripe/resources/treasury/outbound_payment.rb +39 -9
  397. data/lib/stripe/resources/treasury/outbound_transfer.rb +67 -9
  398. data/lib/stripe/resources/treasury/received_credit.rb +31 -1
  399. data/lib/stripe/resources/treasury/received_debit.rb +33 -1
  400. data/lib/stripe/resources/v2/billing/bill_setting.rb +102 -0
  401. data/lib/stripe/resources/v2/billing/bill_setting_version.rb +91 -0
  402. data/lib/stripe/resources/v2/billing/collection_setting.rb +327 -0
  403. data/lib/stripe/resources/v2/billing/collection_setting_version.rb +316 -0
  404. data/lib/stripe/resources/v2/billing/profile.rb +47 -0
  405. data/lib/stripe/resources/v2/core/account.rb +1095 -52
  406. data/lib/stripe/resources/v2/core/account_link.rb +18 -1
  407. data/lib/stripe/resources/v2/core/account_person_token.rb +2 -0
  408. data/lib/stripe/resources/v2/core/account_token.rb +3 -1
  409. data/lib/stripe/resources/v2/core/approval_request.rb +395 -0
  410. data/lib/stripe/resources/v2/core/batch_job.rb +536 -0
  411. data/lib/stripe/resources/v2/core/claimable_sandbox.rb +269 -0
  412. data/lib/stripe/resources/v2/core/event_base.rb +8 -25
  413. data/lib/stripe/resources/v2/core/event_notification.rb +33 -0
  414. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +91 -1
  415. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +26 -1
  416. data/lib/stripe/resources/v2/data/query_run.rb +255 -0
  417. data/lib/stripe/resources/v2/data/report.rb +104 -0
  418. data/lib/stripe/resources/v2/data/report_run.rb +246 -0
  419. data/lib/stripe/resources/v2/data/reporting/query_run.rb +143 -0
  420. data/lib/stripe/resources/v2/data/schema.rb +121 -0
  421. data/lib/stripe/resources/v2/extend/workflow.rb +80 -0
  422. data/lib/stripe/resources/v2/extend/workflow_run.rb +158 -0
  423. data/lib/stripe/resources/v2/iam/activity_log.rb +926 -0
  424. data/lib/stripe/resources/v2/money_management/adjustment.rb +4 -0
  425. data/lib/stripe/resources/v2/money_management/financial_account.rb +50 -1
  426. data/lib/stripe/resources/v2/money_management/financial_address_generated_microdeposits.rb +33 -0
  427. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +2 -0
  428. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +63 -1
  429. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +255 -0
  430. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +31 -1
  431. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +260 -0
  432. data/lib/stripe/resources/v2/money_management/payout_method.rb +77 -1
  433. data/lib/stripe/resources/v2/money_management/received_credit.rb +2 -0
  434. data/lib/stripe/resources/v2/money_management/received_debit.rb +177 -0
  435. data/lib/stripe/resources/v2/money_management/recipient_verification.rb +2 -0
  436. data/lib/stripe/resources/v2/network/business_profile.rb +84 -0
  437. data/lib/stripe/resources/v2/orchestrated_commerce/agreement.rb +93 -0
  438. data/lib/stripe/resources/v2/signals/account_activity.rb +252 -0
  439. data/lib/stripe/resources/v2/signals/account_evaluation.rb +249 -0
  440. data/lib/stripe/resources/v2/signals/account_signal.rb +184 -0
  441. data/lib/stripe/resources.rb +356 -0
  442. data/lib/stripe/services/account_notice_service.rb +39 -0
  443. data/lib/stripe/services/account_service.rb +15 -0
  444. data/lib/stripe/services/apps/install_service.rb +2 -2
  445. data/lib/stripe/services/billing/analytics/meter_usage_service.rb +21 -0
  446. data/lib/stripe/services/billing/analytics_service.rb +15 -0
  447. data/lib/stripe/services/billing_service.rb +2 -1
  448. data/lib/stripe/services/capital/financing_offer_service.rb +42 -0
  449. data/lib/stripe/services/capital/financing_summary_service.rb +19 -0
  450. data/lib/stripe/services/capital/financing_transaction_service.rb +31 -0
  451. data/lib/stripe/services/capital_service.rb +15 -0
  452. data/lib/stripe/services/checkout/session_service.rb +2 -0
  453. data/lib/stripe/services/coupon_service.rb +14 -0
  454. data/lib/stripe/services/customer_service.rb +15 -0
  455. data/lib/stripe/services/event_service.rb +1 -1
  456. data/lib/stripe/services/external_account_service.rb +68 -0
  457. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +19 -0
  458. data/lib/stripe/services/financial_connections/account_service.rb +3 -1
  459. data/lib/stripe/services/financial_connections/authorization_service.rb +19 -0
  460. data/lib/stripe/services/financial_connections/institution_service.rb +30 -0
  461. data/lib/stripe/services/financial_connections_service.rb +3 -1
  462. data/lib/stripe/services/fx_quote_service.rb +27 -0
  463. data/lib/stripe/services/invoice_service.rb +11 -0
  464. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +74 -0
  465. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +30 -0
  466. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +30 -0
  467. data/lib/stripe/services/issuing_service.rb +5 -1
  468. data/lib/stripe/services/mandate_service.rb +5 -0
  469. data/lib/stripe/services/margin_service.rb +50 -0
  470. data/lib/stripe/services/order_service.rb +53 -0
  471. data/lib/stripe/services/payment_intent_service.rb +37 -0
  472. data/lib/stripe/services/payment_plan_service.rb +50 -0
  473. data/lib/stripe/services/privacy/redaction_job_service.rb +104 -0
  474. data/lib/stripe/services/privacy/redaction_job_validation_error_service.rb +19 -0
  475. data/lib/stripe/services/privacy_service.rb +13 -0
  476. data/lib/stripe/services/promotion_code_service.rb +29 -0
  477. data/lib/stripe/services/quote_line_service.rb +17 -0
  478. data/lib/stripe/services/quote_preview_invoice_service.rb +17 -0
  479. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +17 -0
  480. data/lib/stripe/services/quote_service.rb +49 -1
  481. data/lib/stripe/services/radar/billing_evaluation_service.rb +19 -0
  482. data/lib/stripe/services/radar_service.rb +2 -1
  483. data/lib/stripe/services/reserve/hold_service.rb +30 -0
  484. data/lib/stripe/services/reserve/plan_service.rb +30 -0
  485. data/lib/stripe/services/reserve/release_service.rb +30 -0
  486. data/lib/stripe/services/reserve_service.rb +15 -0
  487. data/lib/stripe/services/shared_payment/granted_token_service.rb +19 -0
  488. data/lib/stripe/services/shared_payment/issued_token_service.rb +41 -0
  489. data/lib/stripe/services/shared_payment_service.rb +14 -0
  490. data/lib/stripe/services/subscription_schedule_service.rb +11 -0
  491. data/lib/stripe/services/subscription_service.rb +45 -0
  492. data/lib/stripe/services/tax/form_service.rb +37 -0
  493. data/lib/stripe/services/tax_service.rb +2 -1
  494. data/lib/stripe/services/terminal/reader_collected_data_service.rb +19 -0
  495. data/lib/stripe/services/terminal_service.rb +2 -1
  496. data/lib/stripe/services/test_helpers/capital/financing_offer_service.rb +32 -0
  497. data/lib/stripe/services/test_helpers/capital_service.rb +15 -0
  498. data/lib/stripe/services/test_helpers/shared_payment/granted_token_service.rb +32 -0
  499. data/lib/stripe/services/test_helpers/shared_payment_service.rb +15 -0
  500. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +3 -3
  501. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +4 -4
  502. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +4 -4
  503. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +1 -1
  504. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +1 -1
  505. data/lib/stripe/services/test_helpers_service.rb +3 -1
  506. data/lib/stripe/services/v1_services.rb +11 -1
  507. data/lib/stripe/services/v2/billing/bill_setting_service.rb +61 -0
  508. data/lib/stripe/services/v2/billing/bill_settings/version_service.rb +34 -0
  509. data/lib/stripe/services/v2/billing/collection_setting_service.rb +69 -0
  510. data/lib/stripe/services/v2/billing/collection_settings/version_service.rb +34 -0
  511. data/lib/stripe/services/v2/billing/profile_service.rb +54 -0
  512. data/lib/stripe/services/v2/billing_service.rb +4 -1
  513. data/lib/stripe/services/v2/core/account_link_service.rb +1 -1
  514. data/lib/stripe/services/v2/core/account_token_service.rb +2 -2
  515. data/lib/stripe/services/v2/core/accounts/person_token_service.rb +2 -1
  516. data/lib/stripe/services/v2/core/approval_request_service.rb +58 -0
  517. data/lib/stripe/services/v2/core/batch_job_service.rb +43 -0
  518. data/lib/stripe/services/v2/core/claimable_sandbox_service.rb +49 -0
  519. data/lib/stripe/services/v2/core_service.rb +4 -1
  520. data/lib/stripe/services/v2/data/query_run_service.rb +34 -0
  521. data/lib/stripe/services/v2/data/report_run_service.rb +36 -0
  522. data/lib/stripe/services/v2/data/report_service.rb +34 -0
  523. data/lib/stripe/services/v2/data/reporting/query_run_service.rb +35 -0
  524. data/lib/stripe/services/v2/data/reporting_service.rb +17 -0
  525. data/lib/stripe/services/v2/data/schema_service.rb +32 -0
  526. data/lib/stripe/services/v2/data_service.rb +19 -0
  527. data/lib/stripe/services/v2/extend/workflow_run_service.rb +32 -0
  528. data/lib/stripe/services/v2/extend/workflow_service.rb +45 -0
  529. data/lib/stripe/services/v2/extend_service.rb +16 -0
  530. data/lib/stripe/services/v2/iam/activity_log_service.rb +32 -0
  531. data/lib/stripe/services/v2/iam_service.rb +15 -0
  532. data/lib/stripe/services/v2/money_management/financial_account_service.rb +27 -0
  533. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +35 -0
  534. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +61 -0
  535. data/lib/stripe/services/v2/money_management/payout_method_service.rb +15 -0
  536. data/lib/stripe/services/v2/money_management/received_debit_service.rb +32 -0
  537. data/lib/stripe/services/v2/money_management/test_helpers/financial_address_service.rb +13 -0
  538. data/lib/stripe/services/v2/money_management_service.rb +5 -1
  539. data/lib/stripe/services/v2/network/business_profile_service.rb +32 -0
  540. data/lib/stripe/services/v2/network_service.rb +15 -0
  541. data/lib/stripe/services/v2/orchestrated_commerce/agreement_service.rb +65 -0
  542. data/lib/stripe/services/v2/orchestrated_commerce_service.rb +15 -0
  543. data/lib/stripe/services/v2/signals/account_activity_service.rb +43 -0
  544. data/lib/stripe/services/v2/signals/account_evaluation_service.rb +32 -0
  545. data/lib/stripe/services/v2/signals/account_signal_service.rb +32 -0
  546. data/lib/stripe/services/v2/signals_service.rb +17 -0
  547. data/lib/stripe/services/v2_services.rb +7 -1
  548. data/lib/stripe/services.rb +188 -0
  549. data/lib/stripe/stripe_client.rb +10 -1
  550. data/lib/stripe/stripe_configuration.rb +12 -3
  551. data/lib/stripe/stripe_event_notification_handler.rb +242 -0
  552. data/lib/stripe/stripe_object.rb +23 -10
  553. data/lib/stripe/util.rb +7 -1
  554. data/lib/stripe/version.rb +1 -1
  555. data/lib/stripe.rb +53 -0
  556. data/rbi/stripe/resources/v2/core/event_notification.rbi +2 -0
  557. data/rbi/stripe.rbi +134977 -66505
  558. metadata +341 -4
@@ -144,32 +144,88 @@ module Stripe
144
144
  end
145
145
 
146
146
  class Discount < ::Stripe::RequestParams
147
+ class DiscountEnd < ::Stripe::RequestParams
148
+ class Duration < ::Stripe::RequestParams
149
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
150
+ attr_accessor :interval
151
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
152
+ attr_accessor :interval_count
153
+
154
+ def initialize(interval: nil, interval_count: nil)
155
+ @interval = interval
156
+ @interval_count = interval_count
157
+ end
158
+ end
159
+ # Time span for the redeemed discount.
160
+ attr_accessor :duration
161
+ # A precise Unix timestamp for the discount to end. Must be in the future.
162
+ attr_accessor :timestamp
163
+ # The type of calculation made to determine when the discount ends.
164
+ attr_accessor :type
165
+
166
+ def initialize(duration: nil, timestamp: nil, type: nil)
167
+ @duration = duration
168
+ @timestamp = timestamp
169
+ @type = type
170
+ end
171
+ end
147
172
  # ID of the coupon to create a new discount for.
148
173
  attr_accessor :coupon
149
174
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
150
175
  attr_accessor :discount
176
+ # Details to determine how long the discount should be applied for.
177
+ attr_accessor :discount_end
151
178
  # ID of the promotion code to create a new discount for.
152
179
  attr_accessor :promotion_code
153
180
 
154
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
181
+ def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
155
182
  @coupon = coupon
156
183
  @discount = discount
184
+ @discount_end = discount_end
157
185
  @promotion_code = promotion_code
158
186
  end
159
187
  end
160
188
 
161
189
  class InvoiceItem < ::Stripe::RequestParams
162
190
  class Discount < ::Stripe::RequestParams
191
+ class DiscountEnd < ::Stripe::RequestParams
192
+ class Duration < ::Stripe::RequestParams
193
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
194
+ attr_accessor :interval
195
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
196
+ attr_accessor :interval_count
197
+
198
+ def initialize(interval: nil, interval_count: nil)
199
+ @interval = interval
200
+ @interval_count = interval_count
201
+ end
202
+ end
203
+ # Time span for the redeemed discount.
204
+ attr_accessor :duration
205
+ # A precise Unix timestamp for the discount to end. Must be in the future.
206
+ attr_accessor :timestamp
207
+ # The type of calculation made to determine when the discount ends.
208
+ attr_accessor :type
209
+
210
+ def initialize(duration: nil, timestamp: nil, type: nil)
211
+ @duration = duration
212
+ @timestamp = timestamp
213
+ @type = type
214
+ end
215
+ end
163
216
  # ID of the coupon to create a new discount for.
164
217
  attr_accessor :coupon
165
218
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
166
219
  attr_accessor :discount
220
+ # Details to determine how long the discount should be applied for.
221
+ attr_accessor :discount_end
167
222
  # ID of the promotion code to create a new discount for.
168
223
  attr_accessor :promotion_code
169
224
 
170
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
225
+ def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
171
226
  @coupon = coupon
172
227
  @discount = discount
228
+ @discount_end = discount_end
173
229
  @promotion_code = promotion_code
174
230
  end
175
231
  end
@@ -311,6 +367,466 @@ module Stripe
311
367
  end
312
368
 
313
369
  class ScheduleDetails < ::Stripe::RequestParams
370
+ class Amendment < ::Stripe::RequestParams
371
+ class AmendmentEnd < ::Stripe::RequestParams
372
+ class DiscountEnd < ::Stripe::RequestParams
373
+ # The ID of a specific discount.
374
+ attr_accessor :discount
375
+
376
+ def initialize(discount: nil)
377
+ @discount = discount
378
+ end
379
+ end
380
+
381
+ class Duration < ::Stripe::RequestParams
382
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
383
+ attr_accessor :interval
384
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
385
+ attr_accessor :interval_count
386
+
387
+ def initialize(interval: nil, interval_count: nil)
388
+ @interval = interval
389
+ @interval_count = interval_count
390
+ end
391
+ end
392
+ # Use the `end` time of a given discount.
393
+ attr_accessor :discount_end
394
+ # Time span for the amendment starting from the `amendment_start`.
395
+ attr_accessor :duration
396
+ # A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
397
+ attr_accessor :timestamp
398
+ # Select one of three ways to pass the `amendment_end`.
399
+ attr_accessor :type
400
+
401
+ def initialize(discount_end: nil, duration: nil, timestamp: nil, type: nil)
402
+ @discount_end = discount_end
403
+ @duration = duration
404
+ @timestamp = timestamp
405
+ @type = type
406
+ end
407
+ end
408
+
409
+ class AmendmentStart < ::Stripe::RequestParams
410
+ class AmendmentEnd < ::Stripe::RequestParams
411
+ # 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.
412
+ attr_accessor :index
413
+
414
+ def initialize(index: nil)
415
+ @index = index
416
+ end
417
+ end
418
+
419
+ class DiscountEnd < ::Stripe::RequestParams
420
+ # The ID of a specific discount.
421
+ attr_accessor :discount
422
+
423
+ def initialize(discount: nil)
424
+ @discount = discount
425
+ end
426
+ end
427
+ # Details of another amendment in the same array, immediately after which this amendment should begin.
428
+ attr_accessor :amendment_end
429
+ # Use the `end` time of a given discount.
430
+ attr_accessor :discount_end
431
+ # A precise Unix timestamp for the amendment to start.
432
+ attr_accessor :timestamp
433
+ # Select one of three ways to pass the `amendment_start`.
434
+ attr_accessor :type
435
+
436
+ def initialize(amendment_end: nil, discount_end: nil, timestamp: nil, type: nil)
437
+ @amendment_end = amendment_end
438
+ @discount_end = discount_end
439
+ @timestamp = timestamp
440
+ @type = type
441
+ end
442
+ end
443
+
444
+ class DiscountAction < ::Stripe::RequestParams
445
+ class Add < ::Stripe::RequestParams
446
+ class DiscountEnd < ::Stripe::RequestParams
447
+ # The type of calculation made to determine when the discount ends.
448
+ attr_accessor :type
449
+
450
+ def initialize(type: nil)
451
+ @type = type
452
+ end
453
+ end
454
+ # The coupon code to redeem.
455
+ attr_accessor :coupon
456
+ # An ID of an existing discount for a coupon that was already redeemed.
457
+ attr_accessor :discount
458
+ # Details to determine how long the discount should be applied for.
459
+ attr_accessor :discount_end
460
+ # 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.
461
+ attr_accessor :index
462
+ # The promotion code to redeem.
463
+ attr_accessor :promotion_code
464
+
465
+ def initialize(
466
+ coupon: nil,
467
+ discount: nil,
468
+ discount_end: nil,
469
+ index: nil,
470
+ promotion_code: nil
471
+ )
472
+ @coupon = coupon
473
+ @discount = discount
474
+ @discount_end = discount_end
475
+ @index = index
476
+ @promotion_code = promotion_code
477
+ end
478
+ end
479
+
480
+ class Remove < ::Stripe::RequestParams
481
+ # The coupon code to remove from the `discounts` array.
482
+ attr_accessor :coupon
483
+ # The ID of a discount to remove from the `discounts` array.
484
+ attr_accessor :discount
485
+ # The ID of a promotion code to remove from the `discounts` array.
486
+ attr_accessor :promotion_code
487
+
488
+ def initialize(coupon: nil, discount: nil, promotion_code: nil)
489
+ @coupon = coupon
490
+ @discount = discount
491
+ @promotion_code = promotion_code
492
+ end
493
+ end
494
+
495
+ class Set < ::Stripe::RequestParams
496
+ # The coupon code to replace the `discounts` array with.
497
+ attr_accessor :coupon
498
+ # An ID of an existing discount to replace the `discounts` array with.
499
+ attr_accessor :discount
500
+ # An ID of an existing promotion code to replace the `discounts` array with.
501
+ attr_accessor :promotion_code
502
+
503
+ def initialize(coupon: nil, discount: nil, promotion_code: nil)
504
+ @coupon = coupon
505
+ @discount = discount
506
+ @promotion_code = promotion_code
507
+ end
508
+ end
509
+ # Details of the discount to add.
510
+ attr_accessor :add
511
+ # Details of the discount to remove.
512
+ attr_accessor :remove
513
+ # Details of the discount to replace the existing discounts with.
514
+ attr_accessor :set
515
+ # Determines the type of discount action.
516
+ attr_accessor :type
517
+
518
+ def initialize(add: nil, remove: nil, set: nil, type: nil)
519
+ @add = add
520
+ @remove = remove
521
+ @set = set
522
+ @type = type
523
+ end
524
+ end
525
+
526
+ class ItemAction < ::Stripe::RequestParams
527
+ class Add < ::Stripe::RequestParams
528
+ class Discount < ::Stripe::RequestParams
529
+ class DiscountEnd < ::Stripe::RequestParams
530
+ class Duration < ::Stripe::RequestParams
531
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
532
+ attr_accessor :interval
533
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
534
+ attr_accessor :interval_count
535
+
536
+ def initialize(interval: nil, interval_count: nil)
537
+ @interval = interval
538
+ @interval_count = interval_count
539
+ end
540
+ end
541
+ # Time span for the redeemed discount.
542
+ attr_accessor :duration
543
+ # A precise Unix timestamp for the discount to end. Must be in the future.
544
+ attr_accessor :timestamp
545
+ # The type of calculation made to determine when the discount ends.
546
+ attr_accessor :type
547
+
548
+ def initialize(duration: nil, timestamp: nil, type: nil)
549
+ @duration = duration
550
+ @timestamp = timestamp
551
+ @type = type
552
+ end
553
+ end
554
+ # ID of the coupon to create a new discount for.
555
+ attr_accessor :coupon
556
+ # ID of an existing discount on the object (or one of its ancestors) to reuse.
557
+ attr_accessor :discount
558
+ # Details to determine how long the discount should be applied for.
559
+ attr_accessor :discount_end
560
+ # ID of the promotion code to create a new discount for.
561
+ attr_accessor :promotion_code
562
+
563
+ def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
564
+ @coupon = coupon
565
+ @discount = discount
566
+ @discount_end = discount_end
567
+ @promotion_code = promotion_code
568
+ end
569
+ end
570
+
571
+ class Trial < ::Stripe::RequestParams
572
+ # 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.
573
+ attr_accessor :converts_to
574
+ # Determines the type of trial for this item.
575
+ attr_accessor :type
576
+
577
+ def initialize(converts_to: nil, type: nil)
578
+ @converts_to = converts_to
579
+ @type = type
580
+ end
581
+ end
582
+ # The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
583
+ attr_accessor :discounts
584
+ # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
585
+ attr_accessor :metadata
586
+ # The ID of the price object.
587
+ attr_accessor :price
588
+ # Quantity for this item.
589
+ attr_accessor :quantity
590
+ # 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`.
591
+ attr_accessor :tax_rates
592
+ # Options that configure the trial on the subscription item.
593
+ attr_accessor :trial
594
+ # The ID of the trial offer to apply to the configuration item.
595
+ attr_accessor :trial_offer
596
+
597
+ def initialize(
598
+ discounts: nil,
599
+ metadata: nil,
600
+ price: nil,
601
+ quantity: nil,
602
+ tax_rates: nil,
603
+ trial: nil,
604
+ trial_offer: nil
605
+ )
606
+ @discounts = discounts
607
+ @metadata = metadata
608
+ @price = price
609
+ @quantity = quantity
610
+ @tax_rates = tax_rates
611
+ @trial = trial
612
+ @trial_offer = trial_offer
613
+ end
614
+ end
615
+
616
+ class Remove < ::Stripe::RequestParams
617
+ # ID of a price to remove.
618
+ attr_accessor :price
619
+
620
+ def initialize(price: nil)
621
+ @price = price
622
+ end
623
+ end
624
+
625
+ class Set < ::Stripe::RequestParams
626
+ class Discount < ::Stripe::RequestParams
627
+ class DiscountEnd < ::Stripe::RequestParams
628
+ class Duration < ::Stripe::RequestParams
629
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
630
+ attr_accessor :interval
631
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
632
+ attr_accessor :interval_count
633
+
634
+ def initialize(interval: nil, interval_count: nil)
635
+ @interval = interval
636
+ @interval_count = interval_count
637
+ end
638
+ end
639
+ # Time span for the redeemed discount.
640
+ attr_accessor :duration
641
+ # A precise Unix timestamp for the discount to end. Must be in the future.
642
+ attr_accessor :timestamp
643
+ # The type of calculation made to determine when the discount ends.
644
+ attr_accessor :type
645
+
646
+ def initialize(duration: nil, timestamp: nil, type: nil)
647
+ @duration = duration
648
+ @timestamp = timestamp
649
+ @type = type
650
+ end
651
+ end
652
+ # ID of the coupon to create a new discount for.
653
+ attr_accessor :coupon
654
+ # ID of an existing discount on the object (or one of its ancestors) to reuse.
655
+ attr_accessor :discount
656
+ # Details to determine how long the discount should be applied for.
657
+ attr_accessor :discount_end
658
+ # ID of the promotion code to create a new discount for.
659
+ attr_accessor :promotion_code
660
+
661
+ def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
662
+ @coupon = coupon
663
+ @discount = discount
664
+ @discount_end = discount_end
665
+ @promotion_code = promotion_code
666
+ end
667
+ end
668
+
669
+ class Trial < ::Stripe::RequestParams
670
+ # 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.
671
+ attr_accessor :converts_to
672
+ # Determines the type of trial for this item.
673
+ attr_accessor :type
674
+
675
+ def initialize(converts_to: nil, type: nil)
676
+ @converts_to = converts_to
677
+ @type = type
678
+ end
679
+ end
680
+ # 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`.
681
+ attr_accessor :discounts
682
+ # 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`.
683
+ attr_accessor :metadata
684
+ # The ID of the price object.
685
+ attr_accessor :price
686
+ # 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`.
687
+ attr_accessor :quantity
688
+ # 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`.
689
+ attr_accessor :tax_rates
690
+ # 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`.
691
+ attr_accessor :trial
692
+ # The ID of the trial offer to apply to the configuration item.
693
+ attr_accessor :trial_offer
694
+
695
+ def initialize(
696
+ discounts: nil,
697
+ metadata: nil,
698
+ price: nil,
699
+ quantity: nil,
700
+ tax_rates: nil,
701
+ trial: nil,
702
+ trial_offer: nil
703
+ )
704
+ @discounts = discounts
705
+ @metadata = metadata
706
+ @price = price
707
+ @quantity = quantity
708
+ @tax_rates = tax_rates
709
+ @trial = trial
710
+ @trial_offer = trial_offer
711
+ end
712
+ end
713
+ # 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.
714
+ attr_accessor :add
715
+ # Details of the subscription item to remove.
716
+ attr_accessor :remove
717
+ # 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.
718
+ attr_accessor :set
719
+ # Determines the type of item action.
720
+ attr_accessor :type
721
+
722
+ def initialize(add: nil, remove: nil, set: nil, type: nil)
723
+ @add = add
724
+ @remove = remove
725
+ @set = set
726
+ @type = type
727
+ end
728
+ end
729
+
730
+ class MetadataAction < ::Stripe::RequestParams
731
+ # Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
732
+ attr_accessor :add
733
+ # Keys to remove from schedule phase metadata.
734
+ attr_accessor :remove
735
+ # Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
736
+ attr_accessor :set
737
+ # Select one of three ways to update phase-level `metadata` on subscription schedules.
738
+ attr_accessor :type
739
+
740
+ def initialize(add: nil, remove: nil, set: nil, type: nil)
741
+ @add = add
742
+ @remove = remove
743
+ @set = set
744
+ @type = type
745
+ end
746
+ end
747
+
748
+ class SetPauseCollection < ::Stripe::RequestParams
749
+ class Set < ::Stripe::RequestParams
750
+ # The payment collection behavior for this subscription while paused.
751
+ attr_accessor :behavior
752
+
753
+ def initialize(behavior: nil)
754
+ @behavior = behavior
755
+ end
756
+ end
757
+ # Details of the pause_collection behavior to apply to the amendment.
758
+ attr_accessor :set
759
+ # Determines the type of the pause_collection amendment.
760
+ attr_accessor :type
761
+
762
+ def initialize(set: nil, type: nil)
763
+ @set = set
764
+ @type = type
765
+ end
766
+ end
767
+
768
+ class TrialSettings < ::Stripe::RequestParams
769
+ class EndBehavior < ::Stripe::RequestParams
770
+ # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
771
+ attr_accessor :prorate_up_front
772
+
773
+ def initialize(prorate_up_front: nil)
774
+ @prorate_up_front = prorate_up_front
775
+ end
776
+ end
777
+ # Defines how the subscription should behave when a trial ends.
778
+ attr_accessor :end_behavior
779
+
780
+ def initialize(end_behavior: nil)
781
+ @end_behavior = end_behavior
782
+ end
783
+ end
784
+ # 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.
785
+ attr_accessor :amendment_end
786
+ # Details to identify the earliest timestamp where the proposed change should take effect.
787
+ attr_accessor :amendment_start
788
+ # 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.
789
+ attr_accessor :billing_cycle_anchor
790
+ # Changes to the coupons being redeemed or discounts being applied during the amendment time span.
791
+ attr_accessor :discount_actions
792
+ # Changes to the subscription items during the amendment time span.
793
+ attr_accessor :item_actions
794
+ # Instructions for how to modify phase metadata
795
+ attr_accessor :metadata_actions
796
+ # 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`.
797
+ attr_accessor :proration_behavior
798
+ # Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
799
+ attr_accessor :set_pause_collection
800
+ # Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
801
+ attr_accessor :set_schedule_end
802
+ # Settings related to subscription trials.
803
+ attr_accessor :trial_settings
804
+
805
+ def initialize(
806
+ amendment_end: nil,
807
+ amendment_start: nil,
808
+ billing_cycle_anchor: nil,
809
+ discount_actions: nil,
810
+ item_actions: nil,
811
+ metadata_actions: nil,
812
+ proration_behavior: nil,
813
+ set_pause_collection: nil,
814
+ set_schedule_end: nil,
815
+ trial_settings: nil
816
+ )
817
+ @amendment_end = amendment_end
818
+ @amendment_start = amendment_start
819
+ @billing_cycle_anchor = billing_cycle_anchor
820
+ @discount_actions = discount_actions
821
+ @item_actions = item_actions
822
+ @metadata_actions = metadata_actions
823
+ @proration_behavior = proration_behavior
824
+ @set_pause_collection = set_pause_collection
825
+ @set_schedule_end = set_schedule_end
826
+ @trial_settings = trial_settings
827
+ end
828
+ end
829
+
314
830
  class BillingMode < ::Stripe::RequestParams
315
831
  class Flexible < ::Stripe::RequestParams
316
832
  # Controls how invoices and invoice items display proration amounts and discount amounts.
@@ -470,16 +986,44 @@ module Stripe
470
986
  class Phase < ::Stripe::RequestParams
471
987
  class AddInvoiceItem < ::Stripe::RequestParams
472
988
  class Discount < ::Stripe::RequestParams
989
+ class DiscountEnd < ::Stripe::RequestParams
990
+ class Duration < ::Stripe::RequestParams
991
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
992
+ attr_accessor :interval
993
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
994
+ attr_accessor :interval_count
995
+
996
+ def initialize(interval: nil, interval_count: nil)
997
+ @interval = interval
998
+ @interval_count = interval_count
999
+ end
1000
+ end
1001
+ # Time span for the redeemed discount.
1002
+ attr_accessor :duration
1003
+ # A precise Unix timestamp for the discount to end. Must be in the future.
1004
+ attr_accessor :timestamp
1005
+ # The type of calculation made to determine when the discount ends.
1006
+ attr_accessor :type
1007
+
1008
+ def initialize(duration: nil, timestamp: nil, type: nil)
1009
+ @duration = duration
1010
+ @timestamp = timestamp
1011
+ @type = type
1012
+ end
1013
+ end
473
1014
  # ID of the coupon to create a new discount for.
474
1015
  attr_accessor :coupon
475
1016
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
476
1017
  attr_accessor :discount
1018
+ # Details to determine how long the discount should be applied for.
1019
+ attr_accessor :discount_end
477
1020
  # ID of the promotion code to create a new discount for.
478
1021
  attr_accessor :promotion_code
479
1022
 
480
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
1023
+ def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
481
1024
  @coupon = coupon
482
1025
  @discount = discount
1026
+ @discount_end = discount_end
483
1027
  @promotion_code = promotion_code
484
1028
  end
485
1029
  end
@@ -629,16 +1173,44 @@ module Stripe
629
1173
  end
630
1174
 
631
1175
  class Discount < ::Stripe::RequestParams
1176
+ class DiscountEnd < ::Stripe::RequestParams
1177
+ class Duration < ::Stripe::RequestParams
1178
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1179
+ attr_accessor :interval
1180
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1181
+ attr_accessor :interval_count
1182
+
1183
+ def initialize(interval: nil, interval_count: nil)
1184
+ @interval = interval
1185
+ @interval_count = interval_count
1186
+ end
1187
+ end
1188
+ # Time span for the redeemed discount.
1189
+ attr_accessor :duration
1190
+ # A precise Unix timestamp for the discount to end. Must be in the future.
1191
+ attr_accessor :timestamp
1192
+ # The type of calculation made to determine when the discount ends.
1193
+ attr_accessor :type
1194
+
1195
+ def initialize(duration: nil, timestamp: nil, type: nil)
1196
+ @duration = duration
1197
+ @timestamp = timestamp
1198
+ @type = type
1199
+ end
1200
+ end
632
1201
  # ID of the coupon to create a new discount for.
633
1202
  attr_accessor :coupon
634
1203
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
635
1204
  attr_accessor :discount
1205
+ # Details to determine how long the discount should be applied for.
1206
+ attr_accessor :discount_end
636
1207
  # ID of the promotion code to create a new discount for.
637
1208
  attr_accessor :promotion_code
638
1209
 
639
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
1210
+ def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
640
1211
  @coupon = coupon
641
1212
  @discount = discount
1213
+ @discount_end = discount_end
642
1214
  @promotion_code = promotion_code
643
1215
  end
644
1216
  end
@@ -692,16 +1264,44 @@ module Stripe
692
1264
  end
693
1265
 
694
1266
  class Discount < ::Stripe::RequestParams
1267
+ class DiscountEnd < ::Stripe::RequestParams
1268
+ class Duration < ::Stripe::RequestParams
1269
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1270
+ attr_accessor :interval
1271
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1272
+ attr_accessor :interval_count
1273
+
1274
+ def initialize(interval: nil, interval_count: nil)
1275
+ @interval = interval
1276
+ @interval_count = interval_count
1277
+ end
1278
+ end
1279
+ # Time span for the redeemed discount.
1280
+ attr_accessor :duration
1281
+ # A precise Unix timestamp for the discount to end. Must be in the future.
1282
+ attr_accessor :timestamp
1283
+ # The type of calculation made to determine when the discount ends.
1284
+ attr_accessor :type
1285
+
1286
+ def initialize(duration: nil, timestamp: nil, type: nil)
1287
+ @duration = duration
1288
+ @timestamp = timestamp
1289
+ @type = type
1290
+ end
1291
+ end
695
1292
  # ID of the coupon to create a new discount for.
696
1293
  attr_accessor :coupon
697
1294
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
698
1295
  attr_accessor :discount
1296
+ # Details to determine how long the discount should be applied for.
1297
+ attr_accessor :discount_end
699
1298
  # ID of the promotion code to create a new discount for.
700
1299
  attr_accessor :promotion_code
701
1300
 
702
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
1301
+ def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
703
1302
  @coupon = coupon
704
1303
  @discount = discount
1304
+ @discount_end = discount_end
705
1305
  @promotion_code = promotion_code
706
1306
  end
707
1307
  end
@@ -751,6 +1351,18 @@ module Stripe
751
1351
  @field_encodings = { unit_amount_decimal: :decimal_string }
752
1352
  end
753
1353
  end
1354
+
1355
+ class Trial < ::Stripe::RequestParams
1356
+ # 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.
1357
+ attr_accessor :converts_to
1358
+ # Determines the type of trial for this item.
1359
+ attr_accessor :type
1360
+
1361
+ def initialize(converts_to: nil, type: nil)
1362
+ @converts_to = converts_to
1363
+ @type = type
1364
+ end
1365
+ end
754
1366
  # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
755
1367
  attr_accessor :billing_thresholds
756
1368
  # The coupons to redeem into discounts for the subscription item.
@@ -767,6 +1379,10 @@ module Stripe
767
1379
  attr_accessor :quantity
768
1380
  # A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
769
1381
  attr_accessor :tax_rates
1382
+ # Options that configure the trial on the subscription item.
1383
+ attr_accessor :trial
1384
+ # The ID of the trial offer to apply to the configuration item.
1385
+ attr_accessor :trial_offer
770
1386
 
771
1387
  def initialize(
772
1388
  billing_thresholds: nil,
@@ -776,7 +1392,9 @@ module Stripe
776
1392
  price: nil,
777
1393
  price_data: nil,
778
1394
  quantity: nil,
779
- tax_rates: nil
1395
+ tax_rates: nil,
1396
+ trial: nil,
1397
+ trial_offer: nil
780
1398
  )
781
1399
  @billing_thresholds = billing_thresholds
782
1400
  @discounts = discounts
@@ -786,6 +1404,8 @@ module Stripe
786
1404
  @price_data = price_data
787
1405
  @quantity = quantity
788
1406
  @tax_rates = tax_rates
1407
+ @trial = trial
1408
+ @trial_offer = trial_offer
789
1409
  end
790
1410
 
791
1411
  def self.field_encodings
@@ -795,6 +1415,15 @@ module Stripe
795
1415
  end
796
1416
  end
797
1417
 
1418
+ class PauseCollection < ::Stripe::RequestParams
1419
+ # The payment collection behavior for this subscription while paused.
1420
+ attr_accessor :behavior
1421
+
1422
+ def initialize(behavior: nil)
1423
+ @behavior = behavior
1424
+ end
1425
+ end
1426
+
798
1427
  class TransferData < ::Stripe::RequestParams
799
1428
  # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
800
1429
  attr_accessor :amount_percent
@@ -806,6 +1435,23 @@ module Stripe
806
1435
  @destination = destination
807
1436
  end
808
1437
  end
1438
+
1439
+ class TrialSettings < ::Stripe::RequestParams
1440
+ class EndBehavior < ::Stripe::RequestParams
1441
+ # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
1442
+ attr_accessor :prorate_up_front
1443
+
1444
+ def initialize(prorate_up_front: nil)
1445
+ @prorate_up_front = prorate_up_front
1446
+ end
1447
+ end
1448
+ # Defines how the subscription should behave when a trial ends.
1449
+ attr_accessor :end_behavior
1450
+
1451
+ def initialize(end_behavior: nil)
1452
+ @end_behavior = end_behavior
1453
+ end
1454
+ end
809
1455
  # 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.
810
1456
  attr_accessor :add_invoice_items
811
1457
  # 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).
@@ -840,6 +1486,8 @@ module Stripe
840
1486
  attr_accessor :metadata
841
1487
  # The account on behalf of which to charge, for each of the associated subscription's invoices.
842
1488
  attr_accessor :on_behalf_of
1489
+ # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
1490
+ attr_accessor :pause_collection
843
1491
  # Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
844
1492
  attr_accessor :proration_behavior
845
1493
  # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase. Prefer to specify `now` over an explicit timestamp when appropriate to avoid unexpected behavior due to request delays or clock skew resulting in the phase being slightly backdated or postdated.
@@ -848,8 +1496,12 @@ module Stripe
848
1496
  attr_accessor :transfer_data
849
1497
  # If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
850
1498
  attr_accessor :trial
1499
+ # Specify trial behavior when crossing phase boundaries
1500
+ attr_accessor :trial_continuation
851
1501
  # Sets the phase to trialing from the start date to this date. Must be within the phase. When previewing an update, if combined with `trial=true`, it must match the phase end date.
852
1502
  attr_accessor :trial_end
1503
+ # Settings related to subscription trials.
1504
+ attr_accessor :trial_settings
853
1505
 
854
1506
  def initialize(
855
1507
  add_invoice_items: nil,
@@ -869,11 +1521,14 @@ module Stripe
869
1521
  items: nil,
870
1522
  metadata: nil,
871
1523
  on_behalf_of: nil,
1524
+ pause_collection: nil,
872
1525
  proration_behavior: nil,
873
1526
  start_date: nil,
874
1527
  transfer_data: nil,
875
1528
  trial: nil,
876
- trial_end: nil
1529
+ trial_continuation: nil,
1530
+ trial_end: nil,
1531
+ trial_settings: nil
877
1532
  )
878
1533
  @add_invoice_items = add_invoice_items
879
1534
  @application_fee_percent = application_fee_percent
@@ -892,11 +1547,14 @@ module Stripe
892
1547
  @items = items
893
1548
  @metadata = metadata
894
1549
  @on_behalf_of = on_behalf_of
1550
+ @pause_collection = pause_collection
895
1551
  @proration_behavior = proration_behavior
896
1552
  @start_date = start_date
897
1553
  @transfer_data = transfer_data
898
1554
  @trial = trial
1555
+ @trial_continuation = trial_continuation
899
1556
  @trial_end = trial_end
1557
+ @trial_settings = trial_settings
900
1558
  end
901
1559
 
902
1560
  def self.field_encodings
@@ -922,6 +1580,59 @@ module Stripe
922
1580
  }
923
1581
  end
924
1582
  end
1583
+
1584
+ class Prebilling < ::Stripe::RequestParams
1585
+ class BillUntil < ::Stripe::RequestParams
1586
+ class AmendmentEnd < ::Stripe::RequestParams
1587
+ # 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.
1588
+ attr_accessor :index
1589
+
1590
+ def initialize(index: nil)
1591
+ @index = index
1592
+ end
1593
+ end
1594
+
1595
+ class Duration < ::Stripe::RequestParams
1596
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1597
+ attr_accessor :interval
1598
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1599
+ attr_accessor :interval_count
1600
+
1601
+ def initialize(interval: nil, interval_count: nil)
1602
+ @interval = interval
1603
+ @interval_count = interval_count
1604
+ end
1605
+ end
1606
+ # End the prebilled period when a specified amendment ends.
1607
+ attr_accessor :amendment_end
1608
+ # Time span for prebilling, starting from `bill_from`.
1609
+ attr_accessor :duration
1610
+ # End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
1611
+ attr_accessor :timestamp
1612
+ # Select one of several ways to pass the `bill_until` value.
1613
+ attr_accessor :type
1614
+
1615
+ def initialize(amendment_end: nil, duration: nil, timestamp: nil, type: nil)
1616
+ @amendment_end = amendment_end
1617
+ @duration = duration
1618
+ @timestamp = timestamp
1619
+ @type = type
1620
+ end
1621
+ end
1622
+ # The end of the prebilled time period.
1623
+ attr_accessor :bill_until
1624
+ # This is used to determine the number of billing cycles to prebill.
1625
+ attr_accessor :iterations
1626
+
1627
+ def initialize(bill_until: nil, iterations: nil)
1628
+ @bill_until = bill_until
1629
+ @iterations = iterations
1630
+ end
1631
+ end
1632
+ # Changes to apply to the phases of the subscription schedule, in the order provided.
1633
+ attr_accessor :amendments
1634
+ # 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.
1635
+ attr_accessor :billing_behavior
925
1636
  # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
926
1637
  attr_accessor :billing_mode
927
1638
  # 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.
@@ -930,20 +1641,28 @@ module Stripe
930
1641
  attr_accessor :pause_schedules
931
1642
  # 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.
932
1643
  attr_accessor :phases
1644
+ # Provide any time periods to bill in advance.
1645
+ attr_accessor :prebilling
933
1646
  # In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
934
1647
  attr_accessor :proration_behavior
935
1648
 
936
1649
  def initialize(
1650
+ amendments: nil,
1651
+ billing_behavior: nil,
937
1652
  billing_mode: nil,
938
1653
  end_behavior: nil,
939
1654
  pause_schedules: nil,
940
1655
  phases: nil,
1656
+ prebilling: nil,
941
1657
  proration_behavior: nil
942
1658
  )
1659
+ @amendments = amendments
1660
+ @billing_behavior = billing_behavior
943
1661
  @billing_mode = billing_mode
944
1662
  @end_behavior = end_behavior
945
1663
  @pause_schedules = pause_schedules
946
1664
  @phases = phases
1665
+ @prebilling = prebilling
947
1666
  @proration_behavior = proration_behavior
948
1667
  end
949
1668
 
@@ -1075,25 +1794,56 @@ module Stripe
1075
1794
  end
1076
1795
 
1077
1796
  class CurrentTrial < ::Stripe::RequestParams
1797
+ # Unix timestamp representing the end of the trial offer period. Required when the trial offer has `duration.type=timestamp`. Cannot be specified when `duration.type=relative`.
1798
+ attr_accessor :trial_end
1078
1799
  # The ID of the trial offer to apply to the subscription item.
1079
1800
  attr_accessor :trial_offer
1080
1801
 
1081
- def initialize(trial_offer: nil)
1802
+ def initialize(trial_end: nil, trial_offer: nil)
1803
+ @trial_end = trial_end
1082
1804
  @trial_offer = trial_offer
1083
1805
  end
1084
1806
  end
1085
1807
 
1086
1808
  class Discount < ::Stripe::RequestParams
1809
+ class DiscountEnd < ::Stripe::RequestParams
1810
+ class Duration < ::Stripe::RequestParams
1811
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1812
+ attr_accessor :interval
1813
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1814
+ attr_accessor :interval_count
1815
+
1816
+ def initialize(interval: nil, interval_count: nil)
1817
+ @interval = interval
1818
+ @interval_count = interval_count
1819
+ end
1820
+ end
1821
+ # Time span for the redeemed discount.
1822
+ attr_accessor :duration
1823
+ # A precise Unix timestamp for the discount to end. Must be in the future.
1824
+ attr_accessor :timestamp
1825
+ # The type of calculation made to determine when the discount ends.
1826
+ attr_accessor :type
1827
+
1828
+ def initialize(duration: nil, timestamp: nil, type: nil)
1829
+ @duration = duration
1830
+ @timestamp = timestamp
1831
+ @type = type
1832
+ end
1833
+ end
1087
1834
  # ID of the coupon to create a new discount for.
1088
1835
  attr_accessor :coupon
1089
1836
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
1090
1837
  attr_accessor :discount
1838
+ # Details to determine how long the discount should be applied for.
1839
+ attr_accessor :discount_end
1091
1840
  # ID of the promotion code to create a new discount for.
1092
1841
  attr_accessor :promotion_code
1093
1842
 
1094
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
1843
+ def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
1095
1844
  @coupon = coupon
1096
1845
  @discount = discount
1846
+ @discount_end = discount_end
1097
1847
  @promotion_code = promotion_code
1098
1848
  end
1099
1849
  end
@@ -1245,6 +1995,15 @@ module Stripe
1245
1995
  @type = type
1246
1996
  end
1247
1997
  end
1998
+
1999
+ class Prebilling < ::Stripe::RequestParams
2000
+ # This is used to determine the number of billing cycles to prebill.
2001
+ attr_accessor :iterations
2002
+
2003
+ def initialize(iterations: nil)
2004
+ @iterations = iterations
2005
+ end
2006
+ end
1248
2007
  # For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.
1249
2008
  attr_accessor :billing_cycle_anchor
1250
2009
  # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
@@ -1269,6 +2028,8 @@ module Stripe
1269
2028
  #
1270
2029
  # `pending_invoice_item` never has a preview available because pausing wouldn't generate an invoice, and paused subscriptions don't generate invoices either.
1271
2030
  attr_accessor :pause
2031
+ # The pre-billing to apply to the subscription as a preview.
2032
+ attr_accessor :prebilling
1272
2033
  # Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
1273
2034
  attr_accessor :proration_behavior
1274
2035
  # If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.
@@ -1291,6 +2052,7 @@ module Stripe
1291
2052
  items: nil,
1292
2053
  metadata: nil,
1293
2054
  pause: nil,
2055
+ prebilling: nil,
1294
2056
  proration_behavior: nil,
1295
2057
  proration_date: nil,
1296
2058
  resume_at: nil,
@@ -1307,6 +2069,7 @@ module Stripe
1307
2069
  @items = items
1308
2070
  @metadata = metadata
1309
2071
  @pause = pause
2072
+ @prebilling = prebilling
1310
2073
  @proration_behavior = proration_behavior
1311
2074
  @proration_date = proration_date
1312
2075
  @resume_at = resume_at