stripe 15.5.0 → 15.6.0.pre.alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (717) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1717 -642
  3. data/OPENAPI_VERSION +1 -1
  4. data/VERSION +1 -1
  5. data/lib/stripe/api_requestor.rb +34 -0
  6. data/lib/stripe/api_version.rb +1 -2
  7. data/lib/stripe/errors.rb +63 -0
  8. data/lib/stripe/event_types.rb +185 -0
  9. data/lib/stripe/events/v2_billing_cadence_billed_event.rb +21 -0
  10. data/lib/stripe/events/v2_billing_cadence_canceled_event.rb +21 -0
  11. data/lib/stripe/events/v2_billing_cadence_created_event.rb +23 -0
  12. data/lib/stripe/events/v2_billing_cadence_errored_event.rb +21 -0
  13. data/lib/stripe/events/v2_billing_license_fee_created_event.rb +21 -0
  14. data/lib/stripe/events/v2_billing_license_fee_updated_event.rb +21 -0
  15. data/lib/stripe/events/v2_billing_license_fee_version_created_event.rb +23 -0
  16. data/lib/stripe/events/v2_billing_licensed_item_created_event.rb +21 -0
  17. data/lib/stripe/events/v2_billing_licensed_item_updated_event.rb +21 -0
  18. data/lib/stripe/events/v2_billing_metered_item_created_event.rb +21 -0
  19. data/lib/stripe/events/v2_billing_metered_item_updated_event.rb +21 -0
  20. data/lib/stripe/events/v2_billing_pricing_plan_component_created_event.rb +23 -0
  21. data/lib/stripe/events/v2_billing_pricing_plan_component_updated_event.rb +23 -0
  22. data/lib/stripe/events/v2_billing_pricing_plan_created_event.rb +21 -0
  23. data/lib/stripe/events/v2_billing_pricing_plan_subscription_collection_awaiting_customer_action_event.rb +21 -0
  24. data/lib/stripe/events/v2_billing_pricing_plan_subscription_collection_current_event.rb +21 -0
  25. data/lib/stripe/events/v2_billing_pricing_plan_subscription_collection_past_due_event.rb +21 -0
  26. data/lib/stripe/events/v2_billing_pricing_plan_subscription_collection_paused_event.rb +21 -0
  27. data/lib/stripe/events/v2_billing_pricing_plan_subscription_collection_unpaid_event.rb +21 -0
  28. data/lib/stripe/events/v2_billing_pricing_plan_subscription_servicing_activated_event.rb +21 -0
  29. data/lib/stripe/events/v2_billing_pricing_plan_subscription_servicing_canceled_event.rb +21 -0
  30. data/lib/stripe/events/v2_billing_pricing_plan_subscription_servicing_paused_event.rb +21 -0
  31. data/lib/stripe/events/v2_billing_pricing_plan_updated_event.rb +21 -0
  32. data/lib/stripe/events/v2_billing_pricing_plan_version_created_event.rb +23 -0
  33. data/lib/stripe/events/v2_billing_rate_card_created_event.rb +23 -0
  34. data/lib/stripe/events/v2_billing_rate_card_rate_created_event.rb +23 -0
  35. data/lib/stripe/events/v2_billing_rate_card_subscription_activated_event.rb +21 -0
  36. data/lib/stripe/events/v2_billing_rate_card_subscription_canceled_event.rb +21 -0
  37. data/lib/stripe/events/v2_billing_rate_card_subscription_collection_awaiting_customer_action_event.rb +21 -0
  38. data/lib/stripe/events/v2_billing_rate_card_subscription_collection_current_event.rb +21 -0
  39. data/lib/stripe/events/v2_billing_rate_card_subscription_collection_past_due_event.rb +21 -0
  40. data/lib/stripe/events/v2_billing_rate_card_subscription_collection_paused_event.rb +21 -0
  41. data/lib/stripe/events/v2_billing_rate_card_subscription_collection_unpaid_event.rb +21 -0
  42. data/lib/stripe/events/v2_billing_rate_card_subscription_servicing_activated_event.rb +21 -0
  43. data/lib/stripe/events/v2_billing_rate_card_subscription_servicing_canceled_event.rb +21 -0
  44. data/lib/stripe/events/v2_billing_rate_card_subscription_servicing_paused_event.rb +21 -0
  45. data/lib/stripe/events/v2_billing_rate_card_updated_event.rb +21 -0
  46. data/lib/stripe/events/v2_billing_rate_card_version_created_event.rb +23 -0
  47. data/lib/stripe/events/v2_core_account_closed_event.rb +21 -0
  48. data/lib/stripe/events/v2_core_account_created_event.rb +21 -0
  49. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  50. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  51. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  52. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  53. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  54. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  55. data/lib/stripe/events/v2_core_account_including_configuration_storer_capability_status_updated_event.rb +23 -0
  56. data/lib/stripe/events/v2_core_account_including_configuration_storer_updated_event.rb +21 -0
  57. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +21 -0
  58. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  59. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  60. data/lib/stripe/events/v2_core_account_link_returned_event.rb +13 -0
  61. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  62. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  63. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  64. data/lib/stripe/events/v2_core_account_updated_event.rb +21 -0
  65. data/lib/stripe/events/v2_core_health_api_error_firing_event.rb +13 -0
  66. data/lib/stripe/events/v2_core_health_api_error_resolved_event.rb +13 -0
  67. data/lib/stripe/events/v2_core_health_api_latency_firing_event.rb +13 -0
  68. data/lib/stripe/events/v2_core_health_api_latency_resolved_event.rb +13 -0
  69. data/lib/stripe/events/v2_core_health_authorization_rate_drop_firing_event.rb +13 -0
  70. data/lib/stripe/events/v2_core_health_authorization_rate_drop_resolved_event.rb +13 -0
  71. data/lib/stripe/events/v2_core_health_event_generation_failure_resolved_event.rb +13 -0
  72. data/lib/stripe/events/v2_core_health_fraud_rate_increased_event.rb +13 -0
  73. data/lib/stripe/events/v2_core_health_issuing_authorization_request_timeout_firing_event.rb +13 -0
  74. data/lib/stripe/events/v2_core_health_issuing_authorization_request_timeout_resolved_event.rb +13 -0
  75. data/lib/stripe/events/v2_core_health_payment_method_error_firing_event.rb +13 -0
  76. data/lib/stripe/events/v2_core_health_payment_method_error_resolved_event.rb +13 -0
  77. data/lib/stripe/events/v2_core_health_traffic_volume_drop_firing_event.rb +13 -0
  78. data/lib/stripe/events/v2_core_health_traffic_volume_drop_resolved_event.rb +13 -0
  79. data/lib/stripe/events/v2_core_health_webhook_latency_firing_event.rb +13 -0
  80. data/lib/stripe/events/v2_core_health_webhook_latency_resolved_event.rb +13 -0
  81. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +21 -0
  82. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  83. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +21 -0
  84. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  85. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  86. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  87. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  88. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  89. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  90. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  91. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  92. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  93. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  94. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  95. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  96. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  97. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +21 -0
  98. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  99. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  100. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  101. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  102. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  103. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +21 -0
  104. data/lib/stripe/events/v2_money_management_payout_method_updated_event.rb +21 -0
  105. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  106. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  107. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  108. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  109. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  110. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  111. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  112. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  113. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  114. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +21 -0
  115. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +21 -0
  116. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +21 -0
  117. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +22 -0
  118. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +21 -0
  119. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +21 -0
  120. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +21 -0
  121. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +21 -0
  122. data/lib/stripe/events/v2_reporting_report_run_created_event.rb +21 -0
  123. data/lib/stripe/events/v2_reporting_report_run_failed_event.rb +21 -0
  124. data/lib/stripe/events/v2_reporting_report_run_succeeded_event.rb +21 -0
  125. data/lib/stripe/events/v2_reporting_report_run_updated_event.rb +21 -0
  126. data/lib/stripe/object_types.rb +80 -0
  127. data/lib/stripe/resources/account.rb +653 -1
  128. data/lib/stripe/resources/account_notice.rb +123 -0
  129. data/lib/stripe/resources/account_session.rb +256 -1
  130. data/lib/stripe/resources/balance_settings.rb +112 -0
  131. data/lib/stripe/resources/billing/alert.rb +128 -1
  132. data/lib/stripe/resources/billing/alert_triggered.rb +6 -0
  133. data/lib/stripe/resources/billing/credit_balance_summary.rb +52 -0
  134. data/lib/stripe/resources/billing/credit_balance_transaction.rb +54 -0
  135. data/lib/stripe/resources/billing/credit_grant.rb +71 -2
  136. data/lib/stripe/resources/billing/meter_usage.rb +23 -0
  137. data/lib/stripe/resources/billing/meter_usage_row.rb +28 -0
  138. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  139. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  140. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  141. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  142. data/lib/stripe/resources/card.rb +2 -0
  143. data/lib/stripe/resources/cash_balance.rb +2 -0
  144. data/lib/stripe/resources/charge.rb +1540 -4
  145. data/lib/stripe/resources/checkout/session.rb +623 -5
  146. data/lib/stripe/resources/confirmation_token.rb +170 -0
  147. data/lib/stripe/resources/coupon.rb +30 -1
  148. data/lib/stripe/resources/credit_note.rb +6 -0
  149. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  150. data/lib/stripe/resources/customer.rb +2 -0
  151. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  152. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  153. data/lib/stripe/resources/customer_session.rb +6 -1
  154. data/lib/stripe/resources/discount.rb +2 -0
  155. data/lib/stripe/resources/dispute.rb +11 -0
  156. data/lib/stripe/resources/event.rb +31 -0
  157. data/lib/stripe/resources/financial_connections/account.rb +22 -1
  158. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  159. data/lib/stripe/resources/financial_connections/institution.rb +92 -0
  160. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  161. data/lib/stripe/resources/fx_quote.rb +186 -0
  162. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  163. data/lib/stripe/resources/invoice.rb +1151 -16
  164. data/lib/stripe/resources/invoice_item.rb +126 -2
  165. data/lib/stripe/resources/invoice_line_item.rb +107 -1
  166. data/lib/stripe/resources/invoice_payment.rb +6 -1
  167. data/lib/stripe/resources/issuing/card.rb +0 -8
  168. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  169. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  170. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  171. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  172. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  173. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  174. data/lib/stripe/resources/line_item.rb +37 -0
  175. data/lib/stripe/resources/mandate.rb +89 -1
  176. data/lib/stripe/resources/margin.rb +115 -0
  177. data/lib/stripe/resources/order.rb +2958 -0
  178. data/lib/stripe/resources/payment_attempt_record.rb +1177 -0
  179. data/lib/stripe/resources/payment_intent.rb +6448 -545
  180. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +72 -0
  181. data/lib/stripe/resources/payment_method.rb +194 -1
  182. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  183. data/lib/stripe/resources/payment_record.rb +1723 -0
  184. data/lib/stripe/resources/price.rb +30 -0
  185. data/lib/stripe/resources/privacy/redaction_job.rb +298 -0
  186. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +33 -0
  187. data/lib/stripe/resources/promotion_code.rb +10 -0
  188. data/lib/stripe/resources/quote.rb +2038 -7
  189. data/lib/stripe/resources/quote_line.rb +274 -0
  190. data/lib/stripe/resources/quote_preview_invoice.rb +687 -0
  191. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +395 -0
  192. data/lib/stripe/resources/refund.rb +9 -0
  193. data/lib/stripe/resources/setup_attempt.rb +24 -0
  194. data/lib/stripe/resources/setup_intent.rb +771 -9
  195. data/lib/stripe/resources/source.rb +29 -0
  196. data/lib/stripe/resources/subscription.rb +403 -9
  197. data/lib/stripe/resources/subscription_item.rb +84 -3
  198. data/lib/stripe/resources/subscription_schedule.rb +1007 -10
  199. data/lib/stripe/resources/tax/association.rb +66 -0
  200. data/lib/stripe/resources/tax/form.rb +211 -0
  201. data/lib/stripe/resources/tax_id.rb +12 -2
  202. data/lib/stripe/resources/terminal/configuration.rb +33 -0
  203. data/lib/stripe/resources/terminal/onboarding_link.rb +84 -0
  204. data/lib/stripe/resources/terminal/reader.rb +8 -0
  205. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  206. data/lib/stripe/resources/transfer.rb +6 -0
  207. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  208. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  209. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  210. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  211. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  212. data/lib/stripe/resources/v2/billing/bill_setting.rb +62 -0
  213. data/lib/stripe/resources/v2/billing/bill_setting_version.rb +50 -0
  214. data/lib/stripe/resources/v2/billing/cadence.rb +182 -0
  215. data/lib/stripe/resources/v2/billing/collection_setting.rb +148 -0
  216. data/lib/stripe/resources/v2/billing/collection_setting_version.rb +136 -0
  217. data/lib/stripe/resources/v2/billing/custom_pricing_unit.rb +35 -0
  218. data/lib/stripe/resources/v2/billing/intent.rb +59 -0
  219. data/lib/stripe/resources/v2/billing/intent_action.rb +200 -0
  220. data/lib/stripe/resources/v2/billing/license_fee.rb +79 -0
  221. data/lib/stripe/resources/v2/billing/license_fee_subscription.rb +36 -0
  222. data/lib/stripe/resources/v2/billing/license_fee_version.rb +56 -0
  223. data/lib/stripe/resources/v2/billing/licensed_item.rb +44 -0
  224. data/lib/stripe/resources/v2/billing/metered_item.rb +58 -0
  225. data/lib/stripe/resources/v2/billing/pricing_plan.rb +43 -0
  226. data/lib/stripe/resources/v2/billing/pricing_plan_component.rb +58 -0
  227. data/lib/stripe/resources/v2/billing/pricing_plan_subscription.rb +63 -0
  228. data/lib/stripe/resources/v2/billing/pricing_plan_version.rb +30 -0
  229. data/lib/stripe/resources/v2/billing/profile.rb +38 -0
  230. data/lib/stripe/resources/v2/billing/rate_card.rb +53 -0
  231. data/lib/stripe/resources/v2/billing/rate_card_rate.rb +71 -0
  232. data/lib/stripe/resources/v2/billing/rate_card_subscription.rb +63 -0
  233. data/lib/stripe/resources/v2/billing/rate_card_version.rb +26 -0
  234. data/lib/stripe/resources/v2/billing/service_action.rb +117 -0
  235. data/lib/stripe/resources/v2/core/account.rb +1938 -0
  236. data/lib/stripe/resources/v2/core/account_link.rb +72 -0
  237. data/lib/stripe/resources/v2/core/claimable_sandbox.rb +57 -0
  238. data/lib/stripe/resources/v2/core/person.rb +276 -0
  239. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +74 -0
  240. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +39 -0
  241. data/lib/stripe/resources/v2/event.rb +2 -0
  242. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +20 -0
  243. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +22 -0
  244. data/lib/stripe/resources/v2/money_management/adjustment.rb +51 -0
  245. data/lib/stripe/resources/v2/money_management/financial_account.rb +79 -0
  246. data/lib/stripe/resources/v2/money_management/financial_address.rb +68 -0
  247. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +94 -0
  248. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +129 -0
  249. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +82 -0
  250. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +45 -0
  251. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +117 -0
  252. data/lib/stripe/resources/v2/money_management/payout_method.rb +77 -0
  253. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +49 -0
  254. data/lib/stripe/resources/v2/money_management/received_credit.rb +122 -0
  255. data/lib/stripe/resources/v2/money_management/received_debit.rb +84 -0
  256. data/lib/stripe/resources/v2/money_management/transaction.rb +80 -0
  257. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +70 -0
  258. data/lib/stripe/resources/v2/payments/off_session_payment.rb +89 -0
  259. data/lib/stripe/resources/v2/reporting/report.rb +64 -0
  260. data/lib/stripe/resources/v2/reporting/report_run.rb +89 -0
  261. data/lib/stripe/resources/v2/tax/automatic_rule.rb +31 -0
  262. data/lib/stripe/resources.rb +194 -0
  263. data/lib/stripe/services/account_notice_service.rb +101 -0
  264. data/lib/stripe/services/account_service.rb +562 -1
  265. data/lib/stripe/services/account_session_service.rb +226 -1
  266. data/lib/stripe/services/balance_settings_service.rb +99 -0
  267. data/lib/stripe/services/billing/alert_service.rb +75 -1
  268. data/lib/stripe/services/billing/credit_balance_summary_service.rb +17 -2
  269. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  270. data/lib/stripe/services/billing/credit_grant_service.rb +37 -2
  271. data/lib/stripe/services/billing/meter_usage_service.rb +76 -0
  272. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  273. data/lib/stripe/services/billing_service.rb +2 -1
  274. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  275. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  276. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  277. data/lib/stripe/services/capital_service.rb +15 -0
  278. data/lib/stripe/services/charge_service.rb +1418 -0
  279. data/lib/stripe/services/checkout/session_service.rb +472 -5
  280. data/lib/stripe/services/coupon_service.rb +17 -1
  281. data/lib/stripe/services/credit_note_service.rb +4 -0
  282. data/lib/stripe/services/customer_session_service.rb +4 -1
  283. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -122
  284. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  285. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  286. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  287. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  288. data/lib/stripe/services/financial_connections_service.rb +2 -1
  289. data/lib/stripe/services/fx_quote_service.rb +123 -0
  290. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  291. data/lib/stripe/services/invoice_item_service.rb +74 -2
  292. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  293. data/lib/stripe/services/invoice_payment_service.rb +4 -1
  294. data/lib/stripe/services/invoice_service.rb +1078 -16
  295. data/lib/stripe/services/issuing/card_service.rb +0 -8
  296. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  297. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  298. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  299. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  300. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  301. data/lib/stripe/services/issuing_service.rb +5 -1
  302. data/lib/stripe/services/mandate_service.rb +40 -0
  303. data/lib/stripe/services/margin_service.rb +119 -0
  304. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  305. data/lib/stripe/services/order_service.rb +2388 -0
  306. data/lib/stripe/services/payment_attempt_record_service.rb +52 -0
  307. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/payment_intent_amount_details_line_item_service.rb} +20 -16
  308. data/lib/stripe/services/payment_intent_service.rb +7630 -2215
  309. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  310. data/lib/stripe/services/payment_method_service.rb +120 -1
  311. data/lib/stripe/services/payment_record_service.rb +562 -0
  312. data/lib/stripe/services/price_service.rb +19 -0
  313. data/lib/stripe/services/privacy/redaction_job_service.rb +240 -0
  314. data/{rbi/stripe/services/tax/calculation_line_item_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +21 -17
  315. data/lib/stripe/services/privacy_service.rb +13 -0
  316. data/lib/stripe/services/promotion_code_service.rb +8 -0
  317. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  318. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  319. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  320. data/lib/stripe/services/quote_service.rb +1723 -8
  321. data/lib/stripe/services/setup_intent_service.rb +691 -9
  322. data/lib/stripe/services/subscription_item_service.rb +75 -3
  323. data/lib/stripe/services/subscription_schedule_service.rb +911 -10
  324. data/lib/stripe/services/subscription_service.rb +336 -9
  325. data/lib/stripe/services/tax/association_service.rb +31 -0
  326. data/lib/stripe/services/tax/form_service.rb +100 -0
  327. data/lib/stripe/services/tax_id_service.rb +8 -2
  328. data/lib/stripe/services/tax_service.rb +3 -1
  329. data/lib/stripe/services/terminal/configuration_service.rb +26 -0
  330. data/lib/stripe/services/terminal/onboarding_link_service.rb +56 -0
  331. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  332. data/lib/stripe/services/terminal_service.rb +3 -1
  333. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +97 -0
  334. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  335. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  336. data/lib/stripe/services/transfer_service.rb +4 -0
  337. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  338. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  339. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  340. data/lib/stripe/services/v1_services.rb +11 -1
  341. data/lib/stripe/services/v2/billing/bill_setting_service.rb +214 -0
  342. data/lib/stripe/services/v2/billing/bill_settings/version_service.rb +45 -0
  343. data/lib/stripe/services/v2/billing/cadence_service.rb +428 -0
  344. data/lib/stripe/services/v2/billing/collection_setting_service.rb +518 -0
  345. data/lib/stripe/services/v2/billing/collection_settings/version_service.rb +45 -0
  346. data/lib/stripe/services/v2/billing/custom_pricing_unit_service.rb +108 -0
  347. data/lib/stripe/services/v2/billing/intent_service.rb +465 -0
  348. data/lib/stripe/services/v2/billing/intents/action_service.rb +45 -0
  349. data/lib/stripe/services/v2/billing/license_fee_service.rb +250 -0
  350. data/lib/stripe/services/v2/billing/license_fee_subscription_service.rb +23 -0
  351. data/lib/stripe/services/v2/billing/license_fees/version_service.rb +45 -0
  352. data/lib/stripe/services/v2/billing/licensed_item_service.rb +149 -0
  353. data/lib/stripe/services/v2/billing/metered_item_service.rb +176 -0
  354. data/lib/stripe/services/v2/billing/pricing_plan_service.rb +142 -0
  355. data/lib/stripe/services/v2/billing/pricing_plan_subscription_service.rb +76 -0
  356. data/lib/stripe/services/v2/billing/pricing_plans/component_service.rb +162 -0
  357. data/lib/stripe/services/v2/billing/pricing_plans/version_service.rb +45 -0
  358. data/lib/stripe/services/v2/billing/profile_service.rb +144 -0
  359. data/lib/stripe/services/v2/billing/rate_card_service.rb +151 -0
  360. data/lib/stripe/services/v2/billing/rate_card_subscription_service.rb +144 -0
  361. data/lib/stripe/services/v2/billing/rate_cards/rate_service.rb +161 -0
  362. data/lib/stripe/services/v2/billing/rate_cards/version_service.rb +45 -0
  363. data/lib/stripe/services/v2/billing/service_action_service.rb +259 -0
  364. data/lib/stripe/services/v2/billing_service.rb +18 -1
  365. data/lib/stripe/services/v2/core/account_link_service.rb +114 -0
  366. data/lib/stripe/services/v2/core/account_service.rb +4536 -0
  367. data/lib/stripe/services/v2/core/accounts/person_service.rb +1045 -0
  368. data/lib/stripe/services/v2/core/claimable_sandbox_service.rb +50 -0
  369. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +130 -0
  370. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +107 -0
  371. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  372. data/lib/stripe/services/v2/core_service.rb +5 -1
  373. data/lib/stripe/services/v2/money_management/adjustment_service.rb +74 -0
  374. data/lib/stripe/services/v2/money_management/financial_account_service.rb +119 -0
  375. data/lib/stripe/services/v2/money_management/financial_address_service.rb +82 -0
  376. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +125 -0
  377. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +95 -0
  378. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +199 -0
  379. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +235 -0
  380. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +172 -0
  381. data/lib/stripe/services/v2/money_management/payout_method_service.rb +90 -0
  382. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  383. data/lib/stripe/services/v2/money_management/received_credit_service.rb +70 -0
  384. data/lib/stripe/services/v2/money_management/received_debit_service.rb +43 -0
  385. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +69 -0
  386. data/lib/stripe/services/v2/money_management/transaction_service.rb +73 -0
  387. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  388. data/lib/stripe/services/v2/payment_service.rb +15 -0
  389. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +152 -0
  390. data/lib/stripe/services/v2/reporting/report_run_service.rb +88 -0
  391. data/lib/stripe/services/v2/reporting/report_service.rb +25 -0
  392. data/lib/stripe/services/v2/reporting_service.rb +16 -0
  393. data/lib/stripe/services/v2/tax/automatic_rule_service.rb +99 -0
  394. data/lib/stripe/services/v2/tax_service.rb +15 -0
  395. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  396. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +53 -0
  397. data/lib/stripe/services/v2_services.rb +6 -1
  398. data/lib/stripe/services.rb +84 -0
  399. data/lib/stripe/stripe_configuration.rb +3 -1
  400. data/lib/stripe/stripe_object.rb +1 -1
  401. data/lib/stripe/util.rb +7 -1
  402. data/lib/stripe/version.rb +1 -1
  403. data/lib/stripe.rb +53 -0
  404. data/stripe.gemspec +4 -1
  405. metadata +281 -323
  406. data/rbi/stripe/resources/account.rbi +0 -4991
  407. data/rbi/stripe/resources/account_link.rbi +0 -76
  408. data/rbi/stripe/resources/account_session.rbi +0 -1173
  409. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -88
  410. data/rbi/stripe/resources/application.rbi +0 -20
  411. data/rbi/stripe/resources/application_fee.rbi +0 -118
  412. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  413. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  414. data/rbi/stripe/resources/balance.rbi +0 -230
  415. data/rbi/stripe/resources/balance_transaction.rbi +0 -147
  416. data/rbi/stripe/resources/bank_account.rbi +0 -127
  417. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  418. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  419. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  420. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  421. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  422. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  423. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  424. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  425. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  426. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -712
  427. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  428. data/rbi/stripe/resources/capability.rbi +0 -125
  429. data/rbi/stripe/resources/card.rbi +0 -125
  430. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  431. data/rbi/stripe/resources/charge.rbi +0 -2136
  432. data/rbi/stripe/resources/checkout/session.rbi +0 -4105
  433. data/rbi/stripe/resources/climate/order.rbi +0 -245
  434. data/rbi/stripe/resources/climate/product.rbi +0 -75
  435. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  436. data/rbi/stripe/resources/confirmation_token.rbi +0 -1818
  437. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  438. data/rbi/stripe/resources/country_spec.rbi +0 -85
  439. data/rbi/stripe/resources/coupon.rbi +0 -250
  440. data/rbi/stripe/resources/credit_note.rbi +0 -752
  441. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  442. data/rbi/stripe/resources/customer.rbi +0 -993
  443. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  444. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  445. data/rbi/stripe/resources/customer_session.rbi +0 -200
  446. data/rbi/stripe/resources/discount.rbi +0 -53
  447. data/rbi/stripe/resources/dispute.rbi +0 -761
  448. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  449. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  450. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  451. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  452. data/rbi/stripe/resources/event.rbi +0 -137
  453. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  454. data/rbi/stripe/resources/file.rbi +0 -143
  455. data/rbi/stripe/resources/file_link.rbi +0 -141
  456. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  457. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  458. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  459. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  460. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  461. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  462. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  463. data/rbi/stripe/resources/identity/verification_report.rbi +0 -360
  464. data/rbi/stripe/resources/identity/verification_session.rbi +0 -564
  465. data/rbi/stripe/resources/invoice.rbi +0 -3894
  466. data/rbi/stripe/resources/invoice_item.rbi +0 -470
  467. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  468. data/rbi/stripe/resources/invoice_payment.rbi +0 -121
  469. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  470. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  471. data/rbi/stripe/resources/issuing/card.rbi +0 -749
  472. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  473. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  474. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  475. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  476. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  477. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  478. data/rbi/stripe/resources/line_item.rbi +0 -72
  479. data/rbi/stripe/resources/login_link.rbi +0 -19
  480. data/rbi/stripe/resources/mandate.rbi +0 -191
  481. data/rbi/stripe/resources/payment_intent.rbi +0 -10011
  482. data/rbi/stripe/resources/payment_link.rbi +0 -1891
  483. data/rbi/stripe/resources/payment_method.rbi +0 -1770
  484. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3550
  485. data/rbi/stripe/resources/payment_method_domain.rbi +0 -228
  486. data/rbi/stripe/resources/payout.rbi +0 -307
  487. data/rbi/stripe/resources/person.rbi +0 -401
  488. data/rbi/stripe/resources/plan.rbi +0 -371
  489. data/rbi/stripe/resources/price.rbi +0 -694
  490. data/rbi/stripe/resources/product.rbi +0 -553
  491. data/rbi/stripe/resources/product_feature.rbi +0 -26
  492. data/rbi/stripe/resources/promotion_code.rbi +0 -264
  493. data/rbi/stripe/resources/quote.rbi +0 -1137
  494. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  495. data/rbi/stripe/resources/radar/value_list.rbi +0 -168
  496. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -129
  497. data/rbi/stripe/resources/refund.rbi +0 -523
  498. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  499. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  500. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  501. data/rbi/stripe/resources/reversal.rbi +0 -51
  502. data/rbi/stripe/resources/review.rbi +0 -154
  503. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  504. data/rbi/stripe/resources/setup_intent.rbi +0 -3974
  505. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  506. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  507. data/rbi/stripe/resources/source.rbi +0 -1496
  508. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  509. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  510. data/rbi/stripe/resources/subscription.rbi +0 -2154
  511. data/rbi/stripe/resources/subscription_item.rbi +0 -404
  512. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1795
  513. data/rbi/stripe/resources/tax/calculation.rbi +0 -478
  514. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -91
  515. data/rbi/stripe/resources/tax/registration.rbi +0 -3216
  516. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  517. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  518. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  519. data/rbi/stripe/resources/tax_code.rbi +0 -44
  520. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  521. data/rbi/stripe/resources/tax_id.rbi +0 -165
  522. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  523. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1647
  524. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  525. data/rbi/stripe/resources/terminal/location.rbi +0 -222
  526. data/rbi/stripe/resources/terminal/reader.rbi +0 -1016
  527. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -132
  528. data/rbi/stripe/resources/token.rbi +0 -1281
  529. data/rbi/stripe/resources/topup.rbi +0 -222
  530. data/rbi/stripe/resources/transfer.rbi +0 -199
  531. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  532. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  533. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -869
  534. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  535. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  536. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  537. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  538. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  539. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  540. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  541. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  542. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  543. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  544. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  545. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  546. data/rbi/stripe/resources/v2/event.rbi +0 -48
  547. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  548. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -168
  549. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  550. data/rbi/stripe/services/account_link_service.rbi +0 -60
  551. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  552. data/rbi/stripe/services/account_person_service.rbi +0 -1007
  553. data/rbi/stripe/services/account_service.rbi +0 -4281
  554. data/rbi/stripe/services/account_session_service.rbi +0 -748
  555. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -76
  556. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  557. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  558. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  559. data/rbi/stripe/services/apps_service.rbi +0 -9
  560. data/rbi/stripe/services/balance_service.rbi +0 -21
  561. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  562. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  563. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  564. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  565. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  566. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  567. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  568. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  569. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  570. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -561
  571. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  572. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  573. data/rbi/stripe/services/billing_service.rbi +0 -15
  574. data/rbi/stripe/services/charge_service.rbi +0 -448
  575. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  576. data/rbi/stripe/services/checkout/session_service.rbi +0 -2697
  577. data/rbi/stripe/services/checkout_service.rbi +0 -9
  578. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  579. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  580. data/rbi/stripe/services/climate_service.rbi +0 -11
  581. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  582. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  583. data/rbi/stripe/services/coupon_service.rbi +0 -194
  584. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  585. data/rbi/stripe/services/credit_note_service.rbi +0 -415
  586. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  587. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  588. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  589. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  590. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  591. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  592. data/rbi/stripe/services/customer_service.rbi +0 -635
  593. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  594. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -70
  595. data/rbi/stripe/services/dispute_service.rbi +0 -424
  596. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  597. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  598. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  599. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  600. data/rbi/stripe/services/event_service.rbi +0 -83
  601. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  602. data/rbi/stripe/services/file_link_service.rbi +0 -124
  603. data/rbi/stripe/services/file_service.rbi +0 -116
  604. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  605. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  606. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  607. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  608. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  609. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  610. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  611. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  612. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -339
  613. data/rbi/stripe/services/identity_service.rbi +0 -10
  614. data/rbi/stripe/services/invoice_item_service.rbi +0 -366
  615. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  616. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  617. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  618. data/rbi/stripe/services/invoice_service.rbi +0 -3073
  619. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  620. data/rbi/stripe/services/issuing/card_service.rbi +0 -503
  621. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  622. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  623. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  624. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  625. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  626. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  627. data/rbi/stripe/services/issuing_service.rbi +0 -16
  628. data/rbi/stripe/services/mandate_service.rbi +0 -20
  629. data/rbi/stripe/services/payment_intent_service.rbi +0 -8010
  630. data/rbi/stripe/services/payment_link_service.rbi +0 -1441
  631. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2487
  632. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  633. data/rbi/stripe/services/payment_method_service.rbi +0 -781
  634. data/rbi/stripe/services/payout_service.rbi +0 -209
  635. data/rbi/stripe/services/plan_service.rbi +0 -282
  636. data/rbi/stripe/services/price_service.rbi +0 -546
  637. data/rbi/stripe/services/product_feature_service.rbi +0 -67
  638. data/rbi/stripe/services/product_service.rbi +0 -477
  639. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  640. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  641. data/rbi/stripe/services/quote_service.rbi +0 -695
  642. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  643. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -109
  644. data/rbi/stripe/services/radar/value_list_service.rbi +0 -141
  645. data/rbi/stripe/services/radar_service.rbi +0 -11
  646. data/rbi/stripe/services/refund_service.rbi +0 -185
  647. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  648. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  649. data/rbi/stripe/services/reporting_service.rbi +0 -10
  650. data/rbi/stripe/services/review_service.rbi +0 -84
  651. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  652. data/rbi/stripe/services/setup_intent_service.rbi +0 -3709
  653. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  654. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  655. data/rbi/stripe/services/sigma_service.rbi +0 -9
  656. data/rbi/stripe/services/source_service.rbi +0 -663
  657. data/rbi/stripe/services/subscription_item_service.rbi +0 -350
  658. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1425
  659. data/rbi/stripe/services/subscription_service.rbi +0 -1768
  660. data/rbi/stripe/services/tax/calculation_service.rbi +0 -234
  661. data/rbi/stripe/services/tax/registration_service.rbi +0 -2278
  662. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  663. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  664. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  665. data/rbi/stripe/services/tax_id_service.rbi +0 -110
  666. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  667. data/rbi/stripe/services/tax_service.rbi +0 -12
  668. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1328
  669. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  670. data/rbi/stripe/services/terminal/location_service.rbi +0 -182
  671. data/rbi/stripe/services/terminal/reader_service.rbi +0 -540
  672. data/rbi/stripe/services/terminal_service.rbi +0 -12
  673. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -746
  674. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  675. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  676. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  677. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  678. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  679. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  680. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  681. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -117
  682. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  683. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -90
  684. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  685. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  686. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  687. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  688. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  689. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  690. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  691. data/rbi/stripe/services/token_service.rbi +0 -1255
  692. data/rbi/stripe/services/topup_service.rbi +0 -176
  693. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  694. data/rbi/stripe/services/transfer_service.rbi +0 -152
  695. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  696. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  697. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  698. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -566
  699. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  700. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  701. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  702. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  703. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  704. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  705. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  706. data/rbi/stripe/services/treasury_service.rbi +0 -18
  707. data/rbi/stripe/services/v1_services.rbi +0 -77
  708. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  709. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  710. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -18
  711. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  712. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  713. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -192
  714. data/rbi/stripe/services/v2/core/event_service.rbi +0 -36
  715. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  716. data/rbi/stripe/services/v2_services.rbi +0 -10
  717. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -129
@@ -1,404 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # Subscription items allow you to create customer subscriptions with more than
7
- # one plan, making it easy to represent complex billing relationships.
8
- class SubscriptionItem < APIResource
9
- class BillingThresholds < Stripe::StripeObject
10
- # Usage threshold that triggers the subscription to create an invoice
11
- sig { returns(T.nilable(Integer)) }
12
- attr_reader :usage_gte
13
- end
14
- # Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
15
- sig { returns(T.nilable(BillingThresholds)) }
16
- attr_reader :billing_thresholds
17
- # Time at which the object was created. Measured in seconds since the Unix epoch.
18
- sig { returns(Integer) }
19
- attr_reader :created
20
- # The end time of this subscription item's current billing period.
21
- sig { returns(Integer) }
22
- attr_reader :current_period_end
23
- # The start time of this subscription item's current billing period.
24
- sig { returns(Integer) }
25
- attr_reader :current_period_start
26
- # The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
27
- sig { returns(T::Array[T.any(String, Stripe::Discount)]) }
28
- attr_reader :discounts
29
- # Unique identifier for the object.
30
- sig { returns(String) }
31
- attr_reader :id
32
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
33
- sig { returns(T::Hash[String, String]) }
34
- attr_reader :metadata
35
- # String representing the object's type. Objects of the same type share the same value.
36
- sig { returns(String) }
37
- attr_reader :object
38
- # You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
39
- #
40
- # Plans define the base price, currency, and billing cycle for recurring purchases of products.
41
- # [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
42
- #
43
- # For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
44
- #
45
- # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview).
46
- sig { returns(Stripe::Plan) }
47
- attr_reader :plan
48
- # Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.
49
- # [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
50
- #
51
- # For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
52
- #
53
- # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).
54
- sig { returns(Stripe::Price) }
55
- attr_reader :price
56
- # The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed.
57
- sig { returns(Integer) }
58
- attr_reader :quantity
59
- # The `subscription` this `subscription_item` belongs to.
60
- sig { returns(String) }
61
- attr_reader :subscription
62
- # The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
63
- sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
64
- attr_reader :tax_rates
65
- # Always true for a deleted object
66
- sig { returns(T::Boolean) }
67
- attr_reader :deleted
68
- class DeleteParams < Stripe::RequestParams
69
- # Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`.
70
- sig { returns(T.nilable(T::Boolean)) }
71
- attr_accessor :clear_usage
72
- # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
73
- sig { returns(T.nilable(String)) }
74
- attr_accessor :proration_behavior
75
- # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
76
- sig { returns(T.nilable(Integer)) }
77
- attr_accessor :proration_date
78
- sig {
79
- params(clear_usage: T.nilable(T::Boolean), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer)).void
80
- }
81
- def initialize(clear_usage: nil, proration_behavior: nil, proration_date: nil); end
82
- end
83
- class UpdateParams < Stripe::RequestParams
84
- class BillingThresholds < Stripe::RequestParams
85
- # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
86
- sig { returns(Integer) }
87
- attr_accessor :usage_gte
88
- sig { params(usage_gte: Integer).void }
89
- def initialize(usage_gte: nil); end
90
- end
91
- class Discount < Stripe::RequestParams
92
- # ID of the coupon to create a new discount for.
93
- sig { returns(T.nilable(String)) }
94
- attr_accessor :coupon
95
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
96
- sig { returns(T.nilable(String)) }
97
- attr_accessor :discount
98
- # ID of the promotion code to create a new discount for.
99
- sig { returns(T.nilable(String)) }
100
- attr_accessor :promotion_code
101
- sig {
102
- params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
103
- }
104
- def initialize(coupon: nil, discount: nil, promotion_code: nil); end
105
- end
106
- class PriceData < Stripe::RequestParams
107
- class Recurring < Stripe::RequestParams
108
- # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
109
- sig { returns(String) }
110
- attr_accessor :interval
111
- # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
112
- sig { returns(T.nilable(Integer)) }
113
- attr_accessor :interval_count
114
- sig { params(interval: String, interval_count: T.nilable(Integer)).void }
115
- def initialize(interval: nil, interval_count: nil); end
116
- end
117
- # 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).
118
- sig { returns(String) }
119
- attr_accessor :currency
120
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
121
- sig { returns(String) }
122
- attr_accessor :product
123
- # The recurring components of a price such as `interval` and `interval_count`.
124
- sig { returns(::Stripe::SubscriptionItem::UpdateParams::PriceData::Recurring) }
125
- attr_accessor :recurring
126
- # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
127
- sig { returns(T.nilable(String)) }
128
- attr_accessor :tax_behavior
129
- # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
130
- sig { returns(T.nilable(Integer)) }
131
- attr_accessor :unit_amount
132
- # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
133
- sig { returns(T.nilable(String)) }
134
- attr_accessor :unit_amount_decimal
135
- sig {
136
- params(currency: String, product: String, recurring: ::Stripe::SubscriptionItem::UpdateParams::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
137
- }
138
- def initialize(
139
- currency: nil,
140
- product: nil,
141
- recurring: nil,
142
- tax_behavior: nil,
143
- unit_amount: nil,
144
- unit_amount_decimal: nil
145
- ); end
146
- end
147
- # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
148
- sig {
149
- returns(T.nilable(T.any(String, ::Stripe::SubscriptionItem::UpdateParams::BillingThresholds)))
150
- }
151
- attr_accessor :billing_thresholds
152
- # The coupons to redeem into discounts for the subscription item.
153
- sig {
154
- returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::UpdateParams::Discount])))
155
- }
156
- attr_accessor :discounts
157
- # Specifies which fields in the response should be expanded.
158
- sig { returns(T.nilable(T::Array[String])) }
159
- attr_accessor :expand
160
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
161
- sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) }
162
- attr_accessor :metadata
163
- # Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
164
- sig { returns(T.nilable(T::Boolean)) }
165
- attr_accessor :off_session
166
- # Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
167
- #
168
- # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
169
- #
170
- # Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
171
- #
172
- # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
173
- sig { returns(T.nilable(String)) }
174
- attr_accessor :payment_behavior
175
- # The identifier of the new plan for this subscription item.
176
- sig { returns(T.nilable(String)) }
177
- attr_accessor :plan
178
- # The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
179
- sig { returns(T.nilable(String)) }
180
- attr_accessor :price
181
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
182
- sig { returns(T.nilable(::Stripe::SubscriptionItem::UpdateParams::PriceData)) }
183
- attr_accessor :price_data
184
- # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
185
- sig { returns(T.nilable(String)) }
186
- attr_accessor :proration_behavior
187
- # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
188
- sig { returns(T.nilable(Integer)) }
189
- attr_accessor :proration_date
190
- # The quantity you'd like to apply to the subscription item you're creating.
191
- sig { returns(T.nilable(Integer)) }
192
- attr_accessor :quantity
193
- # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
194
- sig { returns(T.nilable(T.any(String, T::Array[String]))) }
195
- attr_accessor :tax_rates
196
- sig {
197
- params(billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionItem::UpdateParams::BillingThresholds)), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::UpdateParams::Discount])), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.any(String, T::Hash[String, String])), off_session: T.nilable(T::Boolean), payment_behavior: T.nilable(String), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionItem::UpdateParams::PriceData), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), quantity: T.nilable(Integer), tax_rates: T.nilable(T.any(String, T::Array[String]))).void
198
- }
199
- def initialize(
200
- billing_thresholds: nil,
201
- discounts: nil,
202
- expand: nil,
203
- metadata: nil,
204
- off_session: nil,
205
- payment_behavior: nil,
206
- plan: nil,
207
- price: nil,
208
- price_data: nil,
209
- proration_behavior: nil,
210
- proration_date: nil,
211
- quantity: nil,
212
- tax_rates: nil
213
- ); end
214
- end
215
- class ListParams < Stripe::RequestParams
216
- # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
217
- sig { returns(T.nilable(String)) }
218
- attr_accessor :ending_before
219
- # Specifies which fields in the response should be expanded.
220
- sig { returns(T.nilable(T::Array[String])) }
221
- attr_accessor :expand
222
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
223
- sig { returns(T.nilable(Integer)) }
224
- attr_accessor :limit
225
- # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
226
- sig { returns(T.nilable(String)) }
227
- attr_accessor :starting_after
228
- # The ID of the subscription whose items will be retrieved.
229
- sig { returns(String) }
230
- attr_accessor :subscription
231
- sig {
232
- params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), subscription: String).void
233
- }
234
- def initialize(
235
- ending_before: nil,
236
- expand: nil,
237
- limit: nil,
238
- starting_after: nil,
239
- subscription: nil
240
- ); end
241
- end
242
- class CreateParams < Stripe::RequestParams
243
- class BillingThresholds < Stripe::RequestParams
244
- # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
245
- sig { returns(Integer) }
246
- attr_accessor :usage_gte
247
- sig { params(usage_gte: Integer).void }
248
- def initialize(usage_gte: nil); end
249
- end
250
- class Discount < Stripe::RequestParams
251
- # ID of the coupon to create a new discount for.
252
- sig { returns(T.nilable(String)) }
253
- attr_accessor :coupon
254
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
255
- sig { returns(T.nilable(String)) }
256
- attr_accessor :discount
257
- # ID of the promotion code to create a new discount for.
258
- sig { returns(T.nilable(String)) }
259
- attr_accessor :promotion_code
260
- sig {
261
- params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
262
- }
263
- def initialize(coupon: nil, discount: nil, promotion_code: nil); end
264
- end
265
- class PriceData < Stripe::RequestParams
266
- class Recurring < Stripe::RequestParams
267
- # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
268
- sig { returns(String) }
269
- attr_accessor :interval
270
- # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
271
- sig { returns(T.nilable(Integer)) }
272
- attr_accessor :interval_count
273
- sig { params(interval: String, interval_count: T.nilable(Integer)).void }
274
- def initialize(interval: nil, interval_count: nil); end
275
- end
276
- # 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).
277
- sig { returns(String) }
278
- attr_accessor :currency
279
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
280
- sig { returns(String) }
281
- attr_accessor :product
282
- # The recurring components of a price such as `interval` and `interval_count`.
283
- sig { returns(::Stripe::SubscriptionItem::CreateParams::PriceData::Recurring) }
284
- attr_accessor :recurring
285
- # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
286
- sig { returns(T.nilable(String)) }
287
- attr_accessor :tax_behavior
288
- # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
289
- sig { returns(T.nilable(Integer)) }
290
- attr_accessor :unit_amount
291
- # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
292
- sig { returns(T.nilable(String)) }
293
- attr_accessor :unit_amount_decimal
294
- sig {
295
- params(currency: String, product: String, recurring: ::Stripe::SubscriptionItem::CreateParams::PriceData::Recurring, tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
296
- }
297
- def initialize(
298
- currency: nil,
299
- product: nil,
300
- recurring: nil,
301
- tax_behavior: nil,
302
- unit_amount: nil,
303
- unit_amount_decimal: nil
304
- ); end
305
- end
306
- # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
307
- sig {
308
- returns(T.nilable(T.any(String, ::Stripe::SubscriptionItem::CreateParams::BillingThresholds)))
309
- }
310
- attr_accessor :billing_thresholds
311
- # The coupons to redeem into discounts for the subscription item.
312
- sig {
313
- returns(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::CreateParams::Discount])))
314
- }
315
- attr_accessor :discounts
316
- # Specifies which fields in the response should be expanded.
317
- sig { returns(T.nilable(T::Array[String])) }
318
- attr_accessor :expand
319
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
320
- sig { returns(T.nilable(T::Hash[String, String])) }
321
- attr_accessor :metadata
322
- # Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
323
- #
324
- # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
325
- #
326
- # Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
327
- #
328
- # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
329
- sig { returns(T.nilable(String)) }
330
- attr_accessor :payment_behavior
331
- # The identifier of the plan to add to the subscription.
332
- sig { returns(T.nilable(String)) }
333
- attr_accessor :plan
334
- # The ID of the price object.
335
- sig { returns(T.nilable(String)) }
336
- attr_accessor :price
337
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
338
- sig { returns(T.nilable(::Stripe::SubscriptionItem::CreateParams::PriceData)) }
339
- attr_accessor :price_data
340
- # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
341
- sig { returns(T.nilable(String)) }
342
- attr_accessor :proration_behavior
343
- # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
344
- sig { returns(T.nilable(Integer)) }
345
- attr_accessor :proration_date
346
- # The quantity you'd like to apply to the subscription item you're creating.
347
- sig { returns(T.nilable(Integer)) }
348
- attr_accessor :quantity
349
- # The identifier of the subscription to modify.
350
- sig { returns(String) }
351
- attr_accessor :subscription
352
- # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
353
- sig { returns(T.nilable(T.any(String, T::Array[String]))) }
354
- attr_accessor :tax_rates
355
- sig {
356
- params(billing_thresholds: T.nilable(T.any(String, ::Stripe::SubscriptionItem::CreateParams::BillingThresholds)), discounts: T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::CreateParams::Discount])), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), payment_behavior: T.nilable(String), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionItem::CreateParams::PriceData), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), quantity: T.nilable(Integer), subscription: String, tax_rates: T.nilable(T.any(String, T::Array[String]))).void
357
- }
358
- def initialize(
359
- billing_thresholds: nil,
360
- discounts: nil,
361
- expand: nil,
362
- metadata: nil,
363
- payment_behavior: nil,
364
- plan: nil,
365
- price: nil,
366
- price_data: nil,
367
- proration_behavior: nil,
368
- proration_date: nil,
369
- quantity: nil,
370
- subscription: nil,
371
- tax_rates: nil
372
- ); end
373
- end
374
- # Adds a new item to an existing subscription. No existing items will be changed or replaced.
375
- sig {
376
- params(params: T.any(::Stripe::SubscriptionItem::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionItem)
377
- }
378
- def self.create(params = {}, opts = {}); end
379
-
380
- # Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
381
- sig {
382
- params(item: String, params: T.any(::Stripe::SubscriptionItem::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionItem)
383
- }
384
- def self.delete(item, params = {}, opts = {}); end
385
-
386
- # Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
387
- sig {
388
- params(params: T.any(::Stripe::SubscriptionItem::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionItem)
389
- }
390
- def delete(params = {}, opts = {}); end
391
-
392
- # Returns a list of your subscription items for a given subscription.
393
- sig {
394
- params(params: T.any(::Stripe::SubscriptionItem::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
395
- }
396
- def self.list(params = {}, opts = {}); end
397
-
398
- # Updates the plan or quantity of an item on a current subscription.
399
- sig {
400
- params(item: String, params: T.any(::Stripe::SubscriptionItem::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SubscriptionItem)
401
- }
402
- def self.update(item, params = {}, opts = {}); end
403
- end
404
- end