stripe 13.3.0 → 13.4.0.pre.beta.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (743) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1416 -645
  3. data/OPENAPI_VERSION +1 -1
  4. data/VERSION +1 -1
  5. data/lib/stripe/api_operations/request.rb +1 -0
  6. data/lib/stripe/api_requestor.rb +1 -0
  7. data/lib/stripe/object_types.rb +32 -0
  8. data/lib/stripe/request_params.rb +24 -0
  9. data/lib/stripe/request_signing_authenticator.rb +79 -0
  10. data/lib/stripe/resources/account.rb +5071 -0
  11. data/lib/stripe/resources/account_link.rb +54 -0
  12. data/lib/stripe/resources/account_notice.rb +132 -0
  13. data/lib/stripe/resources/account_session.rb +877 -0
  14. data/lib/stripe/resources/apple_pay_domain.rb +63 -0
  15. data/lib/stripe/resources/application.rb +20 -0
  16. data/lib/stripe/resources/application_fee.rb +96 -0
  17. data/lib/stripe/resources/application_fee_refund.rb +17 -0
  18. data/lib/stripe/resources/apps/secret.rb +141 -0
  19. data/lib/stripe/resources/balance.rb +131 -0
  20. data/lib/stripe/resources/balance_transaction.rb +112 -0
  21. data/lib/stripe/resources/bank_account.rb +84 -2
  22. data/lib/stripe/resources/billing/alert.rb +144 -0
  23. data/lib/stripe/resources/billing/alert_triggered.rb +26 -0
  24. data/lib/stripe/resources/billing/credit_balance_summary.rb +77 -0
  25. data/lib/stripe/resources/billing/credit_balance_transaction.rb +116 -0
  26. data/lib/stripe/resources/billing/credit_grant.rb +203 -0
  27. data/lib/stripe/resources/billing/meter.rb +178 -0
  28. data/lib/stripe/resources/billing/meter_error_report.rb +59 -0
  29. data/lib/stripe/resources/billing/meter_event.rb +35 -0
  30. data/lib/stripe/resources/billing/meter_event_adjustment.rb +43 -0
  31. data/lib/stripe/resources/billing/meter_event_summary.rb +15 -0
  32. data/lib/stripe/resources/billing_portal/configuration.rb +562 -0
  33. data/lib/stripe/resources/billing_portal/session.rb +271 -0
  34. data/lib/stripe/resources/capability.rb +84 -0
  35. data/lib/stripe/resources/capital/financing_offer.rb +188 -0
  36. data/lib/stripe/resources/capital/financing_summary.rb +64 -0
  37. data/lib/stripe/resources/capital/financing_transaction.rb +123 -0
  38. data/lib/stripe/resources/card.rb +79 -0
  39. data/lib/stripe/resources/cash_balance.rb +17 -0
  40. data/lib/stripe/resources/charge.rb +3026 -0
  41. data/lib/stripe/resources/checkout/session.rb +3654 -0
  42. data/lib/stripe/resources/climate/order.rb +176 -0
  43. data/lib/stripe/resources/climate/product.rb +56 -0
  44. data/lib/stripe/resources/climate/supplier.rb +54 -0
  45. data/lib/stripe/resources/confirmation_token.rb +1520 -0
  46. data/lib/stripe/resources/connect_collection_transfer.rb +24 -0
  47. data/lib/stripe/resources/country_spec.rb +63 -0
  48. data/lib/stripe/resources/coupon.rb +198 -0
  49. data/lib/stripe/resources/credit_note.rb +660 -0
  50. data/lib/stripe/resources/credit_note_line_item.rb +65 -0
  51. data/lib/stripe/resources/customer.rb +840 -0
  52. data/lib/stripe/resources/customer_balance_transaction.rb +27 -0
  53. data/lib/stripe/resources/customer_cash_balance_transaction.rb +109 -0
  54. data/lib/stripe/resources/customer_session.rb +159 -0
  55. data/lib/stripe/resources/discount.rb +29 -0
  56. data/lib/stripe/resources/dispute.rb +619 -0
  57. data/lib/stripe/resources/entitlements/active_entitlement.rb +46 -0
  58. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +23 -0
  59. data/lib/stripe/resources/entitlements/feature.rb +90 -0
  60. data/lib/stripe/resources/ephemeral_key.rb +21 -0
  61. data/lib/stripe/resources/event.rb +130 -0
  62. data/lib/stripe/resources/exchange_rate.rb +33 -0
  63. data/lib/stripe/resources/file.rb +111 -0
  64. data/lib/stripe/resources/file_link.rb +112 -0
  65. data/lib/stripe/resources/financial_connections/account.rb +260 -0
  66. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  67. data/lib/stripe/resources/financial_connections/account_owner.rb +17 -0
  68. data/lib/stripe/resources/financial_connections/account_ownership.rb +9 -0
  69. data/lib/stripe/resources/financial_connections/institution.rb +99 -0
  70. data/lib/stripe/resources/financial_connections/session.rb +159 -0
  71. data/lib/stripe/resources/financial_connections/transaction.rb +101 -0
  72. data/lib/stripe/resources/forwarding/request.rb +165 -0
  73. data/lib/stripe/resources/funding_instructions.rb +308 -0
  74. data/lib/stripe/resources/gift_cards/card.rb +217 -0
  75. data/lib/stripe/resources/gift_cards/transaction.rb +281 -0
  76. data/lib/stripe/resources/identity/verification_report.rb +266 -0
  77. data/lib/stripe/resources/identity/verification_session.rb +361 -0
  78. data/lib/stripe/resources/invoice.rb +8078 -0
  79. data/lib/stripe/resources/invoice_item.rb +445 -0
  80. data/lib/stripe/resources/invoice_line_item.rb +333 -0
  81. data/lib/stripe/resources/invoice_payment.rb +56 -0
  82. data/lib/stripe/resources/invoice_rendering_template.rb +67 -0
  83. data/lib/stripe/resources/issuing/authorization.rb +1117 -2
  84. data/lib/stripe/resources/issuing/card.rb +666 -0
  85. data/lib/stripe/resources/issuing/cardholder.rb +658 -0
  86. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +611 -0
  87. data/lib/stripe/resources/issuing/dispute.rb +790 -0
  88. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +84 -0
  89. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +95 -0
  90. data/lib/stripe/resources/issuing/personalization_design.rb +285 -0
  91. data/lib/stripe/resources/issuing/physical_bundle.rb +63 -0
  92. data/lib/stripe/resources/issuing/settlement.rb +49 -0
  93. data/lib/stripe/resources/issuing/token.rb +175 -0
  94. data/lib/stripe/resources/issuing/transaction.rb +927 -0
  95. data/lib/stripe/resources/line_item.rb +75 -0
  96. data/lib/stripe/resources/login_link.rb +7 -0
  97. data/lib/stripe/resources/mandate.rb +169 -0
  98. data/lib/stripe/resources/margin.rb +124 -0
  99. data/lib/stripe/resources/order.rb +2850 -0
  100. data/lib/stripe/resources/payment_attempt_record.rb +184 -0
  101. data/lib/stripe/resources/payment_intent.rb +12864 -0
  102. data/lib/stripe/resources/payment_link.rb +1563 -0
  103. data/lib/stripe/resources/payment_method.rb +1638 -0
  104. data/lib/stripe/resources/payment_method_configuration.rb +2844 -0
  105. data/lib/stripe/resources/payment_method_domain.rb +153 -0
  106. data/lib/stripe/resources/payment_record.rb +715 -0
  107. data/lib/stripe/resources/payout.rb +218 -0
  108. data/lib/stripe/resources/person.rb +263 -0
  109. data/lib/stripe/resources/plan.rb +317 -0
  110. data/lib/stripe/resources/price.rb +649 -0
  111. data/lib/stripe/resources/product.rb +536 -0
  112. data/lib/stripe/resources/product_feature.rb +12 -0
  113. data/lib/stripe/resources/promotion_code.rb +221 -0
  114. data/lib/stripe/resources/quote.rb +2946 -0
  115. data/lib/stripe/resources/quote_line.rb +274 -0
  116. data/lib/stripe/resources/quote_preview_invoice.rb +652 -0
  117. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +362 -0
  118. data/lib/stripe/resources/radar/early_fraud_warning.rb +77 -0
  119. data/lib/stripe/resources/radar/value_list.rb +125 -0
  120. data/lib/stripe/resources/radar/value_list_item.rb +95 -0
  121. data/lib/stripe/resources/refund.rb +397 -0
  122. data/lib/stripe/resources/reporting/report_run.rb +150 -0
  123. data/lib/stripe/resources/reporting/report_type.rb +36 -0
  124. data/lib/stripe/resources/reserve_transaction.rb +22 -0
  125. data/lib/stripe/resources/reversal.rb +21 -0
  126. data/lib/stripe/resources/review.rb +108 -0
  127. data/lib/stripe/resources/setup_attempt.rb +373 -0
  128. data/lib/stripe/resources/setup_intent.rb +3834 -0
  129. data/lib/stripe/resources/shipping_rate.rb +259 -0
  130. data/lib/stripe/resources/sigma/scheduled_query_run.rb +54 -0
  131. data/lib/stripe/resources/source.rb +1239 -0
  132. data/lib/stripe/resources/source_mandate_notification.rb +66 -0
  133. data/lib/stripe/resources/source_transaction.rb +85 -0
  134. data/lib/stripe/resources/subscription.rb +2057 -0
  135. data/lib/stripe/resources/subscription_item.rb +433 -0
  136. data/lib/stripe/resources/subscription_schedule.rb +2402 -0
  137. data/lib/stripe/resources/tax/association.rb +89 -0
  138. data/lib/stripe/resources/tax/calculation.rb +387 -0
  139. data/lib/stripe/resources/tax/calculation_line_item.rb +56 -0
  140. data/lib/stripe/resources/tax/form.rb +220 -0
  141. data/lib/stripe/resources/tax/registration.rb +2382 -0
  142. data/lib/stripe/resources/tax/settings.rb +126 -0
  143. data/lib/stripe/resources/tax/transaction.rb +267 -0
  144. data/lib/stripe/resources/tax/transaction_line_item.rb +31 -0
  145. data/lib/stripe/resources/tax_code.rb +35 -0
  146. data/lib/stripe/resources/tax_deducted_at_source.rb +22 -0
  147. data/lib/stripe/resources/tax_id.rb +121 -0
  148. data/lib/stripe/resources/tax_rate.rb +200 -0
  149. data/lib/stripe/resources/terminal/configuration.rb +1011 -0
  150. data/lib/stripe/resources/terminal/connection_token.rb +18 -0
  151. data/lib/stripe/resources/terminal/location.rb +175 -0
  152. data/lib/stripe/resources/terminal/reader.rb +782 -0
  153. data/lib/stripe/resources/terminal/reader_collected_data.rb +40 -0
  154. data/lib/stripe/resources/test_helpers/test_clock.rb +86 -0
  155. data/lib/stripe/resources/token.rb +1149 -0
  156. data/lib/stripe/resources/topup.rb +174 -0
  157. data/lib/stripe/resources/transfer.rb +153 -0
  158. data/lib/stripe/resources/treasury/credit_reversal.rb +92 -0
  159. data/lib/stripe/resources/treasury/debit_reversal.rb +103 -0
  160. data/lib/stripe/resources/treasury/financial_account.rb +772 -0
  161. data/lib/stripe/resources/treasury/financial_account_features.rb +191 -0
  162. data/lib/stripe/resources/treasury/inbound_transfer.rb +235 -0
  163. data/lib/stripe/resources/treasury/outbound_payment.rb +495 -0
  164. data/lib/stripe/resources/treasury/outbound_transfer.rb +387 -0
  165. data/lib/stripe/resources/treasury/received_credit.rb +283 -0
  166. data/lib/stripe/resources/treasury/received_debit.rb +244 -0
  167. data/lib/stripe/resources/treasury/transaction.rb +176 -0
  168. data/lib/stripe/resources/treasury/transaction_entry.rb +157 -0
  169. data/lib/stripe/resources/usage_record.rb +13 -0
  170. data/lib/stripe/resources/usage_record_summary.rb +21 -0
  171. data/lib/stripe/resources/v2/amount.rb +9 -0
  172. data/lib/stripe/resources/v2/billing/meter_event.rb +18 -0
  173. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +21 -0
  174. data/lib/stripe/resources/v2/billing/meter_event_session.rb +14 -0
  175. data/lib/stripe/resources/v2/event.rb +27 -0
  176. data/lib/stripe/resources/v2/event_destination.rb +59 -0
  177. data/lib/stripe/resources/webhook_endpoint.rb +122 -0
  178. data/lib/stripe/resources.rb +31 -0
  179. data/lib/stripe/services/account_capability_service.rb +32 -0
  180. data/lib/stripe/services/account_external_account_service.rb +250 -0
  181. data/lib/stripe/services/account_link_service.rb +46 -0
  182. data/lib/stripe/services/account_login_link_service.rb +9 -0
  183. data/lib/stripe/services/account_notice_service.rb +101 -0
  184. data/lib/stripe/services/account_person_service.rb +875 -0
  185. data/lib/stripe/services/account_service.rb +4351 -0
  186. data/lib/stripe/services/account_session_service.rb +664 -0
  187. data/lib/stripe/services/apple_pay_domain_service.rb +51 -0
  188. data/lib/stripe/services/application_fee_refund_service.rb +54 -0
  189. data/lib/stripe/services/application_fee_service.rb +57 -0
  190. data/lib/stripe/services/apps/secret_service.rb +116 -0
  191. data/lib/stripe/services/balance_service.rb +9 -0
  192. data/lib/stripe/services/balance_transaction_service.rb +69 -0
  193. data/lib/stripe/services/billing/alert_service.rb +113 -0
  194. data/lib/stripe/services/billing/credit_balance_summary_service.rb +37 -0
  195. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +40 -0
  196. data/lib/stripe/services/billing/credit_grant_service.rb +151 -0
  197. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +26 -0
  198. data/lib/stripe/services/billing/meter_event_service.rb +21 -0
  199. data/lib/stripe/services/billing/meter_event_summary_service.rb +39 -0
  200. data/lib/stripe/services/billing/meter_service.rb +130 -0
  201. data/lib/stripe/services/billing_portal/configuration_service.rb +444 -0
  202. data/lib/stripe/services/billing_portal/session_service.rb +173 -0
  203. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  204. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  205. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  206. data/lib/stripe/services/capital_service.rb +15 -0
  207. data/lib/stripe/services/charge_service.rb +1736 -0
  208. data/lib/stripe/services/checkout/session_line_item_service.rb +18 -0
  209. data/lib/stripe/services/checkout/session_service.rb +2465 -0
  210. data/lib/stripe/services/climate/order_service.rb +102 -0
  211. data/lib/stripe/services/climate/product_service.rb +27 -0
  212. data/lib/stripe/services/climate/supplier_service.rb +27 -0
  213. data/lib/stripe/services/confirmation_token_service.rb +9 -0
  214. data/lib/stripe/services/country_spec_service.rb +27 -0
  215. data/lib/stripe/services/coupon_service.rb +152 -0
  216. data/lib/stripe/services/credit_note_line_item_service.rb +18 -0
  217. data/lib/stripe/services/credit_note_preview_lines_service.rb +156 -0
  218. data/lib/stripe/services/credit_note_service.rb +373 -0
  219. data/lib/stripe/services/customer_balance_transaction_service.rb +63 -0
  220. data/lib/stripe/services/customer_cash_balance_service.rb +29 -0
  221. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +27 -0
  222. data/lib/stripe/services/customer_funding_instructions_service.rb +42 -0
  223. data/lib/stripe/services/customer_payment_method_service.rb +40 -0
  224. data/lib/stripe/services/customer_payment_source_service.rb +179 -0
  225. data/lib/stripe/services/customer_service.rb +593 -0
  226. data/lib/stripe/services/customer_session_service.rb +96 -0
  227. data/lib/stripe/services/customer_tax_id_service.rb +45 -0
  228. data/lib/stripe/services/dispute_service.rb +374 -0
  229. data/lib/stripe/services/entitlements/active_entitlement_service.rb +36 -0
  230. data/lib/stripe/services/entitlements/feature_service.rb +76 -0
  231. data/lib/stripe/services/ephemeral_key_service.rb +36 -0
  232. data/lib/stripe/services/event_service.rb +65 -0
  233. data/lib/stripe/services/exchange_rate_service.rb +27 -0
  234. data/lib/stripe/services/file_link_service.rb +94 -0
  235. data/lib/stripe/services/file_service.rb +89 -0
  236. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +37 -0
  237. data/lib/stripe/services/financial_connections/account_owner_service.rb +27 -0
  238. data/lib/stripe/services/financial_connections/account_service.rb +99 -1
  239. data/lib/stripe/services/financial_connections/institution_service.rb +57 -0
  240. data/lib/stripe/services/financial_connections/session_service.rb +97 -0
  241. data/lib/stripe/services/financial_connections/transaction_service.rb +70 -0
  242. data/lib/stripe/services/financial_connections_service.rb +2 -1
  243. data/lib/stripe/services/forwarding/request_service.rb +106 -0
  244. data/lib/stripe/services/gift_cards/card_service.rb +170 -0
  245. data/lib/stripe/services/gift_cards/transaction_service.rb +209 -0
  246. data/lib/stripe/services/gift_cards_service.rb +14 -0
  247. data/lib/stripe/services/identity/verification_report_service.rb +65 -0
  248. data/lib/stripe/services/identity/verification_session_service.rb +231 -0
  249. data/lib/stripe/services/invoice_item_service.rb +388 -0
  250. data/lib/stripe/services/invoice_line_item_service.rb +237 -0
  251. data/lib/stripe/services/invoice_payment_service.rb +55 -0
  252. data/lib/stripe/services/invoice_rendering_template_service.rb +51 -0
  253. data/lib/stripe/services/invoice_service.rb +5567 -1
  254. data/lib/stripe/services/invoice_upcoming_lines_service.rb +1864 -0
  255. data/lib/stripe/services/issuing/authorization_service.rb +104 -0
  256. data/lib/stripe/services/issuing/card_service.rb +455 -0
  257. data/lib/stripe/services/issuing/cardholder_service.rb +526 -0
  258. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  259. data/lib/stripe/services/issuing/dispute_service.rb +633 -0
  260. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  261. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  262. data/lib/stripe/services/issuing/personalization_design_service.rb +193 -0
  263. data/lib/stripe/services/issuing/physical_bundle_service.rb +40 -0
  264. data/lib/stripe/services/issuing/token_service.rb +73 -0
  265. data/lib/stripe/services/issuing/transaction_service.rb +81 -0
  266. data/lib/stripe/services/issuing_service.rb +5 -1
  267. data/lib/stripe/services/mandate_service.rb +9 -0
  268. data/lib/stripe/services/margin_service.rb +119 -0
  269. data/lib/stripe/services/order_line_item_service.rb +35 -0
  270. data/lib/stripe/services/order_service.rb +2254 -0
  271. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  272. data/lib/stripe/services/payment_intent_service.rb +10894 -0
  273. data/lib/stripe/services/payment_link_line_item_service.rb +18 -0
  274. data/lib/stripe/services/payment_link_service.rb +1223 -0
  275. data/lib/stripe/services/payment_method_configuration_service.rb +2046 -0
  276. data/lib/stripe/services/payment_method_domain_service.rb +76 -0
  277. data/lib/stripe/services/payment_method_service.rb +864 -0
  278. data/lib/stripe/services/payment_record_service.rb +542 -0
  279. data/lib/stripe/services/payout_service.rb +159 -0
  280. data/lib/stripe/services/plan_service.rb +253 -0
  281. data/lib/stripe/services/price_service.rb +516 -0
  282. data/lib/stripe/services/product_feature_service.rb +42 -0
  283. data/lib/stripe/services/product_service.rb +459 -0
  284. data/lib/stripe/services/promotion_code_service.rb +178 -0
  285. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +18 -0
  286. data/lib/stripe/services/quote_line_item_service.rb +18 -0
  287. data/lib/stripe/services/quote_line_service.rb +35 -0
  288. data/lib/stripe/services/quote_preview_invoice_service.rb +35 -0
  289. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  290. data/lib/stripe/services/quote_service.rb +2319 -1
  291. data/lib/stripe/services/radar/early_fraud_warning_service.rb +61 -0
  292. data/lib/stripe/services/radar/value_list_item_service.rb +79 -0
  293. data/lib/stripe/services/radar/value_list_service.rb +103 -0
  294. data/lib/stripe/services/refund_service.rb +137 -0
  295. data/lib/stripe/services/reporting/report_run_service.rb +106 -0
  296. data/lib/stripe/services/reporting/report_type_service.rb +18 -0
  297. data/lib/stripe/services/review_service.rb +56 -0
  298. data/lib/stripe/services/setup_attempt_service.rb +51 -0
  299. data/lib/stripe/services/setup_intent_service.rb +3476 -0
  300. data/lib/stripe/services/shipping_rate_service.rb +200 -0
  301. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +27 -0
  302. data/lib/stripe/services/source_service.rb +601 -0
  303. data/lib/stripe/services/source_transaction_service.rb +18 -0
  304. data/lib/stripe/services/subscription_item_service.rb +383 -0
  305. data/lib/stripe/services/subscription_item_usage_record_service.rb +18 -0
  306. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +18 -0
  307. data/lib/stripe/services/subscription_schedule_service.rb +2053 -0
  308. data/lib/stripe/services/subscription_service.rb +1722 -0
  309. data/lib/stripe/services/tax/association_service.rb +31 -0
  310. data/lib/stripe/services/tax/calculation_line_item_service.rb +18 -0
  311. data/lib/stripe/services/tax/calculation_service.rb +205 -0
  312. data/lib/stripe/services/tax/form_service.rb +100 -0
  313. data/lib/stripe/services/tax/registration_service.rb +1564 -0
  314. data/lib/stripe/services/tax/settings_service.rb +74 -0
  315. data/lib/stripe/services/tax/transaction_line_item_service.rb +18 -0
  316. data/lib/stripe/services/tax/transaction_service.rb +111 -0
  317. data/lib/stripe/services/tax_code_service.rb +27 -0
  318. data/lib/stripe/services/tax_id_service.rb +79 -0
  319. data/lib/stripe/services/tax_rate_service.rb +155 -0
  320. data/lib/stripe/services/tax_service.rb +3 -1
  321. data/lib/stripe/services/terminal/configuration_service.rb +793 -0
  322. data/lib/stripe/services/terminal/connection_token_service.rb +12 -0
  323. data/lib/stripe/services/terminal/location_service.rb +144 -0
  324. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  325. data/lib/stripe/services/terminal/reader_service.rb +443 -0
  326. data/lib/stripe/services/terminal_service.rb +2 -1
  327. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +673 -0
  328. data/lib/stripe/services/test_helpers/customer_service.rb +18 -0
  329. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +745 -0
  330. data/lib/stripe/services/test_helpers/issuing/card_service.rb +45 -0
  331. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +41 -0
  332. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +632 -0
  333. data/lib/stripe/services/test_helpers/refund_service.rb +9 -0
  334. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +44 -0
  335. data/lib/stripe/services/test_helpers/test_clock_service.rb +57 -0
  336. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +38 -0
  337. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +87 -0
  338. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +87 -0
  339. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +84 -0
  340. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +84 -0
  341. data/lib/stripe/services/token_service.rb +1121 -0
  342. data/lib/stripe/services/topup_service.rb +142 -0
  343. data/lib/stripe/services/transfer_reversal_service.rb +66 -0
  344. data/lib/stripe/services/transfer_service.rb +119 -0
  345. data/lib/stripe/services/treasury/credit_reversal_service.rb +59 -0
  346. data/lib/stripe/services/treasury/debit_reversal_service.rb +63 -0
  347. data/lib/stripe/services/treasury/financial_account_features_service.rb +169 -0
  348. data/lib/stripe/services/treasury/financial_account_service.rb +509 -0
  349. data/lib/stripe/services/treasury/inbound_transfer_service.rb +88 -0
  350. data/lib/stripe/services/treasury/outbound_payment_service.rb +258 -0
  351. data/lib/stripe/services/treasury/outbound_transfer_service.rb +148 -0
  352. data/lib/stripe/services/treasury/received_credit_service.rb +52 -0
  353. data/lib/stripe/services/treasury/received_debit_service.rb +40 -0
  354. data/lib/stripe/services/treasury/transaction_entry_service.rb +87 -0
  355. data/lib/stripe/services/treasury/transaction_service.rb +95 -0
  356. data/lib/stripe/services/v1_services.rb +8 -1
  357. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +23 -0
  358. data/lib/stripe/services/v2/billing/meter_event_service.rb +25 -0
  359. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +3 -0
  360. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +33 -0
  361. data/lib/stripe/services/v2/core/event_destination_service.rb +146 -0
  362. data/lib/stripe/services/v2/core/event_service.rb +18 -0
  363. data/lib/stripe/services/webhook_endpoint_service.rb +96 -0
  364. data/lib/stripe/services.rb +25 -0
  365. data/lib/stripe/stripe_client.rb +1 -1
  366. data/lib/stripe/stripe_configuration.rb +3 -1
  367. data/lib/stripe/stripe_object.rb +5 -0
  368. data/lib/stripe/util.rb +7 -1
  369. data/lib/stripe/version.rb +1 -1
  370. data/lib/stripe.rb +46 -0
  371. data/rbi/stripe/resources/account.rbi +5100 -0
  372. data/rbi/stripe/resources/account_link.rbi +74 -0
  373. data/rbi/stripe/resources/account_notice.rbi +139 -0
  374. data/rbi/stripe/resources/account_session.rbi +1007 -0
  375. data/rbi/stripe/resources/apple_pay_domain.rbi +97 -0
  376. data/rbi/stripe/resources/application.rbi +20 -0
  377. data/rbi/stripe/resources/application_fee.rbi +123 -0
  378. data/rbi/stripe/resources/application_fee_refund.rbi +37 -0
  379. data/rbi/stripe/resources/apps/secret.rbi +195 -0
  380. data/rbi/stripe/resources/balance.rbi +187 -0
  381. data/rbi/stripe/resources/balance_transaction.rbi +149 -0
  382. data/rbi/stripe/resources/bank_account.rbi +127 -0
  383. data/rbi/stripe/resources/billing/alert.rbi +206 -0
  384. data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
  385. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +102 -0
  386. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +154 -0
  387. data/rbi/stripe/resources/billing/credit_grant.rbi +269 -0
  388. data/rbi/stripe/resources/billing/meter.rbi +233 -0
  389. data/rbi/stripe/resources/billing/meter_error_report.rbi +71 -0
  390. data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
  391. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
  392. data/rbi/stripe/resources/billing/meter_event_summary.rbi +33 -0
  393. data/rbi/stripe/resources/billing_portal/configuration.rbi +640 -0
  394. data/rbi/stripe/resources/billing_portal/session.rbi +341 -0
  395. data/rbi/stripe/resources/capability.rbi +125 -0
  396. data/rbi/stripe/resources/capital/financing_offer.rbi +190 -0
  397. data/rbi/stripe/resources/capital/financing_summary.rbi +74 -0
  398. data/rbi/stripe/resources/capital/financing_transaction.rbi +130 -0
  399. data/rbi/stripe/resources/card.rbi +128 -0
  400. data/rbi/stripe/resources/cash_balance.rbi +32 -0
  401. data/rbi/stripe/resources/charge.rbi +3484 -0
  402. data/rbi/stripe/resources/checkout/session.rbi +3995 -0
  403. data/rbi/stripe/resources/climate/order.rbi +250 -0
  404. data/rbi/stripe/resources/climate/product.rbi +82 -0
  405. data/rbi/stripe/resources/climate/supplier.rbi +79 -0
  406. data/rbi/stripe/resources/confirmation_token.rbi +1776 -0
  407. data/rbi/stripe/resources/connect_collection_transfer.rbi +26 -0
  408. data/rbi/stripe/resources/country_spec.rbi +92 -0
  409. data/rbi/stripe/resources/coupon.rbi +257 -0
  410. data/rbi/stripe/resources/credit_note.rbi +759 -0
  411. data/rbi/stripe/resources/credit_note_line_item.rbi +99 -0
  412. data/rbi/stripe/resources/customer.rbi +1001 -0
  413. data/rbi/stripe/resources/customer_balance_transaction.rbi +53 -0
  414. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
  415. data/rbi/stripe/resources/customer_session.rbi +196 -0
  416. data/rbi/stripe/resources/discount.rbi +53 -0
  417. data/rbi/stripe/resources/dispute.rbi +764 -0
  418. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +65 -0
  419. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
  420. data/rbi/stripe/resources/entitlements/feature.rbi +124 -0
  421. data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
  422. data/rbi/stripe/resources/event.rbi +190 -0
  423. data/rbi/stripe/resources/exchange_rate.rbi +73 -0
  424. data/rbi/stripe/resources/file.rbi +148 -0
  425. data/rbi/stripe/resources/file_link.rbi +146 -0
  426. data/rbi/stripe/resources/financial_connections/account.rbi +358 -0
  427. data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +27 -0
  428. data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
  429. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
  430. data/rbi/stripe/resources/financial_connections/institution.rbi +99 -0
  431. data/rbi/stripe/resources/financial_connections/session.rbi +186 -0
  432. data/rbi/stripe/resources/financial_connections/transaction.rbi +127 -0
  433. data/rbi/stripe/resources/forwarding/request.rbi +219 -0
  434. data/rbi/stripe/resources/funding_instructions.rbi +437 -0
  435. data/rbi/stripe/resources/gift_cards/card.rbi +206 -0
  436. data/rbi/stripe/resources/gift_cards/transaction.rbi +257 -0
  437. data/rbi/stripe/resources/identity/verification_report.rbi +354 -0
  438. data/rbi/stripe/resources/identity/verification_session.rbi +518 -0
  439. data/rbi/stripe/resources/invoice.rbi +8928 -0
  440. data/rbi/stripe/resources/invoice_item.rbi +514 -0
  441. data/rbi/stripe/resources/invoice_line_item.rbi +400 -0
  442. data/rbi/stripe/resources/invoice_payment.rbi +70 -0
  443. data/rbi/stripe/resources/invoice_rendering_template.rbi +114 -0
  444. data/rbi/stripe/resources/issuing/authorization.rbi +1266 -0
  445. data/rbi/stripe/resources/issuing/card.rbi +738 -0
  446. data/rbi/stripe/resources/issuing/cardholder.rbi +732 -0
  447. data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +622 -0
  448. data/rbi/stripe/resources/issuing/dispute.rbi +900 -0
  449. data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +83 -0
  450. data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +90 -0
  451. data/rbi/stripe/resources/issuing/personalization_design.rbi +333 -0
  452. data/rbi/stripe/resources/issuing/physical_bundle.rbi +86 -0
  453. data/rbi/stripe/resources/issuing/settlement.rbi +62 -0
  454. data/rbi/stripe/resources/issuing/token.rbi +231 -0
  455. data/rbi/stripe/resources/issuing/transaction.rbi +1057 -0
  456. data/rbi/stripe/resources/line_item.rbi +108 -0
  457. data/rbi/stripe/resources/login_link.rbi +18 -0
  458. data/rbi/stripe/resources/mandate.rbi +219 -0
  459. data/rbi/stripe/resources/margin.rbi +127 -0
  460. data/rbi/stripe/resources/order.rbi +3016 -0
  461. data/rbi/stripe/resources/payment_attempt_record.rbi +215 -0
  462. data/rbi/stripe/resources/payment_intent.rbi +13843 -0
  463. data/rbi/stripe/resources/payment_link.rbi +1666 -0
  464. data/rbi/stripe/resources/payment_method.rbi +1908 -0
  465. data/rbi/stripe/resources/payment_method_configuration.rbi +3171 -0
  466. data/rbi/stripe/resources/payment_method_domain.rbi +217 -0
  467. data/rbi/stripe/resources/payment_record.rbi +722 -0
  468. data/rbi/stripe/resources/payout.rbi +299 -0
  469. data/rbi/stripe/resources/person.rbi +371 -0
  470. data/rbi/stripe/resources/plan.rbi +385 -0
  471. data/rbi/stripe/resources/price.rbi +731 -0
  472. data/rbi/stripe/resources/product.rbi +615 -0
  473. data/rbi/stripe/resources/product_feature.rbi +26 -0
  474. data/rbi/stripe/resources/promotion_code.rbi +266 -0
  475. data/rbi/stripe/resources/quote.rbi +3186 -0
  476. data/rbi/stripe/resources/quote_line.rbi +350 -0
  477. data/rbi/stripe/resources/quote_preview_invoice.rbi +850 -0
  478. data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +474 -0
  479. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +101 -0
  480. data/rbi/stripe/resources/radar/value_list.rbi +175 -0
  481. data/rbi/stripe/resources/radar/value_list_item.rbi +134 -0
  482. data/rbi/stripe/resources/refund.rbi +515 -0
  483. data/rbi/stripe/resources/reporting/report_run.rbi +194 -0
  484. data/rbi/stripe/resources/reporting/report_type.rbi +64 -0
  485. data/rbi/stripe/resources/reserve_transaction.rbi +23 -0
  486. data/rbi/stripe/resources/reversal.rbi +51 -0
  487. data/rbi/stripe/resources/review.rbi +159 -0
  488. data/rbi/stripe/resources/setup_attempt.rbi +484 -0
  489. data/rbi/stripe/resources/setup_intent.rbi +4041 -0
  490. data/rbi/stripe/resources/shipping_rate.rbi +310 -0
  491. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +82 -0
  492. data/rbi/stripe/resources/source.rbi +1543 -0
  493. data/rbi/stripe/resources/source_mandate_notification.rbi +77 -0
  494. data/rbi/stripe/resources/source_transaction.rbi +127 -0
  495. data/rbi/stripe/resources/subscription.rbi +2308 -0
  496. data/rbi/stripe/resources/subscription_item.rbi +478 -0
  497. data/rbi/stripe/resources/subscription_schedule.rbi +2653 -0
  498. data/rbi/stripe/resources/tax/association.rbi +94 -0
  499. data/rbi/stripe/resources/tax/calculation.rbi +479 -0
  500. data/rbi/stripe/resources/tax/calculation_line_item.rbi +88 -0
  501. data/rbi/stripe/resources/tax/form.rbi +224 -0
  502. data/rbi/stripe/resources/tax/registration.rbi +2438 -0
  503. data/rbi/stripe/resources/tax/settings.rbi +148 -0
  504. data/rbi/stripe/resources/tax/transaction.rbi +356 -0
  505. data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
  506. data/rbi/stripe/resources/tax_code.rbi +51 -0
  507. data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
  508. data/rbi/stripe/resources/tax_id.rbi +174 -0
  509. data/rbi/stripe/resources/tax_rate.rbi +244 -0
  510. data/rbi/stripe/resources/terminal/configuration.rbi +1091 -0
  511. data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
  512. data/rbi/stripe/resources/terminal/location.rbi +231 -0
  513. data/rbi/stripe/resources/terminal/reader.rbi +952 -0
  514. data/rbi/stripe/resources/terminal/reader_collected_data.rbi +41 -0
  515. data/rbi/stripe/resources/test_helpers/test_clock.rbi +139 -0
  516. data/rbi/stripe/resources/token.rbi +1175 -0
  517. data/rbi/stripe/resources/topup.rbi +225 -0
  518. data/rbi/stripe/resources/transfer.rbi +204 -0
  519. data/rbi/stripe/resources/treasury/credit_reversal.rbi +126 -0
  520. data/rbi/stripe/resources/treasury/debit_reversal.rbi +138 -0
  521. data/rbi/stripe/resources/treasury/financial_account.rbi +870 -0
  522. data/rbi/stripe/resources/treasury/financial_account_features.rbi +263 -0
  523. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +302 -0
  524. data/rbi/stripe/resources/treasury/outbound_payment.rbi +589 -0
  525. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +473 -0
  526. data/rbi/stripe/resources/treasury/received_credit.rbi +348 -0
  527. data/rbi/stripe/resources/treasury/received_debit.rbi +305 -0
  528. data/rbi/stripe/resources/treasury/transaction.rbi +216 -0
  529. data/rbi/stripe/resources/treasury/transaction_entry.rbi +193 -0
  530. data/rbi/stripe/resources/usage_record.rbi +32 -0
  531. data/rbi/stripe/resources/usage_record_summary.rbi +38 -0
  532. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  533. data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
  534. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
  535. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
  536. data/rbi/stripe/resources/v2/event.rbi +47 -0
  537. data/rbi/stripe/resources/v2/event_destination.rbi +90 -0
  538. data/rbi/stripe/resources/webhook_endpoint.rbi +177 -0
  539. data/rbi/stripe/services/account_capability_service.rbi +51 -0
  540. data/rbi/stripe/services/account_external_account_service.rbi +306 -0
  541. data/rbi/stripe/services/account_link_service.rbi +58 -0
  542. data/rbi/stripe/services/account_login_link_service.rbi +22 -0
  543. data/rbi/stripe/services/account_notice_service.rbi +90 -0
  544. data/rbi/stripe/services/account_person_service.rbi +903 -0
  545. data/rbi/stripe/services/account_service.rbi +4185 -0
  546. data/rbi/stripe/services/account_session_service.rbi +757 -0
  547. data/rbi/stripe/services/apple_pay_domain_service.rbi +78 -0
  548. data/rbi/stripe/services/application_fee_refund_service.rbi +91 -0
  549. data/rbi/stripe/services/application_fee_service.rbi +74 -0
  550. data/rbi/stripe/services/apps/secret_service.rbi +151 -0
  551. data/rbi/stripe/services/apps_service.rbi +9 -0
  552. data/rbi/stripe/services/balance_service.rbi +21 -0
  553. data/rbi/stripe/services/balance_transaction_service.rbi +89 -0
  554. data/rbi/stripe/services/billing/alert_service.rbi +152 -0
  555. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +54 -0
  556. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
  557. data/rbi/stripe/services/billing/credit_grant_service.rbi +191 -0
  558. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +40 -0
  559. data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
  560. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
  561. data/rbi/stripe/services/billing/meter_service.rbi +163 -0
  562. data/rbi/stripe/services/billing_portal/configuration_service.rbi +497 -0
  563. data/rbi/stripe/services/billing_portal/session_service.rbi +202 -0
  564. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  565. data/rbi/stripe/services/billing_service.rbi +15 -0
  566. data/rbi/stripe/services/capital/financing_offer_service.rbi +95 -0
  567. data/rbi/stripe/services/capital/financing_summary_service.rbi +22 -0
  568. data/rbi/stripe/services/capital/financing_transaction_service.rbi +68 -0
  569. data/rbi/stripe/services/capital_service.rbi +11 -0
  570. data/rbi/stripe/services/charge_service.rbi +1816 -0
  571. data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
  572. data/rbi/stripe/services/checkout/session_service.rbi +2582 -0
  573. data/rbi/stripe/services/checkout_service.rbi +9 -0
  574. data/rbi/stripe/services/climate/order_service.rbi +140 -0
  575. data/rbi/stripe/services/climate/product_service.rbi +46 -0
  576. data/rbi/stripe/services/climate/supplier_service.rbi +46 -0
  577. data/rbi/stripe/services/climate_service.rbi +11 -0
  578. data/rbi/stripe/services/confirmation_token_service.rbi +20 -0
  579. data/rbi/stripe/services/country_spec_service.rbi +44 -0
  580. data/rbi/stripe/services/coupon_service.rbi +190 -0
  581. data/rbi/stripe/services/credit_note_line_item_service.rbi +31 -0
  582. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +167 -0
  583. data/rbi/stripe/services/credit_note_service.rbi +420 -0
  584. data/rbi/stripe/services/customer_balance_transaction_service.rbi +92 -0
  585. data/rbi/stripe/services/customer_cash_balance_service.rbi +45 -0
  586. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +44 -0
  587. data/rbi/stripe/services/customer_funding_instructions_service.rbi +59 -0
  588. data/rbi/stripe/services/customer_payment_method_service.rbi +57 -0
  589. data/rbi/stripe/services/customer_payment_source_service.rbi +228 -0
  590. data/rbi/stripe/services/customer_service.rbi +647 -0
  591. data/rbi/stripe/services/customer_session_service.rbi +110 -0
  592. data/rbi/stripe/services/customer_tax_id_service.rbi +72 -0
  593. data/rbi/stripe/services/dispute_service.rbi +422 -0
  594. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
  595. data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
  596. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  597. data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
  598. data/rbi/stripe/services/event_service.rbi +81 -0
  599. data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
  600. data/rbi/stripe/services/file_link_service.rbi +122 -0
  601. data/rbi/stripe/services/file_service.rbi +114 -0
  602. data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +33 -0
  603. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
  604. data/rbi/stripe/services/financial_connections/account_service.rbi +132 -0
  605. data/rbi/stripe/services/financial_connections/institution_service.rbi +46 -0
  606. data/rbi/stripe/services/financial_connections/session_service.rbi +111 -0
  607. data/rbi/stripe/services/financial_connections/transaction_service.rbi +90 -0
  608. data/rbi/stripe/services/financial_connections_service.rbi +12 -0
  609. data/rbi/stripe/services/forwarding/request_service.rbi +132 -0
  610. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  611. data/rbi/stripe/services/gift_cards/card_service.rbi +142 -0
  612. data/rbi/stripe/services/gift_cards/transaction_service.rbi +174 -0
  613. data/rbi/stripe/services/gift_cards_service.rbi +10 -0
  614. data/rbi/stripe/services/identity/verification_report_service.rbi +85 -0
  615. data/rbi/stripe/services/identity/verification_session_service.rbi +317 -0
  616. data/rbi/stripe/services/identity_service.rbi +10 -0
  617. data/rbi/stripe/services/invoice_item_service.rbi +424 -0
  618. data/rbi/stripe/services/invoice_line_item_service.rbi +270 -0
  619. data/rbi/stripe/services/invoice_payment_service.rbi +44 -0
  620. data/rbi/stripe/services/invoice_rendering_template_service.rbi +82 -0
  621. data/rbi/stripe/services/invoice_service.rbi +6040 -0
  622. data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +2023 -0
  623. data/rbi/stripe/services/issuing/authorization_service.rbi +140 -0
  624. data/rbi/stripe/services/issuing/card_service.rbi +479 -0
  625. data/rbi/stripe/services/issuing/cardholder_service.rbi +568 -0
  626. data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +498 -0
  627. data/rbi/stripe/services/issuing/dispute_service.rbi +701 -0
  628. data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +55 -0
  629. data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +73 -0
  630. data/rbi/stripe/services/issuing/personalization_design_service.rbi +233 -0
  631. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
  632. data/rbi/stripe/services/issuing/token_service.rbi +95 -0
  633. data/rbi/stripe/services/issuing/transaction_service.rbi +103 -0
  634. data/rbi/stripe/services/issuing_service.rbi +19 -0
  635. data/rbi/stripe/services/mandate_service.rbi +20 -0
  636. data/rbi/stripe/services/margin_service.rbi +104 -0
  637. data/rbi/stripe/services/order_line_item_service.rbi +31 -0
  638. data/rbi/stripe/services/order_service.rbi +2306 -0
  639. data/rbi/stripe/services/payment_attempt_record_service.rbi +36 -0
  640. data/rbi/stripe/services/payment_intent_service.rbi +11429 -0
  641. data/rbi/stripe/services/payment_link_line_item_service.rbi +31 -0
  642. data/rbi/stripe/services/payment_link_service.rbi +1250 -0
  643. data/rbi/stripe/services/payment_method_configuration_service.rbi +2171 -0
  644. data/rbi/stripe/services/payment_method_domain_service.rbi +110 -0
  645. data/rbi/stripe/services/payment_method_service.rbi +883 -0
  646. data/rbi/stripe/services/payment_record_service.rbi +521 -0
  647. data/rbi/stripe/services/payout_service.rbi +197 -0
  648. data/rbi/stripe/services/plan_service.rbi +286 -0
  649. data/rbi/stripe/services/price_service.rbi +551 -0
  650. data/rbi/stripe/services/product_feature_service.rbi +69 -0
  651. data/rbi/stripe/services/product_service.rbi +503 -0
  652. data/rbi/stripe/services/promotion_code_service.rbi +210 -0
  653. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
  654. data/rbi/stripe/services/quote_line_item_service.rbi +31 -0
  655. data/rbi/stripe/services/quote_line_service.rbi +31 -0
  656. data/rbi/stripe/services/quote_preview_invoice_service.rbi +31 -0
  657. data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +31 -0
  658. data/rbi/stripe/services/quote_service.rbi +2390 -0
  659. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +83 -0
  660. data/rbi/stripe/services/radar/value_list_item_service.rbi +107 -0
  661. data/rbi/stripe/services/radar/value_list_service.rbi +139 -0
  662. data/rbi/stripe/services/radar_service.rbi +11 -0
  663. data/rbi/stripe/services/refund_service.rbi +181 -0
  664. data/rbi/stripe/services/reporting/report_run_service.rbi +131 -0
  665. data/rbi/stripe/services/reporting/report_type_service.rbi +35 -0
  666. data/rbi/stripe/services/reporting_service.rbi +10 -0
  667. data/rbi/stripe/services/review_service.rbi +82 -0
  668. data/rbi/stripe/services/setup_attempt_service.rbi +63 -0
  669. data/rbi/stripe/services/setup_intent_service.rbi +3609 -0
  670. data/rbi/stripe/services/shipping_rate_service.rbi +235 -0
  671. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +46 -0
  672. data/rbi/stripe/services/sigma_service.rbi +9 -0
  673. data/rbi/stripe/services/source_service.rbi +647 -0
  674. data/rbi/stripe/services/source_transaction_service.rbi +31 -0
  675. data/rbi/stripe/services/subscription_item_service.rbi +422 -0
  676. data/rbi/stripe/services/subscription_item_usage_record_service.rbi +37 -0
  677. data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +33 -0
  678. data/rbi/stripe/services/subscription_schedule_service.rbi +2208 -0
  679. data/rbi/stripe/services/subscription_service.rbi +1870 -0
  680. data/rbi/stripe/services/tax/association_service.rbi +25 -0
  681. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +33 -0
  682. data/rbi/stripe/services/tax/calculation_service.rbi +228 -0
  683. data/rbi/stripe/services/tax/form_service.rbi +85 -0
  684. data/rbi/stripe/services/tax/registration_service.rbi +1517 -0
  685. data/rbi/stripe/services/tax/settings_service.rbi +93 -0
  686. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +33 -0
  687. data/rbi/stripe/services/tax/transaction_service.rbi +142 -0
  688. data/rbi/stripe/services/tax_code_service.rbi +44 -0
  689. data/rbi/stripe/services/tax_id_service.rbi +112 -0
  690. data/rbi/stripe/services/tax_rate_service.rbi +183 -0
  691. data/rbi/stripe/services/tax_service.rbi +14 -0
  692. data/rbi/stripe/services/terminal/configuration_service.rbi +822 -0
  693. data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
  694. data/rbi/stripe/services/terminal/location_service.rbi +184 -0
  695. data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +22 -0
  696. data/rbi/stripe/services/terminal/reader_service.rbi +513 -0
  697. data/rbi/stripe/services/terminal_service.rbi +13 -0
  698. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +778 -0
  699. data/rbi/stripe/services/test_helpers/customer_service.rbi +33 -0
  700. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +836 -0
  701. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +76 -0
  702. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +67 -0
  703. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +705 -0
  704. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  705. data/rbi/stripe/services/test_helpers/refund_service.rbi +22 -0
  706. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +62 -0
  707. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  708. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +90 -0
  709. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
  710. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +123 -0
  711. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +123 -0
  712. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +114 -0
  713. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +114 -0
  714. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  715. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  716. data/rbi/stripe/services/token_service.rbi +1136 -0
  717. data/rbi/stripe/services/topup_service.rbi +172 -0
  718. data/rbi/stripe/services/transfer_reversal_service.rbi +99 -0
  719. data/rbi/stripe/services/transfer_service.rbi +150 -0
  720. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
  721. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
  722. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +201 -0
  723. data/rbi/stripe/services/treasury/financial_account_service.rbi +566 -0
  724. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
  725. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +300 -0
  726. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +182 -0
  727. data/rbi/stripe/services/treasury/received_credit_service.rbi +70 -0
  728. data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
  729. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +107 -0
  730. data/rbi/stripe/services/treasury/transaction_service.rbi +114 -0
  731. data/rbi/stripe/services/treasury_service.rbi +18 -0
  732. data/rbi/stripe/services/v1_services.rbi +83 -0
  733. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
  734. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
  735. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +20 -0
  736. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +55 -0
  737. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  738. data/rbi/stripe/services/v2/core/event_destination_service.rbi +203 -0
  739. data/rbi/stripe/services/v2/core/event_service.rbi +39 -0
  740. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  741. data/rbi/stripe/services/v2_services.rbi +10 -0
  742. data/rbi/stripe/services/webhook_endpoint_service.rbi +131 -0
  743. metadata +435 -4
