stripe 19.2.0.pre.beta.2 → 19.2.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 (551) hide show
  1. checksums.yaml +4 -4
  2. data/lib/stripe/api_requestor.rb +3 -36
  3. data/lib/stripe/api_version.rb +2 -1
  4. data/lib/stripe/errors.rb +0 -87
  5. data/lib/stripe/event_types.rb +0 -228
  6. data/lib/stripe/object_types.rb +0 -61
  7. data/lib/stripe/params/account_create_params.rb +17 -364
  8. data/lib/stripe/params/account_session_create_params.rb +1 -226
  9. data/lib/stripe/params/account_update_params.rb +16 -326
  10. data/lib/stripe/params/balance_settings_update_params.rb +42 -2
  11. data/lib/stripe/params/charge_capture_params.rb +0 -1646
  12. data/lib/stripe/params/charge_create_params.rb +4 -1
  13. data/lib/stripe/params/charge_update_params.rb +0 -1646
  14. data/lib/stripe/params/checkout/session_create_params.rb +31 -141
  15. data/lib/stripe/params/checkout/session_update_params.rb +1 -176
  16. data/lib/stripe/params/confirmation_token_create_params.rb +11 -79
  17. data/lib/stripe/params/coupon_create_params.rb +1 -17
  18. data/lib/stripe/params/customer_session_create_params.rb +1 -32
  19. data/lib/stripe/params/dispute_update_params.rb +1 -10
  20. data/lib/stripe/params/financial_connections/session_create_params.rb +2 -64
  21. data/lib/stripe/params/invoice_add_lines_params.rb +1 -48
  22. data/lib/stripe/params/invoice_attach_payment_params.rb +1 -43
  23. data/lib/stripe/params/invoice_create_params.rb +2 -70
  24. data/lib/stripe/params/invoice_create_preview_params.rb +13 -790
  25. data/lib/stripe/params/invoice_item_create_params.rb +1 -33
  26. data/lib/stripe/params/invoice_item_update_params.rb +1 -33
  27. data/lib/stripe/params/invoice_line_item_update_params.rb +1 -48
  28. data/lib/stripe/params/invoice_update_lines_params.rb +1 -48
  29. data/lib/stripe/params/invoice_update_params.rb +2 -70
  30. data/lib/stripe/params/issuing/cardholder_create_params.rb +1 -2
  31. data/lib/stripe/params/issuing/transaction_list_params.rb +0 -4
  32. data/lib/stripe/params/payment_intent_capture_params.rb +3 -1645
  33. data/lib/stripe/params/payment_intent_confirm_params.rb +136 -3038
  34. data/lib/stripe/params/payment_intent_create_params.rb +167 -3043
  35. data/lib/stripe/params/payment_intent_increment_authorization_params.rb +2 -39
  36. data/lib/stripe/params/payment_intent_update_params.rb +121 -3034
  37. data/lib/stripe/params/payment_link_create_params.rb +30 -16
  38. data/lib/stripe/params/payment_link_update_params.rb +29 -0
  39. data/lib/stripe/params/payment_method_configuration_create_params.rb +24 -87
  40. data/lib/stripe/params/payment_method_configuration_list_params.rb +4 -0
  41. data/lib/stripe/params/payment_method_configuration_update_params.rb +24 -87
  42. data/lib/stripe/params/payment_method_create_params.rb +11 -75
  43. data/lib/stripe/params/payout_create_params.rb +1 -1
  44. data/lib/stripe/params/plan_create_params.rb +0 -15
  45. data/lib/stripe/params/price_create_params.rb +0 -15
  46. data/lib/stripe/params/price_update_params.rb +0 -19
  47. data/lib/stripe/params/product_create_params.rb +0 -16
  48. data/lib/stripe/params/product_update_params.rb +0 -16
  49. data/lib/stripe/params/quote_create_params.rb +3 -809
  50. data/lib/stripe/params/quote_list_params.rb +0 -4
  51. data/lib/stripe/params/quote_update_params.rb +4 -817
  52. data/lib/stripe/params/setup_intent_confirm_params.rb +21 -110
  53. data/lib/stripe/params/setup_intent_create_params.rb +21 -110
  54. data/lib/stripe/params/setup_intent_update_params.rb +21 -110
  55. data/lib/stripe/params/subscription_create_params.rb +11 -181
  56. data/lib/stripe/params/subscription_item_create_params.rb +3 -69
  57. data/lib/stripe/params/subscription_item_delete_params.rb +1 -7
  58. data/lib/stripe/params/subscription_item_update_params.rb +2 -52
  59. data/lib/stripe/params/subscription_schedule_create_params.rb +9 -167
  60. data/lib/stripe/params/subscription_schedule_update_params.rb +9 -167
  61. data/lib/stripe/params/subscription_update_params.rb +11 -161
  62. data/lib/stripe/params/tax/calculation_create_params.rb +0 -4
  63. data/lib/stripe/params/tax/registration_create_params.rb +0 -104
  64. data/lib/stripe/params/terminal/configuration_create_params.rb +52 -13
  65. data/lib/stripe/params/terminal/configuration_update_params.rb +52 -13
  66. data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +11 -79
  67. data/lib/stripe/params/test_helpers/test_clock_create_params.rb +4 -1
  68. data/lib/stripe/params/test_helpers/treasury/received_credit_create_params.rb +1 -25
  69. data/lib/stripe/params/test_helpers/treasury/received_debit_create_params.rb +1 -25
  70. data/lib/stripe/params/transfer_create_params.rb +0 -4
  71. data/lib/stripe/params/treasury/financial_account_create_params.rb +1 -8
  72. data/lib/stripe/params/treasury/financial_account_features_update_params.rb +1 -4
  73. data/lib/stripe/params/treasury/financial_account_update_features_params.rb +1 -4
  74. data/lib/stripe/params/treasury/financial_account_update_params.rb +1 -8
  75. data/lib/stripe/params/treasury/outbound_payment_create_params.rb +0 -4
  76. data/lib/stripe/params/treasury/outbound_transfer_create_params.rb +0 -24
  77. data/lib/stripe/params/treasury/received_credit_create_params.rb +1 -25
  78. data/lib/stripe/params/treasury/received_debit_create_params.rb +1 -25
  79. data/lib/stripe/params/v2/core/account_create_params.rb +33 -288
  80. data/lib/stripe/params/v2/core/account_token_create_params.rb +28 -18
  81. data/lib/stripe/params/v2/core/account_update_params.rb +33 -281
  82. data/lib/stripe/params.rb +1342 -795
  83. data/lib/stripe/railtie.rb +8 -0
  84. data/lib/stripe/resources/account.rb +5 -259
  85. data/lib/stripe/resources/account_session.rb +0 -81
  86. data/lib/stripe/resources/balance.rb +0 -83
  87. data/lib/stripe/resources/balance_settings.rb +42 -2
  88. data/lib/stripe/resources/billing/alert_triggered.rb +0 -4
  89. data/lib/stripe/resources/card.rb +0 -2
  90. data/lib/stripe/resources/charge.rb +36 -211
  91. data/lib/stripe/resources/checkout/session.rb +26 -82
  92. data/lib/stripe/resources/confirmation_token.rb +20 -125
  93. data/lib/stripe/resources/coupon.rb +1 -26
  94. data/lib/stripe/resources/credit_note_line_item.rb +0 -18
  95. data/lib/stripe/resources/customer_session.rb +0 -36
  96. data/lib/stripe/resources/discount.rb +2 -2
  97. data/lib/stripe/resources/dispute.rb +0 -22
  98. data/lib/stripe/resources/event.rb +1 -64
  99. data/lib/stripe/resources/financial_connections/account.rb +0 -57
  100. data/lib/stripe/resources/financial_connections/session.rb +1 -125
  101. data/lib/stripe/resources/invoice.rb +3 -117
  102. data/lib/stripe/resources/invoice_item.rb +34 -3
  103. data/lib/stripe/resources/invoice_line_item.rb +0 -40
  104. data/lib/stripe/resources/issuing/dispute.rb +1 -1
  105. data/lib/stripe/resources/issuing/personalization_design.rb +1 -1
  106. data/lib/stripe/resources/issuing/transaction.rb +0 -2
  107. data/lib/stripe/resources/line_item.rb +0 -42
  108. data/lib/stripe/resources/mandate.rb +13 -12
  109. data/lib/stripe/resources/payment_attempt_record.rb +41 -187
  110. data/lib/stripe/resources/payment_intent.rb +96 -1583
  111. data/lib/stripe/resources/payment_link.rb +40 -0
  112. data/lib/stripe/resources/payment_method.rb +21 -130
  113. data/lib/stripe/resources/payment_method_configuration.rb +20 -122
  114. data/lib/stripe/resources/payment_record.rb +41 -187
  115. data/lib/stripe/resources/price.rb +0 -20
  116. data/lib/stripe/resources/product.rb +0 -18
  117. data/lib/stripe/resources/quote.rb +2 -569
  118. data/lib/stripe/resources/radar/payment_evaluation.rb +1 -1
  119. data/lib/stripe/resources/refund.rb +13 -18
  120. data/lib/stripe/resources/reserve/hold.rb +0 -7
  121. data/lib/stripe/resources/reserve/release.rb +0 -12
  122. data/lib/stripe/resources/setup_attempt.rb +4 -26
  123. data/lib/stripe/resources/setup_intent.rb +27 -22
  124. data/lib/stripe/resources/source.rb +0 -38
  125. data/lib/stripe/resources/subscription.rb +10 -107
  126. data/lib/stripe/resources/subscription_item.rb +1 -41
  127. data/lib/stripe/resources/subscription_schedule.rb +5 -198
  128. data/lib/stripe/resources/tax/calculation_line_item.rb +0 -2
  129. data/lib/stripe/resources/tax/registration.rb +0 -128
  130. data/lib/stripe/resources/tax_code.rb +1 -15
  131. data/lib/stripe/resources/terminal/configuration.rb +64 -16
  132. data/lib/stripe/resources/terminal/reader.rb +116 -8
  133. data/lib/stripe/resources/transfer.rb +0 -2
  134. data/lib/stripe/resources/treasury/financial_account.rb +0 -2
  135. data/lib/stripe/resources/treasury/financial_account_features.rb +0 -2
  136. data/lib/stripe/resources/treasury/outbound_payment.rb +0 -2
  137. data/lib/stripe/resources/treasury/outbound_transfer.rb +0 -30
  138. data/lib/stripe/resources/treasury/received_credit.rb +0 -30
  139. data/lib/stripe/resources/treasury/received_debit.rb +0 -32
  140. data/lib/stripe/resources/v2/commerce/product_catalog_import.rb +1 -1
  141. data/lib/stripe/resources/v2/core/account.rb +40 -607
  142. data/lib/stripe/resources/v2/core/account_token.rb +1 -1
  143. data/lib/stripe/resources/v2/core/event.rb +1 -0
  144. data/lib/stripe/resources.rb +500 -301
  145. data/lib/stripe/services/account_service.rb +0 -15
  146. data/lib/stripe/services/billing_service.rb +1 -2
  147. data/lib/stripe/services/credit_note_service.rb +0 -14
  148. data/lib/stripe/services/customer_service.rb +0 -15
  149. data/lib/stripe/services/financial_connections/account_service.rb +1 -3
  150. data/lib/stripe/services/financial_connections_service.rb +1 -3
  151. data/lib/stripe/services/invoice_service.rb +0 -41
  152. data/lib/stripe/services/issuing_service.rb +1 -5
  153. data/lib/stripe/services/mandate_service.rb +0 -5
  154. data/lib/stripe/services/payment_intent_service.rb +3 -38
  155. data/lib/stripe/services/promotion_code_service.rb +0 -29
  156. data/lib/stripe/services/quote_service.rb +1 -49
  157. data/lib/stripe/services/subscription_schedule_service.rb +0 -55
  158. data/lib/stripe/services/subscription_service.rb +2 -32
  159. data/lib/stripe/services/tax_service.rb +1 -3
  160. data/lib/stripe/services/terminal_service.rb +1 -2
  161. data/lib/stripe/services/test_helpers_service.rb +1 -2
  162. data/lib/stripe/services/v1_services.rb +1 -11
  163. data/lib/stripe/services/v2/billing_service.rb +1 -5
  164. data/lib/stripe/services/v2/core/account_service.rb +1 -1
  165. data/lib/stripe/services/v2/core/account_token_service.rb +5 -1
  166. data/lib/stripe/services/v2/core/event_service.rb +2 -1
  167. data/lib/stripe/services/v2/core_service.rb +1 -3
  168. data/lib/stripe/services/v2_services.rb +1 -8
  169. data/lib/stripe/services.rb +469 -268
  170. data/lib/stripe/stripe_client.rb +1 -8
  171. data/lib/stripe/stripe_configuration.rb +1 -3
  172. data/lib/stripe/stripe_object.rb +1 -1
  173. data/lib/stripe/util.rb +1 -7
  174. data/lib/stripe/version.rb +1 -1
  175. data/lib/stripe.rb +25 -58
  176. data/rbi/stripe/stripe_client.rbi +0 -13
  177. data/rbi/stripe.rbi +53183 -118054
  178. metadata +5 -377
  179. data/lib/stripe/events/v2_core_account_including_configuration_storer_capability_status_updated_event.rb +0 -63
  180. data/lib/stripe/events/v2_core_account_including_configuration_storer_updated_event.rb +0 -44
  181. data/lib/stripe/events/v2_core_batch_job_batch_failed_event.rb +0 -44
  182. data/lib/stripe/events/v2_core_batch_job_canceled_event.rb +0 -44
  183. data/lib/stripe/events/v2_core_batch_job_completed_event.rb +0 -44
  184. data/lib/stripe/events/v2_core_batch_job_created_event.rb +0 -44
  185. data/lib/stripe/events/v2_core_batch_job_ready_for_upload_event.rb +0 -44
  186. data/lib/stripe/events/v2_core_batch_job_timeout_event.rb +0 -44
  187. data/lib/stripe/events/v2_core_batch_job_updated_event.rb +0 -44
  188. data/lib/stripe/events/v2_core_batch_job_upload_timeout_event.rb +0 -44
  189. data/lib/stripe/events/v2_core_batch_job_validating_event.rb +0 -44
  190. data/lib/stripe/events/v2_core_batch_job_validation_failed_event.rb +0 -44
  191. data/lib/stripe/events/v2_core_health_event_generation_failure_resolved_event.rb +0 -78
  192. data/lib/stripe/events/v2_data_reporting_query_run_created_event.rb +0 -44
  193. data/lib/stripe/events/v2_data_reporting_query_run_failed_event.rb +0 -44
  194. data/lib/stripe/events/v2_data_reporting_query_run_succeeded_event.rb +0 -44
  195. data/lib/stripe/events/v2_data_reporting_query_run_updated_event.rb +0 -44
  196. data/lib/stripe/events/v2_extend_workflow_run_failed_event.rb +0 -75
  197. data/lib/stripe/events/v2_extend_workflow_run_started_event.rb +0 -44
  198. data/lib/stripe/events/v2_extend_workflow_run_succeeded_event.rb +0 -44
  199. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +0 -44
  200. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +0 -44
  201. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +0 -44
  202. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +0 -44
  203. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +0 -44
  204. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +0 -61
  205. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +0 -44
  206. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +0 -44
  207. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +0 -44
  208. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +0 -44
  209. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +0 -44
  210. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +0 -44
  211. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +0 -44
  212. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +0 -44
  213. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +0 -44
  214. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +0 -44
  215. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +0 -44
  216. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +0 -44
  217. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +0 -44
  218. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +0 -44
  219. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +0 -44
  220. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +0 -44
  221. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +0 -44
  222. data/lib/stripe/events/v2_money_management_payout_method_created_event.rb +0 -44
  223. data/lib/stripe/events/v2_money_management_payout_method_updated_event.rb +0 -44
  224. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +0 -61
  225. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +0 -44
  226. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +0 -44
  227. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +0 -44
  228. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +0 -44
  229. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +0 -44
  230. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +0 -44
  231. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +0 -44
  232. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +0 -44
  233. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +0 -63
  234. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +0 -44
  235. data/lib/stripe/events/v2_orchestrated_commerce_agreement_confirmed_event.rb +0 -97
  236. data/lib/stripe/events/v2_orchestrated_commerce_agreement_created_event.rb +0 -97
  237. data/lib/stripe/events/v2_orchestrated_commerce_agreement_partially_confirmed_event.rb +0 -97
  238. data/lib/stripe/events/v2_orchestrated_commerce_agreement_terminated_event.rb +0 -97
  239. data/lib/stripe/params/account_notice_list_params.rb +0 -25
  240. data/lib/stripe/params/account_notice_retrieve_params.rb +0 -13
  241. data/lib/stripe/params/account_notice_update_params.rb +0 -36
  242. data/lib/stripe/params/billing/analytics/meter_usage_retrieve_params.rb +0 -65
  243. data/lib/stripe/params/capital/financing_offer_list_params.rb +0 -58
  244. data/lib/stripe/params/capital/financing_offer_mark_delivered_params.rb +0 -15
  245. data/lib/stripe/params/capital/financing_offer_retrieve_params.rb +0 -15
  246. data/lib/stripe/params/capital/financing_summary_retrieve_params.rb +0 -15
  247. data/lib/stripe/params/capital/financing_transaction_list_params.rb +0 -45
  248. data/lib/stripe/params/capital/financing_transaction_retrieve_params.rb +0 -15
  249. data/lib/stripe/params/external_account_create_params.rb +0 -134
  250. data/lib/stripe/params/external_account_delete_params.rb +0 -6
  251. data/lib/stripe/params/external_account_list_params.rb +0 -25
  252. data/lib/stripe/params/external_account_retrieve_params.rb +0 -13
  253. data/lib/stripe/params/external_account_update_params.rb +0 -91
  254. data/lib/stripe/params/financial_connections/account_inferred_balance_list_params.rb +0 -24
  255. data/lib/stripe/params/financial_connections/authorization_retrieve_params.rb +0 -15
  256. data/lib/stripe/params/financial_connections/institution_list_params.rb +0 -24
  257. data/lib/stripe/params/financial_connections/institution_retrieve_params.rb +0 -15
  258. data/lib/stripe/params/fx_quote_create_params.rb +0 -73
  259. data/lib/stripe/params/fx_quote_list_params.rb +0 -22
  260. data/lib/stripe/params/fx_quote_retrieve_params.rb +0 -13
  261. data/lib/stripe/params/invoice_detach_payment_params.rb +0 -16
  262. data/lib/stripe/params/issuing/credit_underwriting_record_correct_params.rb +0 -163
  263. data/lib/stripe/params/issuing/credit_underwriting_record_create_from_application_params.rb +0 -50
  264. data/lib/stripe/params/issuing/credit_underwriting_record_create_from_proactive_review_params.rb +0 -128
  265. data/lib/stripe/params/issuing/credit_underwriting_record_list_params.rb +0 -24
  266. data/lib/stripe/params/issuing/credit_underwriting_record_report_decision_params.rb +0 -86
  267. data/lib/stripe/params/issuing/credit_underwriting_record_retrieve_params.rb +0 -15
  268. data/lib/stripe/params/issuing/dispute_settlement_detail_list_params.rb +0 -33
  269. data/lib/stripe/params/issuing/dispute_settlement_detail_retrieve_params.rb +0 -15
  270. data/lib/stripe/params/issuing/fraud_liability_debit_list_params.rb +0 -44
  271. data/lib/stripe/params/issuing/fraud_liability_debit_retrieve_params.rb +0 -15
  272. data/lib/stripe/params/mandate_list_params.rb +0 -39
  273. data/lib/stripe/params/margin_create_params.rb +0 -25
  274. data/lib/stripe/params/margin_list_params.rb +0 -25
  275. data/lib/stripe/params/margin_retrieve_params.rb +0 -13
  276. data/lib/stripe/params/margin_update_params.rb +0 -22
  277. data/lib/stripe/params/order_create_params.rb +0 -2083
  278. data/lib/stripe/params/order_list_params.rb +0 -25
  279. data/lib/stripe/params/order_retrieve_params.rb +0 -13
  280. data/lib/stripe/params/order_submit_params.rb +0 -16
  281. data/lib/stripe/params/order_update_params.rb +0 -2087
  282. data/lib/stripe/params/payment_intent_decrement_authorization_params.rb +0 -297
  283. data/lib/stripe/params/payment_intent_trigger_action_params.rb +0 -27
  284. data/lib/stripe/params/privacy/redaction_job_cancel_params.rb +0 -15
  285. data/lib/stripe/params/privacy/redaction_job_create_params.rb +0 -67
  286. data/lib/stripe/params/privacy/redaction_job_list_params.rb +0 -27
  287. data/lib/stripe/params/privacy/redaction_job_retrieve_params.rb +0 -15
  288. data/lib/stripe/params/privacy/redaction_job_run_params.rb +0 -15
  289. data/lib/stripe/params/privacy/redaction_job_update_params.rb +0 -18
  290. data/lib/stripe/params/privacy/redaction_job_validate_params.rb +0 -15
  291. data/lib/stripe/params/privacy/redaction_job_validation_error_list_params.rb +0 -24
  292. data/lib/stripe/params/product_catalog/trial_offer_create_params.rb +0 -63
  293. data/lib/stripe/params/quote_line_list_params.rb +0 -22
  294. data/lib/stripe/params/quote_list_lines_params.rb +0 -22
  295. data/lib/stripe/params/quote_list_preview_invoice_lines_params.rb +0 -22
  296. data/lib/stripe/params/quote_mark_draft_params.rb +0 -13
  297. data/lib/stripe/params/quote_mark_stale_params.rb +0 -16
  298. data/lib/stripe/params/quote_preview_invoice_list_params.rb +0 -22
  299. data/lib/stripe/params/quote_preview_subscription_schedule_list_params.rb +0 -22
  300. data/lib/stripe/params/quote_reestimate_params.rb +0 -13
  301. data/lib/stripe/params/reserve/hold_list_params.rb +0 -53
  302. data/lib/stripe/params/reserve/hold_retrieve_params.rb +0 -15
  303. data/lib/stripe/params/reserve/plan_retrieve_params.rb +0 -15
  304. data/lib/stripe/params/reserve/release_list_params.rb +0 -41
  305. data/lib/stripe/params/reserve/release_retrieve_params.rb +0 -15
  306. data/lib/stripe/params/shared_payment/granted_token_create_params.rb +0 -47
  307. data/lib/stripe/params/shared_payment/granted_token_retrieve_params.rb +0 -15
  308. data/lib/stripe/params/shared_payment/granted_token_revoke_params.rb +0 -15
  309. data/lib/stripe/params/shared_payment/issued_token_create_params.rb +0 -67
  310. data/lib/stripe/params/shared_payment/issued_token_retrieve_params.rb +0 -15
  311. data/lib/stripe/params/shared_payment/issued_token_revoke_params.rb +0 -15
  312. data/lib/stripe/params/subscription_schedule_amend_params.rb +0 -578
  313. data/lib/stripe/params/tax/form_list_params.rb +0 -51
  314. data/lib/stripe/params/tax/form_pdf_params.rb +0 -15
  315. data/lib/stripe/params/tax/form_retrieve_params.rb +0 -15
  316. data/lib/stripe/params/tax/location_create_params.rb +0 -54
  317. data/lib/stripe/params/tax/location_list_params.rb +0 -27
  318. data/lib/stripe/params/tax/location_retrieve_params.rb +0 -15
  319. data/lib/stripe/params/terminal/reader_collected_data_retrieve_params.rb +0 -15
  320. data/lib/stripe/params/test_helpers/shared_payment/granted_token_create_params.rb +0 -49
  321. data/lib/stripe/params/test_helpers/shared_payment/granted_token_revoke_params.rb +0 -17
  322. data/lib/stripe/params/v2/billing/bill_setting_create_params.rb +0 -74
  323. data/lib/stripe/params/v2/billing/bill_setting_list_params.rb +0 -21
  324. data/lib/stripe/params/v2/billing/bill_setting_retrieve_params.rb +0 -10
  325. data/lib/stripe/params/v2/billing/bill_setting_update_params.rb +0 -80
  326. data/lib/stripe/params/v2/billing/bill_settings/version_list_params.rb +0 -19
  327. data/lib/stripe/params/v2/billing/bill_settings/version_retrieve_params.rb +0 -12
  328. data/lib/stripe/params/v2/billing/cadence_cancel_params.rb +0 -10
  329. data/lib/stripe/params/v2/billing/cadence_create_params.rb +0 -253
  330. data/lib/stripe/params/v2/billing/cadence_list_params.rb +0 -43
  331. data/lib/stripe/params/v2/billing/cadence_retrieve_params.rb +0 -17
  332. data/lib/stripe/params/v2/billing/cadence_update_params.rb +0 -75
  333. data/lib/stripe/params/v2/billing/collection_setting_create_params.rb +0 -257
  334. data/lib/stripe/params/v2/billing/collection_setting_list_params.rb +0 -21
  335. data/lib/stripe/params/v2/billing/collection_setting_retrieve_params.rb +0 -10
  336. data/lib/stripe/params/v2/billing/collection_setting_update_params.rb +0 -263
  337. data/lib/stripe/params/v2/billing/collection_settings/version_list_params.rb +0 -19
  338. data/lib/stripe/params/v2/billing/collection_settings/version_retrieve_params.rb +0 -12
  339. data/lib/stripe/params/v2/billing/profile_create_params.rb +0 -37
  340. data/lib/stripe/params/v2/billing/profile_list_params.rb +0 -40
  341. data/lib/stripe/params/v2/billing/profile_retrieve_params.rb +0 -10
  342. data/lib/stripe/params/v2/billing/profile_update_params.rb +0 -35
  343. data/lib/stripe/params/v2/core/batch_job_cancel_params.rb +0 -10
  344. data/lib/stripe/params/v2/core/batch_job_create_params.rb +0 -58
  345. data/lib/stripe/params/v2/core/batch_job_retrieve_params.rb +0 -10
  346. data/lib/stripe/params/v2/core/vault/gb_bank_account_acknowledge_confirmation_of_payee_params.rb +0 -12
  347. data/lib/stripe/params/v2/core/vault/gb_bank_account_archive_params.rb +0 -12
  348. data/lib/stripe/params/v2/core/vault/gb_bank_account_create_params.rb +0 -58
  349. data/lib/stripe/params/v2/core/vault/gb_bank_account_initiate_confirmation_of_payee_params.rb +0 -22
  350. data/lib/stripe/params/v2/core/vault/gb_bank_account_list_params.rb +0 -19
  351. data/lib/stripe/params/v2/core/vault/gb_bank_account_retrieve_params.rb +0 -12
  352. data/lib/stripe/params/v2/core/vault/us_bank_account_archive_params.rb +0 -12
  353. data/lib/stripe/params/v2/core/vault/us_bank_account_confirm_microdeposits_params.rb +0 -22
  354. data/lib/stripe/params/v2/core/vault/us_bank_account_create_params.rb +0 -37
  355. data/lib/stripe/params/v2/core/vault/us_bank_account_list_params.rb +0 -22
  356. data/lib/stripe/params/v2/core/vault/us_bank_account_retrieve_params.rb +0 -12
  357. data/lib/stripe/params/v2/core/vault/us_bank_account_send_microdeposits_params.rb +0 -12
  358. data/lib/stripe/params/v2/core/vault/us_bank_account_update_params.rb +0 -22
  359. data/lib/stripe/params/v2/data/reporting/query_run_create_params.rb +0 -31
  360. data/lib/stripe/params/v2/data/reporting/query_run_retrieve_params.rb +0 -12
  361. data/lib/stripe/params/v2/extend/workflow_invoke_params.rb +0 -17
  362. data/lib/stripe/params/v2/extend/workflow_list_params.rb +0 -21
  363. data/lib/stripe/params/v2/extend/workflow_retrieve_params.rb +0 -10
  364. data/lib/stripe/params/v2/extend/workflow_run_list_params.rb +0 -23
  365. data/lib/stripe/params/v2/extend/workflow_run_retrieve_params.rb +0 -10
  366. data/lib/stripe/params/v2/iam/activity_log_list_params.rb +0 -23
  367. data/lib/stripe/params/v2/money_management/adjustment_list_params.rb +0 -48
  368. data/lib/stripe/params/v2/money_management/adjustment_retrieve_params.rb +0 -10
  369. data/lib/stripe/params/v2/money_management/financial_account_close_params.rb +0 -28
  370. data/lib/stripe/params/v2/money_management/financial_account_create_params.rb +0 -34
  371. data/lib/stripe/params/v2/money_management/financial_account_list_params.rb +0 -20
  372. data/lib/stripe/params/v2/money_management/financial_account_retrieve_params.rb +0 -10
  373. data/lib/stripe/params/v2/money_management/financial_account_update_params.rb +0 -20
  374. data/lib/stripe/params/v2/money_management/financial_address_create_params.rb +0 -20
  375. data/lib/stripe/params/v2/money_management/financial_address_list_params.rb +0 -23
  376. data/lib/stripe/params/v2/money_management/financial_address_retrieve_params.rb +0 -17
  377. data/lib/stripe/params/v2/money_management/inbound_transfer_create_params.rb +0 -50
  378. data/lib/stripe/params/v2/money_management/inbound_transfer_list_params.rb +0 -44
  379. data/lib/stripe/params/v2/money_management/inbound_transfer_retrieve_params.rb +0 -10
  380. data/lib/stripe/params/v2/money_management/outbound_payment_cancel_params.rb +0 -10
  381. data/lib/stripe/params/v2/money_management/outbound_payment_create_params.rb +0 -102
  382. data/lib/stripe/params/v2/money_management/outbound_payment_list_params.rb +0 -52
  383. data/lib/stripe/params/v2/money_management/outbound_payment_quote_create_params.rb +0 -67
  384. data/lib/stripe/params/v2/money_management/outbound_payment_quote_retrieve_params.rb +0 -10
  385. data/lib/stripe/params/v2/money_management/outbound_payment_retrieve_params.rb +0 -10
  386. data/lib/stripe/params/v2/money_management/outbound_setup_intent_cancel_params.rb +0 -10
  387. data/lib/stripe/params/v2/money_management/outbound_setup_intent_create_params.rb +0 -92
  388. data/lib/stripe/params/v2/money_management/outbound_setup_intent_list_params.rb +0 -17
  389. data/lib/stripe/params/v2/money_management/outbound_setup_intent_retrieve_params.rb +0 -10
  390. data/lib/stripe/params/v2/money_management/outbound_setup_intent_update_params.rb +0 -87
  391. data/lib/stripe/params/v2/money_management/outbound_transfer_cancel_params.rb +0 -10
  392. data/lib/stripe/params/v2/money_management/outbound_transfer_create_params.rb +0 -77
  393. data/lib/stripe/params/v2/money_management/outbound_transfer_list_params.rb +0 -48
  394. data/lib/stripe/params/v2/money_management/outbound_transfer_retrieve_params.rb +0 -10
  395. data/lib/stripe/params/v2/money_management/payout_method_archive_params.rb +0 -10
  396. data/lib/stripe/params/v2/money_management/payout_method_list_params.rb +0 -31
  397. data/lib/stripe/params/v2/money_management/payout_method_retrieve_params.rb +0 -10
  398. data/lib/stripe/params/v2/money_management/payout_method_unarchive_params.rb +0 -10
  399. data/lib/stripe/params/v2/money_management/payout_methods_bank_account_spec_retrieve_params.rb +0 -17
  400. data/lib/stripe/params/v2/money_management/received_credit_list_params.rb +0 -44
  401. data/lib/stripe/params/v2/money_management/received_credit_retrieve_params.rb +0 -10
  402. data/lib/stripe/params/v2/money_management/received_debit_list_params.rb +0 -17
  403. data/lib/stripe/params/v2/money_management/received_debit_retrieve_params.rb +0 -10
  404. data/lib/stripe/params/v2/money_management/transaction_entry_list_params.rb +0 -43
  405. data/lib/stripe/params/v2/money_management/transaction_entry_retrieve_params.rb +0 -10
  406. data/lib/stripe/params/v2/money_management/transaction_list_params.rb +0 -47
  407. data/lib/stripe/params/v2/money_management/transaction_retrieve_params.rb +0 -10
  408. data/lib/stripe/params/v2/network/business_profile_me_params.rb +0 -10
  409. data/lib/stripe/params/v2/network/business_profile_retrieve_params.rb +0 -10
  410. data/lib/stripe/params/v2/orchestrated_commerce/agreement_confirm_params.rb +0 -10
  411. data/lib/stripe/params/v2/orchestrated_commerce/agreement_create_params.rb +0 -17
  412. data/lib/stripe/params/v2/orchestrated_commerce/agreement_list_params.rb +0 -20
  413. data/lib/stripe/params/v2/orchestrated_commerce/agreement_retrieve_params.rb +0 -10
  414. data/lib/stripe/params/v2/orchestrated_commerce/agreement_terminate_params.rb +0 -10
  415. data/lib/stripe/params/v2/test_helpers/financial_address_credit_params.rb +0 -23
  416. data/lib/stripe/params/v2/test_helpers/financial_address_generate_microdeposits_params.rb +0 -10
  417. data/lib/stripe/resources/account_notice.rb +0 -94
  418. data/lib/stripe/resources/billing/analytics/meter_usage.rb +0 -33
  419. data/lib/stripe/resources/billing/analytics/meter_usage_row.rb +0 -38
  420. data/lib/stripe/resources/capital/financing_offer.rb +0 -142
  421. data/lib/stripe/resources/capital/financing_summary.rb +0 -82
  422. data/lib/stripe/resources/capital/financing_transaction.rb +0 -99
  423. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -35
  424. data/lib/stripe/resources/financial_connections/authorization.rb +0 -82
  425. data/lib/stripe/resources/financial_connections/institution.rb +0 -127
  426. data/lib/stripe/resources/fx_quote.rb +0 -147
  427. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -263
  428. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -71
  429. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -51
  430. data/lib/stripe/resources/issuing/settlement.rb +0 -61
  431. data/lib/stripe/resources/margin.rb +0 -64
  432. data/lib/stripe/resources/order.rb +0 -927
  433. data/lib/stripe/resources/privacy/redaction_job.rb +0 -189
  434. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +0 -49
  435. data/lib/stripe/resources/product_catalog/trial_offer.rb +0 -103
  436. data/lib/stripe/resources/quote_line.rb +0 -525
  437. data/lib/stripe/resources/quote_preview_invoice.rb +0 -1181
  438. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -734
  439. data/lib/stripe/resources/shared_payment/granted_token.rb +0 -1766
  440. data/lib/stripe/resources/shared_payment/issued_token.rb +0 -291
  441. data/lib/stripe/resources/tax/form.rb +0 -264
  442. data/lib/stripe/resources/tax/location.rb +0 -72
  443. data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -47
  444. data/lib/stripe/resources/v2/billing/bill_setting.rb +0 -102
  445. data/lib/stripe/resources/v2/billing/bill_setting_version.rb +0 -91
  446. data/lib/stripe/resources/v2/billing/cadence.rb +0 -710
  447. data/lib/stripe/resources/v2/billing/collection_setting.rb +0 -327
  448. data/lib/stripe/resources/v2/billing/collection_setting_version.rb +0 -316
  449. data/lib/stripe/resources/v2/billing/profile.rb +0 -47
  450. data/lib/stripe/resources/v2/core/batch_job.rb +0 -492
  451. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +0 -136
  452. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +0 -105
  453. data/lib/stripe/resources/v2/data/reporting/query_run.rb +0 -142
  454. data/lib/stripe/resources/v2/extend/workflow.rb +0 -80
  455. data/lib/stripe/resources/v2/extend/workflow_run.rb +0 -158
  456. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +0 -29
  457. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +0 -31
  458. data/lib/stripe/resources/v2/iam/activity_log.rb +0 -187
  459. data/lib/stripe/resources/v2/money_management/adjustment.rb +0 -67
  460. data/lib/stripe/resources/v2/money_management/financial_account.rb +0 -140
  461. data/lib/stripe/resources/v2/money_management/financial_address.rb +0 -160
  462. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +0 -181
  463. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +0 -219
  464. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +0 -144
  465. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +0 -69
  466. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +0 -196
  467. data/lib/stripe/resources/v2/money_management/payout_method.rb +0 -145
  468. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +0 -83
  469. data/lib/stripe/resources/v2/money_management/received_credit.rb +0 -230
  470. data/lib/stripe/resources/v2/money_management/received_debit.rb +0 -136
  471. data/lib/stripe/resources/v2/money_management/transaction.rb +0 -135
  472. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +0 -105
  473. data/lib/stripe/resources/v2/network/business_profile.rb +0 -84
  474. data/lib/stripe/resources/v2/orchestrated_commerce/agreement.rb +0 -93
  475. data/lib/stripe/services/account_notice_service.rb +0 -39
  476. data/lib/stripe/services/billing/analytics/meter_usage_service.rb +0 -21
  477. data/lib/stripe/services/billing/analytics_service.rb +0 -15
  478. data/lib/stripe/services/capital/financing_offer_service.rb +0 -42
  479. data/lib/stripe/services/capital/financing_summary_service.rb +0 -19
  480. data/lib/stripe/services/capital/financing_transaction_service.rb +0 -31
  481. data/lib/stripe/services/capital_service.rb +0 -15
  482. data/lib/stripe/services/external_account_service.rb +0 -68
  483. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -19
  484. data/lib/stripe/services/financial_connections/authorization_service.rb +0 -19
  485. data/lib/stripe/services/financial_connections/institution_service.rb +0 -30
  486. data/lib/stripe/services/fx_quote_service.rb +0 -27
  487. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -74
  488. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -30
  489. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -30
  490. data/lib/stripe/services/margin_service.rb +0 -50
  491. data/lib/stripe/services/order_service.rb +0 -53
  492. data/lib/stripe/services/privacy/redaction_job_service.rb +0 -104
  493. data/lib/stripe/services/privacy/redaction_job_validation_error_service.rb +0 -19
  494. data/lib/stripe/services/privacy_service.rb +0 -13
  495. data/lib/stripe/services/product_catalog/trial_offer_service.rb +0 -19
  496. data/lib/stripe/services/product_catalog_service.rb +0 -13
  497. data/lib/stripe/services/quote_line_service.rb +0 -17
  498. data/lib/stripe/services/quote_preview_invoice_service.rb +0 -17
  499. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -17
  500. data/lib/stripe/services/reserve/hold_service.rb +0 -30
  501. data/lib/stripe/services/reserve/plan_service.rb +0 -19
  502. data/lib/stripe/services/reserve/release_service.rb +0 -30
  503. data/lib/stripe/services/reserve_service.rb +0 -15
  504. data/lib/stripe/services/shared_payment/granted_token_service.rb +0 -19
  505. data/lib/stripe/services/shared_payment/issued_token_service.rb +0 -41
  506. data/lib/stripe/services/shared_payment_service.rb +0 -14
  507. data/lib/stripe/services/tax/form_service.rb +0 -37
  508. data/lib/stripe/services/tax/location_service.rb +0 -45
  509. data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -19
  510. data/lib/stripe/services/test_helpers/shared_payment/granted_token_service.rb +0 -32
  511. data/lib/stripe/services/test_helpers/shared_payment_service.rb +0 -15
  512. data/lib/stripe/services/v2/billing/bill_setting_service.rb +0 -61
  513. data/lib/stripe/services/v2/billing/bill_settings/version_service.rb +0 -34
  514. data/lib/stripe/services/v2/billing/cadence_service.rb +0 -65
  515. data/lib/stripe/services/v2/billing/collection_setting_service.rb +0 -69
  516. data/lib/stripe/services/v2/billing/collection_settings/version_service.rb +0 -34
  517. data/lib/stripe/services/v2/billing/profile_service.rb +0 -54
  518. data/lib/stripe/services/v2/core/batch_job_service.rb +0 -43
  519. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +0 -85
  520. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +0 -101
  521. data/lib/stripe/services/v2/core/vault_service.rb +0 -18
  522. data/lib/stripe/services/v2/data/reporting/query_run_service.rb +0 -35
  523. data/lib/stripe/services/v2/data/reporting_service.rb +0 -17
  524. data/lib/stripe/services/v2/datum_service.rb +0 -15
  525. data/lib/stripe/services/v2/extend/workflow_run_service.rb +0 -32
  526. data/lib/stripe/services/v2/extend/workflow_service.rb +0 -45
  527. data/lib/stripe/services/v2/extend_service.rb +0 -16
  528. data/lib/stripe/services/v2/iam/activity_log_service.rb +0 -21
  529. data/lib/stripe/services/v2/iam_service.rb +0 -15
  530. data/lib/stripe/services/v2/money_management/adjustment_service.rb +0 -32
  531. data/lib/stripe/services/v2/money_management/financial_account_service.rb +0 -70
  532. data/lib/stripe/services/v2/money_management/financial_address_service.rb +0 -46
  533. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +0 -45
  534. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +0 -34
  535. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +0 -62
  536. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +0 -75
  537. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +0 -60
  538. data/lib/stripe/services/v2/money_management/payout_method_service.rb +0 -66
  539. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +0 -23
  540. data/lib/stripe/services/v2/money_management/received_credit_service.rb +0 -32
  541. data/lib/stripe/services/v2/money_management/received_debit_service.rb +0 -32
  542. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +0 -32
  543. data/lib/stripe/services/v2/money_management/transaction_service.rb +0 -32
  544. data/lib/stripe/services/v2/money_management_service.rb +0 -31
  545. data/lib/stripe/services/v2/network/business_profile_service.rb +0 -32
  546. data/lib/stripe/services/v2/network_service.rb +0 -15
  547. data/lib/stripe/services/v2/orchestrated_commerce/agreement_service.rb +0 -65
  548. data/lib/stripe/services/v2/orchestrated_commerce_service.rb +0 -15
  549. data/lib/stripe/services/v2/test_helper_service.rb +0 -15
  550. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +0 -36
  551. data/lib/stripe/stripe_event_notification_handler.rb +0 -581
