stripe 13.5.0 → 13.6.0.pre.beta.1

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