stripe 20.2.0.pre.beta.1 → 21.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (514) hide show
  1. checksums.yaml +4 -4
  2. data/lib/stripe/api_operations/request.rb +2 -0
  3. data/lib/stripe/api_requestor.rb +1 -4
  4. data/lib/stripe/api_version.rb +2 -2
  5. data/lib/stripe/errors.rb +0 -6
  6. data/lib/stripe/event_types.rb +0 -193
  7. data/lib/stripe/events/unknown_event_notification.rb +0 -1
  8. data/lib/stripe/object_types.rb +0 -53
  9. data/lib/stripe/params/account_create_params.rb +1 -299
  10. data/lib/stripe/params/account_session_create_params.rb +0 -191
  11. data/lib/stripe/params/account_update_params.rb +0 -261
  12. data/lib/stripe/params/balance_settings_update_params.rb +1 -9
  13. data/lib/stripe/params/charge_capture_params.rb +0 -1646
  14. data/lib/stripe/params/charge_update_params.rb +0 -1646
  15. data/lib/stripe/params/checkout/session_create_params.rb +3 -87
  16. data/lib/stripe/params/checkout/session_update_params.rb +1 -161
  17. data/lib/stripe/params/confirmation_token_create_params.rb +0 -92
  18. data/lib/stripe/params/coupon_create_params.rb +1 -17
  19. data/lib/stripe/params/customer_session_create_params.rb +1 -32
  20. data/lib/stripe/params/financial_connections/session_create_params.rb +1 -38
  21. data/lib/stripe/params/invoice_add_lines_params.rb +1 -33
  22. data/lib/stripe/params/invoice_attach_payment_params.rb +1 -43
  23. data/lib/stripe/params/invoice_create_params.rb +2 -64
  24. data/lib/stripe/params/invoice_create_preview_params.rb +9 -772
  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 -33
  28. data/lib/stripe/params/invoice_update_lines_params.rb +1 -33
  29. data/lib/stripe/params/invoice_update_params.rb +2 -64
  30. data/lib/stripe/params/issuing/cardholder_create_params.rb +1 -2
  31. data/lib/stripe/params/issuing/cardholder_update_params.rb +0 -4
  32. data/lib/stripe/params/issuing/transaction_list_params.rb +0 -4
  33. data/lib/stripe/params/payment_intent_capture_params.rb +1 -1643
  34. data/lib/stripe/params/payment_intent_confirm_params.rb +109 -3062
  35. data/lib/stripe/params/payment_intent_create_params.rb +122 -3075
  36. data/lib/stripe/params/payment_intent_increment_authorization_params.rb +0 -37
  37. data/lib/stripe/params/payment_intent_update_params.rb +76 -3060
  38. data/lib/stripe/params/payment_method_configuration_create_params.rb +0 -105
  39. data/lib/stripe/params/payment_method_configuration_update_params.rb +0 -105
  40. data/lib/stripe/params/payment_method_create_params.rb +0 -88
  41. data/lib/stripe/params/price_update_params.rb +0 -19
  42. data/lib/stripe/params/quote_create_params.rb +3 -809
  43. data/lib/stripe/params/quote_list_params.rb +0 -4
  44. data/lib/stripe/params/quote_update_params.rb +4 -817
  45. data/lib/stripe/params/setup_intent_confirm_params.rb +3 -122
  46. data/lib/stripe/params/setup_intent_create_params.rb +3 -122
  47. data/lib/stripe/params/setup_intent_update_params.rb +3 -122
  48. data/lib/stripe/params/subscription_create_params.rb +6 -133
  49. data/lib/stripe/params/subscription_item_create_params.rb +3 -50
  50. data/lib/stripe/params/subscription_item_update_params.rb +2 -33
  51. data/lib/stripe/params/subscription_schedule_create_params.rb +5 -167
  52. data/lib/stripe/params/subscription_schedule_update_params.rb +5 -167
  53. data/lib/stripe/params/subscription_update_params.rb +5 -116
  54. data/lib/stripe/params/tax/registration_create_params.rb +1 -13
  55. data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +0 -92
  56. data/lib/stripe/params/test_helpers/treasury/received_credit_create_params.rb +1 -25
  57. data/lib/stripe/params/test_helpers/treasury/received_debit_create_params.rb +1 -25
  58. data/lib/stripe/params/transfer_create_params.rb +0 -4
  59. data/lib/stripe/params/treasury/financial_account_create_params.rb +1 -8
  60. data/lib/stripe/params/treasury/financial_account_features_update_params.rb +1 -4
  61. data/lib/stripe/params/treasury/financial_account_update_features_params.rb +1 -4
  62. data/lib/stripe/params/treasury/financial_account_update_params.rb +1 -8
  63. data/lib/stripe/params/treasury/outbound_payment_create_params.rb +0 -19
  64. data/lib/stripe/params/treasury/outbound_transfer_create_params.rb +0 -24
  65. data/lib/stripe/params/treasury/received_credit_create_params.rb +1 -25
  66. data/lib/stripe/params/treasury/received_debit_create_params.rb +1 -25
  67. data/lib/stripe/params/v2/core/account_create_params.rb +5 -392
  68. data/lib/stripe/params/v2/core/account_token_create_params.rb +1 -29
  69. data/lib/stripe/params/v2/core/account_update_params.rb +4 -376
  70. data/lib/stripe/params/v2/core/vault/gb_bank_account_create_params.rb +0 -21
  71. data/lib/stripe/params/v2/money_management/outbound_payment_create_params.rb +0 -21
  72. data/lib/stripe/params/v2/money_management/outbound_setup_intent_create_params.rb +1 -40
  73. data/lib/stripe/params/v2/money_management/outbound_setup_intent_update_params.rb +1 -22
  74. data/lib/stripe/params.rb +0 -364
  75. data/lib/stripe/request_options.rb +18 -0
  76. data/lib/stripe/resources/account.rb +1 -176
  77. data/lib/stripe/resources/account_session.rb +0 -81
  78. data/lib/stripe/resources/balance.rb +0 -83
  79. data/lib/stripe/resources/balance_settings.rb +0 -4
  80. data/lib/stripe/resources/billing/alert_triggered.rb +0 -4
  81. data/lib/stripe/resources/card.rb +1 -18
  82. data/lib/stripe/resources/charge.rb +1 -227
  83. data/lib/stripe/resources/checkout/session.rb +3 -91
  84. data/lib/stripe/resources/confirmation_token.rb +0 -131
  85. data/lib/stripe/resources/coupon.rb +1 -26
  86. data/lib/stripe/resources/credit_note_line_item.rb +0 -18
  87. data/lib/stripe/resources/customer.rb +0 -16
  88. data/lib/stripe/resources/customer_session.rb +0 -36
  89. data/lib/stripe/resources/dispute.rb +0 -18
  90. data/lib/stripe/resources/event.rb +1 -64
  91. data/lib/stripe/resources/financial_connections/account.rb +1 -45
  92. data/lib/stripe/resources/financial_connections/authorization.rb +1 -24
  93. data/lib/stripe/resources/financial_connections/session.rb +0 -92
  94. data/lib/stripe/resources/invoice.rb +1 -106
  95. data/lib/stripe/resources/invoice_item.rb +0 -2
  96. data/lib/stripe/resources/invoice_line_item.rb +0 -40
  97. data/lib/stripe/resources/issuing/authorization.rb +0 -16
  98. data/lib/stripe/resources/issuing/card.rb +0 -16
  99. data/lib/stripe/resources/issuing/cardholder.rb +0 -16
  100. data/lib/stripe/resources/issuing/dispute.rb +1 -16
  101. data/lib/stripe/resources/issuing/transaction.rb +0 -18
  102. data/lib/stripe/resources/line_item.rb +0 -42
  103. data/lib/stripe/resources/mandate.rb +0 -12
  104. data/lib/stripe/resources/payment_attempt_record.rb +1 -177
  105. data/lib/stripe/resources/payment_intent.rb +24 -1602
  106. data/lib/stripe/resources/payment_method.rb +0 -151
  107. data/lib/stripe/resources/payment_method_configuration.rb +0 -170
  108. data/lib/stripe/resources/payment_record.rb +1 -177
  109. data/lib/stripe/resources/price.rb +0 -20
  110. data/lib/stripe/resources/quote.rb +2 -569
  111. data/lib/stripe/resources/radar/value_list_item.rb +1 -15
  112. data/lib/stripe/resources/refund.rb +0 -18
  113. data/lib/stripe/resources/reserve/hold.rb +0 -7
  114. data/lib/stripe/resources/reserve/plan.rb +0 -7
  115. data/lib/stripe/resources/reserve/release.rb +0 -12
  116. data/lib/stripe/resources/setup_attempt.rb +0 -35
  117. data/lib/stripe/resources/setup_intent.rb +1 -38
  118. data/lib/stripe/resources/source.rb +0 -54
  119. data/lib/stripe/resources/subscription.rb +0 -73
  120. data/lib/stripe/resources/subscription_item.rb +1 -22
  121. data/lib/stripe/resources/subscription_schedule.rb +3 -198
  122. data/lib/stripe/resources/tax/registration.rb +1 -16
  123. data/lib/stripe/resources/terminal/reader.rb +0 -8
  124. data/lib/stripe/resources/token.rb +1 -15
  125. data/lib/stripe/resources/transfer.rb +0 -2
  126. data/lib/stripe/resources/treasury/financial_account.rb +0 -2
  127. data/lib/stripe/resources/treasury/financial_account_features.rb +0 -2
  128. data/lib/stripe/resources/treasury/outbound_payment.rb +0 -2
  129. data/lib/stripe/resources/treasury/outbound_transfer.rb +0 -30
  130. data/lib/stripe/resources/treasury/received_credit.rb +0 -30
  131. data/lib/stripe/resources/treasury/received_debit.rb +0 -32
  132. data/lib/stripe/resources/v2/core/account.rb +2 -802
  133. data/lib/stripe/resources/v2/core/event.rb +1 -1
  134. data/lib/stripe/resources/v2/core/event_base.rb +36 -0
  135. data/lib/stripe/resources/v2/core/event_notification.rb +0 -1
  136. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +1 -91
  137. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +1 -26
  138. data/lib/stripe/resources/v2/money_management/adjustment.rb +0 -4
  139. data/lib/stripe/resources/v2/money_management/financial_account.rb +1 -50
  140. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +0 -2
  141. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +1 -63
  142. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +1 -31
  143. data/lib/stripe/resources/v2/money_management/payout_method.rb +1 -50
  144. data/lib/stripe/resources/v2/money_management/received_credit.rb +0 -2
  145. data/lib/stripe/resources/v2/money_management/recipient_verification.rb +0 -2
  146. data/lib/stripe/resources.rb +2 -341
  147. data/lib/stripe/services/account_service.rb +0 -15
  148. data/lib/stripe/services/billing_service.rb +1 -2
  149. data/lib/stripe/services/coupon_service.rb +0 -14
  150. data/lib/stripe/services/customer_service.rb +0 -15
  151. data/lib/stripe/services/financial_connections/account_service.rb +1 -3
  152. data/lib/stripe/services/financial_connections_service.rb +1 -3
  153. data/lib/stripe/services/invoice_service.rb +0 -11
  154. data/lib/stripe/services/issuing_service.rb +1 -5
  155. data/lib/stripe/services/mandate_service.rb +0 -5
  156. data/lib/stripe/services/payment_intent_service.rb +0 -37
  157. data/lib/stripe/services/promotion_code_service.rb +0 -29
  158. data/lib/stripe/services/quote_service.rb +1 -49
  159. data/lib/stripe/services/radar_service.rb +1 -2
  160. data/lib/stripe/services/subscription_schedule_service.rb +0 -11
  161. data/lib/stripe/services/subscription_service.rb +0 -45
  162. data/lib/stripe/services/tax_service.rb +1 -2
  163. data/lib/stripe/services/terminal_service.rb +1 -2
  164. data/lib/stripe/services/test_helpers_service.rb +1 -2
  165. data/lib/stripe/services/v1_services.rb +1 -11
  166. data/lib/stripe/services/v2/billing_service.rb +1 -5
  167. data/lib/stripe/services/v2/core_service.rb +1 -3
  168. data/lib/stripe/services/v2/money_management/financial_account_service.rb +0 -27
  169. data/lib/stripe/services/v2/money_management/payout_method_service.rb +0 -15
  170. data/lib/stripe/services/v2/money_management/test_helpers/financial_address_service.rb +0 -13
  171. data/lib/stripe/services/v2/money_management_service.rb +1 -5
  172. data/lib/stripe/services/v2_services.rb +1 -7
  173. data/lib/stripe/services.rb +0 -181
  174. data/lib/stripe/stripe_client.rb +1 -4
  175. data/lib/stripe/stripe_configuration.rb +1 -3
  176. data/lib/stripe/stripe_event_notification_handler.rb +0 -216
  177. data/lib/stripe/stripe_object.rb +60 -1
  178. data/lib/stripe/stripe_service.rb +13 -9
  179. data/lib/stripe/util.rb +1 -7
  180. data/lib/stripe/version.rb +1 -1
  181. data/lib/stripe/webhook.rb +68 -3
  182. data/lib/stripe.rb +0 -53
  183. data/rbi/stripe/resources/v2/core/event_base.rbi +11 -0
  184. data/rbi/stripe/resources/v2/core/event_notification.rbi +0 -2
  185. data/rbi/stripe.rbi +33552 -100276
  186. metadata +6 -332
  187. data/lib/stripe/events/v2_core_account_including_configuration_money_manager_capability_status_updated_event.rb +0 -63
  188. data/lib/stripe/events/v2_core_account_including_configuration_money_manager_updated_event.rb +0 -44
  189. data/lib/stripe/events/v2_core_approval_request_approved_event.rb +0 -44
  190. data/lib/stripe/events/v2_core_approval_request_canceled_event.rb +0 -44
  191. data/lib/stripe/events/v2_core_approval_request_created_event.rb +0 -44
  192. data/lib/stripe/events/v2_core_approval_request_expired_event.rb +0 -44
  193. data/lib/stripe/events/v2_core_approval_request_failed_event.rb +0 -44
  194. data/lib/stripe/events/v2_core_approval_request_rejected_event.rb +0 -44
  195. data/lib/stripe/events/v2_core_approval_request_succeeded_event.rb +0 -44
  196. data/lib/stripe/events/v2_core_batch_job_batch_failed_event.rb +0 -44
  197. data/lib/stripe/events/v2_core_batch_job_canceled_event.rb +0 -44
  198. data/lib/stripe/events/v2_core_batch_job_completed_event.rb +0 -44
  199. data/lib/stripe/events/v2_core_batch_job_created_event.rb +0 -44
  200. data/lib/stripe/events/v2_core_batch_job_ready_for_upload_event.rb +0 -44
  201. data/lib/stripe/events/v2_core_batch_job_timeout_event.rb +0 -44
  202. data/lib/stripe/events/v2_core_batch_job_updated_event.rb +0 -44
  203. data/lib/stripe/events/v2_core_batch_job_upload_timeout_event.rb +0 -44
  204. data/lib/stripe/events/v2_core_batch_job_validating_event.rb +0 -44
  205. data/lib/stripe/events/v2_core_batch_job_validation_failed_event.rb +0 -44
  206. data/lib/stripe/events/v2_core_health_event_generation_failure_resolved_event.rb +0 -78
  207. data/lib/stripe/events/v2_data_query_run_created_event.rb +0 -44
  208. data/lib/stripe/events/v2_data_query_run_failed_event.rb +0 -44
  209. data/lib/stripe/events/v2_data_query_run_succeeded_event.rb +0 -44
  210. data/lib/stripe/events/v2_data_query_run_updated_event.rb +0 -44
  211. data/lib/stripe/events/v2_data_report_run_created_event.rb +0 -44
  212. data/lib/stripe/events/v2_data_report_run_failed_event.rb +0 -44
  213. data/lib/stripe/events/v2_data_report_run_succeeded_event.rb +0 -44
  214. data/lib/stripe/events/v2_data_report_run_updated_event.rb +0 -44
  215. data/lib/stripe/events/v2_data_reporting_query_run_created_event.rb +0 -44
  216. data/lib/stripe/events/v2_data_reporting_query_run_failed_event.rb +0 -44
  217. data/lib/stripe/events/v2_data_reporting_query_run_succeeded_event.rb +0 -44
  218. data/lib/stripe/events/v2_data_reporting_query_run_updated_event.rb +0 -44
  219. data/lib/stripe/events/v2_extend_workflow_run_failed_event.rb +0 -75
  220. data/lib/stripe/events/v2_extend_workflow_run_started_event.rb +0 -44
  221. data/lib/stripe/events/v2_extend_workflow_run_succeeded_event.rb +0 -44
  222. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +0 -44
  223. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +0 -44
  224. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +0 -44
  225. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +0 -44
  226. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +0 -44
  227. data/lib/stripe/events/v2_money_management_outbound_transfer_under_review_event.rb +0 -44
  228. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +0 -44
  229. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +0 -44
  230. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +0 -44
  231. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +0 -44
  232. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +0 -44
  233. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +0 -44
  234. data/lib/stripe/events/v2_orchestrated_commerce_agreement_confirmed_event.rb +0 -97
  235. data/lib/stripe/events/v2_orchestrated_commerce_agreement_created_event.rb +0 -97
  236. data/lib/stripe/events/v2_orchestrated_commerce_agreement_partially_confirmed_event.rb +0 -97
  237. data/lib/stripe/events/v2_orchestrated_commerce_agreement_terminated_event.rb +0 -97
  238. data/lib/stripe/events/v2_signals_account_evaluation_complete_event.rb +0 -44
  239. data/lib/stripe/events/v2_signals_account_signal_fraudulent_merchant_ready_event.rb +0 -44
  240. data/lib/stripe/events/v2_signals_account_signal_fraudulent_website_ready_event.rb +0 -44
  241. data/lib/stripe/params/account_notice_list_params.rb +0 -25
  242. data/lib/stripe/params/account_notice_retrieve_params.rb +0 -13
  243. data/lib/stripe/params/account_notice_update_params.rb +0 -36
  244. data/lib/stripe/params/billing/analytics/meter_usage_retrieve_params.rb +0 -65
  245. data/lib/stripe/params/capital/financing_offer_list_params.rb +0 -58
  246. data/lib/stripe/params/capital/financing_offer_mark_delivered_params.rb +0 -15
  247. data/lib/stripe/params/capital/financing_offer_retrieve_params.rb +0 -15
  248. data/lib/stripe/params/capital/financing_summary_retrieve_params.rb +0 -15
  249. data/lib/stripe/params/capital/financing_transaction_list_params.rb +0 -45
  250. data/lib/stripe/params/capital/financing_transaction_retrieve_params.rb +0 -15
  251. data/lib/stripe/params/external_account_create_params.rb +0 -134
  252. data/lib/stripe/params/external_account_delete_params.rb +0 -6
  253. data/lib/stripe/params/external_account_list_params.rb +0 -25
  254. data/lib/stripe/params/external_account_retrieve_params.rb +0 -13
  255. data/lib/stripe/params/external_account_update_params.rb +0 -91
  256. data/lib/stripe/params/financial_connections/account_inferred_balance_list_params.rb +0 -24
  257. data/lib/stripe/params/financial_connections/authorization_retrieve_params.rb +0 -15
  258. data/lib/stripe/params/financial_connections/institution_list_params.rb +0 -24
  259. data/lib/stripe/params/financial_connections/institution_retrieve_params.rb +0 -15
  260. data/lib/stripe/params/fx_quote_create_params.rb +0 -73
  261. data/lib/stripe/params/fx_quote_list_params.rb +0 -22
  262. data/lib/stripe/params/fx_quote_retrieve_params.rb +0 -13
  263. data/lib/stripe/params/invoice_detach_payment_params.rb +0 -16
  264. data/lib/stripe/params/issuing/credit_underwriting_record_correct_params.rb +0 -163
  265. data/lib/stripe/params/issuing/credit_underwriting_record_create_from_application_params.rb +0 -50
  266. data/lib/stripe/params/issuing/credit_underwriting_record_create_from_proactive_review_params.rb +0 -128
  267. data/lib/stripe/params/issuing/credit_underwriting_record_list_params.rb +0 -24
  268. data/lib/stripe/params/issuing/credit_underwriting_record_report_decision_params.rb +0 -86
  269. data/lib/stripe/params/issuing/credit_underwriting_record_retrieve_params.rb +0 -15
  270. data/lib/stripe/params/issuing/dispute_settlement_detail_list_params.rb +0 -33
  271. data/lib/stripe/params/issuing/dispute_settlement_detail_retrieve_params.rb +0 -15
  272. data/lib/stripe/params/issuing/fraud_liability_debit_list_params.rb +0 -44
  273. data/lib/stripe/params/issuing/fraud_liability_debit_retrieve_params.rb +0 -15
  274. data/lib/stripe/params/mandate_list_params.rb +0 -39
  275. data/lib/stripe/params/margin_create_params.rb +0 -25
  276. data/lib/stripe/params/margin_list_params.rb +0 -25
  277. data/lib/stripe/params/margin_retrieve_params.rb +0 -13
  278. data/lib/stripe/params/margin_update_params.rb +0 -22
  279. data/lib/stripe/params/order_create_params.rb +0 -2083
  280. data/lib/stripe/params/order_list_params.rb +0 -25
  281. data/lib/stripe/params/order_retrieve_params.rb +0 -13
  282. data/lib/stripe/params/order_submit_params.rb +0 -16
  283. data/lib/stripe/params/order_update_params.rb +0 -2087
  284. data/lib/stripe/params/payment_intent_decrement_authorization_params.rb +0 -297
  285. data/lib/stripe/params/payment_intent_trigger_action_params.rb +0 -27
  286. data/lib/stripe/params/payment_plan_create_params.rb +0 -128
  287. data/lib/stripe/params/payment_plan_list_params.rb +0 -25
  288. data/lib/stripe/params/payment_plan_retrieve_params.rb +0 -13
  289. data/lib/stripe/params/payment_plan_update_params.rb +0 -105
  290. data/lib/stripe/params/privacy/redaction_job_cancel_params.rb +0 -15
  291. data/lib/stripe/params/privacy/redaction_job_create_params.rb +0 -67
  292. data/lib/stripe/params/privacy/redaction_job_list_params.rb +0 -27
  293. data/lib/stripe/params/privacy/redaction_job_retrieve_params.rb +0 -15
  294. data/lib/stripe/params/privacy/redaction_job_run_params.rb +0 -15
  295. data/lib/stripe/params/privacy/redaction_job_update_params.rb +0 -18
  296. data/lib/stripe/params/privacy/redaction_job_validate_params.rb +0 -15
  297. data/lib/stripe/params/privacy/redaction_job_validation_error_list_params.rb +0 -24
  298. data/lib/stripe/params/quote_line_list_params.rb +0 -22
  299. data/lib/stripe/params/quote_list_lines_params.rb +0 -22
  300. data/lib/stripe/params/quote_list_preview_invoice_lines_params.rb +0 -22
  301. data/lib/stripe/params/quote_mark_draft_params.rb +0 -13
  302. data/lib/stripe/params/quote_mark_stale_params.rb +0 -16
  303. data/lib/stripe/params/quote_preview_invoice_list_params.rb +0 -22
  304. data/lib/stripe/params/quote_preview_subscription_schedule_list_params.rb +0 -22
  305. data/lib/stripe/params/quote_reestimate_params.rb +0 -13
  306. data/lib/stripe/params/radar/billing_evaluation_create_params.rb +0 -231
  307. data/lib/stripe/params/reserve/hold_list_params.rb +0 -53
  308. data/lib/stripe/params/reserve/hold_retrieve_params.rb +0 -15
  309. data/lib/stripe/params/reserve/plan_list_params.rb +0 -37
  310. data/lib/stripe/params/reserve/plan_retrieve_params.rb +0 -15
  311. data/lib/stripe/params/reserve/release_list_params.rb +0 -41
  312. data/lib/stripe/params/reserve/release_retrieve_params.rb +0 -15
  313. data/lib/stripe/params/shared_payment/granted_token_create_params.rb +0 -47
  314. data/lib/stripe/params/shared_payment/granted_token_retrieve_params.rb +0 -15
  315. data/lib/stripe/params/shared_payment/granted_token_revoke_params.rb +0 -15
  316. data/lib/stripe/params/shared_payment/issued_token_create_params.rb +0 -71
  317. data/lib/stripe/params/shared_payment/issued_token_retrieve_params.rb +0 -15
  318. data/lib/stripe/params/shared_payment/issued_token_revoke_params.rb +0 -15
  319. data/lib/stripe/params/subscription_schedule_amend_params.rb +0 -578
  320. data/lib/stripe/params/tax/form_list_params.rb +0 -51
  321. data/lib/stripe/params/tax/form_pdf_params.rb +0 -15
  322. data/lib/stripe/params/tax/form_retrieve_params.rb +0 -15
  323. data/lib/stripe/params/terminal/reader_collected_data_retrieve_params.rb +0 -15
  324. data/lib/stripe/params/test_helpers/shared_payment/granted_token_create_params.rb +0 -49
  325. data/lib/stripe/params/test_helpers/shared_payment/granted_token_revoke_params.rb +0 -17
  326. data/lib/stripe/params/v2/billing/bill_setting_create_params.rb +0 -74
  327. data/lib/stripe/params/v2/billing/bill_setting_list_params.rb +0 -21
  328. data/lib/stripe/params/v2/billing/bill_setting_retrieve_params.rb +0 -10
  329. data/lib/stripe/params/v2/billing/bill_setting_update_params.rb +0 -80
  330. data/lib/stripe/params/v2/billing/bill_settings/version_list_params.rb +0 -19
  331. data/lib/stripe/params/v2/billing/bill_settings/version_retrieve_params.rb +0 -12
  332. data/lib/stripe/params/v2/billing/cadence_cancel_params.rb +0 -10
  333. data/lib/stripe/params/v2/billing/cadence_create_params.rb +0 -253
  334. data/lib/stripe/params/v2/billing/cadence_list_params.rb +0 -43
  335. data/lib/stripe/params/v2/billing/cadence_retrieve_params.rb +0 -17
  336. data/lib/stripe/params/v2/billing/cadence_update_params.rb +0 -75
  337. data/lib/stripe/params/v2/billing/collection_setting_create_params.rb +0 -257
  338. data/lib/stripe/params/v2/billing/collection_setting_list_params.rb +0 -21
  339. data/lib/stripe/params/v2/billing/collection_setting_retrieve_params.rb +0 -10
  340. data/lib/stripe/params/v2/billing/collection_setting_update_params.rb +0 -263
  341. data/lib/stripe/params/v2/billing/collection_settings/version_list_params.rb +0 -19
  342. data/lib/stripe/params/v2/billing/collection_settings/version_retrieve_params.rb +0 -12
  343. data/lib/stripe/params/v2/billing/profile_create_params.rb +0 -37
  344. data/lib/stripe/params/v2/billing/profile_list_params.rb +0 -40
  345. data/lib/stripe/params/v2/billing/profile_retrieve_params.rb +0 -10
  346. data/lib/stripe/params/v2/billing/profile_update_params.rb +0 -35
  347. data/lib/stripe/params/v2/core/approval_request_cancel_params.rb +0 -10
  348. data/lib/stripe/params/v2/core/approval_request_list_params.rb +0 -47
  349. data/lib/stripe/params/v2/core/approval_request_retrieve_params.rb +0 -10
  350. data/lib/stripe/params/v2/core/approval_request_update_params.rb +0 -17
  351. data/lib/stripe/params/v2/core/batch_job_cancel_params.rb +0 -10
  352. data/lib/stripe/params/v2/core/batch_job_create_params.rb +0 -53
  353. data/lib/stripe/params/v2/core/batch_job_retrieve_params.rb +0 -10
  354. data/lib/stripe/params/v2/data/query_run_create_params.rb +0 -50
  355. data/lib/stripe/params/v2/data/query_run_retrieve_params.rb +0 -23
  356. data/lib/stripe/params/v2/data/report_list_params.rb +0 -23
  357. data/lib/stripe/params/v2/data/report_retrieve_params.rb +0 -17
  358. data/lib/stripe/params/v2/data/report_run_create_params.rb +0 -48
  359. data/lib/stripe/params/v2/data/report_run_retrieve_params.rb +0 -23
  360. data/lib/stripe/params/v2/data/reporting/query_run_create_params.rb +0 -31
  361. data/lib/stripe/params/v2/data/reporting/query_run_retrieve_params.rb +0 -12
  362. data/lib/stripe/params/v2/data/schema_list_params.rb +0 -26
  363. data/lib/stripe/params/v2/data/schema_retrieve_params.rb +0 -10
  364. data/lib/stripe/params/v2/extend/workflow_invoke_params.rb +0 -17
  365. data/lib/stripe/params/v2/extend/workflow_list_params.rb +0 -21
  366. data/lib/stripe/params/v2/extend/workflow_retrieve_params.rb +0 -10
  367. data/lib/stripe/params/v2/extend/workflow_run_list_params.rb +0 -23
  368. data/lib/stripe/params/v2/extend/workflow_run_retrieve_params.rb +0 -10
  369. data/lib/stripe/params/v2/iam/activity_log_list_params.rb +0 -23
  370. data/lib/stripe/params/v2/iam/activity_log_retrieve_params.rb +0 -10
  371. data/lib/stripe/params/v2/money_management/financial_account_close_params.rb +0 -30
  372. data/lib/stripe/params/v2/money_management/financial_account_create_params.rb +0 -35
  373. data/lib/stripe/params/v2/money_management/outbound_payment_quote_create_params.rb +0 -113
  374. data/lib/stripe/params/v2/money_management/outbound_payment_quote_retrieve_params.rb +0 -10
  375. data/lib/stripe/params/v2/money_management/outbound_transfer_cancel_params.rb +0 -10
  376. data/lib/stripe/params/v2/money_management/outbound_transfer_create_params.rb +0 -112
  377. data/lib/stripe/params/v2/money_management/outbound_transfer_list_params.rb +0 -48
  378. data/lib/stripe/params/v2/money_management/outbound_transfer_retrieve_params.rb +0 -10
  379. data/lib/stripe/params/v2/money_management/payout_method_disable_params.rb +0 -10
  380. data/lib/stripe/params/v2/money_management/received_debit_list_params.rb +0 -17
  381. data/lib/stripe/params/v2/money_management/received_debit_retrieve_params.rb +0 -10
  382. data/lib/stripe/params/v2/money_management/test_helpers/financial_address_generate_microdeposits_params.rb +0 -12
  383. data/lib/stripe/params/v2/network/business_profile_me_params.rb +0 -10
  384. data/lib/stripe/params/v2/network/business_profile_retrieve_params.rb +0 -10
  385. data/lib/stripe/params/v2/orchestrated_commerce/agreement_confirm_params.rb +0 -10
  386. data/lib/stripe/params/v2/orchestrated_commerce/agreement_create_params.rb +0 -17
  387. data/lib/stripe/params/v2/orchestrated_commerce/agreement_list_params.rb +0 -20
  388. data/lib/stripe/params/v2/orchestrated_commerce/agreement_retrieve_params.rb +0 -10
  389. data/lib/stripe/params/v2/orchestrated_commerce/agreement_terminate_params.rb +0 -10
  390. data/lib/stripe/params/v2/signals/account_activity_create_params.rb +0 -200
  391. data/lib/stripe/params/v2/signals/account_activity_delete_params.rb +0 -10
  392. data/lib/stripe/params/v2/signals/account_activity_retrieve_params.rb +0 -10
  393. data/lib/stripe/params/v2/signals/account_evaluation_create_params.rb +0 -192
  394. data/lib/stripe/params/v2/signals/account_evaluation_retrieve_params.rb +0 -10
  395. data/lib/stripe/params/v2/signals/account_signal_list_params.rb +0 -35
  396. data/lib/stripe/params/v2/signals/account_signal_retrieve_params.rb +0 -10
  397. data/lib/stripe/resources/account_notice.rb +0 -94
  398. data/lib/stripe/resources/billing/analytics/meter_usage.rb +0 -33
  399. data/lib/stripe/resources/billing/analytics/meter_usage_row.rb +0 -38
  400. data/lib/stripe/resources/capital/financing_offer.rb +0 -144
  401. data/lib/stripe/resources/capital/financing_summary.rb +0 -82
  402. data/lib/stripe/resources/capital/financing_transaction.rb +0 -99
  403. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -35
  404. data/lib/stripe/resources/financial_connections/institution.rb +0 -127
  405. data/lib/stripe/resources/fx_quote.rb +0 -149
  406. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -263
  407. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -71
  408. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -51
  409. data/lib/stripe/resources/issuing/settlement.rb +0 -61
  410. data/lib/stripe/resources/margin.rb +0 -64
  411. data/lib/stripe/resources/order.rb +0 -927
  412. data/lib/stripe/resources/payment_plan.rb +0 -213
  413. data/lib/stripe/resources/privacy/redaction_job.rb +0 -189
  414. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +0 -49
  415. data/lib/stripe/resources/quote_line.rb +0 -525
  416. data/lib/stripe/resources/quote_preview_invoice.rb +0 -1241
  417. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -968
  418. data/lib/stripe/resources/radar/billing_evaluation.rb +0 -281
  419. data/lib/stripe/resources/shared_payment/granted_token.rb +0 -681
  420. data/lib/stripe/resources/shared_payment/issued_token.rb +0 -310
  421. data/lib/stripe/resources/tax/form.rb +0 -264
  422. data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -47
  423. data/lib/stripe/resources/v2/billing/bill_setting.rb +0 -102
  424. data/lib/stripe/resources/v2/billing/bill_setting_version.rb +0 -91
  425. data/lib/stripe/resources/v2/billing/cadence.rb +0 -710
  426. data/lib/stripe/resources/v2/billing/collection_setting.rb +0 -327
  427. data/lib/stripe/resources/v2/billing/collection_setting_version.rb +0 -316
  428. data/lib/stripe/resources/v2/billing/profile.rb +0 -47
  429. data/lib/stripe/resources/v2/core/approval_request.rb +0 -395
  430. data/lib/stripe/resources/v2/core/batch_job.rb +0 -536
  431. data/lib/stripe/resources/v2/data/query_run.rb +0 -255
  432. data/lib/stripe/resources/v2/data/report.rb +0 -104
  433. data/lib/stripe/resources/v2/data/report_run.rb +0 -246
  434. data/lib/stripe/resources/v2/data/reporting/query_run.rb +0 -142
  435. data/lib/stripe/resources/v2/data/schema.rb +0 -121
  436. data/lib/stripe/resources/v2/extend/workflow.rb +0 -80
  437. data/lib/stripe/resources/v2/extend/workflow_run.rb +0 -158
  438. data/lib/stripe/resources/v2/iam/activity_log.rb +0 -368
  439. data/lib/stripe/resources/v2/money_management/financial_address_generated_microdeposits.rb +0 -33
  440. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +0 -255
  441. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +0 -260
  442. data/lib/stripe/resources/v2/money_management/received_debit.rb +0 -137
  443. data/lib/stripe/resources/v2/network/business_profile.rb +0 -84
  444. data/lib/stripe/resources/v2/orchestrated_commerce/agreement.rb +0 -93
  445. data/lib/stripe/resources/v2/signals/account_activity.rb +0 -252
  446. data/lib/stripe/resources/v2/signals/account_evaluation.rb +0 -249
  447. data/lib/stripe/resources/v2/signals/account_signal.rb +0 -184
  448. data/lib/stripe/services/account_notice_service.rb +0 -39
  449. data/lib/stripe/services/billing/analytics/meter_usage_service.rb +0 -21
  450. data/lib/stripe/services/billing/analytics_service.rb +0 -15
  451. data/lib/stripe/services/capital/financing_offer_service.rb +0 -42
  452. data/lib/stripe/services/capital/financing_summary_service.rb +0 -19
  453. data/lib/stripe/services/capital/financing_transaction_service.rb +0 -31
  454. data/lib/stripe/services/capital_service.rb +0 -15
  455. data/lib/stripe/services/external_account_service.rb +0 -68
  456. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -19
  457. data/lib/stripe/services/financial_connections/authorization_service.rb +0 -19
  458. data/lib/stripe/services/financial_connections/institution_service.rb +0 -30
  459. data/lib/stripe/services/fx_quote_service.rb +0 -27
  460. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -74
  461. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -30
  462. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -30
  463. data/lib/stripe/services/margin_service.rb +0 -50
  464. data/lib/stripe/services/order_service.rb +0 -53
  465. data/lib/stripe/services/payment_plan_service.rb +0 -50
  466. data/lib/stripe/services/privacy/redaction_job_service.rb +0 -104
  467. data/lib/stripe/services/privacy/redaction_job_validation_error_service.rb +0 -19
  468. data/lib/stripe/services/privacy_service.rb +0 -13
  469. data/lib/stripe/services/quote_line_service.rb +0 -17
  470. data/lib/stripe/services/quote_preview_invoice_service.rb +0 -17
  471. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -17
  472. data/lib/stripe/services/radar/billing_evaluation_service.rb +0 -19
  473. data/lib/stripe/services/reserve/hold_service.rb +0 -30
  474. data/lib/stripe/services/reserve/plan_service.rb +0 -30
  475. data/lib/stripe/services/reserve/release_service.rb +0 -30
  476. data/lib/stripe/services/reserve_service.rb +0 -15
  477. data/lib/stripe/services/shared_payment/granted_token_service.rb +0 -19
  478. data/lib/stripe/services/shared_payment/issued_token_service.rb +0 -41
  479. data/lib/stripe/services/shared_payment_service.rb +0 -14
  480. data/lib/stripe/services/tax/form_service.rb +0 -37
  481. data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -19
  482. data/lib/stripe/services/test_helpers/shared_payment/granted_token_service.rb +0 -32
  483. data/lib/stripe/services/test_helpers/shared_payment_service.rb +0 -15
  484. data/lib/stripe/services/v2/billing/bill_setting_service.rb +0 -61
  485. data/lib/stripe/services/v2/billing/bill_settings/version_service.rb +0 -34
  486. data/lib/stripe/services/v2/billing/cadence_service.rb +0 -65
  487. data/lib/stripe/services/v2/billing/collection_setting_service.rb +0 -69
  488. data/lib/stripe/services/v2/billing/collection_settings/version_service.rb +0 -34
  489. data/lib/stripe/services/v2/billing/profile_service.rb +0 -54
  490. data/lib/stripe/services/v2/core/approval_request_service.rb +0 -58
  491. data/lib/stripe/services/v2/core/batch_job_service.rb +0 -43
  492. data/lib/stripe/services/v2/data/query_run_service.rb +0 -34
  493. data/lib/stripe/services/v2/data/report_run_service.rb +0 -36
  494. data/lib/stripe/services/v2/data/report_service.rb +0 -34
  495. data/lib/stripe/services/v2/data/reporting/query_run_service.rb +0 -35
  496. data/lib/stripe/services/v2/data/reporting_service.rb +0 -17
  497. data/lib/stripe/services/v2/data/schema_service.rb +0 -32
  498. data/lib/stripe/services/v2/data_service.rb +0 -19
  499. data/lib/stripe/services/v2/extend/workflow_run_service.rb +0 -32
  500. data/lib/stripe/services/v2/extend/workflow_service.rb +0 -45
  501. data/lib/stripe/services/v2/extend_service.rb +0 -16
  502. data/lib/stripe/services/v2/iam/activity_log_service.rb +0 -32
  503. data/lib/stripe/services/v2/iam_service.rb +0 -15
  504. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +0 -35
  505. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +0 -61
  506. data/lib/stripe/services/v2/money_management/received_debit_service.rb +0 -32
  507. data/lib/stripe/services/v2/network/business_profile_service.rb +0 -32
  508. data/lib/stripe/services/v2/network_service.rb +0 -15
  509. data/lib/stripe/services/v2/orchestrated_commerce/agreement_service.rb +0 -65
  510. data/lib/stripe/services/v2/orchestrated_commerce_service.rb +0 -15
  511. data/lib/stripe/services/v2/signals/account_activity_service.rb +0 -43
  512. data/lib/stripe/services/v2/signals/account_evaluation_service.rb +0 -32
  513. data/lib/stripe/services/v2/signals/account_signal_service.rb +0 -32
  514. data/lib/stripe/services/v2/signals_service.rb +0 -17