@@ -27,44 +27,16 @@ module Stripe
27
27
  end
28
28
 
29
29
  class Discount < ::Stripe::RequestParams
30
- class DiscountEnd < ::Stripe::RequestParams
31
- class Duration < ::Stripe::RequestParams
32
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
33
- attr_accessor :interval
34
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
35
- attr_accessor :interval_count
36
-
37
- def initialize(interval: nil, interval_count: nil)
38
- @interval = interval
39
- @interval_count = interval_count
40
- end
41
- end
42
- # Time span for the redeemed discount.
43
- attr_accessor :duration
44
- # A precise Unix timestamp for the discount to end. Must be in the future.
45
- attr_accessor :timestamp
46
- # The type of calculation made to determine when the discount ends.
47
- attr_accessor :type
48
-
49
- def initialize(duration: nil, timestamp: nil, type: nil)
50
- @duration = duration
51
- @timestamp = timestamp
52
- @type = type
53
- end
54
- end
55
30
  # ID of the coupon to create a new discount for.
56
31
  attr_accessor :coupon
57
32
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
58
33
  attr_accessor :discount
59
- # Details to determine how long the discount should be applied for.
60
- attr_accessor :discount_end
61
34
  # ID of the promotion code to create a new discount for.
62
35
  attr_accessor :promotion_code