@@ -0,0 +1,1870 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # typed: true
5
+ module Stripe
6
+ class SubscriptionService < StripeService
7
+ class CancelParams < Stripe::RequestParams
8
+ class CancellationDetails < Stripe::RequestParams
9
+ # Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
10
+ sig { returns(T.nilable(String)) }
11
+ attr_accessor :comment
12
+ # The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
13
+ sig { returns(T.nilable(String)) }
14
+ attr_accessor :feedback
15
+ sig { params(comment: T.nilable(String), feedback: T.nilable(String)).void }
16
+ def initialize(comment: nil, feedback: nil); end
17
+ end
18
+ # Details about why this subscription was cancelled
19
+ sig { returns(::Stripe::SubscriptionService::CancelParams::CancellationDetails) }
20
+ attr_accessor :cancellation_details
21
+ # Specifies which fields in the response should be expanded.
22
+ sig { returns(T::Array[String]) }
23
+ attr_accessor :expand
24
+ # Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `false`.
25
+ sig { returns(T::Boolean) }
26
+ attr_accessor :invoice_now
27
+ # Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to `false`.
28
+ sig { returns(T::Boolean) }
29
+ attr_accessor :prorate
30
+ sig {
31
+ params(cancellation_details: ::Stripe::SubscriptionService::CancelParams::CancellationDetails, expand: T::Array[String], invoice_now: T::Boolean, prorate: T::Boolean).void
32
+ }
33
+ def initialize(cancellation_details: nil, expand: nil, invoice_now: nil, prorate: nil); end
34
+ end
35
+ class RetrieveParams < Stripe::RequestParams
36
+ # Specifies which fields in the response should be expanded.
37
+ sig { returns(T::Array[String]) }
38
+ attr_accessor :expand
39
+ sig { params(expand: T::Array[String]).void }
40
+ def initialize(expand: nil); end
41
+ end
42
+ class UpdateParams < Stripe::RequestParams
43
+ class AddInvoiceItem < Stripe::RequestParams
44
+ class Discount < Stripe::RequestParams
45
+ class DiscountEnd < Stripe::RequestParams
46
+ class Duration < Stripe::RequestParams
47
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
48
+ sig { returns(String) }
49
+ attr_accessor :interval
50
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
51
+ sig { returns(Integer) }
52
+ attr_accessor :interval_count
53
+ sig { params(interval: String, interval_count: Integer).void }
54
+ def initialize(interval: nil, interval_count: nil); end
55
+ end
56
+ # Time span for the redeemed discount.
57
+ sig {
58
+ returns(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd::Duration)
59
+ }
60
+ attr_accessor :duration
61
+ # A precise Unix timestamp for the discount to end. Must be in the future.
62
+ sig { returns(Integer) }
63
+ attr_accessor :timestamp
64
+ # The type of calculation made to determine when the discount ends.
65
+ sig { returns(String) }
66
+ attr_accessor :type
67
+ sig {
68
+ params(duration: ::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
69
+ }
70
+ def initialize(duration: nil, timestamp: nil, type: nil); end
71
+ end
72
+ # ID of the coupon to create a new discount for.
73
+ sig { returns(String) }
74
+ attr_accessor :coupon
75
+ # ID of an existing discount on the object (or one of its ancestors) to reuse.
76
+ sig { returns(String) }
77
+ attr_accessor :discount
78
+ # Details to determine how long the discount should be applied for.
79
+ sig {
80
+ returns(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd)
81
+ }
82
+ attr_accessor :discount_end
83
+ # ID of the promotion code to create a new discount for.
84
+ sig { returns(String) }
85
+ attr_accessor :promotion_code
86
+ sig {
87
+ params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount::DiscountEnd, promotion_code: String).void
88
+ }
89
+ def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
90
+ end
91
+ class PriceData < Stripe::RequestParams
92
+ # 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).
93
+ sig { returns(String) }
94
+ attr_accessor :currency
95
+ # The ID of the product that this price will belong to.
96
+ sig { returns(String) }
97
+ attr_accessor :product
98
+ # 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.
99
+ sig { returns(String) }
100
+ attr_accessor :tax_behavior
101
+ # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
102
+ sig { returns(Integer) }
103
+ attr_accessor :unit_amount
104
+ # 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.
105
+ sig { returns(String) }
106
+ attr_accessor :unit_amount_decimal
107
+ sig {
108
+ params(currency: String, product: String, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
109
+ }
110
+ def initialize(
111
+ currency: nil,
112
+ product: nil,
113
+ tax_behavior: nil,
114
+ unit_amount: nil,
115
+ unit_amount_decimal: nil
116
+ ); end
117
+ end
118
+ # The coupons to redeem into discounts for the item.
119
+ sig {
120
+ returns(T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount])
121
+ }
122
+ attr_accessor :discounts
123
+ # The ID of the price object. One of `price` or `price_data` is required.
124
+ sig { returns(String) }
125
+ attr_accessor :price
126
+ # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
127
+ sig { returns(::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::PriceData) }
128
+ attr_accessor :price_data
129
+ # Quantity for this item. Defaults to 1.
130
+ sig { returns(Integer) }
131
+ attr_accessor :quantity
132
+ # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
133
+ sig { returns(T.nilable(T::Array[String])) }
134
+ attr_accessor :tax_rates
135
+ sig {
136
+ params(discounts: T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::Discount], price: String, price_data: ::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
137
+ }
138
+ def initialize(
139
+ discounts: nil,
140
+ price: nil,
141
+ price_data: nil,
142
+ quantity: nil,
143
+ tax_rates: nil
144
+ ); end
145
+ end
146
+ class AutomaticTax < Stripe::RequestParams
147
+ class Liability < Stripe::RequestParams
148
+ # The connected account being referenced when `type` is `account`.
149
+ sig { returns(String) }
150
+ attr_accessor :account
151
+ # Type of the account referenced in the request.
152
+ sig { returns(String) }
153
+ attr_accessor :type
154
+ sig { params(account: String, type: String).void }
155
+ def initialize(account: nil, type: nil); end
156
+ end
157
+ # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
158
+ sig { returns(T::Boolean) }
159
+ attr_accessor :enabled
160
+ # 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.
161
+ sig { returns(::Stripe::SubscriptionService::UpdateParams::AutomaticTax::Liability) }
162
+ attr_accessor :liability
163
+ sig {
164
+ params(enabled: T::Boolean, liability: ::Stripe::SubscriptionService::UpdateParams::AutomaticTax::Liability).void
165
+ }
166
+ def initialize(enabled: nil, liability: nil); end
167
+ end
168
+ class BillingThresholds < Stripe::RequestParams
169
+ # Monetary threshold that triggers the subscription to advance to a new billing period
170
+ sig { returns(Integer) }
171
+ attr_accessor :amount_gte
172
+ # 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.
173
+ sig { returns(T::Boolean) }
174
+ attr_accessor :reset_billing_cycle_anchor
175
+ sig { params(amount_gte: Integer, reset_billing_cycle_anchor: T::Boolean).void }
176
+ def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
177
+ end
178
+ class CancellationDetails < Stripe::RequestParams
179
+ # Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
180
+ sig { returns(T.nilable(String)) }
181
+ attr_accessor :comment
182
+ # The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
183
+ sig { returns(T.nilable(String)) }
184
+ attr_accessor :feedback
185
+ sig { params(comment: T.nilable(String), feedback: T.nilable(String)).void }
186
+ def initialize(comment: nil, feedback: nil); end
187
+ end
188
+ class Discount < Stripe::RequestParams
189
+ class DiscountEnd < Stripe::RequestParams
190
+ class Duration < Stripe::RequestParams
191
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
192
+ sig { returns(String) }
193
+ attr_accessor :interval
194
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
195
+ sig { returns(Integer) }
196
+ attr_accessor :interval_count
197
+ sig { params(interval: String, interval_count: Integer).void }
198
+ def initialize(interval: nil, interval_count: nil); end
199
+ end
200
+ # Time span for the redeemed discount.
201
+ sig {
202
+ returns(::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd::Duration)
203
+ }
204
+ attr_accessor :duration
205
+ # A precise Unix timestamp for the discount to end. Must be in the future.
206
+ sig { returns(Integer) }
207
+ attr_accessor :timestamp
208
+ # The type of calculation made to determine when the discount ends.
209
+ sig { returns(String) }
210
+ attr_accessor :type
211
+ sig {
212
+ params(duration: ::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
213
+ }
214
+ def initialize(duration: nil, timestamp: nil, type: nil); end
215
+ end
216
+ # ID of the coupon to create a new discount for.
217
+ sig { returns(String) }
218
+ attr_accessor :coupon
219
+ # ID of an existing discount on the object (or one of its ancestors) to reuse.
220
+ sig { returns(String) }
221
+ attr_accessor :discount
222
+ # Details to determine how long the discount should be applied for.
223
+ sig { returns(::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd) }
224
+ attr_accessor :discount_end
225
+ # ID of the promotion code to create a new discount for.
226
+ sig { returns(String) }
227
+ attr_accessor :promotion_code
228
+ sig {
229
+ params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionService::UpdateParams::Discount::DiscountEnd, promotion_code: String).void
230
+ }
231
+ def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
232
+ end
233
+ class InvoiceSettings < Stripe::RequestParams
234
+ class Issuer < Stripe::RequestParams
235
+ # The connected account being referenced when `type` is `account`.
236
+ sig { returns(String) }
237
+ attr_accessor :account
238
+ # Type of the account referenced in the request.
239
+ sig { returns(String) }
240
+ attr_accessor :type
241
+ sig { params(account: String, type: String).void }
242
+ def initialize(account: nil, type: nil); end
243
+ end
244
+ # The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
245
+ sig { returns(T.nilable(T::Array[String])) }
246
+ attr_accessor :account_tax_ids
247
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
248
+ sig { returns(::Stripe::SubscriptionService::UpdateParams::InvoiceSettings::Issuer) }
249
+ attr_accessor :issuer
250
+ sig {
251
+ params(account_tax_ids: T.nilable(T::Array[String]), issuer: ::Stripe::SubscriptionService::UpdateParams::InvoiceSettings::Issuer).void
252
+ }
253
+ def initialize(account_tax_ids: nil, issuer: nil); end
254
+ end
255
+ class Item < Stripe::RequestParams
256
+ class BillingThresholds < Stripe::RequestParams
257
+ # 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))
258
+ sig { returns(Integer) }
259
+ attr_accessor :usage_gte
260
+ sig { params(usage_gte: Integer).void }
261
+ def initialize(usage_gte: nil); end
262
+ end
263
+ class Discount < Stripe::RequestParams
264
+ class DiscountEnd < Stripe::RequestParams
265
+ class Duration < Stripe::RequestParams
266
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
267
+ sig { returns(String) }
268
+ attr_accessor :interval
269
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
270
+ sig { returns(Integer) }
271
+ attr_accessor :interval_count
272
+ sig { params(interval: String, interval_count: Integer).void }
273
+ def initialize(interval: nil, interval_count: nil); end
274
+ end
275
+ # Time span for the redeemed discount.
276
+ sig {
277
+ returns(::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd::Duration)
278
+ }
279
+ attr_accessor :duration
280
+ # A precise Unix timestamp for the discount to end. Must be in the future.
281
+ sig { returns(Integer) }
282
+ attr_accessor :timestamp
283
+ # The type of calculation made to determine when the discount ends.
284
+ sig { returns(String) }
285
+ attr_accessor :type
286
+ sig {
287
+ params(duration: ::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
288
+ }
289
+ def initialize(duration: nil, timestamp: nil, type: nil); end
290
+ end
291
+ # ID of the coupon to create a new discount for.
292
+ sig { returns(String) }
293
+ attr_accessor :coupon
294
+ # ID of an existing discount on the object (or one of its ancestors) to reuse.
295
+ sig { returns(String) }
296
+ attr_accessor :discount
297
+ # Details to determine how long the discount should be applied for.
298
+ sig { returns(::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd) }
299
+ attr_accessor :discount_end
300
+ # ID of the promotion code to create a new discount for.
301
+ sig { returns(String) }
302
+ attr_accessor :promotion_code
303
+ sig {
304
+ params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionService::UpdateParams::Item::Discount::DiscountEnd, promotion_code: String).void
305
+ }
306
+ def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
307
+ end
308
+ class PriceData < Stripe::RequestParams
309
+ class Recurring < Stripe::RequestParams
310
+ # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
311
+ sig { returns(String) }
312
+ attr_accessor :interval
313
+ # 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).
314
+ sig { returns(Integer) }
315
+ attr_accessor :interval_count
316
+ sig { params(interval: String, interval_count: Integer).void }
317
+ def initialize(interval: nil, interval_count: nil); end
318
+ end
319
+ # 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).
320
+ sig { returns(String) }
321
+ attr_accessor :currency
322
+ # The ID of the product that this price will belong to.
323
+ sig { returns(String) }
324
+ attr_accessor :product
325
+ # The recurring components of a price such as `interval` and `interval_count`.
326
+ sig { returns(::Stripe::SubscriptionService::UpdateParams::Item::PriceData::Recurring) }
327
+ attr_accessor :recurring
328
+ # 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.
329
+ sig { returns(String) }
330
+ attr_accessor :tax_behavior
331
+ # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
332
+ sig { returns(Integer) }
333
+ attr_accessor :unit_amount
334
+ # 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.
335
+ sig { returns(String) }
336
+ attr_accessor :unit_amount_decimal
337
+ sig {
338
+ params(currency: String, product: String, recurring: ::Stripe::SubscriptionService::UpdateParams::Item::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
339
+ }
340
+ def initialize(
341
+ currency: nil,
342
+ product: nil,
343
+ recurring: nil,
344
+ tax_behavior: nil,
345
+ unit_amount: nil,
346
+ unit_amount_decimal: nil
347
+ ); end
348
+ end
349
+ # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
350
+ sig {
351
+ returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::BillingThresholds))
352
+ }
353
+ attr_accessor :billing_thresholds
354
+ # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
355
+ sig { returns(T::Boolean) }
356
+ attr_accessor :clear_usage
357
+ # A flag that, if set to `true`, will delete the specified item.
358
+ sig { returns(T::Boolean) }
359
+ attr_accessor :deleted
360
+ # The coupons to redeem into discounts for the subscription item.
361
+ sig {
362
+ returns(T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::Item::Discount]))
363
+ }
364
+ attr_accessor :discounts
365
+ # Subscription item to update.
366
+ sig { returns(String) }
367
+ attr_accessor :id
368
+ # 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`.
369
+ sig { returns(T.nilable(T::Hash[String, String])) }
370
+ attr_accessor :metadata
371
+ # Plan ID for this item, as a string.
372
+ sig { returns(String) }
373
+ attr_accessor :plan
374
+ # 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.
375
+ sig { returns(String) }
376
+ attr_accessor :price
377
+ # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
378
+ sig { returns(::Stripe::SubscriptionService::UpdateParams::Item::PriceData) }
379
+ attr_accessor :price_data
380
+ # Quantity for this item.
381
+ sig { returns(Integer) }
382
+ attr_accessor :quantity
383
+ # 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.
384
+ sig { returns(T.nilable(T::Array[String])) }
385
+ attr_accessor :tax_rates
386
+ sig {
387
+ params(billing_thresholds: T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::BillingThresholds), clear_usage: T::Boolean, deleted: T::Boolean, discounts: T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::Item::Discount]), id: String, metadata: T.nilable(T::Hash[String, String]), plan: String, price: String, price_data: ::Stripe::SubscriptionService::UpdateParams::Item::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
388
+ }
389
+ def initialize(
390
+ billing_thresholds: nil,
391
+ clear_usage: nil,
392
+ deleted: nil,
393
+ discounts: nil,
394
+ id: nil,
395
+ metadata: nil,
396
+ plan: nil,
397
+ price: nil,
398
+ price_data: nil,
399
+ quantity: nil,
400
+ tax_rates: nil
401
+ ); end
402
+ end
403
+ class PauseCollection < Stripe::RequestParams
404
+ # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
405
+ sig { returns(String) }
406
+ attr_accessor :behavior
407
+ # The time after which the subscription will resume collecting payments.
408
+ sig { returns(Integer) }
409
+ attr_accessor :resumes_at
410
+ sig { params(behavior: String, resumes_at: Integer).void }
411
+ def initialize(behavior: nil, resumes_at: nil); end
412
+ end
413
+ class PaymentSettings < Stripe::RequestParams
414
+ class PaymentMethodOptions < Stripe::RequestParams
415
+ class AcssDebit < Stripe::RequestParams
416
+ class MandateOptions < Stripe::RequestParams
417
+ # Transaction type of the mandate.
418
+ sig { returns(String) }
419
+ attr_accessor :transaction_type
420
+ sig { params(transaction_type: String).void }
421
+ def initialize(transaction_type: nil); end
422
+ end
423
+ # Additional fields for Mandate creation
424
+ sig {
425
+ returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions)
426
+ }
427
+ attr_accessor :mandate_options
428
+ # Verification method for the intent
429
+ sig { returns(String) }
430
+ attr_accessor :verification_method
431
+ sig {
432
+ params(mandate_options: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions, verification_method: String).void
433
+ }
434
+ def initialize(mandate_options: nil, verification_method: nil); end
435
+ end
436
+ class Bancontact < Stripe::RequestParams
437
+ # Preferred language of the Bancontact authorization page that the customer is redirected to.
438
+ sig { returns(String) }
439
+ attr_accessor :preferred_language
440
+ sig { params(preferred_language: String).void }
441
+ def initialize(preferred_language: nil); end
442
+ end
443
+ class Card < Stripe::RequestParams
444
+ class MandateOptions < Stripe::RequestParams
445
+ # Amount to be charged for future payments.
446
+ sig { returns(Integer) }
447
+ attr_accessor :amount
448
+ # One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
449
+ sig { returns(String) }
450
+ attr_accessor :amount_type
451
+ # A description of the mandate or subscription that is meant to be displayed to the customer.
452
+ sig { returns(String) }
453
+ attr_accessor :description
454
+ sig { params(amount: Integer, amount_type: String, description: String).void }
455
+ def initialize(amount: nil, amount_type: nil, description: nil); end
456
+ end
457
+ # Configuration options for setting up an eMandate for cards issued in India.
458
+ sig {
459
+ returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions)
460
+ }
461
+ attr_accessor :mandate_options
462
+ # Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
463
+ sig { returns(String) }
464
+ attr_accessor :network
465
+ # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
466
+ sig { returns(String) }
467
+ attr_accessor :request_three_d_secure
468
+ sig {
469
+ params(mandate_options: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions, network: String, request_three_d_secure: String).void
470
+ }
471
+ def initialize(mandate_options: nil, network: nil, request_three_d_secure: nil); end
472
+ end
473
+ class CustomerBalance < Stripe::RequestParams
474
+ class BankTransfer < Stripe::RequestParams
475
+ class EuBankTransfer < Stripe::RequestParams
476
+ # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
477
+ sig { returns(String) }
478
+ attr_accessor :country
479
+ sig { params(country: String).void }
480
+ def initialize(country: nil); end
481
+ end
482
+ # Configuration for eu_bank_transfer funding type.
483
+ sig {
484
+ returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)
485
+ }
486
+ attr_accessor :eu_bank_transfer
487
+ # The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
488
+ sig { returns(String) }
489
+ attr_accessor :type
490
+ sig {
491
+ params(eu_bank_transfer: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer, type: String).void
492
+ }
493
+ def initialize(eu_bank_transfer: nil, type: nil); end
494
+ end
495
+ # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
496
+ sig {
497
+ returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer)
498
+ }
499
+ attr_accessor :bank_transfer
500
+ # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
501
+ sig { returns(String) }
502
+ attr_accessor :funding_type
503
+ sig {
504
+ params(bank_transfer: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer, funding_type: String).void
505
+ }
506
+ def initialize(bank_transfer: nil, funding_type: nil); end
507
+ end
508
+ class IdBankTransfer < Stripe::RequestParams
509
+
510
+ end
511
+ class Konbini < Stripe::RequestParams
512
+
513
+ end
514
+ class SepaDebit < Stripe::RequestParams
515
+
516
+ end
517
+ class UsBankAccount < Stripe::RequestParams
518
+ class FinancialConnections < Stripe::RequestParams
519
+ class Filters < Stripe::RequestParams
520
+ # The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
521
+ sig { returns(T::Array[String]) }
522
+ attr_accessor :account_subcategories
523
+ # ID of the institution to use to filter for selectable accounts.
524
+ sig { returns(String) }
525
+ attr_accessor :institution
526
+ sig { params(account_subcategories: T::Array[String], institution: String).void }
527
+ def initialize(account_subcategories: nil, institution: nil); end
528
+ end
529
+ # Provide filters for the linked accounts that the customer can select for the payment method.
530
+ sig {
531
+ returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)
532
+ }
533
+ attr_accessor :filters
534
+ # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
535
+ sig { returns(T::Array[String]) }
536
+ attr_accessor :permissions
537
+ # List of data features that you would like to retrieve upon account creation.
538
+ sig { returns(T::Array[String]) }
539
+ attr_accessor :prefetch
540
+ sig {
541
+ params(filters: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters, permissions: T::Array[String], prefetch: T::Array[String]).void
542
+ }
543
+ def initialize(filters: nil, permissions: nil, prefetch: nil); end
544
+ end
545
+ # Additional fields for Financial Connections Session creation
546
+ sig {
547
+ returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections)
548
+ }
549
+ attr_accessor :financial_connections
550
+ # Verification method for the intent
551
+ sig { returns(String) }
552
+ attr_accessor :verification_method
553
+ sig {
554
+ params(financial_connections: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections, verification_method: String).void
555
+ }
556
+ def initialize(financial_connections: nil, verification_method: nil); end
557
+ end
558
+ # This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
559
+ sig {
560
+ returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit))
561
+ }
562
+ attr_accessor :acss_debit
563
+ # This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
564
+ sig {
565
+ returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact))
566
+ }
567
+ attr_accessor :bancontact
568
+ # This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
569
+ sig {
570
+ returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card))
571
+ }
572
+ attr_accessor :card
573
+ # This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
574
+ sig {
575
+ returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance))
576
+ }
577
+ attr_accessor :customer_balance
578
+ # This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
579
+ sig {
580
+ returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer))
581
+ }
582
+ attr_accessor :id_bank_transfer
583
+ # This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
584
+ sig {
585
+ returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini))
586
+ }
587
+ attr_accessor :konbini
588
+ # This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
589
+ sig {
590
+ returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit))
591
+ }
592
+ attr_accessor :sepa_debit
593
+ # This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
594
+ sig {
595
+ returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))
596
+ }
597
+ attr_accessor :us_bank_account
598
+ sig {
599
+ params(acss_debit: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit), bancontact: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact), card: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Card), customer_balance: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance), id_bank_transfer: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer), konbini: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini), sepa_debit: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit), us_bank_account: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)).void
600
+ }
601
+ def initialize(
602
+ acss_debit: nil,
603
+ bancontact: nil,
604
+ card: nil,
605
+ customer_balance: nil,
606
+ id_bank_transfer: nil,
607
+ konbini: nil,
608
+ sepa_debit: nil,
609
+ us_bank_account: nil
610
+ ); end
611
+ end
612
+ # Payment-method-specific configuration to provide to invoices created by the subscription.
613
+ sig {
614
+ returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions)
615
+ }
616
+ attr_accessor :payment_method_options
617
+ # The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
618
+ sig { returns(T.nilable(T::Array[String])) }
619
+ attr_accessor :payment_method_types
620
+ # Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.
621
+ sig { returns(String) }
622
+ attr_accessor :save_default_payment_method
623
+ sig {
624
+ params(payment_method_options: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings::PaymentMethodOptions, payment_method_types: T.nilable(T::Array[String]), save_default_payment_method: String).void
625
+ }
626
+ def initialize(
627
+ payment_method_options: nil,
628
+ payment_method_types: nil,
629
+ save_default_payment_method: nil
630
+ ); end
631
+ end
632
+ class PendingInvoiceItemInterval < Stripe::RequestParams
633
+ # Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
634
+ sig { returns(String) }
635
+ attr_accessor :interval
636
+ # The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
637
+ sig { returns(Integer) }
638
+ attr_accessor :interval_count
639
+ sig { params(interval: String, interval_count: Integer).void }
640
+ def initialize(interval: nil, interval_count: nil); end
641
+ end
642
+ class Prebilling < Stripe::RequestParams
643
+ # This is used to determine the number of billing cycles to prebill.
644
+ sig { returns(Integer) }
645
+ attr_accessor :iterations
646
+ # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
647
+ sig { returns(String) }
648
+ attr_accessor :update_behavior
649
+ sig { params(iterations: Integer, update_behavior: String).void }
650
+ def initialize(iterations: nil, update_behavior: nil); end
651
+ end
652
+ class TransferData < Stripe::RequestParams
653
+ # 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.
654
+ sig { returns(Float) }
655
+ attr_accessor :amount_percent
656
+ # ID of an existing, connected Stripe account.
657
+ sig { returns(String) }
658
+ attr_accessor :destination
659
+ sig { params(amount_percent: Float, destination: String).void }
660
+ def initialize(amount_percent: nil, destination: nil); end
661
+ end
662
+ class TrialSettings < Stripe::RequestParams
663
+ class EndBehavior < Stripe::RequestParams
664
+ # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
665
+ sig { returns(String) }
666
+ attr_accessor :missing_payment_method
667
+ sig { params(missing_payment_method: String).void }
668
+ def initialize(missing_payment_method: nil); end
669
+ end
670
+ # Defines how the subscription should behave when the user's free trial ends.
671
+ sig { returns(::Stripe::SubscriptionService::UpdateParams::TrialSettings::EndBehavior) }
672
+ attr_accessor :end_behavior
673
+ sig {
674
+ params(end_behavior: ::Stripe::SubscriptionService::UpdateParams::TrialSettings::EndBehavior).void
675
+ }
676
+ def initialize(end_behavior: nil); end
677
+ end
678
+ # A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
679
+ sig { returns(T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem]) }
680
+ attr_accessor :add_invoice_items
681
+ # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
682
+ sig { returns(T.nilable(Float)) }
683
+ attr_accessor :application_fee_percent
684
+ # Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
685
+ sig { returns(::Stripe::SubscriptionService::UpdateParams::AutomaticTax) }
686
+ attr_accessor :automatic_tax
687
+ # Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
688
+ sig { returns(String) }
689
+ attr_accessor :billing_cycle_anchor
690
+ # 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.
691
+ sig { returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::BillingThresholds)) }
692
+ attr_accessor :billing_thresholds
693
+ # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
694
+ sig { returns(T.nilable(Integer)) }
695
+ attr_accessor :cancel_at
696
+ # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
697
+ sig { returns(T::Boolean) }
698
+ attr_accessor :cancel_at_period_end
699
+ # Details about why this subscription was cancelled
700
+ sig { returns(::Stripe::SubscriptionService::UpdateParams::CancellationDetails) }
701
+ attr_accessor :cancellation_details
702
+ # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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`. Defaults to `charge_automatically`.
703
+ sig { returns(String) }
704
+ attr_accessor :collection_method
705
+ # The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
706
+ sig { returns(String) }
707
+ attr_accessor :coupon
708
+ # Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
709
+ sig { returns(Integer) }
710
+ attr_accessor :days_until_due
711
+ # ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
712
+ sig { returns(String) }
713
+ attr_accessor :default_payment_method
714
+ # ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
715
+ sig { returns(T.nilable(String)) }
716
+ attr_accessor :default_source
717
+ # The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates.
718
+ sig { returns(T.nilable(T::Array[String])) }
719
+ attr_accessor :default_tax_rates
720
+ # The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
721
+ sig { returns(T.nilable(String)) }
722
+ attr_accessor :description
723
+ # The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
724
+ sig { returns(T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::Discount])) }
725
+ attr_accessor :discounts
726
+ # Specifies which fields in the response should be expanded.
727
+ sig { returns(T::Array[String]) }
728
+ attr_accessor :expand
729
+ # All invoices will be billed using the specified settings.
730
+ sig { returns(::Stripe::SubscriptionService::UpdateParams::InvoiceSettings) }
731
+ attr_accessor :invoice_settings
732
+ # A list of up to 20 subscription items, each with an attached price.
733
+ sig { returns(T::Array[::Stripe::SubscriptionService::UpdateParams::Item]) }
734
+ attr_accessor :items
735
+ # 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`.
736
+ sig { returns(T.nilable(T::Hash[String, String])) }
737
+ attr_accessor :metadata
738
+ # Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
739
+ sig { returns(T::Boolean) }
740
+ attr_accessor :off_session
741
+ # The account on behalf of which to charge, for each of the subscription's invoices.
742
+ sig { returns(T.nilable(String)) }
743
+ attr_accessor :on_behalf_of
744
+ # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
745
+ sig { returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PauseCollection)) }
746
+ attr_accessor :pause_collection
747
+ # 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.
748
+ #
749
+ # 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.
750
+ #
751
+ # 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).
752
+ #
753
+ # 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://stripe.com/docs/upgrades#2019-03-14) to learn more.
754
+ sig { returns(String) }
755
+ attr_accessor :payment_behavior
756
+ # Payment settings to pass to invoices created by the subscription.
757
+ sig { returns(::Stripe::SubscriptionService::UpdateParams::PaymentSettings) }
758
+ attr_accessor :payment_settings
759
+ # Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
760
+ sig {
761
+ returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::PendingInvoiceItemInterval))
762
+ }
763
+ attr_accessor :pending_invoice_item_interval
764
+ # If specified, the invoicing for the given billing cycle iterations will be processed now.
765
+ sig { returns(::Stripe::SubscriptionService::UpdateParams::Prebilling) }
766
+ attr_accessor :prebilling
767
+ # The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
768
+ sig { returns(String) }
769
+ attr_accessor :promotion_code
770
+ # 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`.
771
+ sig { returns(String) }
772
+ attr_accessor :proration_behavior
773
+ # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
774
+ sig { returns(Integer) }
775
+ attr_accessor :proration_date
776
+ # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value.
777
+ sig { returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::TransferData)) }
778
+ attr_accessor :transfer_data
779
+ # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
780
+ sig { returns(T.any(String, Integer)) }
781
+ attr_accessor :trial_end
782
+ # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
783
+ sig { returns(T::Boolean) }
784
+ attr_accessor :trial_from_plan
785
+ # Settings related to subscription trials.
786
+ sig { returns(::Stripe::SubscriptionService::UpdateParams::TrialSettings) }
787
+ attr_accessor :trial_settings
788
+ sig {
789
+ params(add_invoice_items: T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem], application_fee_percent: T.nilable(Float), automatic_tax: ::Stripe::SubscriptionService::UpdateParams::AutomaticTax, billing_cycle_anchor: String, billing_thresholds: T.nilable(::Stripe::SubscriptionService::UpdateParams::BillingThresholds), cancel_at: T.nilable(Integer), cancel_at_period_end: T::Boolean, cancellation_details: ::Stripe::SubscriptionService::UpdateParams::CancellationDetails, collection_method: String, coupon: String, days_until_due: Integer, default_payment_method: String, default_source: T.nilable(String), default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), discounts: T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::Discount]), expand: T::Array[String], invoice_settings: ::Stripe::SubscriptionService::UpdateParams::InvoiceSettings, items: T::Array[::Stripe::SubscriptionService::UpdateParams::Item], metadata: T.nilable(T::Hash[String, String]), off_session: T::Boolean, on_behalf_of: T.nilable(String), pause_collection: T.nilable(::Stripe::SubscriptionService::UpdateParams::PauseCollection), payment_behavior: String, payment_settings: ::Stripe::SubscriptionService::UpdateParams::PaymentSettings, pending_invoice_item_interval: T.nilable(::Stripe::SubscriptionService::UpdateParams::PendingInvoiceItemInterval), prebilling: ::Stripe::SubscriptionService::UpdateParams::Prebilling, promotion_code: String, proration_behavior: String, proration_date: Integer, transfer_data: T.nilable(::Stripe::SubscriptionService::UpdateParams::TransferData), trial_end: T.any(String, Integer), trial_from_plan: T::Boolean, trial_settings: ::Stripe::SubscriptionService::UpdateParams::TrialSettings).void
790
+ }
791
+ def initialize(
792
+ add_invoice_items: nil,
793
+ application_fee_percent: nil,
794
+ automatic_tax: nil,
795
+ billing_cycle_anchor: nil,
796
+ billing_thresholds: nil,
797
+ cancel_at: nil,
798
+ cancel_at_period_end: nil,
799
+ cancellation_details: nil,
800
+ collection_method: nil,
801
+ coupon: nil,
802
+ days_until_due: nil,
803
+ default_payment_method: nil,
804
+ default_source: nil,
805
+ default_tax_rates: nil,
806
+ description: nil,
807
+ discounts: nil,
808
+ expand: nil,
809
+ invoice_settings: nil,
810
+ items: nil,
811
+ metadata: nil,
812
+ off_session: nil,
813
+ on_behalf_of: nil,
814
+ pause_collection: nil,
815
+ payment_behavior: nil,
816
+ payment_settings: nil,
817
+ pending_invoice_item_interval: nil,
818
+ prebilling: nil,
819
+ promotion_code: nil,
820
+ proration_behavior: nil,
821
+ proration_date: nil,
822
+ transfer_data: nil,
823
+ trial_end: nil,
824
+ trial_from_plan: nil,
825
+ trial_settings: nil
826
+ ); end
827
+ end
828
+ class DeleteDiscountParams < Stripe::RequestParams
829
+
830
+ end
831
+ class ListParams < Stripe::RequestParams
832
+ class AutomaticTax < Stripe::RequestParams
833
+ # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
834
+ sig { returns(T::Boolean) }
835
+ attr_accessor :enabled
836
+ sig { params(enabled: T::Boolean).void }
837
+ def initialize(enabled: nil); end
838
+ end
839
+ class Created < Stripe::RequestParams
840
+ # Minimum value to filter by (exclusive)
841
+ sig { returns(Integer) }
842
+ attr_accessor :gt
843
+ # Minimum value to filter by (inclusive)
844
+ sig { returns(Integer) }
845
+ attr_accessor :gte
846
+ # Maximum value to filter by (exclusive)
847
+ sig { returns(Integer) }
848
+ attr_accessor :lt
849
+ # Maximum value to filter by (inclusive)
850
+ sig { returns(Integer) }
851
+ attr_accessor :lte
852
+ sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
853
+ def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
854
+ end
855
+ class CurrentPeriodEnd < Stripe::RequestParams
856
+ # Minimum value to filter by (exclusive)
857
+ sig { returns(Integer) }
858
+ attr_accessor :gt
859
+ # Minimum value to filter by (inclusive)
860
+ sig { returns(Integer) }
861
+ attr_accessor :gte
862
+ # Maximum value to filter by (exclusive)
863
+ sig { returns(Integer) }
864
+ attr_accessor :lt
865
+ # Maximum value to filter by (inclusive)
866
+ sig { returns(Integer) }
867
+ attr_accessor :lte
868
+ sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
869
+ def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
870
+ end
871
+ class CurrentPeriodStart < Stripe::RequestParams
872
+ # Minimum value to filter by (exclusive)
873
+ sig { returns(Integer) }
874
+ attr_accessor :gt
875
+ # Minimum value to filter by (inclusive)
876
+ sig { returns(Integer) }
877
+ attr_accessor :gte
878
+ # Maximum value to filter by (exclusive)
879
+ sig { returns(Integer) }
880
+ attr_accessor :lt
881
+ # Maximum value to filter by (inclusive)
882
+ sig { returns(Integer) }
883
+ attr_accessor :lte
884
+ sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
885
+ def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
886
+ end
887
+ # Filter subscriptions by their automatic tax settings.
888
+ sig { returns(::Stripe::SubscriptionService::ListParams::AutomaticTax) }
889
+ attr_accessor :automatic_tax
890
+ # The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.
891
+ sig { returns(String) }
892
+ attr_accessor :collection_method
893
+ # Only return subscriptions that were created during the given date interval.
894
+ sig { returns(T.any(::Stripe::SubscriptionService::ListParams::Created, Integer)) }
895
+ attr_accessor :created
896
+ # Only return subscriptions whose current_period_end falls within the given date interval.
897
+ sig { returns(T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodEnd, Integer)) }
898
+ attr_accessor :current_period_end
899
+ # Only return subscriptions whose current_period_start falls within the given date interval.
900
+ sig { returns(T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodStart, Integer)) }
901
+ attr_accessor :current_period_start
902
+ # The ID of the customer whose subscriptions will be retrieved.
903
+ sig { returns(String) }
904
+ attr_accessor :customer
905
+ # 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.
906
+ sig { returns(String) }
907
+ attr_accessor :ending_before
908
+ # Specifies which fields in the response should be expanded.
909
+ sig { returns(T::Array[String]) }
910
+ attr_accessor :expand
911
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
912
+ sig { returns(Integer) }
913
+ attr_accessor :limit
914
+ # The ID of the plan whose subscriptions will be retrieved.
915
+ sig { returns(String) }
916
+ attr_accessor :plan
917
+ # Filter for subscriptions that contain this recurring price ID.
918
+ sig { returns(String) }
919
+ attr_accessor :price
920
+ # 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.
921
+ sig { returns(String) }
922
+ attr_accessor :starting_after
923
+ # The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
924
+ sig { returns(String) }
925
+ attr_accessor :status
926
+ # Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.
927
+ sig { returns(String) }
928
+ attr_accessor :test_clock
929
+ sig {
930
+ params(automatic_tax: ::Stripe::SubscriptionService::ListParams::AutomaticTax, collection_method: String, created: T.any(::Stripe::SubscriptionService::ListParams::Created, Integer), current_period_end: T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodEnd, Integer), current_period_start: T.any(::Stripe::SubscriptionService::ListParams::CurrentPeriodStart, Integer), customer: String, ending_before: String, expand: T::Array[String], limit: Integer, plan: String, price: String, starting_after: String, status: String, test_clock: String).void
931
+ }
932
+ def initialize(
933
+ automatic_tax: nil,
934
+ collection_method: nil,
935
+ created: nil,
936
+ current_period_end: nil,
937
+ current_period_start: nil,
938
+ customer: nil,
939
+ ending_before: nil,
940
+ expand: nil,
941
+ limit: nil,
942
+ plan: nil,
943
+ price: nil,
944
+ starting_after: nil,
945
+ status: nil,
946
+ test_clock: nil
947
+ ); end
948
+ end
949
+ class CreateParams < Stripe::RequestParams
950
+ class AddInvoiceItem < Stripe::RequestParams
951
+ class Discount < Stripe::RequestParams
952
+ class DiscountEnd < Stripe::RequestParams
953
+ class Duration < Stripe::RequestParams
954
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
955
+ sig { returns(String) }
956
+ attr_accessor :interval
957
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
958
+ sig { returns(Integer) }
959
+ attr_accessor :interval_count
960
+ sig { params(interval: String, interval_count: Integer).void }
961
+ def initialize(interval: nil, interval_count: nil); end
962
+ end
963
+ # Time span for the redeemed discount.
964
+ sig {
965
+ returns(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd::Duration)
966
+ }
967
+ attr_accessor :duration
968
+ # A precise Unix timestamp for the discount to end. Must be in the future.
969
+ sig { returns(Integer) }
970
+ attr_accessor :timestamp
971
+ # The type of calculation made to determine when the discount ends.
972
+ sig { returns(String) }
973
+ attr_accessor :type
974
+ sig {
975
+ params(duration: ::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
976
+ }
977
+ def initialize(duration: nil, timestamp: nil, type: nil); end
978
+ end
979
+ # ID of the coupon to create a new discount for.
980
+ sig { returns(String) }
981
+ attr_accessor :coupon
982
+ # ID of an existing discount on the object (or one of its ancestors) to reuse.
983
+ sig { returns(String) }
984
+ attr_accessor :discount
985
+ # Details to determine how long the discount should be applied for.
986
+ sig {
987
+ returns(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd)
988
+ }
989
+ attr_accessor :discount_end
990
+ # ID of the promotion code to create a new discount for.
991
+ sig { returns(String) }
992
+ attr_accessor :promotion_code
993
+ sig {
994
+ params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount::DiscountEnd, promotion_code: String).void
995
+ }
996
+ def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
997
+ end
998
+ class PriceData < Stripe::RequestParams
999
+ # 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).
1000
+ sig { returns(String) }
1001
+ attr_accessor :currency
1002
+ # The ID of the product that this price will belong to.
1003
+ sig { returns(String) }
1004
+ attr_accessor :product
1005
+ # 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.
1006
+ sig { returns(String) }
1007
+ attr_accessor :tax_behavior
1008
+ # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
1009
+ sig { returns(Integer) }
1010
+ attr_accessor :unit_amount
1011
+ # 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.
1012
+ sig { returns(String) }
1013
+ attr_accessor :unit_amount_decimal
1014
+ sig {
1015
+ params(currency: String, product: String, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
1016
+ }
1017
+ def initialize(
1018
+ currency: nil,
1019
+ product: nil,
1020
+ tax_behavior: nil,
1021
+ unit_amount: nil,
1022
+ unit_amount_decimal: nil
1023
+ ); end
1024
+ end
1025
+ # The coupons to redeem into discounts for the item.
1026
+ sig {
1027
+ returns(T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount])
1028
+ }
1029
+ attr_accessor :discounts
1030
+ # The ID of the price object. One of `price` or `price_data` is required.
1031
+ sig { returns(String) }
1032
+ attr_accessor :price
1033
+ # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
1034
+ sig { returns(::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::PriceData) }
1035
+ attr_accessor :price_data
1036
+ # Quantity for this item. Defaults to 1.
1037
+ sig { returns(Integer) }
1038
+ attr_accessor :quantity
1039
+ # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
1040
+ sig { returns(T.nilable(T::Array[String])) }
1041
+ attr_accessor :tax_rates
1042
+ sig {
1043
+ params(discounts: T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::Discount], price: String, price_data: ::Stripe::SubscriptionService::CreateParams::AddInvoiceItem::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
1044
+ }
1045
+ def initialize(
1046
+ discounts: nil,
1047
+ price: nil,
1048
+ price_data: nil,
1049
+ quantity: nil,
1050
+ tax_rates: nil
1051
+ ); end
1052
+ end
1053
+ class AutomaticTax < Stripe::RequestParams
1054
+ class Liability < Stripe::RequestParams
1055
+ # The connected account being referenced when `type` is `account`.
1056
+ sig { returns(String) }
1057
+ attr_accessor :account
1058
+ # Type of the account referenced in the request.
1059
+ sig { returns(String) }
1060
+ attr_accessor :type
1061
+ sig { params(account: String, type: String).void }
1062
+ def initialize(account: nil, type: nil); end
1063
+ end
1064
+ # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
1065
+ sig { returns(T::Boolean) }
1066
+ attr_accessor :enabled
1067
+ # 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.
1068
+ sig { returns(::Stripe::SubscriptionService::CreateParams::AutomaticTax::Liability) }
1069
+ attr_accessor :liability
1070
+ sig {
1071
+ params(enabled: T::Boolean, liability: ::Stripe::SubscriptionService::CreateParams::AutomaticTax::Liability).void
1072
+ }
1073
+ def initialize(enabled: nil, liability: nil); end
1074
+ end
1075
+ class BillingCycleAnchorConfig < Stripe::RequestParams
1076
+ # The day of the month the billing_cycle_anchor should be. Ranges from 1 to 31.
1077
+ sig { returns(Integer) }
1078
+ attr_accessor :day_of_month
1079
+ # The hour of the day the billing_cycle_anchor should be. Ranges from 0 to 23.
1080
+ sig { returns(Integer) }
1081
+ attr_accessor :hour
1082
+ # The minute of the hour the billing_cycle_anchor should be. Ranges from 0 to 59.
1083
+ sig { returns(Integer) }
1084
+ attr_accessor :minute
1085
+ # The month to start full cycle billing periods. Ranges from 1 to 12.
1086
+ sig { returns(Integer) }
1087
+ attr_accessor :month
1088
+ # The second of the minute the billing_cycle_anchor should be. Ranges from 0 to 59.
1089
+ sig { returns(Integer) }
1090
+ attr_accessor :second
1091
+ sig {
1092
+ params(day_of_month: Integer, hour: Integer, minute: Integer, month: Integer, second: Integer).void
1093
+ }
1094
+ def initialize(day_of_month: nil, hour: nil, minute: nil, month: nil, second: nil); end
1095
+ end
1096
+ class BillingThresholds < Stripe::RequestParams
1097
+ # Monetary threshold that triggers the subscription to advance to a new billing period
1098
+ sig { returns(Integer) }
1099
+ attr_accessor :amount_gte
1100
+ # 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.
1101
+ sig { returns(T::Boolean) }
1102
+ attr_accessor :reset_billing_cycle_anchor
1103
+ sig { params(amount_gte: Integer, reset_billing_cycle_anchor: T::Boolean).void }
1104
+ def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
1105
+ end
1106
+ class Discount < Stripe::RequestParams
1107
+ class DiscountEnd < Stripe::RequestParams
1108
+ class Duration < Stripe::RequestParams
1109
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1110
+ sig { returns(String) }
1111
+ attr_accessor :interval
1112
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1113
+ sig { returns(Integer) }
1114
+ attr_accessor :interval_count
1115
+ sig { params(interval: String, interval_count: Integer).void }
1116
+ def initialize(interval: nil, interval_count: nil); end
1117
+ end
1118
+ # Time span for the redeemed discount.
1119
+ sig {
1120
+ returns(::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd::Duration)
1121
+ }
1122
+ attr_accessor :duration
1123
+ # A precise Unix timestamp for the discount to end. Must be in the future.
1124
+ sig { returns(Integer) }
1125
+ attr_accessor :timestamp
1126
+ # The type of calculation made to determine when the discount ends.
1127
+ sig { returns(String) }
1128
+ attr_accessor :type
1129
+ sig {
1130
+ params(duration: ::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
1131
+ }
1132
+ def initialize(duration: nil, timestamp: nil, type: nil); end
1133
+ end
1134
+ # ID of the coupon to create a new discount for.
1135
+ sig { returns(String) }
1136
+ attr_accessor :coupon
1137
+ # ID of an existing discount on the object (or one of its ancestors) to reuse.
1138
+ sig { returns(String) }
1139
+ attr_accessor :discount
1140
+ # Details to determine how long the discount should be applied for.
1141
+ sig { returns(::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd) }
1142
+ attr_accessor :discount_end
1143
+ # ID of the promotion code to create a new discount for.
1144
+ sig { returns(String) }
1145
+ attr_accessor :promotion_code
1146
+ sig {
1147
+ params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionService::CreateParams::Discount::DiscountEnd, promotion_code: String).void
1148
+ }
1149
+ def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
1150
+ end
1151
+ class InvoiceSettings < Stripe::RequestParams
1152
+ class Issuer < Stripe::RequestParams
1153
+ # The connected account being referenced when `type` is `account`.
1154
+ sig { returns(String) }
1155
+ attr_accessor :account
1156
+ # Type of the account referenced in the request.
1157
+ sig { returns(String) }
1158
+ attr_accessor :type
1159
+ sig { params(account: String, type: String).void }
1160
+ def initialize(account: nil, type: nil); end
1161
+ end
1162
+ # The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
1163
+ sig { returns(T.nilable(T::Array[String])) }
1164
+ attr_accessor :account_tax_ids
1165
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1166
+ sig { returns(::Stripe::SubscriptionService::CreateParams::InvoiceSettings::Issuer) }
1167
+ attr_accessor :issuer
1168
+ sig {
1169
+ params(account_tax_ids: T.nilable(T::Array[String]), issuer: ::Stripe::SubscriptionService::CreateParams::InvoiceSettings::Issuer).void
1170
+ }
1171
+ def initialize(account_tax_ids: nil, issuer: nil); end
1172
+ end
1173
+ class Item < Stripe::RequestParams
1174
+ class BillingThresholds < Stripe::RequestParams
1175
+ # 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))
1176
+ sig { returns(Integer) }
1177
+ attr_accessor :usage_gte
1178
+ sig { params(usage_gte: Integer).void }
1179
+ def initialize(usage_gte: nil); end
1180
+ end
1181
+ class Discount < Stripe::RequestParams
1182
+ class DiscountEnd < Stripe::RequestParams
1183
+ class Duration < Stripe::RequestParams
1184
+ # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1185
+ sig { returns(String) }
1186
+ attr_accessor :interval
1187
+ # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1188
+ sig { returns(Integer) }
1189
+ attr_accessor :interval_count
1190
+ sig { params(interval: String, interval_count: Integer).void }
1191
+ def initialize(interval: nil, interval_count: nil); end
1192
+ end
1193
+ # Time span for the redeemed discount.
1194
+ sig {
1195
+ returns(::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd::Duration)
1196
+ }
1197
+ attr_accessor :duration
1198
+ # A precise Unix timestamp for the discount to end. Must be in the future.
1199
+ sig { returns(Integer) }
1200
+ attr_accessor :timestamp
1201
+ # The type of calculation made to determine when the discount ends.
1202
+ sig { returns(String) }
1203
+ attr_accessor :type
1204
+ sig {
1205
+ params(duration: ::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
1206
+ }
1207
+ def initialize(duration: nil, timestamp: nil, type: nil); end
1208
+ end
1209
+ # ID of the coupon to create a new discount for.
1210
+ sig { returns(String) }
1211
+ attr_accessor :coupon
1212
+ # ID of an existing discount on the object (or one of its ancestors) to reuse.
1213
+ sig { returns(String) }
1214
+ attr_accessor :discount
1215
+ # Details to determine how long the discount should be applied for.
1216
+ sig { returns(::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd) }
1217
+ attr_accessor :discount_end
1218
+ # ID of the promotion code to create a new discount for.
1219
+ sig { returns(String) }
1220
+ attr_accessor :promotion_code
1221
+ sig {
1222
+ params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionService::CreateParams::Item::Discount::DiscountEnd, promotion_code: String).void
1223
+ }
1224
+ def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
1225
+ end
1226
+ class PriceData < Stripe::RequestParams
1227
+ class Recurring < Stripe::RequestParams
1228
+ # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
1229
+ sig { returns(String) }
1230
+ attr_accessor :interval
1231
+ # 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).
1232
+ sig { returns(Integer) }
1233
+ attr_accessor :interval_count
1234
+ sig { params(interval: String, interval_count: Integer).void }
1235
+ def initialize(interval: nil, interval_count: nil); end
1236
+ end
1237
+ # 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).
1238
+ sig { returns(String) }
1239
+ attr_accessor :currency
1240
+ # The ID of the product that this price will belong to.
1241
+ sig { returns(String) }
1242
+ attr_accessor :product
1243
+ # The recurring components of a price such as `interval` and `interval_count`.
1244
+ sig { returns(::Stripe::SubscriptionService::CreateParams::Item::PriceData::Recurring) }
1245
+ attr_accessor :recurring
1246
+ # 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.
1247
+ sig { returns(String) }
1248
+ attr_accessor :tax_behavior
1249
+ # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
1250
+ sig { returns(Integer) }
1251
+ attr_accessor :unit_amount
1252
+ # 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.
1253
+ sig { returns(String) }
1254
+ attr_accessor :unit_amount_decimal
1255
+ sig {
1256
+ params(currency: String, product: String, recurring: ::Stripe::SubscriptionService::CreateParams::Item::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
1257
+ }
1258
+ def initialize(
1259
+ currency: nil,
1260
+ product: nil,
1261
+ recurring: nil,
1262
+ tax_behavior: nil,
1263
+ unit_amount: nil,
1264
+ unit_amount_decimal: nil
1265
+ ); end
1266
+ end
1267
+ class Trial < Stripe::RequestParams
1268
+ # List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
1269
+ sig { returns(T::Array[String]) }
1270
+ attr_accessor :converts_to
1271
+ # Determines the type of trial for this item.
1272
+ sig { returns(String) }
1273
+ attr_accessor :type
1274
+ sig { params(converts_to: T::Array[String], type: String).void }
1275
+ def initialize(converts_to: nil, type: nil); end
1276
+ end
1277
+ # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
1278
+ sig {
1279
+ returns(T.nilable(::Stripe::SubscriptionService::CreateParams::Item::BillingThresholds))
1280
+ }
1281
+ attr_accessor :billing_thresholds
1282
+ # The coupons to redeem into discounts for the subscription item.
1283
+ sig {
1284
+ returns(T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::Item::Discount]))
1285
+ }
1286
+ attr_accessor :discounts
1287
+ # 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`.
1288
+ sig { returns(T::Hash[String, String]) }
1289
+ attr_accessor :metadata
1290
+ # Plan ID for this item, as a string.
1291
+ sig { returns(String) }
1292
+ attr_accessor :plan
1293
+ # The ID of the price object.
1294
+ sig { returns(String) }
1295
+ attr_accessor :price
1296
+ # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
1297
+ sig { returns(::Stripe::SubscriptionService::CreateParams::Item::PriceData) }
1298
+ attr_accessor :price_data
1299
+ # Quantity for this item.
1300
+ sig { returns(Integer) }
1301
+ attr_accessor :quantity
1302
+ # 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.
1303
+ sig { returns(T.nilable(T::Array[String])) }
1304
+ attr_accessor :tax_rates
1305
+ # Define options to configure the trial on the subscription item.
1306
+ sig { returns(::Stripe::SubscriptionService::CreateParams::Item::Trial) }
1307
+ attr_accessor :trial
1308
+ sig {
1309
+ params(billing_thresholds: T.nilable(::Stripe::SubscriptionService::CreateParams::Item::BillingThresholds), discounts: T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::Item::Discount]), metadata: T::Hash[String, String], plan: String, price: String, price_data: ::Stripe::SubscriptionService::CreateParams::Item::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String]), trial: ::Stripe::SubscriptionService::CreateParams::Item::Trial).void
1310
+ }
1311
+ def initialize(
1312
+ billing_thresholds: nil,
1313
+ discounts: nil,
1314
+ metadata: nil,
1315
+ plan: nil,
1316
+ price: nil,
1317
+ price_data: nil,
1318
+ quantity: nil,
1319
+ tax_rates: nil,
1320
+ trial: nil
1321
+ ); end
1322
+ end
1323
+ class PaymentSettings < Stripe::RequestParams
1324
+ class PaymentMethodOptions < Stripe::RequestParams
1325
+ class AcssDebit < Stripe::RequestParams
1326
+ class MandateOptions < Stripe::RequestParams
1327
+ # Transaction type of the mandate.
1328
+ sig { returns(String) }
1329
+ attr_accessor :transaction_type
1330
+ sig { params(transaction_type: String).void }
1331
+ def initialize(transaction_type: nil); end
1332
+ end
1333
+ # Additional fields for Mandate creation
1334
+ sig {
1335
+ returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions)
1336
+ }
1337
+ attr_accessor :mandate_options
1338
+ # Verification method for the intent
1339
+ sig { returns(String) }
1340
+ attr_accessor :verification_method
1341
+ sig {
1342
+ params(mandate_options: ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions, verification_method: String).void
1343
+ }
1344
+ def initialize(mandate_options: nil, verification_method: nil); end
1345
+ end
1346
+ class Bancontact < Stripe::RequestParams
1347
+ # Preferred language of the Bancontact authorization page that the customer is redirected to.
1348
+ sig { returns(String) }
1349
+ attr_accessor :preferred_language
1350
+ sig { params(preferred_language: String).void }
1351
+ def initialize(preferred_language: nil); end
1352
+ end
1353
+ class Card < Stripe::RequestParams
1354
+ class MandateOptions < Stripe::RequestParams
1355
+ # Amount to be charged for future payments.
1356
+ sig { returns(Integer) }
1357
+ attr_accessor :amount
1358
+ # One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
1359
+ sig { returns(String) }
1360
+ attr_accessor :amount_type
1361
+ # A description of the mandate or subscription that is meant to be displayed to the customer.
1362
+ sig { returns(String) }
1363
+ attr_accessor :description
1364
+ sig { params(amount: Integer, amount_type: String, description: String).void }
1365
+ def initialize(amount: nil, amount_type: nil, description: nil); end
1366
+ end
1367
+ # Configuration options for setting up an eMandate for cards issued in India.
1368
+ sig {
1369
+ returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions)
1370
+ }
1371
+ attr_accessor :mandate_options
1372
+ # Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
1373
+ sig { returns(String) }
1374
+ attr_accessor :network
1375
+ # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
1376
+ sig { returns(String) }
1377
+ attr_accessor :request_three_d_secure
1378
+ sig {
1379
+ params(mandate_options: ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions, network: String, request_three_d_secure: String).void
1380
+ }
1381
+ def initialize(mandate_options: nil, network: nil, request_three_d_secure: nil); end
1382
+ end
1383
+ class CustomerBalance < Stripe::RequestParams
1384
+ class BankTransfer < Stripe::RequestParams
1385
+ class EuBankTransfer < Stripe::RequestParams
1386
+ # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
1387
+ sig { returns(String) }
1388
+ attr_accessor :country
1389
+ sig { params(country: String).void }
1390
+ def initialize(country: nil); end
1391
+ end
1392
+ # Configuration for eu_bank_transfer funding type.
1393
+ sig {
1394
+ returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)
1395
+ }
1396
+ attr_accessor :eu_bank_transfer
1397
+ # The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
1398
+ sig { returns(String) }
1399
+ attr_accessor :type
1400
+ sig {
1401
+ params(eu_bank_transfer: ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer, type: String).void
1402
+ }
1403
+ def initialize(eu_bank_transfer: nil, type: nil); end
1404
+ end
1405
+ # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
1406
+ sig {
1407
+ returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer)
1408
+ }
1409
+ attr_accessor :bank_transfer
1410
+ # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
1411
+ sig { returns(String) }
1412
+ attr_accessor :funding_type
1413
+ sig {
1414
+ params(bank_transfer: ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer, funding_type: String).void
1415
+ }
1416
+ def initialize(bank_transfer: nil, funding_type: nil); end
1417
+ end
1418
+ class IdBankTransfer < Stripe::RequestParams
1419
+
1420
+ end
1421
+ class Konbini < Stripe::RequestParams
1422
+
1423
+ end
1424
+ class SepaDebit < Stripe::RequestParams
1425
+
1426
+ end
1427
+ class UsBankAccount < Stripe::RequestParams
1428
+ class FinancialConnections < Stripe::RequestParams
1429
+ class Filters < Stripe::RequestParams
1430
+ # The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
1431
+ sig { returns(T::Array[String]) }
1432
+ attr_accessor :account_subcategories
1433
+ # ID of the institution to use to filter for selectable accounts.
1434
+ sig { returns(String) }
1435
+ attr_accessor :institution
1436
+ sig { params(account_subcategories: T::Array[String], institution: String).void }
1437
+ def initialize(account_subcategories: nil, institution: nil); end
1438
+ end
1439
+ # Provide filters for the linked accounts that the customer can select for the payment method.
1440
+ sig {
1441
+ returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)
1442
+ }
1443
+ attr_accessor :filters
1444
+ # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
1445
+ sig { returns(T::Array[String]) }
1446
+ attr_accessor :permissions
1447
+ # List of data features that you would like to retrieve upon account creation.
1448
+ sig { returns(T::Array[String]) }
1449
+ attr_accessor :prefetch
1450
+ sig {
1451
+ params(filters: ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters, permissions: T::Array[String], prefetch: T::Array[String]).void
1452
+ }
1453
+ def initialize(filters: nil, permissions: nil, prefetch: nil); end
1454
+ end
1455
+ # Additional fields for Financial Connections Session creation
1456
+ sig {
1457
+ returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections)
1458
+ }
1459
+ attr_accessor :financial_connections
1460
+ # Verification method for the intent
1461
+ sig { returns(String) }
1462
+ attr_accessor :verification_method
1463
+ sig {
1464
+ params(financial_connections: ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections, verification_method: String).void
1465
+ }
1466
+ def initialize(financial_connections: nil, verification_method: nil); end
1467
+ end
1468
+ # This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
1469
+ sig {
1470
+ returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit))
1471
+ }
1472
+ attr_accessor :acss_debit
1473
+ # This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
1474
+ sig {
1475
+ returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact))
1476
+ }
1477
+ attr_accessor :bancontact
1478
+ # This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
1479
+ sig {
1480
+ returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card))
1481
+ }
1482
+ attr_accessor :card
1483
+ # This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
1484
+ sig {
1485
+ returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance))
1486
+ }
1487
+ attr_accessor :customer_balance
1488
+ # This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
1489
+ sig {
1490
+ returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer))
1491
+ }
1492
+ attr_accessor :id_bank_transfer
1493
+ # This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
1494
+ sig {
1495
+ returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini))
1496
+ }
1497
+ attr_accessor :konbini
1498
+ # This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
1499
+ sig {
1500
+ returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit))
1501
+ }
1502
+ attr_accessor :sepa_debit
1503
+ # This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
1504
+ sig {
1505
+ returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))
1506
+ }
1507
+ attr_accessor :us_bank_account
1508
+ sig {
1509
+ params(acss_debit: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit), bancontact: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact), card: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Card), customer_balance: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance), id_bank_transfer: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer), konbini: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini), sepa_debit: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit), us_bank_account: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)).void
1510
+ }
1511
+ def initialize(
1512
+ acss_debit: nil,
1513
+ bancontact: nil,
1514
+ card: nil,
1515
+ customer_balance: nil,
1516
+ id_bank_transfer: nil,
1517
+ konbini: nil,
1518
+ sepa_debit: nil,
1519
+ us_bank_account: nil
1520
+ ); end
1521
+ end
1522
+ # Payment-method-specific configuration to provide to invoices created by the subscription.
1523
+ sig {
1524
+ returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions)
1525
+ }
1526
+ attr_accessor :payment_method_options
1527
+ # The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
1528
+ sig { returns(T.nilable(T::Array[String])) }
1529
+ attr_accessor :payment_method_types
1530
+ # Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.
1531
+ sig { returns(String) }
1532
+ attr_accessor :save_default_payment_method
1533
+ sig {
1534
+ params(payment_method_options: ::Stripe::SubscriptionService::CreateParams::PaymentSettings::PaymentMethodOptions, payment_method_types: T.nilable(T::Array[String]), save_default_payment_method: String).void
1535
+ }
1536
+ def initialize(
1537
+ payment_method_options: nil,
1538
+ payment_method_types: nil,
1539
+ save_default_payment_method: nil
1540
+ ); end
1541
+ end
1542
+ class PendingInvoiceItemInterval < Stripe::RequestParams
1543
+ # Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
1544
+ sig { returns(String) }
1545
+ attr_accessor :interval
1546
+ # The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
1547
+ sig { returns(Integer) }
1548
+ attr_accessor :interval_count
1549
+ sig { params(interval: String, interval_count: Integer).void }
1550
+ def initialize(interval: nil, interval_count: nil); end
1551
+ end
1552
+ class Prebilling < Stripe::RequestParams
1553
+ # This is used to determine the number of billing cycles to prebill.
1554
+ sig { returns(Integer) }
1555
+ attr_accessor :iterations
1556
+ # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
1557
+ sig { returns(String) }
1558
+ attr_accessor :update_behavior
1559
+ sig { params(iterations: Integer, update_behavior: String).void }
1560
+ def initialize(iterations: nil, update_behavior: nil); end
1561
+ end
1562
+ class TransferData < Stripe::RequestParams
1563
+ # 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.
1564
+ sig { returns(Float) }
1565
+ attr_accessor :amount_percent
1566
+ # ID of an existing, connected Stripe account.
1567
+ sig { returns(String) }
1568
+ attr_accessor :destination
1569
+ sig { params(amount_percent: Float, destination: String).void }
1570
+ def initialize(amount_percent: nil, destination: nil); end
1571
+ end
1572
+ class TrialSettings < Stripe::RequestParams
1573
+ class EndBehavior < Stripe::RequestParams
1574
+ # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
1575
+ sig { returns(String) }
1576
+ attr_accessor :missing_payment_method
1577
+ sig { params(missing_payment_method: String).void }
1578
+ def initialize(missing_payment_method: nil); end
1579
+ end
1580
+ # Defines how the subscription should behave when the user's free trial ends.
1581
+ sig { returns(::Stripe::SubscriptionService::CreateParams::TrialSettings::EndBehavior) }
1582
+ attr_accessor :end_behavior
1583
+ sig {
1584
+ params(end_behavior: ::Stripe::SubscriptionService::CreateParams::TrialSettings::EndBehavior).void
1585
+ }
1586
+ def initialize(end_behavior: nil); end
1587
+ end
1588
+ # A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
1589
+ sig { returns(T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem]) }
1590
+ attr_accessor :add_invoice_items
1591
+ # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
1592
+ sig { returns(T.nilable(Float)) }
1593
+ attr_accessor :application_fee_percent
1594
+ # Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
1595
+ sig { returns(::Stripe::SubscriptionService::CreateParams::AutomaticTax) }
1596
+ attr_accessor :automatic_tax
1597
+ # For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
1598
+ sig { returns(Integer) }
1599
+ attr_accessor :backdate_start_date
1600
+ # A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
1601
+ sig { returns(Integer) }
1602
+ attr_accessor :billing_cycle_anchor
1603
+ # Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC.
1604
+ sig { returns(::Stripe::SubscriptionService::CreateParams::BillingCycleAnchorConfig) }
1605
+ attr_accessor :billing_cycle_anchor_config
1606
+ # 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.
1607
+ sig { returns(T.nilable(::Stripe::SubscriptionService::CreateParams::BillingThresholds)) }
1608
+ attr_accessor :billing_thresholds
1609
+ # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
1610
+ sig { returns(Integer) }
1611
+ attr_accessor :cancel_at
1612
+ # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
1613
+ sig { returns(T::Boolean) }
1614
+ attr_accessor :cancel_at_period_end
1615
+ # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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`. Defaults to `charge_automatically`.
1616
+ sig { returns(String) }
1617
+ attr_accessor :collection_method
1618
+ # The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
1619
+ sig { returns(String) }
1620
+ attr_accessor :coupon
1621
+ # 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).
1622
+ sig { returns(String) }
1623
+ attr_accessor :currency
1624
+ # The identifier of the customer to subscribe.
1625
+ sig { returns(String) }
1626
+ attr_accessor :customer
1627
+ # Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
1628
+ sig { returns(Integer) }
1629
+ attr_accessor :days_until_due
1630
+ # ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
1631
+ sig { returns(String) }
1632
+ attr_accessor :default_payment_method
1633
+ # ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
1634
+ sig { returns(String) }
1635
+ attr_accessor :default_source
1636
+ # The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
1637
+ sig { returns(T.nilable(T::Array[String])) }
1638
+ attr_accessor :default_tax_rates
1639
+ # The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
1640
+ sig { returns(String) }
1641
+ attr_accessor :description
1642
+ # The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
1643
+ sig { returns(T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::Discount])) }
1644
+ attr_accessor :discounts
1645
+ # Specifies which fields in the response should be expanded.
1646
+ sig { returns(T::Array[String]) }
1647
+ attr_accessor :expand
1648
+ # All invoices will be billed using the specified settings.
1649
+ sig { returns(::Stripe::SubscriptionService::CreateParams::InvoiceSettings) }
1650
+ attr_accessor :invoice_settings
1651
+ # A list of up to 20 subscription items, each with an attached price.
1652
+ sig { returns(T::Array[::Stripe::SubscriptionService::CreateParams::Item]) }
1653
+ attr_accessor :items
1654
+ # 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`.
1655
+ sig { returns(T.nilable(T::Hash[String, String])) }
1656
+ attr_accessor :metadata
1657
+ # Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
1658
+ sig { returns(T::Boolean) }
1659
+ attr_accessor :off_session
1660
+ # The account on behalf of which to charge, for each of the subscription's invoices.
1661
+ sig { returns(T.nilable(String)) }
1662
+ attr_accessor :on_behalf_of
1663
+ # Only applies to subscriptions with `collection_method=charge_automatically`.
1664
+ #
1665
+ # Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer 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.
1666
+ #
1667
+ # Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer 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. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.
1668
+ #
1669
+ # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.
1670
+ #
1671
+ # `pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription.
1672
+ #
1673
+ # Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status.
1674
+ sig { returns(String) }
1675
+ attr_accessor :payment_behavior
1676
+ # Payment settings to pass to invoices created by the subscription.
1677
+ sig { returns(::Stripe::SubscriptionService::CreateParams::PaymentSettings) }
1678
+ attr_accessor :payment_settings
1679
+ # Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
1680
+ sig {
1681
+ returns(T.nilable(::Stripe::SubscriptionService::CreateParams::PendingInvoiceItemInterval))
1682
+ }
1683
+ attr_accessor :pending_invoice_item_interval
1684
+ # If specified, the invoicing for the given billing cycle iterations will be processed now.
1685
+ sig { returns(::Stripe::SubscriptionService::CreateParams::Prebilling) }
1686
+ attr_accessor :prebilling
1687
+ # The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
1688
+ sig { returns(String) }
1689
+ attr_accessor :promotion_code
1690
+ # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
1691
+ sig { returns(String) }
1692
+ attr_accessor :proration_behavior
1693
+ # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
1694
+ sig { returns(::Stripe::SubscriptionService::CreateParams::TransferData) }
1695
+ attr_accessor :transfer_data
1696
+ # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
1697
+ sig { returns(T.any(String, Integer)) }
1698
+ attr_accessor :trial_end
1699
+ # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
1700
+ sig { returns(T::Boolean) }
1701
+ attr_accessor :trial_from_plan
1702
+ # Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
1703
+ sig { returns(Integer) }
1704
+ attr_accessor :trial_period_days
1705
+ # Settings related to subscription trials.
1706
+ sig { returns(::Stripe::SubscriptionService::CreateParams::TrialSettings) }
1707
+ attr_accessor :trial_settings
1708
+ sig {
1709
+ params(add_invoice_items: T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem], application_fee_percent: T.nilable(Float), automatic_tax: ::Stripe::SubscriptionService::CreateParams::AutomaticTax, backdate_start_date: Integer, billing_cycle_anchor: Integer, billing_cycle_anchor_config: ::Stripe::SubscriptionService::CreateParams::BillingCycleAnchorConfig, billing_thresholds: T.nilable(::Stripe::SubscriptionService::CreateParams::BillingThresholds), cancel_at: Integer, cancel_at_period_end: T::Boolean, collection_method: String, coupon: String, currency: String, customer: String, days_until_due: Integer, default_payment_method: String, default_source: String, default_tax_rates: T.nilable(T::Array[String]), description: String, discounts: T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::Discount]), expand: T::Array[String], invoice_settings: ::Stripe::SubscriptionService::CreateParams::InvoiceSettings, items: T::Array[::Stripe::SubscriptionService::CreateParams::Item], metadata: T.nilable(T::Hash[String, String]), off_session: T::Boolean, on_behalf_of: T.nilable(String), payment_behavior: String, payment_settings: ::Stripe::SubscriptionService::CreateParams::PaymentSettings, pending_invoice_item_interval: T.nilable(::Stripe::SubscriptionService::CreateParams::PendingInvoiceItemInterval), prebilling: ::Stripe::SubscriptionService::CreateParams::Prebilling, promotion_code: String, proration_behavior: String, transfer_data: ::Stripe::SubscriptionService::CreateParams::TransferData, trial_end: T.any(String, Integer), trial_from_plan: T::Boolean, trial_period_days: Integer, trial_settings: ::Stripe::SubscriptionService::CreateParams::TrialSettings).void
1710
+ }
1711
+ def initialize(
1712
+ add_invoice_items: nil,
1713
+ application_fee_percent: nil,
1714
+ automatic_tax: nil,
1715
+ backdate_start_date: nil,
1716
+ billing_cycle_anchor: nil,
1717
+ billing_cycle_anchor_config: nil,
1718
+ billing_thresholds: nil,
1719
+ cancel_at: nil,
1720
+ cancel_at_period_end: nil,
1721
+ collection_method: nil,
1722
+ coupon: nil,
1723
+ currency: nil,
1724
+ customer: nil,
1725
+ days_until_due: nil,
1726
+ default_payment_method: nil,
1727
+ default_source: nil,
1728
+ default_tax_rates: nil,
1729
+ description: nil,
1730
+ discounts: nil,
1731
+ expand: nil,
1732
+ invoice_settings: nil,
1733
+ items: nil,
1734
+ metadata: nil,
1735
+ off_session: nil,
1736
+ on_behalf_of: nil,
1737
+ payment_behavior: nil,
1738
+ payment_settings: nil,
1739
+ pending_invoice_item_interval: nil,
1740
+ prebilling: nil,
1741
+ promotion_code: nil,
1742
+ proration_behavior: nil,
1743
+ transfer_data: nil,
1744
+ trial_end: nil,
1745
+ trial_from_plan: nil,
1746
+ trial_period_days: nil,
1747
+ trial_settings: nil
1748
+ ); end
1749
+ end
1750
+ class SearchParams < Stripe::RequestParams
1751
+ # Specifies which fields in the response should be expanded.
1752
+ sig { returns(T::Array[String]) }
1753
+ attr_accessor :expand
1754
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1755
+ sig { returns(Integer) }
1756
+ attr_accessor :limit
1757
+ # A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
1758
+ sig { returns(String) }
1759
+ attr_accessor :page
1760
+ # The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions).
1761
+ sig { returns(String) }
1762
+ attr_accessor :query
1763
+ sig { params(expand: T::Array[String], limit: Integer, page: String, query: String).void }
1764
+ def initialize(expand: nil, limit: nil, page: nil, query: nil); end
1765
+ end
1766
+ class ResumeParams < Stripe::RequestParams
1767
+ # The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
1768
+ sig { returns(String) }
1769
+ attr_accessor :billing_cycle_anchor
1770
+ # Specifies which fields in the response should be expanded.
1771
+ sig { returns(T::Array[String]) }
1772
+ attr_accessor :expand
1773
+ # 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`.
1774
+ sig { returns(String) }
1775
+ attr_accessor :proration_behavior
1776
+ # If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
1777
+ sig { returns(Integer) }
1778
+ attr_accessor :proration_date
1779
+ sig {
1780
+ params(billing_cycle_anchor: String, expand: T::Array[String], proration_behavior: String, proration_date: Integer).void
1781
+ }
1782
+ def initialize(
1783
+ billing_cycle_anchor: nil,
1784
+ expand: nil,
1785
+ proration_behavior: nil,
1786
+ proration_date: nil
1787
+ ); end
1788
+ end
1789
+ # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://stripe.com/metadata).
1790
+ #
1791
+ # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed.
1792
+ #
1793
+ # By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
1794
+ sig {
1795
+ params(subscription_exposed_id: String, params: T.any(::Stripe::SubscriptionService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
1796
+ }
1797
+ def cancel(subscription_exposed_id, params = {}, opts = {}); end
1798
+
1799
+ # Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
1800
+ #
1801
+ # When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.
1802
+ # The payment_behavior parameter determines the exact behavior of the initial payment.
1803
+ #
1804
+ # To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead.
1805
+ # Schedules provide the flexibility to model more complex billing configurations that change over time.
1806
+ sig {
1807
+ params(params: T.any(::Stripe::SubscriptionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
1808
+ }
1809
+ def create(params = {}, opts = {}); end
1810
+
1811
+ # Removes the currently applied discount on a subscription.
1812
+ sig {
1813
+ params(subscription_exposed_id: String, params: T.any(::Stripe::SubscriptionService::DeleteDiscountParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Discount)
1814
+ }
1815
+ def delete_discount(subscription_exposed_id, params = {}, opts = {}); end
1816
+
1817
+ # By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
1818
+ sig {
1819
+ params(params: T.any(::Stripe::SubscriptionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
1820
+ }
1821
+ def list(params = {}, opts = {}); end
1822
+
1823
+ # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.
1824
+ sig {
1825
+ params(subscription: String, params: T.any(::Stripe::SubscriptionService::ResumeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
1826
+ }
1827
+ def resume(subscription, params = {}, opts = {}); end
1828
+
1829
+ # Retrieves the subscription with the given ID.
1830
+ sig {
1831
+ params(subscription_exposed_id: String, params: T.any(::Stripe::SubscriptionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
1832
+ }
1833
+ def retrieve(subscription_exposed_id, params = {}, opts = {}); end
1834
+
1835
+ # Search for subscriptions you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
1836
+ # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
1837
+ # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
1838
+ # to an hour behind during outages. Search functionality is not available to merchants in India.
1839
+ sig {
1840
+ params(params: T.any(::Stripe::SubscriptionService::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
1841
+ }
1842
+ def search(params = {}, opts = {}); end
1843
+
1844
+ # Updates an existing subscription to match the specified parameters.
1845
+ # When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.
1846
+ # To preview how the proration is calculated, use the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint.
1847
+ #
1848
+ # By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.
1849
+ #
1850
+ # Switching prices does not normally change the billing date or generate an immediate charge unless:
1851
+ #
1852
+ #
1853
+ # The billing interval is changed (for example, from monthly to yearly).
1854
+ # The subscription moves from free to paid.
1855
+ # A trial starts or ends.
1856
+ #
1857
+ #
1858
+ # In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment).
1859
+ #
1860
+ # If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://stripe.com/docs/api/invoices/create).
1861
+ #
1862
+ # If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription.
1863
+ #
1864
+ # Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating <a href="/docs/billing/subscriptions/usage-based">usage-based billing](https://stripe.com/docs/rate-limits) instead.
1865
+ sig {
1866
+ params(subscription_exposed_id: String, params: T.any(::Stripe::SubscriptionService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription)
1867
+ }
1868
+ def update(subscription_exposed_id, params = {}, opts = {}); end
1869
+ end
1870
+ end