@@ -1,968 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- module Stripe
5
- # A subscription schedule allows you to create and manage the lifecycle of a subscription by
6
- # predefining expected changes. A quote preview subscription schedule shows the subscription schedule
7
- # that would be created by accepting the quote.
8
- class QuotePreviewSubscriptionSchedule < APIResource
9
- OBJECT_NAME = "quote_preview_subscription_schedule"
10
- def self.object_name
11
- "quote_preview_subscription_schedule"
12
- end
13
-
14
- class AppliesTo < ::Stripe::StripeObject
15
- # 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.
16
- attr_reader :new_reference
17
- # The ID of the schedule the line applies to.
18
- attr_reader :subscription_schedule
19
- # Describes whether the quote line is affecting a new schedule or an existing schedule.
20
- attr_reader :type
21
-
22
- def self.inner_class_types
23
- @inner_class_types = {}
24
- end
25
-
26
- def self.field_remappings
27
- @field_remappings = {}
28
- end
29
- end
30
-
31
- class BillingMode < ::Stripe::StripeObject
32
- class Flexible < ::Stripe::StripeObject
33
- # Controls how invoices and invoice items display proration amounts and discount amounts.
34
- attr_reader :proration_discounts
35
-
36
- def self.inner_class_types
37
- @inner_class_types = {}
38
- end
39
-
40
- def self.field_remappings
41
- @field_remappings = {}
42
- end
43
- end
44
- # Configure behavior for flexible billing mode
45
- attr_reader :flexible
46
- # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
47
- attr_reader :type
48
- # Details on when the current billing_mode was adopted.
49
- attr_reader :updated_at
50
-
51
- def self.inner_class_types
52
- @inner_class_types = { flexible: Flexible }
53
- end
54
-
55
- def self.field_remappings
56
- @field_remappings = {}
57
- end
58
- end
59
-
60
- class CurrentPhase < ::Stripe::StripeObject
61
- # The end of this phase of the subscription schedule.
62
- attr_reader :end_date
63
- # The start of this phase of the subscription schedule.
64
- attr_reader :start_date
65
-
66
- def self.inner_class_types
67
- @inner_class_types = {}
68
- end
69
-
70
- def self.field_remappings
71
- @field_remappings = {}
72
- end
73
- end
74
-
75
- class DefaultSettings < ::Stripe::StripeObject
76
- class AutomaticTax < ::Stripe::StripeObject
77
- class Liability < ::Stripe::StripeObject
78
- # The connected account being referenced when `type` is `account`.
79
- attr_reader :account
80
- # Type of the account referenced.
81
- attr_reader :type
82
-
83
- def self.inner_class_types
84
- @inner_class_types = {}
85
- end
86
-
87
- def self.field_remappings
88
- @field_remappings = {}
89
- end
90
- end
91
- # If Stripe disabled automatic tax, this enum describes why.
92
- attr_reader :disabled_reason
93
- # Whether Stripe automatically computes tax on invoices created during this phase.
94
- attr_reader :enabled
95
- # The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
96
- attr_reader :liability
97
-
98
- def self.inner_class_types
99
- @inner_class_types = { liability: Liability }
100
- end
101
-
102
- def self.field_remappings
103
- @field_remappings = {}
104
- end
105
- end
106
-
107
- class BillingThresholds < ::Stripe::StripeObject
108
- # Monetary threshold that triggers the subscription to create an invoice
109
- attr_reader :amount_gte
110
- # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
111
- attr_reader :reset_billing_cycle_anchor
112
-
113
- def self.inner_class_types
114
- @inner_class_types = {}
115
- end
116
-
117
- def self.field_remappings
118
- @field_remappings = {}
119
- end
120
- end
121
-
122
- class InvoiceSettings < ::Stripe::StripeObject
123
- class CustomField < ::Stripe::StripeObject
124
- # The name of the custom field.
125
- attr_reader :name
126
- # The value of the custom field.
127
- attr_reader :value
128
-
129
- def self.inner_class_types
130
- @inner_class_types = {}
131
- end
132
-
133
- def self.field_remappings
134
- @field_remappings = {}
135
- end
136
- end
137
-
138
- class Issuer < ::Stripe::StripeObject
139
- # The connected account being referenced when `type` is `account`.
140
- attr_reader :account
141
- # Type of the account referenced.
142
- attr_reader :type
143
-
144
- def self.inner_class_types
145
- @inner_class_types = {}
146
- end
147
-
148
- def self.field_remappings
149
- @field_remappings = {}
150
- end
151
- end
152
- # The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
153
- attr_reader :account_tax_ids
154
- # A list of up to 4 custom fields to be displayed on the invoice.
155
- attr_reader :custom_fields
156
- # Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
157
- attr_reader :days_until_due
158
- # An arbitrary string attached to the object. Often useful for displaying to users.
159
- attr_reader :description
160
- # Footer to be displayed on the invoice.
161
- attr_reader :footer
162
- # Attribute for field issuer
163
- attr_reader :issuer
164
-
165
- def self.inner_class_types
166
- @inner_class_types = { custom_fields: CustomField, issuer: Issuer }
167
- end
168
-
169
- def self.field_remappings
170
- @field_remappings = {}
171
- end
172
- end
173
-
174
- class TransferData < ::Stripe::StripeObject
175
- # 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.
176
- attr_reader :amount_percent
177
- # The account where funds from the payment will be transferred to upon payment success.
178
- attr_reader :destination
179
-
180
- def self.inner_class_types
181
- @inner_class_types = {}
182
- end
183
-
184
- def self.field_remappings
185
- @field_remappings = {}
186
- end
187
- end
188
- # 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 during this phase of the schedule.
189
- attr_reader :application_fee_percent
190
- # Attribute for field automatic_tax
191
- attr_reader :automatic_tax
192
- # Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
193
- attr_reader :billing_cycle_anchor
194
- # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
195
- attr_reader :billing_thresholds
196
- # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
197
- attr_reader :collection_method
198
- # ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
199
- attr_reader :default_payment_method
200
- # Subscription 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.
201
- attr_reader :description
202
- # Attribute for field invoice_settings
203
- attr_reader :invoice_settings
204
- # The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
205
- attr_reader :on_behalf_of
206
- # The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
207
- attr_reader :transfer_data
208
-
209
- def self.inner_class_types
210
- @inner_class_types = {
211
- automatic_tax: AutomaticTax,
212
- billing_thresholds: BillingThresholds,
213
- invoice_settings: InvoiceSettings,
214
- transfer_data: TransferData,
215
- }
216
- end
217
-
218
- def self.field_remappings
219
- @field_remappings = {}
220
- end
221
- end
222
-
223
- class LastPriceMigrationError < ::Stripe::StripeObject
224
- class FailedTransition < ::Stripe::StripeObject
225
- # The original price to be migrated.
226
- attr_reader :source_price
227
- # The intended resulting price of the migration.
228
- attr_reader :target_price
229
-
230
- def self.inner_class_types
231
- @inner_class_types = {}
232
- end
233
-
234
- def self.field_remappings
235
- @field_remappings = {}
236
- end
237
- end
238
- # The time at which the price migration encountered an error.
239
- attr_reader :errored_at
240
- # The involved price pairs in each failed transition.
241
- attr_reader :failed_transitions
242
- # The type of error encountered by the price migration.
243
- attr_reader :type
244
-
245
- def self.inner_class_types
246
- @inner_class_types = { failed_transitions: FailedTransition }
247
- end
248
-
249
- def self.field_remappings
250
- @field_remappings = {}
251
- end
252
- end
253
-
254
- class PauseSchedule < ::Stripe::StripeObject
255
- class Pause < ::Stripe::StripeObject
256
- class Settings < ::Stripe::StripeObject
257
- class BillFor < ::Stripe::StripeObject
258
- class OutstandingUsageThrough < ::Stripe::StripeObject
259
- # The type of outstanding usage billing behavior.
260
- attr_reader :type
261
-
262
- def self.inner_class_types
263
- @inner_class_types = {}
264
- end
265
-
266
- def self.field_remappings
267
- @field_remappings = {}
268
- end
269
- end
270
-
271
- class UnusedTimeFrom < ::Stripe::StripeObject
272
- # The type of unused time credit behavior.
273
- attr_reader :type
274
-
275
- def self.inner_class_types
276
- @inner_class_types = {}
277
- end
278
-
279
- def self.field_remappings
280
- @field_remappings = {}
281
- end
282
- end
283
- # Attribute for field outstanding_usage_through
284
- attr_reader :outstanding_usage_through
285
- # Attribute for field unused_time_from
286
- attr_reader :unused_time_from
287
-
288
- def self.inner_class_types
289
- @inner_class_types = {
290
- outstanding_usage_through: OutstandingUsageThrough,
291
- unused_time_from: UnusedTimeFrom,
292
- }
293
- end
294
-
295
- def self.field_remappings
296
- @field_remappings = {}
297
- end
298
- end
299
- # Attribute for field bill_for
300
- attr_reader :bill_for
301
- # Determines how to handle debits and credits when pausing.
302
- attr_reader :invoicing_behavior
303
- # The type of pause settings.
304
- attr_reader :type
305
-
306
- def self.inner_class_types
307
- @inner_class_types = { bill_for: BillFor }
308
- end
309
-
310
- def self.field_remappings
311
- @field_remappings = {}
312
- end
313
- end
314
-
315
- class Status < ::Stripe::StripeObject
316
- class Error < ::Stripe::StripeObject
317
- # A machine-readable error code.
318
- attr_reader :code
319
- # A description of the error.
320
- attr_reader :message
321
-
322
- def self.inner_class_types
323
- @inner_class_types = {}
324
- end
325
-
326
- def self.field_remappings
327
- @field_remappings = {}
328
- end
329
- end
330
- # Attribute for field error
331
- attr_reader :error
332
- # The lifecycle state of the pause operation.
333
- attr_reader :type
334
-
335
- def self.inner_class_types
336
- @inner_class_types = { error: Error }
337
- end
338
-
339
- def self.field_remappings
340
- @field_remappings = {}
341
- end
342
- end
343
- # Time at which the subscription pauses.
344
- attr_reader :pause_at
345
- # Settings controlling billing behavior during the pause.
346
- attr_reader :settings
347
- # Attribute for field status
348
- attr_reader :status
349
-
350
- def self.inner_class_types
351
- @inner_class_types = { settings: Settings, status: Status }
352
- end
353
-
354
- def self.field_remappings
355
- @field_remappings = {}
356
- end
357
- end
358
-
359
- class Resume < ::Stripe::StripeObject
360
- class Settings < ::Stripe::StripeObject
361
- # The billing cycle anchor that applies when the subscription is resumed.
362
- attr_reader :billing_cycle_anchor
363
- # Controls whether Stripe attempts payment on the resumption invoice and how that affects the subscription's status.
364
- attr_reader :payment_behavior
365
- # Determines how to handle prorations resulting from the billing_cycle_anchor change on resume.
366
- attr_reader :proration_behavior
367
-
368
- def self.inner_class_types
369
- @inner_class_types = {}
370
- end
371
-
372
- def self.field_remappings
373
- @field_remappings = {}
374
- end
375
- end
376
-
377
- class Status < ::Stripe::StripeObject
378
- class Error < ::Stripe::StripeObject
379
- # A machine-readable error code.
380
- attr_reader :code
381
- # A description of the error.
382
- attr_reader :message
383
-
384
- def self.inner_class_types
385
- @inner_class_types = {}
386
- end
387
-
388
- def self.field_remappings
389
- @field_remappings = {}
390
- end
391
- end
392
- # Attribute for field error
393
- attr_reader :error
394
- # The lifecycle state of the resume operation.
395
- attr_reader :type
396
-
397
- def self.inner_class_types
398
- @inner_class_types = { error: Error }
399
- end
400
-
401
- def self.field_remappings
402
- @field_remappings = {}
403
- end
404
- end
405
- # Time at which the subscription resumes.
406
- attr_reader :resume_at
407
- # Attribute for field settings
408
- attr_reader :settings
409
- # Attribute for field status
410
- attr_reader :status
411
-
412
- def self.inner_class_types
413
- @inner_class_types = { settings: Settings, status: Status }
414
- end
415
-
416
- def self.field_remappings
417
- @field_remappings = {}
418
- end
419
- end
420
- # A unique identifier for this pause schedule.
421
- attr_reader :key
422
- # Attribute for field pause
423
- attr_reader :pause
424
- # Details about when and how the subscription resumes.
425
- attr_reader :resume
426
-
427
- def self.inner_class_types
428
- @inner_class_types = { pause: Pause, resume: Resume }
429
- end
430
-
431
- def self.field_remappings
432
- @field_remappings = {}
433
- end
434
- end
435
-
436
- class Phase < ::Stripe::StripeObject
437
- class AddInvoiceItem < ::Stripe::StripeObject
438
- class Discount < ::Stripe::StripeObject
439
- class DiscountEnd < ::Stripe::StripeObject
440
- # The discount end timestamp.
441
- attr_reader :timestamp
442
- # The discount end type.
443
- attr_reader :type
444
-
445
- def self.inner_class_types
446
- @inner_class_types = {}
447
- end
448
-
449
- def self.field_remappings
450
- @field_remappings = {}
451
- end
452
- end
453
- # ID of the coupon to create a new discount for.
454
- attr_reader :coupon
455
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
456
- attr_reader :discount
457
- # Details to determine how long the discount should be applied for.
458
- attr_reader :discount_end
459
- # ID of the promotion code to create a new discount for.
460
- attr_reader :promotion_code
461
-
462
- def self.inner_class_types
463
- @inner_class_types = { discount_end: DiscountEnd }
464
- end
465
-
466
- def self.field_remappings
467
- @field_remappings = {}
468
- end
469
- end
470
-
471
- class Period < ::Stripe::StripeObject
472
- class End < ::Stripe::StripeObject
473
- # A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
474
- attr_reader :timestamp
475
- # Select how to calculate the end of the invoice item period.
476
- attr_reader :type
477
-
478
- def self.inner_class_types
479
- @inner_class_types = {}
480
- end
481
-
482
- def self.field_remappings
483
- @field_remappings = {}
484
- end
485
- end
486
-
487
- class Start < ::Stripe::StripeObject
488
- # A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
489
- attr_reader :timestamp
490
- # Select how to calculate the start of the invoice item period.
491
- attr_reader :type
492
-
493
- def self.inner_class_types
494
- @inner_class_types = {}
495
- end
496
-
497
- def self.field_remappings
498
- @field_remappings = {}
499
- end
500
- end
501
- # Attribute for field end
502
- attr_reader :end
503
- # Attribute for field start
504
- attr_reader :start
505
-
506
- def self.inner_class_types
507
- @inner_class_types = { end: End, start: Start }
508
- end
509
-
510
- def self.field_remappings
511
- @field_remappings = {}
512
- end
513
- end
514
- # Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
515
- attr_reader :discountable
516
- # The stackable discounts that will be applied to the item.
517
- attr_reader :discounts
518
- # 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.
519
- attr_reader :metadata
520
- # Attribute for field period
521
- attr_reader :period
522
- # ID of the price used to generate the invoice item.
523
- attr_reader :price
524
- # The quantity of the invoice item.
525
- attr_reader :quantity
526
- # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
527
- attr_reader :tax_rates
528
-
529
- def self.inner_class_types
530
- @inner_class_types = { discounts: Discount, period: Period }
531
- end
532
-
533
- def self.field_remappings
534
- @field_remappings = {}
535
- end
536
- end
537
-
538
- class AutomaticTax < ::Stripe::StripeObject
539
- class Liability < ::Stripe::StripeObject
540
- # The connected account being referenced when `type` is `account`.
541
- attr_reader :account
542
- # Type of the account referenced.
543
- attr_reader :type
544
-
545
- def self.inner_class_types
546
- @inner_class_types = {}
547
- end
548
-
549
- def self.field_remappings
550
- @field_remappings = {}
551
- end
552
- end
553
- # If Stripe disabled automatic tax, this enum describes why.
554
- attr_reader :disabled_reason
555
- # Whether Stripe automatically computes tax on invoices created during this phase.
556
- attr_reader :enabled
557
- # The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
558
- attr_reader :liability
559
-
560
- def self.inner_class_types
561
- @inner_class_types = { liability: Liability }
562
- end
563
-
564
- def self.field_remappings
565
- @field_remappings = {}
566
- end
567
- end
568
-
569
- class BillingThresholds < ::Stripe::StripeObject
570
- # Monetary threshold that triggers the subscription to create an invoice
571
- attr_reader :amount_gte
572
- # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
573
- attr_reader :reset_billing_cycle_anchor
574
-
575
- def self.inner_class_types
576
- @inner_class_types = {}
577
- end
578
-
579
- def self.field_remappings
580
- @field_remappings = {}
581
- end
582
- end
583
-
584
- class Discount < ::Stripe::StripeObject
585
- class DiscountEnd < ::Stripe::StripeObject
586
- # The discount end timestamp.
587
- attr_reader :timestamp
588
- # The discount end type.
589
- attr_reader :type
590
-
591
- def self.inner_class_types
592
- @inner_class_types = {}
593
- end
594
-
595
- def self.field_remappings
596
- @field_remappings = {}
597
- end
598
- end
599
- # ID of the coupon to create a new discount for.
600
- attr_reader :coupon
601
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
602
- attr_reader :discount
603
- # Details to determine how long the discount should be applied for.
604
- attr_reader :discount_end
605
- # ID of the promotion code to create a new discount for.
606
- attr_reader :promotion_code
607
-
608
- def self.inner_class_types
609
- @inner_class_types = { discount_end: DiscountEnd }
610
- end
611
-
612
- def self.field_remappings
613
- @field_remappings = {}
614
- end
615
- end
616
-
617
- class InvoiceSettings < ::Stripe::StripeObject
618
- class CustomField < ::Stripe::StripeObject
619
- # The name of the custom field.
620
- attr_reader :name
621
- # The value of the custom field.
622
- attr_reader :value
623
-
624
- def self.inner_class_types
625
- @inner_class_types = {}
626
- end
627
-
628
- def self.field_remappings
629
- @field_remappings = {}
630
- end
631
- end
632
-
633
- class Issuer < ::Stripe::StripeObject
634
- # The connected account being referenced when `type` is `account`.
635
- attr_reader :account
636
- # Type of the account referenced.
637
- attr_reader :type
638
-
639
- def self.inner_class_types
640
- @inner_class_types = {}
641
- end
642
-
643
- def self.field_remappings
644
- @field_remappings = {}
645
- end
646
- end
647
- # The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
648
- attr_reader :account_tax_ids
649
- # A list of up to 4 custom fields to be displayed on the invoice.
650
- attr_reader :custom_fields
651
- # Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
652
- attr_reader :days_until_due
653
- # An arbitrary string attached to the object. Often useful for displaying to users.
654
- attr_reader :description
655
- # Footer to be displayed on the invoice.
656
- attr_reader :footer
657
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
658
- attr_reader :issuer
659
-
660
- def self.inner_class_types
661
- @inner_class_types = { custom_fields: CustomField, issuer: Issuer }
662
- end
663
-
664
- def self.field_remappings
665
- @field_remappings = {}
666
- end
667
- end
668
-
669
- class Item < ::Stripe::StripeObject
670
- class BillingThresholds < ::Stripe::StripeObject
671
- # Usage threshold that triggers the subscription to create an invoice
672
- attr_reader :usage_gte
673
-
674
- def self.inner_class_types
675
- @inner_class_types = {}
676
- end
677
-
678
- def self.field_remappings
679
- @field_remappings = {}
680
- end
681
- end
682
-
683
- class Discount < ::Stripe::StripeObject
684
- class DiscountEnd < ::Stripe::StripeObject
685
- # The discount end timestamp.
686
- attr_reader :timestamp
687
- # The discount end type.
688
- attr_reader :type
689
-
690
- def self.inner_class_types
691
- @inner_class_types = {}
692
- end
693
-
694
- def self.field_remappings
695
- @field_remappings = {}
696
- end
697
- end
698
- # ID of the coupon to create a new discount for.
699
- attr_reader :coupon
700
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
701
- attr_reader :discount
702
- # Details to determine how long the discount should be applied for.
703
- attr_reader :discount_end
704
- # ID of the promotion code to create a new discount for.
705
- attr_reader :promotion_code
706
-
707
- def self.inner_class_types
708
- @inner_class_types = { discount_end: DiscountEnd }
709
- end
710
-
711
- def self.field_remappings
712
- @field_remappings = {}
713
- end
714
- end
715
-
716
- class Trial < ::Stripe::StripeObject
717
- # List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
718
- attr_reader :converts_to
719
- # Determines the type of trial for this item.
720
- attr_reader :type
721
-
722
- def self.inner_class_types
723
- @inner_class_types = {}
724
- end
725
-
726
- def self.field_remappings
727
- @field_remappings = {}
728
- end
729
- end
730
- # Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
731
- attr_reader :billing_thresholds
732
- # The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
733
- attr_reader :discounts
734
- # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
735
- attr_reader :metadata
736
- # ID of the plan to which the customer should be subscribed.
737
- attr_reader :plan
738
- # ID of the price to which the customer should be subscribed.
739
- attr_reader :price
740
- # Quantity of the plan to which the customer should be subscribed.
741
- attr_reader :quantity
742
- # The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
743
- attr_reader :tax_rates
744
- # Options that configure the trial on the subscription item.
745
- attr_reader :trial
746
- # The ID of the trial offer to apply to the configuration item.
747
- attr_reader :trial_offer
748
-
749
- def self.inner_class_types
750
- @inner_class_types = {
751
- billing_thresholds: BillingThresholds,
752
- discounts: Discount,
753
- trial: Trial,
754
- }
755
- end
756
-
757
- def self.field_remappings
758
- @field_remappings = {}
759
- end
760
- end
761
-
762
- class PauseCollection < ::Stripe::StripeObject
763
- # The payment collection behavior for this subscription while paused.
764
- attr_reader :behavior
765
-
766
- def self.inner_class_types
767
- @inner_class_types = {}
768
- end
769
-
770
- def self.field_remappings
771
- @field_remappings = {}
772
- end
773
- end
774
-
775
- class TransferData < ::Stripe::StripeObject
776
- # 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.
777
- attr_reader :amount_percent
778
- # The account where funds from the payment will be transferred to upon payment success.
779
- attr_reader :destination
780
-
781
- def self.inner_class_types
782
- @inner_class_types = {}
783
- end
784
-
785
- def self.field_remappings
786
- @field_remappings = {}
787
- end
788
- end
789
-
790
- class TrialSettings < ::Stripe::StripeObject
791
- class EndBehavior < ::Stripe::StripeObject
792
- # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
793
- attr_reader :prorate_up_front
794
-
795
- def self.inner_class_types
796
- @inner_class_types = {}
797
- end
798
-
799
- def self.field_remappings
800
- @field_remappings = {}
801
- end
802
- end
803
- # Defines how the subscription should behave when a trial ends.
804
- attr_reader :end_behavior
805
-
806
- def self.inner_class_types
807
- @inner_class_types = { end_behavior: EndBehavior }
808
- end
809
-
810
- def self.field_remappings
811
- @field_remappings = {}
812
- end
813
- end
814
- # A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
815
- attr_reader :add_invoice_items
816
- # 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 during this phase of the schedule.
817
- attr_reader :application_fee_percent
818
- # Attribute for field automatic_tax
819
- attr_reader :automatic_tax
820
- # Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
821
- attr_reader :billing_cycle_anchor
822
- # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
823
- attr_reader :billing_thresholds
824
- # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
825
- attr_reader :collection_method
826
- # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
827
- attr_reader :currency
828
- # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
829
- attr_reader :default_payment_method
830
- # The default tax rates to apply to the subscription during this phase of the subscription schedule.
831
- attr_reader :default_tax_rates
832
- # Subscription 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.
833
- attr_reader :description
834
- # The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
835
- attr_reader :discounts
836
- # The end of this phase of the subscription schedule.
837
- attr_reader :end_date
838
- # The invoice settings applicable during this phase.
839
- attr_reader :invoice_settings
840
- # Subscription items to configure the subscription to during this phase of the subscription schedule.
841
- attr_reader :items
842
- # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.
843
- attr_reader :metadata
844
- # The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
845
- attr_reader :on_behalf_of
846
- # 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).
847
- attr_reader :pause_collection
848
- # When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.
849
- attr_reader :proration_behavior
850
- # The start of this phase of the subscription schedule.
851
- attr_reader :start_date
852
- # The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
853
- attr_reader :transfer_data
854
- # If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
855
- attr_reader :trial
856
- # Specify behavior of the trial when crossing schedule phase boundaries
857
- attr_reader :trial_continuation
858
- # When the trial ends within the phase.
859
- attr_reader :trial_end
860
- # Settings related to any trials on the subscription during this phase.
861
- attr_reader :trial_settings
862
-
863
- def self.inner_class_types
864
- @inner_class_types = {
865
- add_invoice_items: AddInvoiceItem,
866
- automatic_tax: AutomaticTax,
867
- billing_thresholds: BillingThresholds,
868
- discounts: Discount,
869
- invoice_settings: InvoiceSettings,
870
- items: Item,
871
- pause_collection: PauseCollection,
872
- transfer_data: TransferData,
873
- trial_settings: TrialSettings,
874
- }
875
- end
876
-
877
- def self.field_remappings
878
- @field_remappings = {}
879
- end
880
- end
881
-
882
- class Prebilling < ::Stripe::StripeObject
883
- # ID of the prebilling invoice.
884
- attr_reader :invoice
885
- # The end of the last period for which the invoice pre-bills.
886
- attr_reader :period_end
887
- # The start of the first period for which the invoice pre-bills.
888
- attr_reader :period_start
889
- # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
890
- attr_reader :update_behavior
891
-
892
- def self.inner_class_types
893
- @inner_class_types = {}
894
- end
895
-
896
- def self.field_remappings
897
- @field_remappings = {}
898
- end
899
- end
900
- # ID of the Connect Application that created the schedule.
901
- attr_reader :application
902
- # Attribute for field applies_to
903
- attr_reader :applies_to
904
- # 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.
905
- attr_reader :billing_behavior
906
- # The billing mode of the subscription.
907
- attr_reader :billing_mode
908
- # Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
909
- attr_reader :canceled_at
910
- # Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
911
- attr_reader :completed_at
912
- # Time at which the object was created. Measured in seconds since the Unix epoch.
913
- attr_reader :created
914
- # Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.
915
- attr_reader :current_phase
916
- # ID of the customer who owns the subscription schedule.
917
- attr_reader :customer
918
- # ID of the account who owns the subscription schedule.
919
- attr_reader :customer_account
920
- # Attribute for field default_settings
921
- attr_reader :default_settings
922
- # 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.
923
- attr_reader :end_behavior
924
- # Unique identifier for the object.
925
- attr_reader :id
926
- # Details of the most recent price migration that failed for the subscription schedule.
927
- attr_reader :last_price_migration_error
928
- # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
929
- attr_reader :livemode
930
- # 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.
931
- attr_reader :metadata
932
- # String representing the object's type. Objects of the same type share the same value.
933
- attr_reader :object
934
- # The pause schedules for this subscription schedule.
935
- attr_reader :pause_schedules
936
- # Configuration for the subscription schedule's phases.
937
- attr_reader :phases
938
- # Time period and invoice for a Subscription billed in advance.
939
- attr_reader :prebilling
940
- # Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
941
- attr_reader :released_at
942
- # ID of the subscription once managed by the subscription schedule (if it is released).
943
- attr_reader :released_subscription
944
- # The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://docs.stripe.com/billing/subscriptions/subscription-schedules).
945
- attr_reader :status
946
- # ID of the subscription managed by the subscription schedule.
947
- attr_reader :subscription
948
- # ID of the test clock this subscription schedule belongs to.
949
- attr_reader :test_clock
950
-
951
- def self.inner_class_types
952
- @inner_class_types = {
953
- applies_to: AppliesTo,
954
- billing_mode: BillingMode,
955
- current_phase: CurrentPhase,
956
- default_settings: DefaultSettings,
957
- last_price_migration_error: LastPriceMigrationError,
958
- pause_schedules: PauseSchedule,
959
- phases: Phase,
960
- prebilling: Prebilling,
961
- }
962
- end
963
-
964
- def self.field_remappings
965
- @field_remappings = {}
966
- end
967
- end
968
- end