63
36
 
64
- def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
37
+ def initialize(coupon: nil, discount: nil, promotion_code: nil)
65
38
  @coupon = coupon
66
39
  @discount = discount
67
- @discount_end = discount_end
68
40
  @promotion_code = promotion_code
69
41
  end
70
42
  end
@@ -92,537 +64,18 @@ module Stripe
92
64
  end
93
65
  end
94
66
 
95
- class Line < ::Stripe::RequestParams
96
- class Action < ::Stripe::RequestParams
97
- class AddDiscount < ::Stripe::RequestParams
98
- class DiscountEnd < ::Stripe::RequestParams
99
- # The type of calculation made to determine when the discount ends.
100
- attr_accessor :type
101
-
102
- def initialize(type: nil)
103
- @type = type
104
- end
105
- end
106
- # The coupon code to redeem.
107
- attr_accessor :coupon
108
- # An ID of an existing discount for a coupon that was already redeemed.
109
- attr_accessor :discount
110
- # Details to determine how long the discount should be applied for.
111
- attr_accessor :discount_end
112
- # 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.
113
- attr_accessor :index
114
- # The promotion code to redeem.
115
- attr_accessor :promotion_code
116
-
117
- def initialize(
118
- coupon: nil,
119
- discount: nil,
120
- discount_end: nil,
121
- index: nil,
122
- promotion_code: nil
123
- )
124
- @coupon = coupon
125
- @discount = discount
126
- @discount_end = discount_end
127
- @index = index
128
- @promotion_code = promotion_code
129
- end
130
- end
131
-
132
- class AddItem < ::Stripe::RequestParams
133
- class Discount < ::Stripe::RequestParams
134
- class DiscountEnd < ::Stripe::RequestParams
135
- class Duration < ::Stripe::RequestParams
136
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
137
- attr_accessor :interval
138
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
139
- attr_accessor :interval_count
140
-
141
- def initialize(interval: nil, interval_count: nil)
142
- @interval = interval
143
- @interval_count = interval_count
144
- end
145
- end
146
- # Time span for the redeemed discount.
147
- attr_accessor :duration
148
- # A precise Unix timestamp for the discount to end. Must be in the future.
149
- attr_accessor :timestamp
150
- # The type of calculation made to determine when the discount ends.
151
- attr_accessor :type
152
-
153
- def initialize(duration: nil, timestamp: nil, type: nil)
154
- @duration = duration
155
- @timestamp = timestamp
156
- @type = type
157
- end
158
- end
159
- # ID of the coupon to create a new discount for.
160
- attr_accessor :coupon
161
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
162
- attr_accessor :discount
163
- # Details to determine how long the discount should be applied for.
164
- attr_accessor :discount_end
165
- # ID of the promotion code to create a new discount for.
166
- attr_accessor :promotion_code
167
-
168
- def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
169
- @coupon = coupon
170
- @discount = discount
171
- @discount_end = discount_end
172
- @promotion_code = promotion_code
173
- end
174
- end
175
-
176
- class Trial < ::Stripe::RequestParams
177
- # 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.
178
- attr_accessor :converts_to
179
- # Determines the type of trial for this item.
180
- attr_accessor :type
181
-
182
- def initialize(converts_to: nil, type: nil)
183
- @converts_to = converts_to
184
- @type = type
185
- end
186
- end
187
- # The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
188
- attr_accessor :discounts
189
- # 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`.
190
- attr_accessor :metadata
191
- # The ID of the price object.
192
- attr_accessor :price
193
- # Quantity for this item.
194
- attr_accessor :quantity
195
- # 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`.
196
- attr_accessor :tax_rates
197
- # Options that configure the trial on the subscription item.
198
- attr_accessor :trial
199
- # The ID of the trial offer to apply to the configuration item.
200
- attr_accessor :trial_offer
201
-
202
- def initialize(
203
- discounts: nil,
204
- metadata: nil,
205
- price: nil,
206
- quantity: nil,
207
- tax_rates: nil,
208
- trial: nil,
209
- trial_offer: nil
210
- )
211
- @discounts = discounts
212
- @metadata = metadata
213
- @price = price
214
- @quantity = quantity
215
- @tax_rates = tax_rates
216
- @trial = trial
217
- @trial_offer = trial_offer
218
- end
219
- end
220
-
221
- class RemoveDiscount < ::Stripe::RequestParams
222
- # The coupon code to remove from the `discounts` array.
223
- attr_accessor :coupon
224
- # The ID of a discount to remove from the `discounts` array.
225
- attr_accessor :discount
226
- # The ID of a promotion code to remove from the `discounts` array.
227
- attr_accessor :promotion_code
228
-
229
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
230
- @coupon = coupon
231
- @discount = discount
232
- @promotion_code = promotion_code
233
- end
234
- end
235
-
236
- class RemoveItem < ::Stripe::RequestParams
237
- # ID of a price to remove.
238
- attr_accessor :price
239
-
240
- def initialize(price: nil)
241
- @price = price
242
- end
243
- end
244
-
245
- class SetDiscount < ::Stripe::RequestParams
246
- # The coupon code to replace the `discounts` array with.
247
- attr_accessor :coupon
248
- # An ID of an existing discount to replace the `discounts` array with.
249
- attr_accessor :discount
250
- # An ID of an existing promotion code to replace the `discounts` array with.
251
- attr_accessor :promotion_code
252
-
253
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
254
- @coupon = coupon
255
- @discount = discount
256
- @promotion_code = promotion_code
257
- end
258
- end
259
-
260
- class SetItem < ::Stripe::RequestParams
261
- class Discount < ::Stripe::RequestParams
262
- class DiscountEnd < ::Stripe::RequestParams
263
- class Duration < ::Stripe::RequestParams
264
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
265
- attr_accessor :interval
266
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
267
- attr_accessor :interval_count
268
-
269
- def initialize(interval: nil, interval_count: nil)
270
- @interval = interval
271
- @interval_count = interval_count
272
- end
273
- end
274
- # Time span for the redeemed discount.
275
- attr_accessor :duration
276
- # A precise Unix timestamp for the discount to end. Must be in the future.
277
- attr_accessor :timestamp
278
- # The type of calculation made to determine when the discount ends.
279
- attr_accessor :type
280
-
281
- def initialize(duration: nil, timestamp: nil, type: nil)
282
- @duration = duration
283
- @timestamp = timestamp
284
- @type = type
285
- end
286
- end
287
- # ID of the coupon to create a new discount for.
288
- attr_accessor :coupon
289
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
290
- attr_accessor :discount
291
- # Details to determine how long the discount should be applied for.
292
- attr_accessor :discount_end
293
- # ID of the promotion code to create a new discount for.
294
- attr_accessor :promotion_code
295
-
296
- def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
297
- @coupon = coupon
298
- @discount = discount
299
- @discount_end = discount_end
300
- @promotion_code = promotion_code
301
- end
302
- end
303
-
304
- class Trial < ::Stripe::RequestParams
305
- # 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.
306
- attr_accessor :converts_to
307
- # Determines the type of trial for this item.
308
- attr_accessor :type
309
-
310
- def initialize(converts_to: nil, type: nil)
311
- @converts_to = converts_to
312
- @type = type
313
- end
314
- end
315
- # 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`.
316
- attr_accessor :discounts
317
- # 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`.
318
- attr_accessor :metadata
319
- # The ID of the price object.
320
- attr_accessor :price
321
- # 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`.
322
- attr_accessor :quantity
323
- # 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`.
324
- attr_accessor :tax_rates
325
- # 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`.
326
- attr_accessor :trial
327
- # The ID of the trial offer to apply to the configuration item.
328
- attr_accessor :trial_offer
329
-
330
- def initialize(
331
- discounts: nil,
332
- metadata: nil,
333
- price: nil,
334
- quantity: nil,
335
- tax_rates: nil,
336
- trial: nil,
337
- trial_offer: nil
338
- )
339
- @discounts = discounts
340
- @metadata = metadata
341
- @price = price
342
- @quantity = quantity
343
- @tax_rates = tax_rates
344
- @trial = trial
345
- @trial_offer = trial_offer
346
- end
347
- end
348
- # Details for the `add_discount` type.
349
- attr_accessor :add_discount
350
- # Details for the `add_item` type.
351
- attr_accessor :add_item
352
- # Details for the `add_metadata` type: specify a hash of key-value pairs.
353
- attr_accessor :add_metadata
354
- # Details for the `remove_discount` type.
355
- attr_accessor :remove_discount
356
- # Details for the `remove_item` type.
357
- attr_accessor :remove_item
358
- # Details for the `remove_metadata` type: specify an array of metadata keys.
359
- attr_accessor :remove_metadata
360
- # Details for the `set_discounts` type.
361
- attr_accessor :set_discounts
362
- # Details for the `set_items` type.
363
- attr_accessor :set_items
364
- # Details for the `set_metadata` type: specify an array of key-value pairs.
365
- attr_accessor :set_metadata
366
- # The type of action the quote line performs.
367
- attr_accessor :type
368
-
369
- def initialize(
370
- add_discount: nil,
371
- add_item: nil,
372
- add_metadata: nil,
373
- remove_discount: nil,
374
- remove_item: nil,
375
- remove_metadata: nil,
376
- set_discounts: nil,
377
- set_items: nil,
378
- set_metadata: nil,
379
- type: nil
380
- )
381
- @add_discount = add_discount
382
- @add_item = add_item
383
- @add_metadata = add_metadata
384
- @remove_discount = remove_discount
385
- @remove_item = remove_item
386
- @remove_metadata = remove_metadata
387
- @set_discounts = set_discounts
388
- @set_items = set_items
389
- @set_metadata = set_metadata
390
- @type = type
391
- end
392
- end
393
-
394
- class AppliesTo < ::Stripe::RequestParams
395
- # A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
396
- attr_accessor :new_reference
397
- # The ID of the schedule the line applies to.
398
- attr_accessor :subscription_schedule
399
- # Describes whether the quote line is affecting a new schedule or an existing schedule.
400
- attr_accessor :type
401
-
402
- def initialize(new_reference: nil, subscription_schedule: nil, type: nil)
403
- @new_reference = new_reference
404
- @subscription_schedule = subscription_schedule
405
- @type = type
406
- end
407
- end
408
-
409
- class CancelSubscriptionSchedule < ::Stripe::RequestParams
410
- # Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
411
- attr_accessor :cancel_at
412
- # If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.
413
- attr_accessor :invoice_now
414
- # If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
415
- attr_accessor :prorate
416
-
417
- def initialize(cancel_at: nil, invoice_now: nil, prorate: nil)
418
- @cancel_at = cancel_at
419
- @invoice_now = invoice_now
420
- @prorate = prorate
421
- end
422
- end
423
-
424
- class EndsAt < ::Stripe::RequestParams
425
- class DiscountEnd < ::Stripe::RequestParams
426
- # The ID of a specific discount.
427
- attr_accessor :discount
428
-
429
- def initialize(discount: nil)
430
- @discount = discount
431
- end
432
- end
433
-
434
- class Duration < ::Stripe::RequestParams
435
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
436
- attr_accessor :interval
437
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
438
- attr_accessor :interval_count
439
-
440
- def initialize(interval: nil, interval_count: nil)
441
- @interval = interval
442
- @interval_count = interval_count
443
- end
444
- end
445
- # Use the `end` time of a given discount.
446
- attr_accessor :discount_end
447
- # Time span for the quote line starting from the `starts_at` date.
448
- attr_accessor :duration
449
- # A precise Unix timestamp.
450
- attr_accessor :timestamp
451
- # Select a way to pass in `ends_at`.
452
- attr_accessor :type
453
-
454
- def initialize(discount_end: nil, duration: nil, timestamp: nil, type: nil)
455
- @discount_end = discount_end
456
- @duration = duration
457
- @timestamp = timestamp
458
- @type = type
459
- end
460
- end
461
-
462
- class SetPauseCollection < ::Stripe::RequestParams
463
- class Set < ::Stripe::RequestParams
464
- # The payment collection behavior for this subscription while paused.
465
- attr_accessor :behavior
466
-
467
- def initialize(behavior: nil)
468
- @behavior = behavior
469
- end
470
- end
471
- # Details of the pause_collection behavior to apply to the amendment.
472
- attr_accessor :set
473
- # Determines the type of the pause_collection amendment.
474
- attr_accessor :type
475
-
476
- def initialize(set: nil, type: nil)
477
- @set = set
478
- @type = type
479
- end
480
- end
481
-
482
- class StartsAt < ::Stripe::RequestParams
483
- class DiscountEnd < ::Stripe::RequestParams
484
- # The ID of a specific discount.
485
- attr_accessor :discount
486
-
487
- def initialize(discount: nil)
488
- @discount = discount
489
- end
490
- end
491
-
492
- class LineEndsAt < ::Stripe::RequestParams
493
- # The ID of a quote line.
494
- attr_accessor :id
495
- # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
496
- attr_accessor :index
497
-
498
- def initialize(id: nil, index: nil)
499
- @id = id
500
- @index = index
501
- end
502
- end
503
- # Use the `end` time of a given discount.
504
- attr_accessor :discount_end
505
- # The timestamp the given line ends at.
506
- attr_accessor :line_ends_at
507
- # A precise Unix timestamp.
508
- attr_accessor :timestamp
509
- # Select a way to pass in `starts_at`.
510
- attr_accessor :type
511
-
512
- def initialize(discount_end: nil, line_ends_at: nil, timestamp: nil, type: nil)
513
- @discount_end = discount_end
514
- @line_ends_at = line_ends_at
515
- @timestamp = timestamp
516
- @type = type
517
- end
518
- end
519
-
520
- class TrialSettings < ::Stripe::RequestParams
521
- class EndBehavior < ::Stripe::RequestParams
522
- # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
523
- attr_accessor :prorate_up_front
524
-
525
- def initialize(prorate_up_front: nil)
526
- @prorate_up_front = prorate_up_front
527
- end
528
- end
529
- # Defines how the subscription should behave when a trial ends.
530
- attr_accessor :end_behavior
531
-
532
- def initialize(end_behavior: nil)
533
- @end_behavior = end_behavior
534
- end
535
- end
536
- # An array of operations the quote line performs.
537
- attr_accessor :actions
538
- # Details to identify the subscription schedule the quote line applies to.
539
- attr_accessor :applies_to
540
- # For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
541
- attr_accessor :billing_cycle_anchor
542
- # A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
543
- attr_accessor :cancel_subscription_schedule
544
- # Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
545
- attr_accessor :ends_at
546
- # The ID of an existing line on the quote.
547
- attr_accessor :id
548
- # Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
549
- attr_accessor :proration_behavior
550
- # Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
551
- attr_accessor :set_pause_collection
552
- # Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
553
- attr_accessor :set_schedule_end
554
- # Details to identify the earliest timestamp where the proposed change should take effect.
555
- attr_accessor :starts_at
556
- # Settings related to subscription trials.
557
- attr_accessor :trial_settings
558
-
559
- def initialize(
560
- actions: nil,
561
- applies_to: nil,
562
- billing_cycle_anchor: nil,
563
- cancel_subscription_schedule: nil,
564
- ends_at: nil,
565
- id: nil,
566
- proration_behavior: nil,
567
- set_pause_collection: nil,
568
- set_schedule_end: nil,
569
- starts_at: nil,
570
- trial_settings: nil
571
- )
572
- @actions = actions
573
- @applies_to = applies_to
574
- @billing_cycle_anchor = billing_cycle_anchor
575
- @cancel_subscription_schedule = cancel_subscription_schedule
576
- @ends_at = ends_at
577
- @id = id
578
- @proration_behavior = proration_behavior
579
- @set_pause_collection = set_pause_collection
580
- @set_schedule_end = set_schedule_end
581
- @starts_at = starts_at
582
- @trial_settings = trial_settings
583
- end
584
- end
585
-
586
67
  class LineItem < ::Stripe::RequestParams
