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,2582 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # typed: true
5
+ module Stripe
6
+ module Checkout
7
+ class SessionService < StripeService
8
+ attr_reader :line_items
9
+ class ListParams < Stripe::RequestParams
10
+ class Created < Stripe::RequestParams
11
+ # Minimum value to filter by (exclusive)
12
+ sig { returns(Integer) }
13
+ attr_accessor :gt
14
+ # Minimum value to filter by (inclusive)
15
+ sig { returns(Integer) }
16
+ attr_accessor :gte
17
+ # Maximum value to filter by (exclusive)
18
+ sig { returns(Integer) }
19
+ attr_accessor :lt
20
+ # Maximum value to filter by (inclusive)
21
+ sig { returns(Integer) }
22
+ attr_accessor :lte
23
+ sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
24
+ def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
25
+ end
26
+ class CustomerDetails < Stripe::RequestParams
27
+ # Customer's email address.
28
+ sig { returns(String) }
29
+ attr_accessor :email
30
+ sig { params(email: String).void }
31
+ def initialize(email: nil); end
32
+ end
33
+ # Only return Checkout Sessions that were created during the given date interval.
34
+ sig { returns(T.any(::Stripe::Checkout::SessionService::ListParams::Created, Integer)) }
35
+ attr_accessor :created
36
+ # Only return the Checkout Sessions for the Customer specified.
37
+ sig { returns(String) }
38
+ attr_accessor :customer
39
+ # Only return the Checkout Sessions for the Customer details specified.
40
+ sig { returns(::Stripe::Checkout::SessionService::ListParams::CustomerDetails) }
41
+ attr_accessor :customer_details
42
+ # 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.
43
+ sig { returns(String) }
44
+ attr_accessor :ending_before
45
+ # Specifies which fields in the response should be expanded.
46
+ sig { returns(T::Array[String]) }
47
+ attr_accessor :expand
48
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
49
+ sig { returns(Integer) }
50
+ attr_accessor :limit
51
+ # Only return the Checkout Session for the PaymentIntent specified.
52
+ sig { returns(String) }
53
+ attr_accessor :payment_intent
54
+ # Only return the Checkout Sessions for the Payment Link specified.
55
+ sig { returns(String) }
56
+ attr_accessor :payment_link
57
+ # 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.
58
+ sig { returns(String) }
59
+ attr_accessor :starting_after
60
+ # Only return the Checkout Sessions matching the given status.
61
+ sig { returns(String) }
62
+ attr_accessor :status
63
+ # Only return the Checkout Session for the subscription specified.
64
+ sig { returns(String) }
65
+ attr_accessor :subscription
66
+ sig {
67
+ params(created: T.any(::Stripe::Checkout::SessionService::ListParams::Created, Integer), customer: String, customer_details: ::Stripe::Checkout::SessionService::ListParams::CustomerDetails, ending_before: String, expand: T::Array[String], limit: Integer, payment_intent: String, payment_link: String, starting_after: String, status: String, subscription: String).void
68
+ }
69
+ def initialize(
70
+ created: nil,
71
+ customer: nil,
72
+ customer_details: nil,
73
+ ending_before: nil,
74
+ expand: nil,
75
+ limit: nil,
76
+ payment_intent: nil,
77
+ payment_link: nil,
78
+ starting_after: nil,
79
+ status: nil,
80
+ subscription: nil
81
+ ); end
82
+ end
83
+ class CreateParams < Stripe::RequestParams
84
+ class AdaptivePricing < Stripe::RequestParams
85
+ # Set to `true` to enable [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). Defaults to your [dashboard setting](https://dashboard.stripe.com/settings/adaptive-pricing).
86
+ sig { returns(T::Boolean) }
87
+ attr_accessor :enabled
88
+ sig { params(enabled: T::Boolean).void }
89
+ def initialize(enabled: nil); end
90
+ end
91
+ class AfterExpiration < Stripe::RequestParams
92
+ class Recovery < Stripe::RequestParams
93
+ # Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
94
+ sig { returns(T::Boolean) }
95
+ attr_accessor :allow_promotion_codes
96
+ # If `true`, a recovery URL will be generated to recover this Checkout Session if it
97
+ # expires before a successful transaction is completed. It will be attached to the
98
+ # Checkout Session object upon expiration.
99
+ sig { returns(T::Boolean) }
100
+ attr_accessor :enabled
101
+ sig { params(allow_promotion_codes: T::Boolean, enabled: T::Boolean).void }
102
+ def initialize(allow_promotion_codes: nil, enabled: nil); end
103
+ end
104
+ # Configure a Checkout Session that can be used to recover an expired session.
105
+ sig {
106
+ returns(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration::Recovery)
107
+ }
108
+ attr_accessor :recovery
109
+ sig {
110
+ params(recovery: ::Stripe::Checkout::SessionService::CreateParams::AfterExpiration::Recovery).void
111
+ }
112
+ def initialize(recovery: nil); end
113
+ end
114
+ class AutomaticTax < Stripe::RequestParams
115
+ class Liability < Stripe::RequestParams
116
+ # The connected account being referenced when `type` is `account`.
117
+ sig { returns(String) }
118
+ attr_accessor :account
119
+ # Type of the account referenced in the request.
120
+ sig { returns(String) }
121
+ attr_accessor :type
122
+ sig { params(account: String, type: String).void }
123
+ def initialize(account: nil, type: nil); end
124
+ end
125
+ # Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
126
+ #
127
+ # Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.
128
+ sig { returns(T::Boolean) }
129
+ attr_accessor :enabled
130
+ # 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.
131
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax::Liability) }
132
+ attr_accessor :liability
133
+ sig {
134
+ params(enabled: T::Boolean, liability: ::Stripe::Checkout::SessionService::CreateParams::AutomaticTax::Liability).void
135
+ }
136
+ def initialize(enabled: nil, liability: nil); end
137
+ end
138
+ class ConsentCollection < Stripe::RequestParams
139
+ class PaymentMethodReuseAgreement < Stripe::RequestParams
140
+ # Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
141
+ # defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
142
+ sig { returns(String) }
143
+ attr_accessor :position
144
+ sig { params(position: String).void }
145
+ def initialize(position: nil); end
146
+ end
147
+ # Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.
148
+ sig {
149
+ returns(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement)
150
+ }
151
+ attr_accessor :payment_method_reuse_agreement
152
+ # If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
153
+ # Session will determine whether to display an option to opt into promotional communication
154
+ # from the merchant depending on the customer's locale. Only available to US merchants.
155
+ sig { returns(String) }
156
+ attr_accessor :promotions
157
+ # If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
158
+ # There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
159
+ sig { returns(String) }
160
+ attr_accessor :terms_of_service
161
+ sig {
162
+ params(payment_method_reuse_agreement: ::Stripe::Checkout::SessionService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement, promotions: String, terms_of_service: String).void
163
+ }
164
+ def initialize(
165
+ payment_method_reuse_agreement: nil,
166
+ promotions: nil,
167
+ terms_of_service: nil
168
+ ); end
169
+ end
170
+ class CustomField < Stripe::RequestParams
171
+ class Dropdown < Stripe::RequestParams
172
+ class Option < Stripe::RequestParams
173
+ # The label for the option, displayed to the customer. Up to 100 characters.
174
+ sig { returns(String) }
175
+ attr_accessor :label
176
+ # The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
177
+ sig { returns(String) }
178
+ attr_accessor :value
179
+ sig { params(label: String, value: String).void }
180
+ def initialize(label: nil, value: nil); end
181
+ end
182
+ # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
183
+ sig { returns(String) }
184
+ attr_accessor :default_value
185
+ # The options available for the customer to select. Up to 200 options allowed.
186
+ sig {
187
+ returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown::Option])
188
+ }
189
+ attr_accessor :options
190
+ sig {
191
+ params(default_value: String, options: T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown::Option]).void
192
+ }
193
+ def initialize(default_value: nil, options: nil); end
194
+ end
195
+ class Label < Stripe::RequestParams
196
+ # Custom text for the label, displayed to the customer. Up to 50 characters.
197
+ sig { returns(String) }
198
+ attr_accessor :custom
199
+ # The type of the label.
200
+ sig { returns(String) }
201
+ attr_accessor :type
202
+ sig { params(custom: String, type: String).void }
203
+ def initialize(custom: nil, type: nil); end
204
+ end
205
+ class Numeric < Stripe::RequestParams
206
+ # The value that will pre-fill the field on the payment page.
207
+ sig { returns(String) }
208
+ attr_accessor :default_value
209
+ # The maximum character length constraint for the customer's input.
210
+ sig { returns(Integer) }
211
+ attr_accessor :maximum_length
212
+ # The minimum character length requirement for the customer's input.
213
+ sig { returns(Integer) }
214
+ attr_accessor :minimum_length
215
+ sig {
216
+ params(default_value: String, maximum_length: Integer, minimum_length: Integer).void
217
+ }
218
+ def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
219
+ end
220
+ class Text < Stripe::RequestParams
221
+ # The value that will pre-fill the field on the payment page.
222
+ sig { returns(String) }
223
+ attr_accessor :default_value
224
+ # The maximum character length constraint for the customer's input.
225
+ sig { returns(Integer) }
226
+ attr_accessor :maximum_length
227
+ # The minimum character length requirement for the customer's input.
228
+ sig { returns(Integer) }
229
+ attr_accessor :minimum_length
230
+ sig {
231
+ params(default_value: String, maximum_length: Integer, minimum_length: Integer).void
232
+ }
233
+ def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
234
+ end
235
+ # Configuration for `type=dropdown` fields.
236
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown) }
237
+ attr_accessor :dropdown
238
+ # String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
239
+ sig { returns(String) }
240
+ attr_accessor :key
241
+ # The label for the field, displayed to the customer.
242
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomField::Label) }
243
+ attr_accessor :label
244
+ # Configuration for `type=numeric` fields.
245
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomField::Numeric) }
246
+ attr_accessor :numeric
247
+ # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
248
+ sig { returns(T::Boolean) }
249
+ attr_accessor :optional
250
+ # Configuration for `type=text` fields.
251
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomField::Text) }
252
+ attr_accessor :text
253
+ # The type of the field.
254
+ sig { returns(String) }
255
+ attr_accessor :type
256
+ sig {
257
+ params(dropdown: ::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown, key: String, label: ::Stripe::Checkout::SessionService::CreateParams::CustomField::Label, numeric: ::Stripe::Checkout::SessionService::CreateParams::CustomField::Numeric, optional: T::Boolean, text: ::Stripe::Checkout::SessionService::CreateParams::CustomField::Text, type: String).void
258
+ }
259
+ def initialize(
260
+ dropdown: nil,
261
+ key: nil,
262
+ label: nil,
263
+ numeric: nil,
264
+ optional: nil,
265
+ text: nil,
266
+ type: nil
267
+ ); end
268
+ end
269
+ class CustomText < Stripe::RequestParams
270
+ class AfterSubmit < Stripe::RequestParams
271
+ # Text may be up to 1200 characters in length.
272
+ sig { returns(String) }
273
+ attr_accessor :message
274
+ sig { params(message: String).void }
275
+ def initialize(message: nil); end
276
+ end
277
+ class ShippingAddress < Stripe::RequestParams
278
+ # Text may be up to 1200 characters in length.
279
+ sig { returns(String) }
280
+ attr_accessor :message
281
+ sig { params(message: String).void }
282
+ def initialize(message: nil); end
283
+ end
284
+ class Submit < Stripe::RequestParams
285
+ # Text may be up to 1200 characters in length.
286
+ sig { returns(String) }
287
+ attr_accessor :message
288
+ sig { params(message: String).void }
289
+ def initialize(message: nil); end
290
+ end
291
+ class TermsOfServiceAcceptance < Stripe::RequestParams
292
+ # Text may be up to 1200 characters in length.
293
+ sig { returns(String) }
294
+ attr_accessor :message
295
+ sig { params(message: String).void }
296
+ def initialize(message: nil); end
297
+ end
298
+ # Custom text that should be displayed after the payment confirmation button.
299
+ sig {
300
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::AfterSubmit))
301
+ }
302
+ attr_accessor :after_submit
303
+ # Custom text that should be displayed alongside shipping address collection.
304
+ sig {
305
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::ShippingAddress))
306
+ }
307
+ attr_accessor :shipping_address
308
+ # Custom text that should be displayed alongside the payment confirmation button.
309
+ sig {
310
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::Submit))
311
+ }
312
+ attr_accessor :submit
313
+ # Custom text that should be displayed in place of the default terms of service agreement text.
314
+ sig {
315
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::TermsOfServiceAcceptance))
316
+ }
317
+ attr_accessor :terms_of_service_acceptance
318
+ sig {
319
+ params(after_submit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::AfterSubmit), shipping_address: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::ShippingAddress), submit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::Submit), terms_of_service_acceptance: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText::TermsOfServiceAcceptance)).void
320
+ }
321
+ def initialize(
322
+ after_submit: nil,
323
+ shipping_address: nil,
324
+ submit: nil,
325
+ terms_of_service_acceptance: nil
326
+ ); end
327
+ end
328
+ class CustomerUpdate < Stripe::RequestParams
329
+ # Describes whether Checkout saves the billing address onto `customer.address`.
330
+ # To always collect a full billing address, use `billing_address_collection`. Defaults to `never`.
331
+ sig { returns(String) }
332
+ attr_accessor :address
333
+ # Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.
334
+ sig { returns(String) }
335
+ attr_accessor :name
336
+ # Describes whether Checkout saves shipping information onto `customer.shipping`.
337
+ # To collect shipping information, use `shipping_address_collection`. Defaults to `never`.
338
+ sig { returns(String) }
339
+ attr_accessor :shipping
340
+ sig { params(address: String, name: String, shipping: String).void }
341
+ def initialize(address: nil, name: nil, shipping: nil); end
342
+ end
343
+ class Discount < Stripe::RequestParams
344
+ # The ID of the coupon to apply to this Session.
345
+ sig { returns(String) }
346
+ attr_accessor :coupon
347
+ # The ID of a promotion code to apply to this Session.
348
+ sig { returns(String) }
349
+ attr_accessor :promotion_code
350
+ sig { params(coupon: String, promotion_code: String).void }
351
+ def initialize(coupon: nil, promotion_code: nil); end
352
+ end
353
+ class InvoiceCreation < Stripe::RequestParams
354
+ class InvoiceData < Stripe::RequestParams
355
+ class CustomField < Stripe::RequestParams
356
+ # The name of the custom field. This may be up to 40 characters.
357
+ sig { returns(String) }
358
+ attr_accessor :name
359
+ # The value of the custom field. This may be up to 140 characters.
360
+ sig { returns(String) }
361
+ attr_accessor :value
362
+ sig { params(name: String, value: String).void }
363
+ def initialize(name: nil, value: nil); end
364
+ end
365
+ class Issuer < Stripe::RequestParams
366
+ # The connected account being referenced when `type` is `account`.
367
+ sig { returns(String) }
368
+ attr_accessor :account
369
+ # Type of the account referenced in the request.
370
+ sig { returns(String) }
371
+ attr_accessor :type
372
+ sig { params(account: String, type: String).void }
373
+ def initialize(account: nil, type: nil); end
374
+ end
375
+ class RenderingOptions < Stripe::RequestParams
376
+ # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
377
+ sig { returns(T.nilable(String)) }
378
+ attr_accessor :amount_tax_display
379
+ sig { params(amount_tax_display: T.nilable(String)).void }
380
+ def initialize(amount_tax_display: nil); end
381
+ end
382
+ # The account tax IDs associated with the invoice.
383
+ sig { returns(T.nilable(T::Array[String])) }
384
+ attr_accessor :account_tax_ids
385
+ # Default custom fields to be displayed on invoices for this customer.
386
+ sig {
387
+ returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::CustomField]))
388
+ }
389
+ attr_accessor :custom_fields
390
+ # An arbitrary string attached to the object. Often useful for displaying to users.
391
+ sig { returns(String) }
392
+ attr_accessor :description
393
+ # Default footer to be displayed on invoices for this customer.
394
+ sig { returns(String) }
395
+ attr_accessor :footer
396
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
397
+ sig {
398
+ returns(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::Issuer)
399
+ }
400
+ attr_accessor :issuer
401
+ # 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`.
402
+ sig { returns(T::Hash[String, String]) }
403
+ attr_accessor :metadata
404
+ # Default options for invoice PDF rendering for this customer.
405
+ sig {
406
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))
407
+ }
408
+ attr_accessor :rendering_options
409
+ sig {
410
+ params(account_tax_ids: T.nilable(T::Array[String]), custom_fields: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::CustomField]), description: String, footer: String, issuer: ::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::Issuer, metadata: T::Hash[String, String], rendering_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)).void
411
+ }
412
+ def initialize(
413
+ account_tax_ids: nil,
414
+ custom_fields: nil,
415
+ description: nil,
416
+ footer: nil,
417
+ issuer: nil,
418
+ metadata: nil,
419
+ rendering_options: nil
420
+ ); end
421
+ end
422
+ # Set to `true` to enable invoice creation.
423
+ sig { returns(T::Boolean) }
424
+ attr_accessor :enabled
425
+ # Parameters passed when creating invoices for payment-mode Checkout Sessions.
426
+ sig {
427
+ returns(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData)
428
+ }
429
+ attr_accessor :invoice_data
430
+ sig {
431
+ params(enabled: T::Boolean, invoice_data: ::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData).void
432
+ }
433
+ def initialize(enabled: nil, invoice_data: nil); end
434
+ end
435
+ class LineItem < Stripe::RequestParams
436
+ class AdjustableQuantity < Stripe::RequestParams
437
+ # Set to true if the quantity can be adjusted to any non-negative integer.
438
+ sig { returns(T::Boolean) }
439
+ attr_accessor :enabled
440
+ # The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
441
+ sig { returns(Integer) }
442
+ attr_accessor :maximum
443
+ # The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
444
+ sig { returns(Integer) }
445
+ attr_accessor :minimum
446
+ sig { params(enabled: T::Boolean, maximum: Integer, minimum: Integer).void }
447
+ def initialize(enabled: nil, maximum: nil, minimum: nil); end
448
+ end
449
+ class PriceData < Stripe::RequestParams
450
+ class ProductData < Stripe::RequestParams
451
+ # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
452
+ sig { returns(String) }
453
+ attr_accessor :description
454
+ # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
455
+ sig { returns(T::Array[String]) }
456
+ attr_accessor :images
457
+ # 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`.
458
+ sig { returns(T::Hash[String, String]) }
459
+ attr_accessor :metadata
460
+ # The product's name, meant to be displayable to the customer.
461
+ sig { returns(String) }
462
+ attr_accessor :name
463
+ # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
464
+ sig { returns(String) }
465
+ attr_accessor :tax_code
466
+ sig {
467
+ params(description: String, images: T::Array[String], metadata: T::Hash[String, String], name: String, tax_code: String).void
468
+ }
469
+ def initialize(
470
+ description: nil,
471
+ images: nil,
472
+ metadata: nil,
473
+ name: nil,
474
+ tax_code: nil
475
+ ); end
476
+ end
477
+ class Recurring < Stripe::RequestParams
478
+ # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
479
+ sig { returns(String) }
480
+ attr_accessor :interval
481
+ # 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).
482
+ sig { returns(Integer) }
483
+ attr_accessor :interval_count
484
+ sig { params(interval: String, interval_count: Integer).void }
485
+ def initialize(interval: nil, interval_count: nil); end
486
+ end
487
+ # 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).
488
+ sig { returns(String) }
489
+ attr_accessor :currency
490
+ # The ID of the product that this price will belong to. One of `product` or `product_data` is required.
491
+ sig { returns(String) }
492
+ attr_accessor :product
493
+ # Data used to generate a new product object inline. One of `product` or `product_data` is required.
494
+ sig {
495
+ returns(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::ProductData)
496
+ }
497
+ attr_accessor :product_data
498
+ # The recurring components of a price such as `interval` and `interval_count`.
499
+ sig {
500
+ returns(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::Recurring)
501
+ }
502
+ attr_accessor :recurring
503
+ # 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.
504
+ sig { returns(String) }
505
+ attr_accessor :tax_behavior
506
+ # A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
507
+ sig { returns(Integer) }
508
+ attr_accessor :unit_amount
509
+ # 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.
510
+ sig { returns(String) }
511
+ attr_accessor :unit_amount_decimal
512
+ sig {
513
+ params(currency: String, product: String, product_data: ::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::ProductData, recurring: ::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
514
+ }
515
+ def initialize(
516
+ currency: nil,
517
+ product: nil,
518
+ product_data: nil,
519
+ recurring: nil,
520
+ tax_behavior: nil,
521
+ unit_amount: nil,
522
+ unit_amount_decimal: nil
523
+ ); end
524
+ end
525
+ # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
526
+ sig {
527
+ returns(::Stripe::Checkout::SessionService::CreateParams::LineItem::AdjustableQuantity)
528
+ }
529
+ attr_accessor :adjustable_quantity
530
+ # The [tax rates](https://stripe.com/docs/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.
531
+ sig { returns(T::Array[String]) }
532
+ attr_accessor :dynamic_tax_rates
533
+ # 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`.
534
+ sig { returns(T::Hash[String, String]) }
535
+ attr_accessor :metadata
536
+ # The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.
537
+ sig { returns(String) }
538
+ attr_accessor :price
539
+ # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
540
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData) }
541
+ attr_accessor :price_data
542
+ # The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
543
+ sig { returns(Integer) }
544
+ attr_accessor :quantity
545
+ # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
546
+ sig { returns(T::Array[String]) }
547
+ attr_accessor :tax_rates
548
+ sig {
549
+ params(adjustable_quantity: ::Stripe::Checkout::SessionService::CreateParams::LineItem::AdjustableQuantity, dynamic_tax_rates: T::Array[String], metadata: T::Hash[String, String], price: String, price_data: ::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData, quantity: Integer, tax_rates: T::Array[String]).void
550
+ }
551
+ def initialize(
552
+ adjustable_quantity: nil,
553
+ dynamic_tax_rates: nil,
554
+ metadata: nil,
555
+ price: nil,
556
+ price_data: nil,
557
+ quantity: nil,
558
+ tax_rates: nil
559
+ ); end
560
+ end
561
+ class PaymentIntentData < Stripe::RequestParams
562
+ class Shipping < Stripe::RequestParams
563
+ class Address < Stripe::RequestParams
564
+ # City, district, suburb, town, or village.
565
+ sig { returns(String) }
566
+ attr_accessor :city
567
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
568
+ sig { returns(String) }
569
+ attr_accessor :country
570
+ # Address line 1 (e.g., street, PO Box, or company name).
571
+ sig { returns(String) }
572
+ attr_accessor :line1
573
+ # Address line 2 (e.g., apartment, suite, unit, or building).
574
+ sig { returns(String) }
575
+ attr_accessor :line2
576
+ # ZIP or postal code.
577
+ sig { returns(String) }
578
+ attr_accessor :postal_code
579
+ # State, county, province, or region.
580
+ sig { returns(String) }
581
+ attr_accessor :state
582
+ sig {
583
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
584
+ }
585
+ def initialize(
586
+ city: nil,
587
+ country: nil,
588
+ line1: nil,
589
+ line2: nil,
590
+ postal_code: nil,
591
+ state: nil
592
+ ); end
593
+ end
594
+ # Shipping address.
595
+ sig {
596
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping::Address)
597
+ }
598
+ attr_accessor :address
599
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
600
+ sig { returns(String) }
601
+ attr_accessor :carrier
602
+ # Recipient name.
603
+ sig { returns(String) }
604
+ attr_accessor :name
605
+ # Recipient phone (including extension).
606
+ sig { returns(String) }
607
+ attr_accessor :phone
608
+ # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
609
+ sig { returns(String) }
610
+ attr_accessor :tracking_number
611
+ sig {
612
+ params(address: ::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping::Address, carrier: String, name: String, phone: String, tracking_number: String).void
613
+ }
614
+ def initialize(
615
+ address: nil,
616
+ carrier: nil,
617
+ name: nil,
618
+ phone: nil,
619
+ tracking_number: nil
620
+ ); end
621
+ end
622
+ class TransferData < Stripe::RequestParams
623
+ # The amount that will be transferred automatically when a charge succeeds.
624
+ sig { returns(Integer) }
625
+ attr_accessor :amount
626
+ # If specified, successful charges will be attributed to the destination
627
+ # account for tax reporting, and the funds from charges will be transferred
628
+ # to the destination account. The ID of the resulting transfer will be
629
+ # returned on the successful charge's `transfer` field.
630
+ sig { returns(String) }
631
+ attr_accessor :destination
632
+ sig { params(amount: Integer, destination: String).void }
633
+ def initialize(amount: nil, destination: nil); end
634
+ end
635
+ # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
636
+ sig { returns(Integer) }
637
+ attr_accessor :application_fee_amount
638
+ # Controls when the funds will be captured from the customer's account.
639
+ sig { returns(String) }
640
+ attr_accessor :capture_method
641
+ # An arbitrary string attached to the object. Often useful for displaying to users.
642
+ sig { returns(String) }
643
+ attr_accessor :description
644
+ # 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`.
645
+ sig { returns(T::Hash[String, String]) }
646
+ attr_accessor :metadata
647
+ # The Stripe account ID for which these funds are intended. For details,
648
+ # see the PaymentIntents [use case for connected
649
+ # accounts](/docs/payments/connected-accounts).
650
+ sig { returns(String) }
651
+ attr_accessor :on_behalf_of
652
+ # Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
653
+ sig { returns(String) }
654
+ attr_accessor :receipt_email
655
+ # Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment
656
+ # method collected by this Checkout Session.
657
+ #
658
+ # When setting this to `on_session`, Checkout will show a notice to the
659
+ # customer that their payment details will be saved.
660
+ #
661
+ # When setting this to `off_session`, Checkout will show a notice to the
662
+ # customer that their payment details will be saved and used for future
663
+ # payments.
664
+ #
665
+ # If a Customer has been provided or Checkout creates a new Customer,
666
+ # Checkout will attach the payment method to the Customer.
667
+ #
668
+ # If Checkout does not create a Customer, the payment method is not attached
669
+ # to a Customer. To reuse the payment method, you can retrieve it from the
670
+ # Checkout Session's PaymentIntent.
671
+ #
672
+ # When processing card payments, Checkout also uses `setup_future_usage`
673
+ # to dynamically optimize your payment flow and comply with regional
674
+ # legislation and network rules, such as SCA.
675
+ sig { returns(String) }
676
+ attr_accessor :setup_future_usage
677
+ # Shipping information for this payment.
678
+ sig {
679
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping)
680
+ }
681
+ attr_accessor :shipping
682
+ # Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
683
+ #
684
+ # Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
685
+ sig { returns(String) }
686
+ attr_accessor :statement_descriptor
687
+ # Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
688
+ sig { returns(String) }
689
+ attr_accessor :statement_descriptor_suffix
690
+ # The parameters used to automatically create a Transfer when the payment succeeds.
691
+ # For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
692
+ sig {
693
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::TransferData)
694
+ }
695
+ attr_accessor :transfer_data
696
+ # A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
697
+ sig { returns(String) }
698
+ attr_accessor :transfer_group
699
+ sig {
700
+ params(application_fee_amount: Integer, capture_method: String, description: String, metadata: T::Hash[String, String], on_behalf_of: String, receipt_email: String, setup_future_usage: String, shipping: ::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping, statement_descriptor: String, statement_descriptor_suffix: String, transfer_data: ::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::TransferData, transfer_group: String).void
701
+ }
702
+ def initialize(
703
+ application_fee_amount: nil,
704
+ capture_method: nil,
705
+ description: nil,
706
+ metadata: nil,
707
+ on_behalf_of: nil,
708
+ receipt_email: nil,
709
+ setup_future_usage: nil,
710
+ shipping: nil,
711
+ statement_descriptor: nil,
712
+ statement_descriptor_suffix: nil,
713
+ transfer_data: nil,
714
+ transfer_group: nil
715
+ ); end
716
+ end
717
+ class PaymentMethodData < Stripe::RequestParams
718
+ # Allow redisplay will be set on the payment method on confirmation and indicates whether this payment method can be shown again to the customer in a checkout flow. Only set this field if you wish to override the allow_redisplay value determined by Checkout.
719
+ sig { returns(String) }
720
+ attr_accessor :allow_redisplay
721
+ sig { params(allow_redisplay: String).void }
722
+ def initialize(allow_redisplay: nil); end
723
+ end
724
+ class PaymentMethodOptions < Stripe::RequestParams
725
+ class AcssDebit < Stripe::RequestParams
726
+ class MandateOptions < Stripe::RequestParams
727
+ # A URL for custom mandate text to render during confirmation step.
728
+ # The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
729
+ # or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
730
+ sig { returns(T.nilable(String)) }
731
+ attr_accessor :custom_mandate_url
732
+ # List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.
733
+ sig { returns(T::Array[String]) }
734
+ attr_accessor :default_for
735
+ # Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
736
+ sig { returns(String) }
737
+ attr_accessor :interval_description
738
+ # Payment schedule for the mandate.
739
+ sig { returns(String) }
740
+ attr_accessor :payment_schedule
741
+ # Transaction type of the mandate.
742
+ sig { returns(String) }
743
+ attr_accessor :transaction_type
744
+ sig {
745
+ params(custom_mandate_url: T.nilable(String), default_for: T::Array[String], interval_description: String, payment_schedule: String, transaction_type: String).void
746
+ }
747
+ def initialize(
748
+ custom_mandate_url: nil,
749
+ default_for: nil,
750
+ interval_description: nil,
751
+ payment_schedule: nil,
752
+ transaction_type: nil
753
+ ); end
754
+ end
755
+ # 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). This is only accepted for Checkout Sessions in `setup` mode.
756
+ sig { returns(String) }
757
+ attr_accessor :currency
758
+ # Additional fields for Mandate creation
759
+ sig {
760
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions)
761
+ }
762
+ attr_accessor :mandate_options
763
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
764
+ #
765
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
766
+ #
767
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
768
+ #
769
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
770
+ sig { returns(String) }
771
+ attr_accessor :setup_future_usage
772
+ # Verification method for the intent
773
+ sig { returns(String) }
774
+ attr_accessor :verification_method
775
+ sig {
776
+ params(currency: String, mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: String, verification_method: String).void
777
+ }
778
+ def initialize(
779
+ currency: nil,
780
+ mandate_options: nil,
781
+ setup_future_usage: nil,
782
+ verification_method: nil
783
+ ); end
784
+ end
785
+ class Affirm < Stripe::RequestParams
786
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
787
+ #
788
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
789
+ #
790
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
791
+ #
792
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
793
+ sig { returns(String) }
794
+ attr_accessor :setup_future_usage
795
+ sig { params(setup_future_usage: String).void }
796
+ def initialize(setup_future_usage: nil); end
797
+ end
798
+ class AfterpayClearpay < Stripe::RequestParams
799
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
800
+ #
801
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
802
+ #
803
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
804
+ #
805
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
806
+ sig { returns(String) }
807
+ attr_accessor :setup_future_usage
808
+ sig { params(setup_future_usage: String).void }
809
+ def initialize(setup_future_usage: nil); end
810
+ end
811
+ class Alipay < Stripe::RequestParams
812
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
813
+ #
814
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
815
+ #
816
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
817
+ #
818
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
819
+ sig { returns(String) }
820
+ attr_accessor :setup_future_usage
821
+ sig { params(setup_future_usage: String).void }
822
+ def initialize(setup_future_usage: nil); end
823
+ end
824
+ class AmazonPay < Stripe::RequestParams
825
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
826
+ #
827
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
828
+ #
829
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
830
+ #
831
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
832
+ sig { returns(String) }
833
+ attr_accessor :setup_future_usage
834
+ sig { params(setup_future_usage: String).void }
835
+ def initialize(setup_future_usage: nil); end
836
+ end
837
+ class AuBecsDebit < Stripe::RequestParams
838
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
839
+ #
840
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
841
+ #
842
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
843
+ #
844
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
845
+ sig { returns(String) }
846
+ attr_accessor :setup_future_usage
847
+ sig { params(setup_future_usage: String).void }
848
+ def initialize(setup_future_usage: nil); end
849
+ end
850
+ class BacsDebit < Stripe::RequestParams
851
+ class MandateOptions < Stripe::RequestParams
852
+ # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
853
+ sig { returns(T.nilable(String)) }
854
+ attr_accessor :reference_prefix
855
+ sig { params(reference_prefix: T.nilable(String)).void }
856
+ def initialize(reference_prefix: nil); end
857
+ end
858
+ # Additional fields for Mandate creation
859
+ sig {
860
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions)
861
+ }
862
+ attr_accessor :mandate_options
863
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
864
+ #
865
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
866
+ #
867
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
868
+ #
869
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
870
+ sig { returns(String) }
871
+ attr_accessor :setup_future_usage
872
+ sig {
873
+ params(mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions, setup_future_usage: String).void
874
+ }
875
+ def initialize(mandate_options: nil, setup_future_usage: nil); end
876
+ end
877
+ class Bancontact < Stripe::RequestParams
878
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
879
+ #
880
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
881
+ #
882
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
883
+ #
884
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
885
+ sig { returns(String) }
886
+ attr_accessor :setup_future_usage
887
+ sig { params(setup_future_usage: String).void }
888
+ def initialize(setup_future_usage: nil); end
889
+ end
890
+ class Boleto < Stripe::RequestParams
891
+ # The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
892
+ sig { returns(Integer) }
893
+ attr_accessor :expires_after_days
894
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
895
+ #
896
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
897
+ #
898
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
899
+ #
900
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
901
+ sig { returns(String) }
902
+ attr_accessor :setup_future_usage
903
+ sig { params(expires_after_days: Integer, setup_future_usage: String).void }
904
+ def initialize(expires_after_days: nil, setup_future_usage: nil); end
905
+ end
906
+ class Card < Stripe::RequestParams
907
+ class Installments < Stripe::RequestParams
908
+ # Setting to true enables installments for this Checkout Session.
909
+ # Setting to false will prevent any installment plan from applying to a payment.
910
+ sig { returns(T::Boolean) }
911
+ attr_accessor :enabled
912
+ sig { params(enabled: T::Boolean).void }
913
+ def initialize(enabled: nil); end
914
+ end
915
+ # Installment options for card payments
916
+ sig {
917
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Installments)
918
+ }
919
+ attr_accessor :installments
920
+ # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
921
+ sig { returns(String) }
922
+ attr_accessor :request_decremental_authorization
923
+ # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
924
+ sig { returns(String) }
925
+ attr_accessor :request_extended_authorization
926
+ # Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
927
+ sig { returns(String) }
928
+ attr_accessor :request_incremental_authorization
929
+ # Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
930
+ sig { returns(String) }
931
+ attr_accessor :request_multicapture
932
+ # Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
933
+ sig { returns(String) }
934
+ attr_accessor :request_overcapture
935
+ # 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. If not provided, this value defaults to `automatic`. 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.
936
+ sig { returns(String) }
937
+ attr_accessor :request_three_d_secure
938
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
939
+ #
940
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
941
+ #
942
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
943
+ #
944
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
945
+ sig { returns(String) }
946
+ attr_accessor :setup_future_usage
947
+ # Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
948
+ sig { returns(String) }
949
+ attr_accessor :statement_descriptor_suffix_kana
950
+ # Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
951
+ sig { returns(String) }
952
+ attr_accessor :statement_descriptor_suffix_kanji
953
+ sig {
954
+ params(installments: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Installments, request_decremental_authorization: String, request_extended_authorization: String, request_incremental_authorization: String, request_multicapture: String, request_overcapture: String, request_three_d_secure: String, setup_future_usage: String, statement_descriptor_suffix_kana: String, statement_descriptor_suffix_kanji: String).void
955
+ }
956
+ def initialize(
957
+ installments: nil,
958
+ request_decremental_authorization: nil,
959
+ request_extended_authorization: nil,
960
+ request_incremental_authorization: nil,
961
+ request_multicapture: nil,
962
+ request_overcapture: nil,
963
+ request_three_d_secure: nil,
964
+ setup_future_usage: nil,
965
+ statement_descriptor_suffix_kana: nil,
966
+ statement_descriptor_suffix_kanji: nil
967
+ ); end
968
+ end
969
+ class Cashapp < Stripe::RequestParams
970
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
971
+ #
972
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
973
+ #
974
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
975
+ #
976
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
977
+ sig { returns(String) }
978
+ attr_accessor :setup_future_usage
979
+ sig { params(setup_future_usage: String).void }
980
+ def initialize(setup_future_usage: nil); end
981
+ end
982
+ class CustomerBalance < Stripe::RequestParams
983
+ class BankTransfer < Stripe::RequestParams
984
+ class EuBankTransfer < Stripe::RequestParams
985
+ # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
986
+ sig { returns(String) }
987
+ attr_accessor :country
988
+ sig { params(country: String).void }
989
+ def initialize(country: nil); end
990
+ end
991
+ # Configuration for eu_bank_transfer funding type.
992
+ sig {
993
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)
994
+ }
995
+ attr_accessor :eu_bank_transfer
996
+ # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
997
+ #
998
+ # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
999
+ sig { returns(T::Array[String]) }
1000
+ attr_accessor :requested_address_types
1001
+ # The list of bank transfer types that this PaymentIntent is allowed to use for funding.
1002
+ sig { returns(String) }
1003
+ attr_accessor :type
1004
+ sig {
1005
+ params(eu_bank_transfer: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer, requested_address_types: T::Array[String], type: String).void
1006
+ }
1007
+ def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
1008
+ end
1009
+ # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
1010
+ sig {
1011
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer)
1012
+ }
1013
+ attr_accessor :bank_transfer
1014
+ # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
1015
+ sig { returns(String) }
1016
+ attr_accessor :funding_type
1017
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1018
+ #
1019
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1020
+ #
1021
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1022
+ #
1023
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1024
+ sig { returns(String) }
1025
+ attr_accessor :setup_future_usage
1026
+ sig {
1027
+ params(bank_transfer: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer, funding_type: String, setup_future_usage: String).void
1028
+ }
1029
+ def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
1030
+ end
1031
+ class Eps < Stripe::RequestParams
1032
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1033
+ #
1034
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1035
+ #
1036
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1037
+ #
1038
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1039
+ sig { returns(String) }
1040
+ attr_accessor :setup_future_usage
1041
+ sig { params(setup_future_usage: String).void }
1042
+ def initialize(setup_future_usage: nil); end
1043
+ end
1044
+ class Fpx < Stripe::RequestParams
1045
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1046
+ #
1047
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1048
+ #
1049
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1050
+ #
1051
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1052
+ sig { returns(String) }
1053
+ attr_accessor :setup_future_usage
1054
+ sig { params(setup_future_usage: String).void }
1055
+ def initialize(setup_future_usage: nil); end
1056
+ end
1057
+ class Giropay < Stripe::RequestParams
1058
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1059
+ #
1060
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1061
+ #
1062
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1063
+ #
1064
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1065
+ sig { returns(String) }
1066
+ attr_accessor :setup_future_usage
1067
+ sig { params(setup_future_usage: String).void }
1068
+ def initialize(setup_future_usage: nil); end
1069
+ end
1070
+ class Grabpay < Stripe::RequestParams
1071
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1072
+ #
1073
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1074
+ #
1075
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1076
+ #
1077
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1078
+ sig { returns(String) }
1079
+ attr_accessor :setup_future_usage
1080
+ sig { params(setup_future_usage: String).void }
1081
+ def initialize(setup_future_usage: nil); end
1082
+ end
1083
+ class Ideal < Stripe::RequestParams
1084
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1085
+ #
1086
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1087
+ #
1088
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1089
+ #
1090
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1091
+ sig { returns(String) }
1092
+ attr_accessor :setup_future_usage
1093
+ sig { params(setup_future_usage: String).void }
1094
+ def initialize(setup_future_usage: nil); end
1095
+ end
1096
+ class KakaoPay < Stripe::RequestParams
1097
+ # Controls when the funds will be captured from the customer's account.
1098
+ sig { returns(String) }
1099
+ attr_accessor :capture_method
1100
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1101
+ #
1102
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1103
+ #
1104
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1105
+ #
1106
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1107
+ sig { returns(String) }
1108
+ attr_accessor :setup_future_usage
1109
+ sig { params(capture_method: String, setup_future_usage: String).void }
1110
+ def initialize(capture_method: nil, setup_future_usage: nil); end
1111
+ end
1112
+ class Klarna < Stripe::RequestParams
1113
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1114
+ #
1115
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1116
+ #
1117
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1118
+ #
1119
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1120
+ sig { returns(String) }
1121
+ attr_accessor :setup_future_usage
1122
+ sig { params(setup_future_usage: String).void }
1123
+ def initialize(setup_future_usage: nil); end
1124
+ end
1125
+ class Konbini < Stripe::RequestParams
1126
+ # The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
1127
+ sig { returns(Integer) }
1128
+ attr_accessor :expires_after_days
1129
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1130
+ #
1131
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1132
+ #
1133
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1134
+ #
1135
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1136
+ sig { returns(String) }
1137
+ attr_accessor :setup_future_usage
1138
+ sig { params(expires_after_days: Integer, setup_future_usage: String).void }
1139
+ def initialize(expires_after_days: nil, setup_future_usage: nil); end
1140
+ end
1141
+ class KrCard < Stripe::RequestParams
1142
+ # Controls when the funds will be captured from the customer's account.
1143
+ sig { returns(String) }
1144
+ attr_accessor :capture_method
1145
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1146
+ #
1147
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1148
+ #
1149
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1150
+ #
1151
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1152
+ sig { returns(String) }
1153
+ attr_accessor :setup_future_usage
1154
+ sig { params(capture_method: String, setup_future_usage: String).void }
1155
+ def initialize(capture_method: nil, setup_future_usage: nil); end
1156
+ end
1157
+ class Link < Stripe::RequestParams
1158
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1159
+ #
1160
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1161
+ #
1162
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1163
+ #
1164
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1165
+ sig { returns(String) }
1166
+ attr_accessor :setup_future_usage
1167
+ sig { params(setup_future_usage: String).void }
1168
+ def initialize(setup_future_usage: nil); end
1169
+ end
1170
+ class Mobilepay < Stripe::RequestParams
1171
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1172
+ #
1173
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1174
+ #
1175
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1176
+ #
1177
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1178
+ sig { returns(String) }
1179
+ attr_accessor :setup_future_usage
1180
+ sig { params(setup_future_usage: String).void }
1181
+ def initialize(setup_future_usage: nil); end
1182
+ end
1183
+ class Multibanco < Stripe::RequestParams
1184
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1185
+ #
1186
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1187
+ #
1188
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1189
+ #
1190
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1191
+ sig { returns(String) }
1192
+ attr_accessor :setup_future_usage
1193
+ sig { params(setup_future_usage: String).void }
1194
+ def initialize(setup_future_usage: nil); end
1195
+ end
1196
+ class NaverPay < Stripe::RequestParams
1197
+ # Controls when the funds will be captured from the customer's account.
1198
+ sig { returns(String) }
1199
+ attr_accessor :capture_method
1200
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1201
+ #
1202
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1203
+ #
1204
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1205
+ #
1206
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1207
+ sig { returns(String) }
1208
+ attr_accessor :setup_future_usage
1209
+ sig { params(capture_method: String, setup_future_usage: String).void }
1210
+ def initialize(capture_method: nil, setup_future_usage: nil); end
1211
+ end
1212
+ class Oxxo < Stripe::RequestParams
1213
+ # The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
1214
+ sig { returns(Integer) }
1215
+ attr_accessor :expires_after_days
1216
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1217
+ #
1218
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1219
+ #
1220
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1221
+ #
1222
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1223
+ sig { returns(String) }
1224
+ attr_accessor :setup_future_usage
1225
+ sig { params(expires_after_days: Integer, setup_future_usage: String).void }
1226
+ def initialize(expires_after_days: nil, setup_future_usage: nil); end
1227
+ end
1228
+ class P24 < Stripe::RequestParams
1229
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1230
+ #
1231
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1232
+ #
1233
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1234
+ #
1235
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1236
+ sig { returns(String) }
1237
+ attr_accessor :setup_future_usage
1238
+ # Confirm that the payer has accepted the P24 terms and conditions.
1239
+ sig { returns(T::Boolean) }
1240
+ attr_accessor :tos_shown_and_accepted
1241
+ sig { params(setup_future_usage: String, tos_shown_and_accepted: T::Boolean).void }
1242
+ def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
1243
+ end
1244
+ class Payco < Stripe::RequestParams
1245
+ # Controls when the funds will be captured from the customer's account.
1246
+ sig { returns(String) }
1247
+ attr_accessor :capture_method
1248
+ sig { params(capture_method: String).void }
1249
+ def initialize(capture_method: nil); end
1250
+ end
1251
+ class Paynow < Stripe::RequestParams
1252
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1253
+ #
1254
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1255
+ #
1256
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1257
+ #
1258
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1259
+ sig { returns(String) }
1260
+ attr_accessor :setup_future_usage
1261
+ sig { params(setup_future_usage: String).void }
1262
+ def initialize(setup_future_usage: nil); end
1263
+ end
1264
+ class Paypal < Stripe::RequestParams
1265
+ # Controls when the funds will be captured from the customer's account.
1266
+ sig { returns(T.nilable(String)) }
1267
+ attr_accessor :capture_method
1268
+ # [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
1269
+ sig { returns(String) }
1270
+ attr_accessor :preferred_locale
1271
+ # A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
1272
+ sig { returns(String) }
1273
+ attr_accessor :reference
1274
+ # A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
1275
+ sig { returns(String) }
1276
+ attr_accessor :reference_id
1277
+ # The risk correlation ID for an on-session payment using a saved PayPal payment method.
1278
+ sig { returns(String) }
1279
+ attr_accessor :risk_correlation_id
1280
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1281
+ #
1282
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1283
+ #
1284
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1285
+ #
1286
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1287
+ #
1288
+ # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
1289
+ sig { returns(T.nilable(String)) }
1290
+ attr_accessor :setup_future_usage
1291
+ # The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
1292
+ sig { returns(T::Array[String]) }
1293
+ attr_accessor :subsellers
1294
+ sig {
1295
+ params(capture_method: T.nilable(String), preferred_locale: String, reference: String, reference_id: String, risk_correlation_id: String, setup_future_usage: T.nilable(String), subsellers: T::Array[String]).void
1296
+ }
1297
+ def initialize(
1298
+ capture_method: nil,
1299
+ preferred_locale: nil,
1300
+ reference: nil,
1301
+ reference_id: nil,
1302
+ risk_correlation_id: nil,
1303
+ setup_future_usage: nil,
1304
+ subsellers: nil
1305
+ ); end
1306
+ end
1307
+ class Payto < Stripe::RequestParams
1308
+ class MandateOptions < Stripe::RequestParams
1309
+ # Amount that will be collected. It is required when `amount_type` is `fixed`.
1310
+ sig { returns(Integer) }
1311
+ attr_accessor :amount
1312
+ # The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
1313
+ sig { returns(String) }
1314
+ attr_accessor :amount_type
1315
+ # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
1316
+ sig { returns(String) }
1317
+ attr_accessor :end_date
1318
+ # The periodicity at which payments will be collected.
1319
+ sig { returns(String) }
1320
+ attr_accessor :payment_schedule
1321
+ # The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
1322
+ sig { returns(Integer) }
1323
+ attr_accessor :payments_per_period
1324
+ # The purpose for which payments are made. Defaults to retail.
1325
+ sig { returns(String) }
1326
+ attr_accessor :purpose
1327
+ # Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
1328
+ sig { returns(String) }
1329
+ attr_accessor :start_date
1330
+ sig {
1331
+ params(amount: Integer, amount_type: String, end_date: String, payment_schedule: String, payments_per_period: Integer, purpose: String, start_date: String).void
1332
+ }
1333
+ def initialize(
1334
+ amount: nil,
1335
+ amount_type: nil,
1336
+ end_date: nil,
1337
+ payment_schedule: nil,
1338
+ payments_per_period: nil,
1339
+ purpose: nil,
1340
+ start_date: nil
1341
+ ); end
1342
+ end
1343
+ # Additional fields for Mandate creation
1344
+ sig {
1345
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto::MandateOptions)
1346
+ }
1347
+ attr_accessor :mandate_options
1348
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1349
+ #
1350
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1351
+ #
1352
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1353
+ #
1354
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1355
+ sig { returns(String) }
1356
+ attr_accessor :setup_future_usage
1357
+ sig {
1358
+ params(mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto::MandateOptions, setup_future_usage: String).void
1359
+ }
1360
+ def initialize(mandate_options: nil, setup_future_usage: nil); end
1361
+ end
1362
+ class Pix < Stripe::RequestParams
1363
+ # The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
1364
+ sig { returns(Integer) }
1365
+ attr_accessor :expires_after_seconds
1366
+ sig { params(expires_after_seconds: Integer).void }
1367
+ def initialize(expires_after_seconds: nil); end
1368
+ end
1369
+ class RevolutPay < Stripe::RequestParams
1370
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1371
+ #
1372
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1373
+ #
1374
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1375
+ #
1376
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1377
+ sig { returns(String) }
1378
+ attr_accessor :setup_future_usage
1379
+ sig { params(setup_future_usage: String).void }
1380
+ def initialize(setup_future_usage: nil); end
1381
+ end
1382
+ class SamsungPay < Stripe::RequestParams
1383
+ # Controls when the funds will be captured from the customer's account.
1384
+ sig { returns(String) }
1385
+ attr_accessor :capture_method
1386
+ sig { params(capture_method: String).void }
1387
+ def initialize(capture_method: nil); end
1388
+ end
1389
+ class SepaDebit < Stripe::RequestParams
1390
+ class MandateOptions < Stripe::RequestParams
1391
+ # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
1392
+ sig { returns(T.nilable(String)) }
1393
+ attr_accessor :reference_prefix
1394
+ sig { params(reference_prefix: T.nilable(String)).void }
1395
+ def initialize(reference_prefix: nil); end
1396
+ end
1397
+ # Additional fields for Mandate creation
1398
+ sig {
1399
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)
1400
+ }
1401
+ attr_accessor :mandate_options
1402
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1403
+ #
1404
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1405
+ #
1406
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1407
+ #
1408
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1409
+ sig { returns(String) }
1410
+ attr_accessor :setup_future_usage
1411
+ sig {
1412
+ params(mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: String).void
1413
+ }
1414
+ def initialize(mandate_options: nil, setup_future_usage: nil); end
1415
+ end
1416
+ class Sofort < Stripe::RequestParams
1417
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1418
+ #
1419
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1420
+ #
1421
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1422
+ #
1423
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1424
+ sig { returns(String) }
1425
+ attr_accessor :setup_future_usage
1426
+ sig { params(setup_future_usage: String).void }
1427
+ def initialize(setup_future_usage: nil); end
1428
+ end
1429
+ class Swish < Stripe::RequestParams
1430
+ # The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
1431
+ sig { returns(String) }
1432
+ attr_accessor :reference
1433
+ sig { params(reference: String).void }
1434
+ def initialize(reference: nil); end
1435
+ end
1436
+ class UsBankAccount < Stripe::RequestParams
1437
+ class FinancialConnections < Stripe::RequestParams
1438
+ # 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`.
1439
+ sig { returns(T::Array[String]) }
1440
+ attr_accessor :permissions
1441
+ # List of data features that you would like to retrieve upon account creation.
1442
+ sig { returns(T::Array[String]) }
1443
+ attr_accessor :prefetch
1444
+ sig { params(permissions: T::Array[String], prefetch: T::Array[String]).void }
1445
+ def initialize(permissions: nil, prefetch: nil); end
1446
+ end
1447
+ # Additional fields for Financial Connections Session creation
1448
+ sig {
1449
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)
1450
+ }
1451
+ attr_accessor :financial_connections
1452
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1453
+ #
1454
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1455
+ #
1456
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1457
+ #
1458
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1459
+ sig { returns(String) }
1460
+ attr_accessor :setup_future_usage
1461
+ # Verification method for the intent
1462
+ sig { returns(String) }
1463
+ attr_accessor :verification_method
1464
+ sig {
1465
+ params(financial_connections: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections, setup_future_usage: String, verification_method: String).void
1466
+ }
1467
+ def initialize(
1468
+ financial_connections: nil,
1469
+ setup_future_usage: nil,
1470
+ verification_method: nil
1471
+ ); end
1472
+ end
1473
+ class WechatPay < Stripe::RequestParams
1474
+ # The app ID registered with WeChat Pay. Only required when client is ios or android.
1475
+ sig { returns(String) }
1476
+ attr_accessor :app_id
1477
+ # The client type that the end customer will pay from
1478
+ sig { returns(String) }
1479
+ attr_accessor :client
1480
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1481
+ #
1482
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1483
+ #
1484
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1485
+ #
1486
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1487
+ sig { returns(String) }
1488
+ attr_accessor :setup_future_usage
1489
+ sig { params(app_id: String, client: String, setup_future_usage: String).void }
1490
+ def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
1491
+ end
1492
+ # contains details about the ACSS Debit payment method options.
1493
+ sig {
1494
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit)
1495
+ }
1496
+ attr_accessor :acss_debit
1497
+ # contains details about the Affirm payment method options.
1498
+ sig {
1499
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Affirm)
1500
+ }
1501
+ attr_accessor :affirm
1502
+ # contains details about the Afterpay Clearpay payment method options.
1503
+ sig {
1504
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AfterpayClearpay)
1505
+ }
1506
+ attr_accessor :afterpay_clearpay
1507
+ # contains details about the Alipay payment method options.
1508
+ sig {
1509
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Alipay)
1510
+ }
1511
+ attr_accessor :alipay
1512
+ # contains details about the AmazonPay payment method options.
1513
+ sig {
1514
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AmazonPay)
1515
+ }
1516
+ attr_accessor :amazon_pay
1517
+ # contains details about the AU Becs Debit payment method options.
1518
+ sig {
1519
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AuBecsDebit)
1520
+ }
1521
+ attr_accessor :au_becs_debit
1522
+ # contains details about the Bacs Debit payment method options.
1523
+ sig {
1524
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit)
1525
+ }
1526
+ attr_accessor :bacs_debit
1527
+ # contains details about the Bancontact payment method options.
1528
+ sig {
1529
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Bancontact)
1530
+ }
1531
+ attr_accessor :bancontact
1532
+ # contains details about the Boleto payment method options.
1533
+ sig {
1534
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Boleto)
1535
+ }
1536
+ attr_accessor :boleto
1537
+ # contains details about the Card payment method options.
1538
+ sig {
1539
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card)
1540
+ }
1541
+ attr_accessor :card
1542
+ # contains details about the Cashapp Pay payment method options.
1543
+ sig {
1544
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Cashapp)
1545
+ }
1546
+ attr_accessor :cashapp
1547
+ # contains details about the Customer Balance payment method options.
1548
+ sig {
1549
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance)
1550
+ }
1551
+ attr_accessor :customer_balance
1552
+ # contains details about the EPS payment method options.
1553
+ sig {
1554
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Eps)
1555
+ }
1556
+ attr_accessor :eps
1557
+ # contains details about the FPX payment method options.
1558
+ sig {
1559
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Fpx)
1560
+ }
1561
+ attr_accessor :fpx
1562
+ # contains details about the Giropay payment method options.
1563
+ sig {
1564
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Giropay)
1565
+ }
1566
+ attr_accessor :giropay
1567
+ # contains details about the Grabpay payment method options.
1568
+ sig {
1569
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Grabpay)
1570
+ }
1571
+ attr_accessor :grabpay
1572
+ # contains details about the Ideal payment method options.
1573
+ sig {
1574
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Ideal)
1575
+ }
1576
+ attr_accessor :ideal
1577
+ # contains details about the Kakao Pay payment method options.
1578
+ sig {
1579
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KakaoPay)
1580
+ }
1581
+ attr_accessor :kakao_pay
1582
+ # contains details about the Klarna payment method options.
1583
+ sig {
1584
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna)
1585
+ }
1586
+ attr_accessor :klarna
1587
+ # contains details about the Konbini payment method options.
1588
+ sig {
1589
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Konbini)
1590
+ }
1591
+ attr_accessor :konbini
1592
+ # contains details about the Korean card payment method options.
1593
+ sig {
1594
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KrCard)
1595
+ }
1596
+ attr_accessor :kr_card
1597
+ # contains details about the Link payment method options.
1598
+ sig {
1599
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Link)
1600
+ }
1601
+ attr_accessor :link
1602
+ # contains details about the Mobilepay payment method options.
1603
+ sig {
1604
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Mobilepay)
1605
+ }
1606
+ attr_accessor :mobilepay
1607
+ # contains details about the Multibanco payment method options.
1608
+ sig {
1609
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Multibanco)
1610
+ }
1611
+ attr_accessor :multibanco
1612
+ # contains details about the Naver Pay payment method options.
1613
+ sig {
1614
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::NaverPay)
1615
+ }
1616
+ attr_accessor :naver_pay
1617
+ # contains details about the OXXO payment method options.
1618
+ sig {
1619
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Oxxo)
1620
+ }
1621
+ attr_accessor :oxxo
1622
+ # contains details about the P24 payment method options.
1623
+ sig {
1624
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::P24)
1625
+ }
1626
+ attr_accessor :p24
1627
+ # contains details about the PAYCO payment method options.
1628
+ sig {
1629
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payco)
1630
+ }
1631
+ attr_accessor :payco
1632
+ # contains details about the PayNow payment method options.
1633
+ sig {
1634
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paynow)
1635
+ }
1636
+ attr_accessor :paynow
1637
+ # contains details about the PayPal payment method options.
1638
+ sig {
1639
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paypal)
1640
+ }
1641
+ attr_accessor :paypal
1642
+ # contains details about the PayTo payment method options.
1643
+ sig {
1644
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto)
1645
+ }
1646
+ attr_accessor :payto
1647
+ # contains details about the Pix payment method options.
1648
+ sig {
1649
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Pix)
1650
+ }
1651
+ attr_accessor :pix
1652
+ # contains details about the RevolutPay payment method options.
1653
+ sig {
1654
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::RevolutPay)
1655
+ }
1656
+ attr_accessor :revolut_pay
1657
+ # contains details about the Samsung Pay payment method options.
1658
+ sig {
1659
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SamsungPay)
1660
+ }
1661
+ attr_accessor :samsung_pay
1662
+ # contains details about the Sepa Debit payment method options.
1663
+ sig {
1664
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit)
1665
+ }
1666
+ attr_accessor :sepa_debit
1667
+ # contains details about the Sofort payment method options.
1668
+ sig {
1669
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Sofort)
1670
+ }
1671
+ attr_accessor :sofort
1672
+ # contains details about the Swish payment method options.
1673
+ sig {
1674
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Swish)
1675
+ }
1676
+ attr_accessor :swish
1677
+ # contains details about the Us Bank Account payment method options.
1678
+ sig {
1679
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount)
1680
+ }
1681
+ attr_accessor :us_bank_account
1682
+ # contains details about the WeChat Pay payment method options.
1683
+ sig {
1684
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::WechatPay)
1685
+ }
1686
+ attr_accessor :wechat_pay
1687
+ sig {
1688
+ params(acss_debit: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit, affirm: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Affirm, afterpay_clearpay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AfterpayClearpay, alipay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Alipay, amazon_pay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AmazonPay, au_becs_debit: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AuBecsDebit, bacs_debit: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit, bancontact: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Bancontact, boleto: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Boleto, card: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card, cashapp: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Cashapp, customer_balance: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance, eps: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Eps, fpx: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Fpx, giropay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Giropay, grabpay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Grabpay, ideal: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Ideal, kakao_pay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KakaoPay, klarna: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna, konbini: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Konbini, kr_card: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KrCard, link: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Link, mobilepay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Mobilepay, multibanco: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Multibanco, naver_pay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::NaverPay, oxxo: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Oxxo, p24: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::P24, payco: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payco, paynow: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paynow, paypal: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paypal, payto: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payto, pix: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Pix, revolut_pay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::RevolutPay, samsung_pay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SamsungPay, sepa_debit: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit, sofort: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Sofort, swish: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Swish, us_bank_account: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount, wechat_pay: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::WechatPay).void
1689
+ }
1690
+ def initialize(
1691
+ acss_debit: nil,
1692
+ affirm: nil,
1693
+ afterpay_clearpay: nil,
1694
+ alipay: nil,
1695
+ amazon_pay: nil,
1696
+ au_becs_debit: nil,
1697
+ bacs_debit: nil,
1698
+ bancontact: nil,
1699
+ boleto: nil,
1700
+ card: nil,
1701
+ cashapp: nil,
1702
+ customer_balance: nil,
1703
+ eps: nil,
1704
+ fpx: nil,
1705
+ giropay: nil,
1706
+ grabpay: nil,
1707
+ ideal: nil,
1708
+ kakao_pay: nil,
1709
+ klarna: nil,
1710
+ konbini: nil,
1711
+ kr_card: nil,
1712
+ link: nil,
1713
+ mobilepay: nil,
1714
+ multibanco: nil,
1715
+ naver_pay: nil,
1716
+ oxxo: nil,
1717
+ p24: nil,
1718
+ payco: nil,
1719
+ paynow: nil,
1720
+ paypal: nil,
1721
+ payto: nil,
1722
+ pix: nil,
1723
+ revolut_pay: nil,
1724
+ samsung_pay: nil,
1725
+ sepa_debit: nil,
1726
+ sofort: nil,
1727
+ swish: nil,
1728
+ us_bank_account: nil,
1729
+ wechat_pay: nil
1730
+ ); end
1731
+ end
1732
+ class Permissions < Stripe::RequestParams
1733
+ class Update < Stripe::RequestParams
1734
+ # Determines which entity is allowed to update the line items.
1735
+ #
1736
+ # Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
1737
+ #
1738
+ # When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
1739
+ sig { returns(String) }
1740
+ attr_accessor :line_items
1741
+ # Determines which entity is allowed to update the shipping details.
1742
+ #
1743
+ # Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
1744
+ #
1745
+ # When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
1746
+ sig { returns(String) }
1747
+ attr_accessor :shipping_details
1748
+ sig { params(line_items: String, shipping_details: String).void }
1749
+ def initialize(line_items: nil, shipping_details: nil); end
1750
+ end
1751
+ # Permissions for updating the Checkout Session.
1752
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::Permissions::Update) }
1753
+ attr_accessor :update
1754
+ sig {
1755
+ params(update: ::Stripe::Checkout::SessionService::CreateParams::Permissions::Update).void
1756
+ }
1757
+ def initialize(update: nil); end
1758
+ end
1759
+ class PhoneNumberCollection < Stripe::RequestParams
1760
+ # Set to `true` to enable phone number collection.
1761
+ #
1762
+ # Can only be set in `payment` and `subscription` mode.
1763
+ sig { returns(T::Boolean) }
1764
+ attr_accessor :enabled
1765
+ sig { params(enabled: T::Boolean).void }
1766
+ def initialize(enabled: nil); end
1767
+ end
1768
+ class SavedPaymentMethodOptions < Stripe::RequestParams
1769
+ # Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.
1770
+ sig { returns(T::Array[String]) }
1771
+ attr_accessor :allow_redisplay_filters
1772
+ # Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
1773
+ sig { returns(String) }
1774
+ attr_accessor :payment_method_save
1775
+ sig {
1776
+ params(allow_redisplay_filters: T::Array[String], payment_method_save: String).void
1777
+ }
1778
+ def initialize(allow_redisplay_filters: nil, payment_method_save: nil); end
1779
+ end
1780
+ class SetupIntentData < Stripe::RequestParams
1781
+ # An arbitrary string attached to the object. Often useful for displaying to users.
1782
+ sig { returns(String) }
1783
+ attr_accessor :description
1784
+ # 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`.
1785
+ sig { returns(T::Hash[String, String]) }
1786
+ attr_accessor :metadata
1787
+ # The Stripe account for which the setup is intended.
1788
+ sig { returns(String) }
1789
+ attr_accessor :on_behalf_of
1790
+ sig {
1791
+ params(description: String, metadata: T::Hash[String, String], on_behalf_of: String).void
1792
+ }
1793
+ def initialize(description: nil, metadata: nil, on_behalf_of: nil); end
1794
+ end
1795
+ class ShippingAddressCollection < Stripe::RequestParams
1796
+ # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
1797
+ # shipping locations.
1798
+ sig { returns(T::Array[String]) }
1799
+ attr_accessor :allowed_countries
1800
+ sig { params(allowed_countries: T::Array[String]).void }
1801
+ def initialize(allowed_countries: nil); end
1802
+ end
1803
+ class ShippingOption < Stripe::RequestParams
1804
+ class ShippingRateData < Stripe::RequestParams
1805
+ class DeliveryEstimate < Stripe::RequestParams
1806
+ class Maximum < Stripe::RequestParams
1807
+ # A unit of time.
1808
+ sig { returns(String) }
1809
+ attr_accessor :unit
1810
+ # Must be greater than 0.
1811
+ sig { returns(Integer) }
1812
+ attr_accessor :value
1813
+ sig { params(unit: String, value: Integer).void }
1814
+ def initialize(unit: nil, value: nil); end
1815
+ end
1816
+ class Minimum < Stripe::RequestParams
1817
+ # A unit of time.
1818
+ sig { returns(String) }
1819
+ attr_accessor :unit
1820
+ # Must be greater than 0.
1821
+ sig { returns(Integer) }
1822
+ attr_accessor :value
1823
+ sig { params(unit: String, value: Integer).void }
1824
+ def initialize(unit: nil, value: nil); end
1825
+ end
1826
+ # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
1827
+ sig {
1828
+ returns(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)
1829
+ }
1830
+ attr_accessor :maximum
1831
+ # The lower bound of the estimated range. If empty, represents no lower bound.
1832
+ sig {
1833
+ returns(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)
1834
+ }
1835
+ attr_accessor :minimum
1836
+ sig {
1837
+ params(maximum: ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum, minimum: ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum).void
1838
+ }
1839
+ def initialize(maximum: nil, minimum: nil); end
1840
+ end
1841
+ class FixedAmount < Stripe::RequestParams
1842
+ class CurrencyOptions < Stripe::RequestParams
1843
+ # A non-negative integer in cents representing how much to charge.
1844
+ sig { returns(Integer) }
1845
+ attr_accessor :amount
1846
+ # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
1847
+ sig { returns(String) }
1848
+ attr_accessor :tax_behavior
1849
+ sig { params(amount: Integer, tax_behavior: String).void }
1850
+ def initialize(amount: nil, tax_behavior: nil); end
1851
+ end
1852
+ # A non-negative integer in cents representing how much to charge.
1853
+ sig { returns(Integer) }
1854
+ attr_accessor :amount
1855
+ # 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).
1856
+ sig { returns(String) }
1857
+ attr_accessor :currency
1858
+ # Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
1859
+ sig {
1860
+ returns(T::Hash[String, ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])
1861
+ }
1862
+ attr_accessor :currency_options
1863
+ sig {
1864
+ params(amount: Integer, currency: String, currency_options: T::Hash[String, ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]).void
1865
+ }
1866
+ def initialize(amount: nil, currency: nil, currency_options: nil); end
1867
+ end
1868
+ # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
1869
+ sig {
1870
+ returns(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate)
1871
+ }
1872
+ attr_accessor :delivery_estimate
1873
+ # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
1874
+ sig { returns(String) }
1875
+ attr_accessor :display_name
1876
+ # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
1877
+ sig {
1878
+ returns(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount)
1879
+ }
1880
+ attr_accessor :fixed_amount
1881
+ # 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`.
1882
+ sig { returns(T::Hash[String, String]) }
1883
+ attr_accessor :metadata
1884
+ # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
1885
+ sig { returns(String) }
1886
+ attr_accessor :tax_behavior
1887
+ # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
1888
+ sig { returns(String) }
1889
+ attr_accessor :tax_code
1890
+ # The type of calculation to use on the shipping rate.
1891
+ sig { returns(String) }
1892
+ attr_accessor :type
1893
+ sig {
1894
+ params(delivery_estimate: ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate, display_name: String, fixed_amount: ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount, metadata: T::Hash[String, String], tax_behavior: String, tax_code: String, type: String).void
1895
+ }
1896
+ def initialize(
1897
+ delivery_estimate: nil,
1898
+ display_name: nil,
1899
+ fixed_amount: nil,
1900
+ metadata: nil,
1901
+ tax_behavior: nil,
1902
+ tax_code: nil,
1903
+ type: nil
1904
+ ); end
1905
+ end
1906
+ # The ID of the Shipping Rate to use for this shipping option.
1907
+ sig { returns(String) }
1908
+ attr_accessor :shipping_rate
1909
+ # Parameters to be passed to Shipping Rate creation for this shipping option.
1910
+ sig {
1911
+ returns(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData)
1912
+ }
1913
+ attr_accessor :shipping_rate_data
1914
+ sig {
1915
+ params(shipping_rate: String, shipping_rate_data: ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData).void
1916
+ }
1917
+ def initialize(shipping_rate: nil, shipping_rate_data: nil); end
1918
+ end
1919
+ class SubscriptionData < Stripe::RequestParams
1920
+ class InvoiceSettings < Stripe::RequestParams
1921
+ class Issuer < Stripe::RequestParams
1922
+ # The connected account being referenced when `type` is `account`.
1923
+ sig { returns(String) }
1924
+ attr_accessor :account
1925
+ # Type of the account referenced in the request.
1926
+ sig { returns(String) }
1927
+ attr_accessor :type
1928
+ sig { params(account: String, type: String).void }
1929
+ def initialize(account: nil, type: nil); end
1930
+ end
1931
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1932
+ sig {
1933
+ returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings::Issuer)
1934
+ }
1935
+ attr_accessor :issuer
1936
+ sig {
1937
+ params(issuer: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings::Issuer).void
1938
+ }
1939
+ def initialize(issuer: nil); end
1940
+ end
1941
+ class TransferData < Stripe::RequestParams
1942
+ # 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.
1943
+ sig { returns(Float) }
1944
+ attr_accessor :amount_percent
1945
+ # ID of an existing, connected Stripe account.
1946
+ sig { returns(String) }
1947
+ attr_accessor :destination
1948
+ sig { params(amount_percent: Float, destination: String).void }
1949
+ def initialize(amount_percent: nil, destination: nil); end
1950
+ end
1951
+ class TrialSettings < Stripe::RequestParams
1952
+ class EndBehavior < Stripe::RequestParams
1953
+ # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
1954
+ sig { returns(String) }
1955
+ attr_accessor :missing_payment_method
1956
+ sig { params(missing_payment_method: String).void }
1957
+ def initialize(missing_payment_method: nil); end
1958
+ end
1959
+ # Defines how the subscription should behave when the user's free trial ends.
1960
+ sig {
1961
+ returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
1962
+ }
1963
+ attr_accessor :end_behavior
1964
+ sig {
1965
+ params(end_behavior: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings::EndBehavior).void
1966
+ }
1967
+ def initialize(end_behavior: nil); end
1968
+ end
1969
+ # 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. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
1970
+ sig { returns(Float) }
1971
+ attr_accessor :application_fee_percent
1972
+ # A future timestamp to anchor the subscription's billing cycle for new subscriptions.
1973
+ sig { returns(Integer) }
1974
+ attr_accessor :billing_cycle_anchor
1975
+ # The tax rates that will apply to any subscription item that does not have
1976
+ # `tax_rates` set. Invoices created will have their `default_tax_rates` populated
1977
+ # from the subscription.
1978
+ sig { returns(T::Array[String]) }
1979
+ attr_accessor :default_tax_rates
1980
+ # The subscription's description, meant to be displayable to the customer.
1981
+ # Use this field to optionally store an explanation of the subscription
1982
+ # for rendering in the [customer portal](https://stripe.com/docs/customer-management).
1983
+ sig { returns(String) }
1984
+ attr_accessor :description
1985
+ # All invoices will be billed using the specified settings.
1986
+ sig {
1987
+ returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings)
1988
+ }
1989
+ attr_accessor :invoice_settings
1990
+ # 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`.
1991
+ sig { returns(T::Hash[String, String]) }
1992
+ attr_accessor :metadata
1993
+ # The account on behalf of which to charge, for each of the subscription's invoices.
1994
+ sig { returns(String) }
1995
+ attr_accessor :on_behalf_of
1996
+ # Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
1997
+ sig { returns(String) }
1998
+ attr_accessor :proration_behavior
1999
+ # 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.
2000
+ sig {
2001
+ returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TransferData)
2002
+ }
2003
+ attr_accessor :transfer_data
2004
+ # Unix timestamp representing the end of the trial period the customer
2005
+ # will get before being charged for the first time. Has to be at least
2006
+ # 48 hours in the future.
2007
+ sig { returns(Integer) }
2008
+ attr_accessor :trial_end
2009
+ # Integer representing the number of trial period days before the
2010
+ # customer is charged for the first time. Has to be at least 1.
2011
+ sig { returns(Integer) }
2012
+ attr_accessor :trial_period_days
2013
+ # Settings related to subscription trials.
2014
+ sig {
2015
+ returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings)
2016
+ }
2017
+ attr_accessor :trial_settings
2018
+ sig {
2019
+ params(application_fee_percent: Float, billing_cycle_anchor: Integer, default_tax_rates: T::Array[String], description: String, invoice_settings: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings, metadata: T::Hash[String, String], on_behalf_of: String, proration_behavior: String, transfer_data: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TransferData, trial_end: Integer, trial_period_days: Integer, trial_settings: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings).void
2020
+ }
2021
+ def initialize(
2022
+ application_fee_percent: nil,
2023
+ billing_cycle_anchor: nil,
2024
+ default_tax_rates: nil,
2025
+ description: nil,
2026
+ invoice_settings: nil,
2027
+ metadata: nil,
2028
+ on_behalf_of: nil,
2029
+ proration_behavior: nil,
2030
+ transfer_data: nil,
2031
+ trial_end: nil,
2032
+ trial_period_days: nil,
2033
+ trial_settings: nil
2034
+ ); end
2035
+ end
2036
+ class TaxIdCollection < Stripe::RequestParams
2037
+ # Enable tax ID collection during checkout. Defaults to `false`.
2038
+ sig { returns(T::Boolean) }
2039
+ attr_accessor :enabled
2040
+ # Describes whether a tax ID is required during checkout. Defaults to `never`.
2041
+ sig { returns(String) }
2042
+ attr_accessor :required
2043
+ sig { params(enabled: T::Boolean, required: String).void }
2044
+ def initialize(enabled: nil, required: nil); end
2045
+ end
2046
+ # Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
2047
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::AdaptivePricing) }
2048
+ attr_accessor :adaptive_pricing
2049
+ # Configure actions after a Checkout Session has expired.
2050
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration) }
2051
+ attr_accessor :after_expiration
2052
+ # Enables user redeemable promotion codes.
2053
+ sig { returns(T::Boolean) }
2054
+ attr_accessor :allow_promotion_codes
2055
+ # Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
2056
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax) }
2057
+ attr_accessor :automatic_tax
2058
+ # Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
2059
+ sig { returns(String) }
2060
+ attr_accessor :billing_address_collection
2061
+ # If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded` or `custom`.
2062
+ sig { returns(String) }
2063
+ attr_accessor :cancel_url
2064
+ # A unique string to reference the Checkout Session. This can be a
2065
+ # customer ID, a cart ID, or similar, and can be used to reconcile the
2066
+ # session with your internal systems.
2067
+ sig { returns(String) }
2068
+ attr_accessor :client_reference_id
2069
+ # Configure fields for the Checkout Session to gather active consent from customers.
2070
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection) }
2071
+ attr_accessor :consent_collection
2072
+ # 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). Required in `setup` mode when `payment_method_types` is not set.
2073
+ sig { returns(String) }
2074
+ attr_accessor :currency
2075
+ # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
2076
+ sig { returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField]) }
2077
+ attr_accessor :custom_fields
2078
+ # Display additional text for your customers using custom text.
2079
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomText) }
2080
+ attr_accessor :custom_text
2081
+ # ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card
2082
+ # payment method will be used to prefill the email, name, card details, and billing address
2083
+ # on the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)
2084
+ # will be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.
2085
+ #
2086
+ # If the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.
2087
+ # If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
2088
+ #
2089
+ # If blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow.
2090
+ #
2091
+ # You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.
2092
+ sig { returns(String) }
2093
+ attr_accessor :customer
2094
+ # Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
2095
+ #
2096
+ # When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
2097
+ # with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).
2098
+ #
2099
+ # Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)
2100
+ # in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
2101
+ #
2102
+ # Can only be set in `payment` and `setup` mode.
2103
+ sig { returns(String) }
2104
+ attr_accessor :customer_creation
2105
+ # If provided, this value will be used when the Customer object is created.
2106
+ # If not provided, customers will be asked to enter their email address.
2107
+ # Use this parameter to prefill customer data if you already have an email
2108
+ # on file. To access information about the customer once a session is
2109
+ # complete, use the `customer` field.
2110
+ sig { returns(String) }
2111
+ attr_accessor :customer_email
2112
+ # Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
2113
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomerUpdate) }
2114
+ attr_accessor :customer_update
2115
+ # The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
2116
+ sig { returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::Discount]) }
2117
+ attr_accessor :discounts
2118
+ # Specifies which fields in the response should be expanded.
2119
+ sig { returns(T::Array[String]) }
2120
+ attr_accessor :expand
2121
+ # The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
2122
+ sig { returns(Integer) }
2123
+ attr_accessor :expires_at
2124
+ # Generate a post-purchase Invoice for one-time payments.
2125
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation) }
2126
+ attr_accessor :invoice_creation
2127
+ # A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
2128
+ #
2129
+ # For `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.
2130
+ #
2131
+ # For `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.
2132
+ sig { returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::LineItem]) }
2133
+ attr_accessor :line_items
2134
+ # The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
2135
+ sig { returns(String) }
2136
+ attr_accessor :locale
2137
+ # 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`.
2138
+ sig { returns(T::Hash[String, String]) }
2139
+ attr_accessor :metadata
2140
+ # The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
2141
+ sig { returns(String) }
2142
+ attr_accessor :mode
2143
+ # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
2144
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData) }
2145
+ attr_accessor :payment_intent_data
2146
+ # Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.
2147
+ # This may occur if the Checkout Session includes a free trial or a discount.
2148
+ #
2149
+ # Can only be set in `subscription` mode. Defaults to `always`.
2150
+ #
2151
+ # If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
2152
+ sig { returns(String) }
2153
+ attr_accessor :payment_method_collection
2154
+ # The ID of the payment method configuration to use with this Checkout session.
2155
+ sig { returns(String) }
2156
+ attr_accessor :payment_method_configuration
2157
+ # This parameter allows you to set some attributes on the payment method created during a Checkout session.
2158
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodData) }
2159
+ attr_accessor :payment_method_data
2160
+ # Payment-method-specific configuration.
2161
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions) }
2162
+ attr_accessor :payment_method_options
2163
+ # A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
2164
+ #
2165
+ # You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
2166
+ # See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.
2167
+ #
2168
+ # Read more about the supported payment methods and their requirements in our [payment
2169
+ # method details guide](/docs/payments/checkout/payment-methods).
2170
+ #
2171
+ # If multiple payment methods are passed, Checkout will dynamically reorder them to
2172
+ # prioritize the most relevant payment methods based on the customer's location and
2173
+ # other characteristics.
2174
+ sig { returns(T::Array[String]) }
2175
+ attr_accessor :payment_method_types
2176
+ # This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
2177
+ #
2178
+ # For specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.
2179
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::Permissions) }
2180
+ attr_accessor :permissions
2181
+ # Controls phone number collection settings for the session.
2182
+ #
2183
+ # We recommend that you review your privacy policy and check with your legal contacts
2184
+ # before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).
2185
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::PhoneNumberCollection) }
2186
+ attr_accessor :phone_number_collection
2187
+ # This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
2188
+ sig { returns(String) }
2189
+ attr_accessor :redirect_on_completion
2190
+ # The URL to redirect your customer back to after they authenticate or cancel their payment on the
2191
+ # payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
2192
+ # and redirect-based payment methods are enabled on the session.
2193
+ sig { returns(String) }
2194
+ attr_accessor :return_url
2195
+ # Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
2196
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::SavedPaymentMethodOptions) }
2197
+ attr_accessor :saved_payment_method_options
2198
+ # A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
2199
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::SetupIntentData) }
2200
+ attr_accessor :setup_intent_data
2201
+ # When set, provides configuration for Checkout to collect a shipping address from a customer.
2202
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::ShippingAddressCollection) }
2203
+ attr_accessor :shipping_address_collection
2204
+ # The shipping rate options to apply to this Session. Up to a maximum of 5.
2205
+ sig { returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::ShippingOption]) }
2206
+ attr_accessor :shipping_options
2207
+ # Describes the type of transaction being performed by Checkout in order to customize
2208
+ # relevant text on the page, such as the submit button. `submit_type` can only be
2209
+ # specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
2210
+ sig { returns(String) }
2211
+ attr_accessor :submit_type
2212
+ # A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
2213
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData) }
2214
+ attr_accessor :subscription_data
2215
+ # The URL to which Stripe should send customers when payment or setup
2216
+ # is complete.
2217
+ # This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
2218
+ # information from the successful Checkout Session on your page, read the
2219
+ # guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
2220
+ sig { returns(String) }
2221
+ attr_accessor :success_url
2222
+ # Controls tax ID collection during checkout.
2223
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::TaxIdCollection) }
2224
+ attr_accessor :tax_id_collection
2225
+ # The UI mode of the Session. Defaults to `hosted`.
2226
+ sig { returns(String) }
2227
+ attr_accessor :ui_mode
2228
+ sig {
2229
+ params(adaptive_pricing: ::Stripe::Checkout::SessionService::CreateParams::AdaptivePricing, after_expiration: ::Stripe::Checkout::SessionService::CreateParams::AfterExpiration, allow_promotion_codes: T::Boolean, automatic_tax: ::Stripe::Checkout::SessionService::CreateParams::AutomaticTax, billing_address_collection: String, cancel_url: String, client_reference_id: String, consent_collection: ::Stripe::Checkout::SessionService::CreateParams::ConsentCollection, currency: String, custom_fields: T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField], custom_text: ::Stripe::Checkout::SessionService::CreateParams::CustomText, customer: String, customer_creation: String, customer_email: String, customer_update: ::Stripe::Checkout::SessionService::CreateParams::CustomerUpdate, discounts: T::Array[::Stripe::Checkout::SessionService::CreateParams::Discount], expand: T::Array[String], expires_at: Integer, invoice_creation: ::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation, line_items: T::Array[::Stripe::Checkout::SessionService::CreateParams::LineItem], locale: String, metadata: T::Hash[String, String], mode: String, payment_intent_data: ::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData, payment_method_collection: String, payment_method_configuration: String, payment_method_data: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodData, payment_method_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions, payment_method_types: T::Array[String], permissions: ::Stripe::Checkout::SessionService::CreateParams::Permissions, phone_number_collection: ::Stripe::Checkout::SessionService::CreateParams::PhoneNumberCollection, redirect_on_completion: String, return_url: String, saved_payment_method_options: ::Stripe::Checkout::SessionService::CreateParams::SavedPaymentMethodOptions, setup_intent_data: ::Stripe::Checkout::SessionService::CreateParams::SetupIntentData, shipping_address_collection: ::Stripe::Checkout::SessionService::CreateParams::ShippingAddressCollection, shipping_options: T::Array[::Stripe::Checkout::SessionService::CreateParams::ShippingOption], submit_type: String, subscription_data: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData, success_url: String, tax_id_collection: ::Stripe::Checkout::SessionService::CreateParams::TaxIdCollection, ui_mode: String).void
2230
+ }
2231
+ def initialize(
2232
+ adaptive_pricing: nil,
2233
+ after_expiration: nil,
2234
+ allow_promotion_codes: nil,
2235
+ automatic_tax: nil,
2236
+ billing_address_collection: nil,
2237
+ cancel_url: nil,
2238
+ client_reference_id: nil,
2239
+ consent_collection: nil,
2240
+ currency: nil,
2241
+ custom_fields: nil,
2242
+ custom_text: nil,
2243
+ customer: nil,
2244
+ customer_creation: nil,
2245
+ customer_email: nil,
2246
+ customer_update: nil,
2247
+ discounts: nil,
2248
+ expand: nil,
2249
+ expires_at: nil,
2250
+ invoice_creation: nil,
2251
+ line_items: nil,
2252
+ locale: nil,
2253
+ metadata: nil,
2254
+ mode: nil,
2255
+ payment_intent_data: nil,
2256
+ payment_method_collection: nil,
2257
+ payment_method_configuration: nil,
2258
+ payment_method_data: nil,
2259
+ payment_method_options: nil,
2260
+ payment_method_types: nil,
2261
+ permissions: nil,
2262
+ phone_number_collection: nil,
2263
+ redirect_on_completion: nil,
2264
+ return_url: nil,
2265
+ saved_payment_method_options: nil,
2266
+ setup_intent_data: nil,
2267
+ shipping_address_collection: nil,
2268
+ shipping_options: nil,
2269
+ submit_type: nil,
2270
+ subscription_data: nil,
2271
+ success_url: nil,
2272
+ tax_id_collection: nil,
2273
+ ui_mode: nil
2274
+ ); end
2275
+ end
2276
+ class RetrieveParams < Stripe::RequestParams
2277
+ # Specifies which fields in the response should be expanded.
2278
+ sig { returns(T::Array[String]) }
2279
+ attr_accessor :expand
2280
+ sig { params(expand: T::Array[String]).void }
2281
+ def initialize(expand: nil); end
2282
+ end
2283
+ class UpdateParams < Stripe::RequestParams
2284
+ class CollectedInformation < Stripe::RequestParams
2285
+ class ShippingDetails < Stripe::RequestParams
2286
+ class Address < Stripe::RequestParams
2287
+ # City, district, suburb, town, or village.
2288
+ sig { returns(String) }
2289
+ attr_accessor :city
2290
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2291
+ sig { returns(String) }
2292
+ attr_accessor :country
2293
+ # Address line 1 (e.g., street, PO Box, or company name).
2294
+ sig { returns(String) }
2295
+ attr_accessor :line1
2296
+ # Address line 2 (e.g., apartment, suite, unit, or building).
2297
+ sig { returns(String) }
2298
+ attr_accessor :line2
2299
+ # ZIP or postal code.
2300
+ sig { returns(String) }
2301
+ attr_accessor :postal_code
2302
+ # State, county, province, or region.
2303
+ sig { returns(String) }
2304
+ attr_accessor :state
2305
+ sig {
2306
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2307
+ }
2308
+ def initialize(
2309
+ city: nil,
2310
+ country: nil,
2311
+ line1: nil,
2312
+ line2: nil,
2313
+ postal_code: nil,
2314
+ state: nil
2315
+ ); end
2316
+ end
2317
+ # The address of the customer
2318
+ sig {
2319
+ returns(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails::Address)
2320
+ }
2321
+ attr_accessor :address
2322
+ # The name of customer
2323
+ sig { returns(String) }
2324
+ attr_accessor :name
2325
+ sig {
2326
+ params(address: ::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails::Address, name: String).void
2327
+ }
2328
+ def initialize(address: nil, name: nil); end
2329
+ end
2330
+ # The shipping details to apply to this Session.
2331
+ sig {
2332
+ returns(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails)
2333
+ }
2334
+ attr_accessor :shipping_details
2335
+ sig {
2336
+ params(shipping_details: ::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails).void
2337
+ }
2338
+ def initialize(shipping_details: nil); end
2339
+ end
2340
+ class LineItem < Stripe::RequestParams
2341
+ class AdjustableQuantity < Stripe::RequestParams
2342
+ # Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.
2343
+ sig { returns(T::Boolean) }
2344
+ attr_accessor :enabled
2345
+ # The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
2346
+ sig { returns(Integer) }
2347
+ attr_accessor :maximum
2348
+ # The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
2349
+ sig { returns(Integer) }
2350
+ attr_accessor :minimum
2351
+ sig { params(enabled: T::Boolean, maximum: Integer, minimum: Integer).void }
2352
+ def initialize(enabled: nil, maximum: nil, minimum: nil); end
2353
+ end
2354
+ # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
2355
+ sig {
2356
+ returns(::Stripe::Checkout::SessionService::UpdateParams::LineItem::AdjustableQuantity)
2357
+ }
2358
+ attr_accessor :adjustable_quantity
2359
+ # ID of an existing line item.
2360
+ sig { returns(String) }
2361
+ attr_accessor :id
2362
+ # 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`.
2363
+ sig { returns(T.nilable(T::Hash[String, String])) }
2364
+ attr_accessor :metadata
2365
+ # The ID of the [Price](https://stripe.com/docs/api/prices).
2366
+ sig { returns(String) }
2367
+ attr_accessor :price
2368
+ # The quantity of the line item being purchased.
2369
+ sig { returns(Integer) }
2370
+ attr_accessor :quantity
2371
+ # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
2372
+ sig { returns(T.nilable(T::Array[String])) }
2373
+ attr_accessor :tax_rates
2374
+ sig {
2375
+ params(adjustable_quantity: ::Stripe::Checkout::SessionService::UpdateParams::LineItem::AdjustableQuantity, id: String, metadata: T.nilable(T::Hash[String, String]), price: String, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
2376
+ }
2377
+ def initialize(
2378
+ adjustable_quantity: nil,
2379
+ id: nil,
2380
+ metadata: nil,
2381
+ price: nil,
2382
+ quantity: nil,
2383
+ tax_rates: nil
2384
+ ); end
2385
+ end
2386
+ class ShippingOption < Stripe::RequestParams
2387
+ class ShippingRateData < Stripe::RequestParams
2388
+ class DeliveryEstimate < Stripe::RequestParams
2389
+ class Maximum < Stripe::RequestParams
2390
+ # A unit of time.
2391
+ sig { returns(String) }
2392
+ attr_accessor :unit
2393
+ # Must be greater than 0.
2394
+ sig { returns(Integer) }
2395
+ attr_accessor :value
2396
+ sig { params(unit: String, value: Integer).void }
2397
+ def initialize(unit: nil, value: nil); end
2398
+ end
2399
+ class Minimum < Stripe::RequestParams
2400
+ # A unit of time.
2401
+ sig { returns(String) }
2402
+ attr_accessor :unit
2403
+ # Must be greater than 0.
2404
+ sig { returns(Integer) }
2405
+ attr_accessor :value
2406
+ sig { params(unit: String, value: Integer).void }
2407
+ def initialize(unit: nil, value: nil); end
2408
+ end
2409
+ # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
2410
+ sig {
2411
+ returns(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)
2412
+ }
2413
+ attr_accessor :maximum
2414
+ # The lower bound of the estimated range. If empty, represents no lower bound.
2415
+ sig {
2416
+ returns(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)
2417
+ }
2418
+ attr_accessor :minimum
2419
+ sig {
2420
+ params(maximum: ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum, minimum: ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum).void
2421
+ }
2422
+ def initialize(maximum: nil, minimum: nil); end
2423
+ end
2424
+ class FixedAmount < Stripe::RequestParams
2425
+ class CurrencyOptions < Stripe::RequestParams
2426
+ # A non-negative integer in cents representing how much to charge.
2427
+ sig { returns(Integer) }
2428
+ attr_accessor :amount
2429
+ # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
2430
+ sig { returns(String) }
2431
+ attr_accessor :tax_behavior
2432
+ sig { params(amount: Integer, tax_behavior: String).void }
2433
+ def initialize(amount: nil, tax_behavior: nil); end
2434
+ end
2435
+ # A non-negative integer in cents representing how much to charge.
2436
+ sig { returns(Integer) }
2437
+ attr_accessor :amount
2438
+ # 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).
2439
+ sig { returns(String) }
2440
+ attr_accessor :currency
2441
+ # Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
2442
+ sig {
2443
+ returns(T::Hash[String, ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])
2444
+ }
2445
+ attr_accessor :currency_options
2446
+ sig {
2447
+ params(amount: Integer, currency: String, currency_options: T::Hash[String, ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]).void
2448
+ }
2449
+ def initialize(amount: nil, currency: nil, currency_options: nil); end
2450
+ end
2451
+ # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
2452
+ sig {
2453
+ returns(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate)
2454
+ }
2455
+ attr_accessor :delivery_estimate
2456
+ # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
2457
+ sig { returns(String) }
2458
+ attr_accessor :display_name
2459
+ # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
2460
+ sig {
2461
+ returns(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount)
2462
+ }
2463
+ attr_accessor :fixed_amount
2464
+ # 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`.
2465
+ sig { returns(T::Hash[String, String]) }
2466
+ attr_accessor :metadata
2467
+ # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
2468
+ sig { returns(String) }
2469
+ attr_accessor :tax_behavior
2470
+ # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
2471
+ sig { returns(String) }
2472
+ attr_accessor :tax_code
2473
+ # The type of calculation to use on the shipping rate.
2474
+ sig { returns(String) }
2475
+ attr_accessor :type
2476
+ sig {
2477
+ params(delivery_estimate: ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate, display_name: String, fixed_amount: ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount, metadata: T::Hash[String, String], tax_behavior: String, tax_code: String, type: String).void
2478
+ }
2479
+ def initialize(
2480
+ delivery_estimate: nil,
2481
+ display_name: nil,
2482
+ fixed_amount: nil,
2483
+ metadata: nil,
2484
+ tax_behavior: nil,
2485
+ tax_code: nil,
2486
+ type: nil
2487
+ ); end
2488
+ end
2489
+ # The ID of the Shipping Rate to use for this shipping option.
2490
+ sig { returns(String) }
2491
+ attr_accessor :shipping_rate
2492
+ # Parameters to be passed to Shipping Rate creation for this shipping option.
2493
+ sig {
2494
+ returns(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData)
2495
+ }
2496
+ attr_accessor :shipping_rate_data
2497
+ sig {
2498
+ params(shipping_rate: String, shipping_rate_data: ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData).void
2499
+ }
2500
+ def initialize(shipping_rate: nil, shipping_rate_data: nil); end
2501
+ end
2502
+ # Information about the customer collected within the Checkout Session.
2503
+ sig { returns(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation) }
2504
+ attr_accessor :collected_information
2505
+ # Specifies which fields in the response should be expanded.
2506
+ sig { returns(T::Array[String]) }
2507
+ attr_accessor :expand
2508
+ # A list of items the customer is purchasing.
2509
+ #
2510
+ # When updating line items, you must retransmit the entire array of line items.
2511
+ #
2512
+ # To retain an existing line item, specify its `id`.
2513
+ #
2514
+ # To update an existing line item, specify its `id` along with the new values of the fields to update.
2515
+ #
2516
+ # To add a new line item, specify a `price` and `quantity`. We don't currently support recurring prices.
2517
+ #
2518
+ # To remove an existing line item, omit the line item's ID from the retransmitted array.
2519
+ #
2520
+ # To reorder a line item, specify it at the desired position in the retransmitted array.
2521
+ sig { returns(T::Array[::Stripe::Checkout::SessionService::UpdateParams::LineItem]) }
2522
+ attr_accessor :line_items
2523
+ # 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`.
2524
+ sig { returns(T.nilable(T::Hash[String, String])) }
2525
+ attr_accessor :metadata
2526
+ # The shipping rate options to apply to this Session. Up to a maximum of 5.
2527
+ sig {
2528
+ returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::UpdateParams::ShippingOption]))
2529
+ }
2530
+ attr_accessor :shipping_options
2531
+ sig {
2532
+ params(collected_information: ::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation, expand: T::Array[String], line_items: T::Array[::Stripe::Checkout::SessionService::UpdateParams::LineItem], metadata: T.nilable(T::Hash[String, String]), shipping_options: T.nilable(T::Array[::Stripe::Checkout::SessionService::UpdateParams::ShippingOption])).void
2533
+ }
2534
+ def initialize(
2535
+ collected_information: nil,
2536
+ expand: nil,
2537
+ line_items: nil,
2538
+ metadata: nil,
2539
+ shipping_options: nil
2540
+ ); end
2541
+ end
2542
+ class ExpireParams < Stripe::RequestParams
2543
+ # Specifies which fields in the response should be expanded.
2544
+ sig { returns(T::Array[String]) }
2545
+ attr_accessor :expand
2546
+ sig { params(expand: T::Array[String]).void }
2547
+ def initialize(expand: nil); end
2548
+ end
2549
+ # Creates a Session object.
2550
+ sig {
2551
+ params(params: T.any(::Stripe::Checkout::SessionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2552
+ }
2553
+ def create(params = {}, opts = {}); end
2554
+
2555
+ # A Session can be expired when it is in one of these statuses: open
2556
+ #
2557
+ # After it expires, a customer can't complete a Session and customers loading the Session see a message saying the Session is expired.
2558
+ sig {
2559
+ params(session: String, params: T.any(::Stripe::Checkout::SessionService::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2560
+ }
2561
+ def expire(session, params = {}, opts = {}); end
2562
+
2563
+ # Returns a list of Checkout Sessions.
2564
+ sig {
2565
+ params(params: T.any(::Stripe::Checkout::SessionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
2566
+ }
2567
+ def list(params = {}, opts = {}); end
2568
+
2569
+ # Retrieves a Session object.
2570
+ sig {
2571
+ params(session: String, params: T.any(::Stripe::Checkout::SessionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2572
+ }
2573
+ def retrieve(session, params = {}, opts = {}); end
2574
+
2575
+ # Updates a Session object.
2576
+ sig {
2577
+ params(session: String, params: T.any(::Stripe::Checkout::SessionService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2578
+ }
2579
+ def update(session, params = {}, opts = {}); end
2580
+ end
2581
+ end
2582
+ end