587
68
  class Discount < ::Stripe::RequestParams
588
- class DiscountEnd < ::Stripe::RequestParams
589
- class Duration < ::Stripe::RequestParams
590
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
591
- attr_accessor :interval
592
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
593
- attr_accessor :interval_count
594
-
595
- def initialize(interval: nil, interval_count: nil)
596
- @interval = interval
597
- @interval_count = interval_count
598
- end
599
- end
600
- # Time span for the redeemed discount.
601
- attr_accessor :duration
602
- # A precise Unix timestamp for the discount to end. Must be in the future.
603
- attr_accessor :timestamp
604
- # The type of calculation made to determine when the discount ends.
605
- attr_accessor :type
606
-
607
- def initialize(duration: nil, timestamp: nil, type: nil)
608
- @duration = duration
609
- @timestamp = timestamp
610
- @type = type
611
- end
612
- end
613
69
  # ID of the coupon to create a new discount for.
614
70
  attr_accessor :coupon
615
71
  # ID of an existing discount on the object (or one of its ancestors) to reuse.
616
72
  attr_accessor :discount
617
- # Details to determine how long the discount should be applied for.
618
- attr_accessor :discount_end
619
73
  # ID of the promotion code to create a new discount for.
620
74
  attr_accessor :promotion_code
621
75
 
622
- def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
76
+ def initialize(coupon: nil, discount: nil, promotion_code: nil)
623
77
  @coupon = coupon
624
78
  @discount = discount
625
- @discount_end = discount_end
626
79
  @promotion_code = promotion_code
627
80
  end
628
81
  end
@@ -709,277 +162,23 @@ module Stripe
709
162
  end
710
163
 
711
164
  class SubscriptionData < ::Stripe::RequestParams
712
- class BillOnAcceptance < ::Stripe::RequestParams
713
- class BillFrom < ::Stripe::RequestParams
714
- class LineStartsAt < ::Stripe::RequestParams
715
- # The ID of a quote line.
716
- attr_accessor :id
717
- # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
718
- attr_accessor :index
719
-
720
- def initialize(id: nil, index: nil)
721
- @id = id
722
- @index = index
723
- end
724
- end
725
- # Details of a Quote line to start the bill period from.
726
- attr_accessor :line_starts_at
727
- # A precise Unix timestamp.
728
- attr_accessor :timestamp
729
- # The type of method to specify the `bill_from` time.
730
- attr_accessor :type
731
-
732
- def initialize(line_starts_at: nil, timestamp: nil, type: nil)
733
- @line_starts_at = line_starts_at
734
- @timestamp = timestamp
735
- @type = type
736
- end
737
- end
738
-
739
- class BillUntil < ::Stripe::RequestParams
740
- class Duration < ::Stripe::RequestParams
741
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
742
- attr_accessor :interval
743
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
744
- attr_accessor :interval_count
745
-
746
- def initialize(interval: nil, interval_count: nil)
747
- @interval = interval
748
- @interval_count = interval_count
749
- end
750
- end
751
-
752
- class LineEndsAt < ::Stripe::RequestParams
753
- # The ID of a quote line.
754
- attr_accessor :id
755
- # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
756
- attr_accessor :index
757
-
758
- def initialize(id: nil, index: nil)
759
- @id = id
760
- @index = index
761
- end
762
- end
763
- # Details of the duration over which to bill.
764
- attr_accessor :duration
765
- # Details of a Quote line item from which to bill until.
766
- attr_accessor :line_ends_at
767
- # A precise Unix timestamp.
768
- attr_accessor :timestamp
769
- # The type of method to specify the `bill_until` time.
770
- attr_accessor :type
771
-
772
- def initialize(duration: nil, line_ends_at: nil, timestamp: nil, type: nil)
773
- @duration = duration
774
- @line_ends_at = line_ends_at
775
- @timestamp = timestamp
776
- @type = type
777
- end
778
- end
779
- # The start of the period to bill from when the Quote is accepted.
780
- attr_accessor :bill_from
781
- # The end of the period to bill until when the Quote is accepted.
782
- attr_accessor :bill_until
783
-
784
- def initialize(bill_from: nil, bill_until: nil)
785
- @bill_from = bill_from
786
- @bill_until = bill_until
787
- end
788
- end
789
-
790
- class Prebilling < ::Stripe::RequestParams
791
- # This is used to determine the number of billing cycles to prebill.
792
- attr_accessor :iterations
793
-
794
- def initialize(iterations: nil)
795
- @iterations = iterations
796
- end
797
- end
798
- # Describes the period to bill for upon accepting the quote.
799
- attr_accessor :bill_on_acceptance
800
- # 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.
801
- attr_accessor :billing_behavior
802
- # When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
803
- attr_accessor :billing_cycle_anchor
804
165
  # The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
805
166
  attr_accessor :description
806
- # When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
167
+ # When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. The `effective_date` is ignored if it is in the past when the quote is accepted.
807
168
  attr_accessor :effective_date
808
- # Behavior of the subscription schedule and underlying subscription when it ends.
809
- attr_accessor :end_behavior
810
169
  # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
811
170
  attr_accessor :metadata
812
- # If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
813
- attr_accessor :prebilling
814
- # Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
815
- #
816
- # When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
817
- #
818
- # Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
819
- #
820
- # Prorations can be disabled by passing `none`.
821
- attr_accessor :proration_behavior
822
171
  # Integer representing the number of trial period days before the customer is charged for the first time.
823
172
  attr_accessor :trial_period_days
824
173
 
825
- def initialize(
826
- bill_on_acceptance: nil,
827
- billing_behavior: nil,
828
- billing_cycle_anchor: nil,
829
- description: nil,
830
- effective_date: nil,
831
- end_behavior: nil,
832
- metadata: nil,
833
- prebilling: nil,
834
- proration_behavior: nil,
835
- trial_period_days: nil
836
- )
837
- @bill_on_acceptance = bill_on_acceptance
838
- @billing_behavior = billing_behavior
839
- @billing_cycle_anchor = billing_cycle_anchor
174
+ def initialize(description: nil, effective_date: nil, metadata: nil, trial_period_days: nil)
840
175
  @description = description
841
176
  @effective_date = effective_date
842
- @end_behavior = end_behavior
843
177
  @metadata = metadata
844
- @prebilling = prebilling
845
- @proration_behavior = proration_behavior
846
178
  @trial_period_days = trial_period_days
847
179
  end
848
180
  end
849
181
 
850
- class SubscriptionDataOverride < ::Stripe::RequestParams
851
- class AppliesTo < ::Stripe::RequestParams
852
- # A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
853
- attr_accessor :new_reference
854
- # The ID of the schedule the line applies to.
855
- attr_accessor :subscription_schedule
856
- # Describes whether the quote line is affecting a new schedule or an existing schedule.
857
- attr_accessor :type
858
-
859
- def initialize(new_reference: nil, subscription_schedule: nil, type: nil)
860
- @new_reference = new_reference
861
- @subscription_schedule = subscription_schedule
862
- @type = type
863
- end
864
- end
865
-
866
- class BillOnAcceptance < ::Stripe::RequestParams
867
- class BillFrom < ::Stripe::RequestParams
868
- class LineStartsAt < ::Stripe::RequestParams
869
- # The ID of a quote line.
870
- attr_accessor :id
871
- # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
872
- attr_accessor :index
873
-
874
- def initialize(id: nil, index: nil)
875
- @id = id
876
- @index = index
877
- end
878
- end
879
- # Details of a Quote line to start the bill period from.
880
- attr_accessor :line_starts_at
881
- # A precise Unix timestamp.
882
- attr_accessor :timestamp
883
- # The type of method to specify the `bill_from` time.
884
- attr_accessor :type
885
-
886
- def initialize(line_starts_at: nil, timestamp: nil, type: nil)
887
- @line_starts_at = line_starts_at
888
- @timestamp = timestamp
889
- @type = type
890
- end
891
- end
892
-
893
- class BillUntil < ::Stripe::RequestParams
894
- class Duration < ::Stripe::RequestParams
895
- # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
896
- attr_accessor :interval
897
- # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
898
- attr_accessor :interval_count
899
-
900
- def initialize(interval: nil, interval_count: nil)
901
- @interval = interval
902
- @interval_count = interval_count
903
- end
904
- end
905
-
906
- class LineEndsAt < ::Stripe::RequestParams
907
- # The ID of a quote line.
908
- attr_accessor :id
909
- # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
910
- attr_accessor :index
911
-
912
- def initialize(id: nil, index: nil)
913
- @id = id
914
- @index = index
915
- end
916
- end
917
- # Details of the duration over which to bill.
918
- attr_accessor :duration
919
- # Details of a Quote line item from which to bill until.
920
- attr_accessor :line_ends_at
921
- # A precise Unix timestamp.
922
- attr_accessor :timestamp
923
- # The type of method to specify the `bill_until` time.
924
- attr_accessor :type
925
-
926
- def initialize(duration: nil, line_ends_at: nil, timestamp: nil, type: nil)
927
- @duration = duration
928
- @line_ends_at = line_ends_at
929
- @timestamp = timestamp
930
- @type = type
931
- end
932
- end
933
- # The start of the period to bill from when the Quote is accepted.
934
- attr_accessor :bill_from
935
- # The end of the period to bill until when the Quote is accepted.
936
- attr_accessor :bill_until
937
-
938
- def initialize(bill_from: nil, bill_until: nil)
939
- @bill_from = bill_from
940
- @bill_until = bill_until
941
- end
942
- end
943
- # Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
944
- attr_accessor :applies_to
945
- # Describes the period to bill for upon accepting the quote.
946
- attr_accessor :bill_on_acceptance
947
- # 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.
948
- attr_accessor :billing_behavior
949
- # The customer the Subscription Data override applies to.
950
- attr_accessor :customer
951
- # The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
952
- attr_accessor :description
953
- # Behavior of the subscription schedule and underlying subscription when it ends.
954
- attr_accessor :end_behavior
955
- # Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
956
- #
957
- # When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
958
- #
959
- # Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
960
- #
961
- # Prorations can be disabled by passing `none`.
962
- attr_accessor :proration_behavior
963
-
964
- def initialize(
965
- applies_to: nil,
966
- bill_on_acceptance: nil,
967
- billing_behavior: nil,
968
- customer: nil,
969
- description: nil,
970
- end_behavior: nil,
971
- proration_behavior: nil
972
- )
973
- @applies_to = applies_to
974
- @bill_on_acceptance = bill_on_acceptance
975
- @billing_behavior = billing_behavior
976
- @customer = customer
977
- @description = description
978
- @end_behavior = end_behavior
979
- @proration_behavior = proration_behavior
980
- end
981
- end
982
-
983
182
  class TransferData < ::Stripe::RequestParams
984
183
  # The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
985
184
  attr_accessor :amount
@@ -994,8 +193,6 @@ module Stripe
994
193
  @destination = destination
995
194
  end
996
195
  end
997
- # Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
998
- attr_accessor :allow_backdated_lines
999
196
  # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
1000
197
  attr_accessor :application_fee_amount
1001
198
  # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.
@@ -1026,21 +223,16 @@ module Stripe
1026
223
  attr_accessor :invoice_settings
1027
224
  # A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
1028
225
  attr_accessor :line_items
1029
- # A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
1030
- attr_accessor :lines
1031
226
  # 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`.
1032
227
  attr_accessor :metadata
1033
228
  # The account on behalf of which to charge.
1034
229
  attr_accessor :on_behalf_of
1035
230
  # When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.
1036
231
  attr_accessor :subscription_data
1037
- # List representing overrides for `subscription_data` configurations for specific subscription schedules.
1038
- attr_accessor :subscription_data_overrides
1039
232
  # The data with which to automatically create a Transfer for each of the invoices.
1040
233
  attr_accessor :transfer_data
1041
234
 
1042
235
  def initialize(
1043
- allow_backdated_lines: nil,
1044
236
  application_fee_amount: nil,
1045
237
  application_fee_percent: nil,
1046
238
  automatic_tax: nil,
@@ -1056,14 +248,11 @@ module Stripe
1056
248
  header: nil,
1057
249
  invoice_settings: nil,
1058
250
  line_items: nil,
1059
- lines: nil,
1060
251
  metadata: nil,
1061
252
  on_behalf_of: nil,
1062
253
  subscription_data: nil,
1063
- subscription_data_overrides: nil,
1064
254
  transfer_data: nil
1065
255
  )
1066
- @allow_backdated_lines = allow_backdated_lines
1067
256
  @application_fee_amount = application_fee_amount
1068
257
  @application_fee_percent = application_fee_percent
1069
258
  @automatic_tax = automatic_tax
@@ -1079,11 +268,9 @@ module Stripe
1079
268
  @header = header
1080
269
  @invoice_settings = invoice_settings
1081
270
  @line_items = line_items
1082
- @lines = lines
1083
271
  @metadata = metadata
1084
272
  @on_behalf_of = on_behalf_of
1085
273
  @subscription_data = subscription_data
1086
- @subscription_data_overrides = subscription_data_overrides
1087
274
  @transfer_data = transfer_data
1088
275
  end
1089
276