stripe 13.4.1 → 13.5.0.pre.beta.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (743) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1427 -645
  3. data/OPENAPI_VERSION +1 -1
  4. data/VERSION +1 -1
  5. data/lib/stripe/api_operations/request.rb +1 -0
  6. data/lib/stripe/api_requestor.rb +1 -0
  7. data/lib/stripe/object_types.rb +32 -0
  8. data/lib/stripe/request_params.rb +24 -0
  9. data/lib/stripe/request_signing_authenticator.rb +79 -0
  10. data/lib/stripe/resources/account.rb +5165 -0
  11. data/lib/stripe/resources/account_link.rb +54 -0
  12. data/lib/stripe/resources/account_notice.rb +132 -0
  13. data/lib/stripe/resources/account_session.rb +985 -0
  14. data/lib/stripe/resources/apple_pay_domain.rb +63 -0
  15. data/lib/stripe/resources/application.rb +20 -0
  16. data/lib/stripe/resources/application_fee.rb +96 -0
  17. data/lib/stripe/resources/application_fee_refund.rb +17 -0
  18. data/lib/stripe/resources/apps/secret.rb +141 -0
  19. data/lib/stripe/resources/balance.rb +131 -0
  20. data/lib/stripe/resources/balance_transaction.rb +112 -0
  21. data/lib/stripe/resources/bank_account.rb +84 -2
  22. data/lib/stripe/resources/billing/alert.rb +144 -0
  23. data/lib/stripe/resources/billing/alert_triggered.rb +26 -0
  24. data/lib/stripe/resources/billing/credit_balance_summary.rb +88 -0
  25. data/lib/stripe/resources/billing/credit_balance_transaction.rb +116 -0
  26. data/lib/stripe/resources/billing/credit_grant.rb +220 -0
  27. data/lib/stripe/resources/billing/meter.rb +178 -0
  28. data/lib/stripe/resources/billing/meter_error_report.rb +59 -0
  29. data/lib/stripe/resources/billing/meter_event.rb +35 -0
  30. data/lib/stripe/resources/billing/meter_event_adjustment.rb +43 -0
  31. data/lib/stripe/resources/billing/meter_event_summary.rb +17 -0
  32. data/lib/stripe/resources/billing_portal/configuration.rb +562 -0
  33. data/lib/stripe/resources/billing_portal/session.rb +271 -0
  34. data/lib/stripe/resources/capability.rb +84 -0
  35. data/lib/stripe/resources/capital/financing_offer.rb +188 -0
  36. data/lib/stripe/resources/capital/financing_summary.rb +64 -0
  37. data/lib/stripe/resources/capital/financing_transaction.rb +123 -0
  38. data/lib/stripe/resources/card.rb +79 -0
  39. data/lib/stripe/resources/cash_balance.rb +17 -0
  40. data/lib/stripe/resources/charge.rb +3034 -0
  41. data/lib/stripe/resources/checkout/session.rb +3690 -0
  42. data/lib/stripe/resources/climate/order.rb +176 -0
  43. data/lib/stripe/resources/climate/product.rb +56 -0
  44. data/lib/stripe/resources/climate/supplier.rb +54 -0
  45. data/lib/stripe/resources/confirmation_token.rb +1530 -0
  46. data/lib/stripe/resources/connect_collection_transfer.rb +24 -0
  47. data/lib/stripe/resources/country_spec.rb +63 -0
  48. data/lib/stripe/resources/coupon.rb +198 -0
  49. data/lib/stripe/resources/credit_note.rb +660 -0
  50. data/lib/stripe/resources/credit_note_line_item.rb +65 -0
  51. data/lib/stripe/resources/customer.rb +840 -0
  52. data/lib/stripe/resources/customer_balance_transaction.rb +27 -0
  53. data/lib/stripe/resources/customer_cash_balance_transaction.rb +109 -0
  54. data/lib/stripe/resources/customer_session.rb +159 -0
  55. data/lib/stripe/resources/discount.rb +29 -0
  56. data/lib/stripe/resources/dispute.rb +619 -0
  57. data/lib/stripe/resources/entitlements/active_entitlement.rb +46 -0
  58. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +23 -0
  59. data/lib/stripe/resources/entitlements/feature.rb +90 -0
  60. data/lib/stripe/resources/ephemeral_key.rb +21 -0
  61. data/lib/stripe/resources/event.rb +130 -0
  62. data/lib/stripe/resources/exchange_rate.rb +33 -0
  63. data/lib/stripe/resources/file.rb +111 -0
  64. data/lib/stripe/resources/file_link.rb +112 -0
  65. data/lib/stripe/resources/financial_connections/account.rb +260 -0
  66. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  67. data/lib/stripe/resources/financial_connections/account_owner.rb +17 -0
  68. data/lib/stripe/resources/financial_connections/account_ownership.rb +9 -0
  69. data/lib/stripe/resources/financial_connections/institution.rb +99 -0
  70. data/lib/stripe/resources/financial_connections/session.rb +159 -0
  71. data/lib/stripe/resources/financial_connections/transaction.rb +101 -0
  72. data/lib/stripe/resources/forwarding/request.rb +165 -0
  73. data/lib/stripe/resources/funding_instructions.rb +308 -0
  74. data/lib/stripe/resources/gift_cards/card.rb +217 -0
  75. data/lib/stripe/resources/gift_cards/transaction.rb +281 -0
  76. data/lib/stripe/resources/identity/verification_report.rb +266 -0
  77. data/lib/stripe/resources/identity/verification_session.rb +361 -0
  78. data/lib/stripe/resources/invoice.rb +8078 -0
  79. data/lib/stripe/resources/invoice_item.rb +445 -0
  80. data/lib/stripe/resources/invoice_line_item.rb +333 -0
  81. data/lib/stripe/resources/invoice_payment.rb +56 -0
  82. data/lib/stripe/resources/invoice_rendering_template.rb +67 -0
  83. data/lib/stripe/resources/issuing/authorization.rb +1113 -0
  84. data/lib/stripe/resources/issuing/card.rb +666 -0
  85. data/lib/stripe/resources/issuing/cardholder.rb +658 -0
  86. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +611 -0
  87. data/lib/stripe/resources/issuing/dispute.rb +790 -0
  88. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +84 -0
  89. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +95 -0
  90. data/lib/stripe/resources/issuing/personalization_design.rb +285 -0
  91. data/lib/stripe/resources/issuing/physical_bundle.rb +63 -0
  92. data/lib/stripe/resources/issuing/settlement.rb +49 -0
  93. data/lib/stripe/resources/issuing/token.rb +175 -0
  94. data/lib/stripe/resources/issuing/transaction.rb +927 -0
  95. data/lib/stripe/resources/line_item.rb +75 -0
  96. data/lib/stripe/resources/login_link.rb +7 -0
  97. data/lib/stripe/resources/mandate.rb +169 -0
  98. data/lib/stripe/resources/margin.rb +124 -0
  99. data/lib/stripe/resources/order.rb +2850 -0
  100. data/lib/stripe/resources/payment_attempt_record.rb +184 -0
  101. data/lib/stripe/resources/payment_intent.rb +12910 -0
  102. data/lib/stripe/resources/payment_link.rb +1563 -0
  103. data/lib/stripe/resources/payment_method.rb +1655 -0
  104. data/lib/stripe/resources/payment_method_configuration.rb +2903 -0
  105. data/lib/stripe/resources/payment_method_domain.rb +153 -0
  106. data/lib/stripe/resources/payment_record.rb +715 -0
  107. data/lib/stripe/resources/payout.rb +218 -0
  108. data/lib/stripe/resources/person.rb +263 -0
  109. data/lib/stripe/resources/plan.rb +317 -0
  110. data/lib/stripe/resources/price.rb +649 -0
  111. data/lib/stripe/resources/product.rb +536 -0
  112. data/lib/stripe/resources/product_feature.rb +12 -0
  113. data/lib/stripe/resources/promotion_code.rb +221 -0
  114. data/lib/stripe/resources/quote.rb +2946 -0
  115. data/lib/stripe/resources/quote_line.rb +274 -0
  116. data/lib/stripe/resources/quote_preview_invoice.rb +652 -0
  117. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +362 -0
  118. data/lib/stripe/resources/radar/early_fraud_warning.rb +77 -0
  119. data/lib/stripe/resources/radar/value_list.rb +125 -0
  120. data/lib/stripe/resources/radar/value_list_item.rb +95 -0
  121. data/lib/stripe/resources/refund.rb +397 -0
  122. data/lib/stripe/resources/reporting/report_run.rb +150 -0
  123. data/lib/stripe/resources/reporting/report_type.rb +36 -0
  124. data/lib/stripe/resources/reserve_transaction.rb +22 -0
  125. data/lib/stripe/resources/reversal.rb +21 -0
  126. data/lib/stripe/resources/review.rb +108 -0
  127. data/lib/stripe/resources/setup_attempt.rb +373 -0
  128. data/lib/stripe/resources/setup_intent.rb +3855 -0
  129. data/lib/stripe/resources/shipping_rate.rb +259 -0
  130. data/lib/stripe/resources/sigma/scheduled_query_run.rb +54 -0
  131. data/lib/stripe/resources/source.rb +1239 -0
  132. data/lib/stripe/resources/source_mandate_notification.rb +66 -0
  133. data/lib/stripe/resources/source_transaction.rb +85 -0
  134. data/lib/stripe/resources/subscription.rb +2057 -0
  135. data/lib/stripe/resources/subscription_item.rb +433 -0
  136. data/lib/stripe/resources/subscription_schedule.rb +2402 -0
  137. data/lib/stripe/resources/tax/association.rb +89 -0
  138. data/lib/stripe/resources/tax/calculation.rb +387 -0
  139. data/lib/stripe/resources/tax/calculation_line_item.rb +56 -0
  140. data/lib/stripe/resources/tax/form.rb +220 -0
  141. data/lib/stripe/resources/tax/registration.rb +2382 -0
  142. data/lib/stripe/resources/tax/settings.rb +126 -0
  143. data/lib/stripe/resources/tax/transaction.rb +267 -0
  144. data/lib/stripe/resources/tax/transaction_line_item.rb +31 -0
  145. data/lib/stripe/resources/tax_code.rb +35 -0
  146. data/lib/stripe/resources/tax_deducted_at_source.rb +22 -0
  147. data/lib/stripe/resources/tax_id.rb +121 -0
  148. data/lib/stripe/resources/tax_rate.rb +202 -2
  149. data/lib/stripe/resources/terminal/configuration.rb +1060 -0
  150. data/lib/stripe/resources/terminal/connection_token.rb +18 -0
  151. data/lib/stripe/resources/terminal/location.rb +175 -0
  152. data/lib/stripe/resources/terminal/reader.rb +774 -0
  153. data/lib/stripe/resources/terminal/reader_collected_data.rb +40 -0
  154. data/lib/stripe/resources/test_helpers/test_clock.rb +86 -0
  155. data/lib/stripe/resources/token.rb +1168 -0
  156. data/lib/stripe/resources/topup.rb +174 -0
  157. data/lib/stripe/resources/transfer.rb +153 -0
  158. data/lib/stripe/resources/treasury/credit_reversal.rb +92 -0
  159. data/lib/stripe/resources/treasury/debit_reversal.rb +103 -0
  160. data/lib/stripe/resources/treasury/financial_account.rb +752 -0
  161. data/lib/stripe/resources/treasury/financial_account_features.rb +191 -0
  162. data/lib/stripe/resources/treasury/inbound_transfer.rb +235 -0
  163. data/lib/stripe/resources/treasury/outbound_payment.rb +495 -0
  164. data/lib/stripe/resources/treasury/outbound_transfer.rb +387 -0
  165. data/lib/stripe/resources/treasury/received_credit.rb +283 -0
  166. data/lib/stripe/resources/treasury/received_debit.rb +244 -0
  167. data/lib/stripe/resources/treasury/transaction.rb +176 -0
  168. data/lib/stripe/resources/treasury/transaction_entry.rb +157 -0
  169. data/lib/stripe/resources/usage_record.rb +13 -0
  170. data/lib/stripe/resources/usage_record_summary.rb +21 -0
  171. data/lib/stripe/resources/v2/amount.rb +9 -0
  172. data/lib/stripe/resources/v2/billing/meter_event.rb +18 -0
  173. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +21 -0
  174. data/lib/stripe/resources/v2/billing/meter_event_session.rb +14 -0
  175. data/lib/stripe/resources/v2/event.rb +27 -0
  176. data/lib/stripe/resources/v2/event_destination.rb +59 -0
  177. data/lib/stripe/resources/webhook_endpoint.rb +122 -0
  178. data/lib/stripe/resources.rb +31 -0
  179. data/lib/stripe/services/account_capability_service.rb +32 -0
  180. data/lib/stripe/services/account_external_account_service.rb +250 -0
  181. data/lib/stripe/services/account_link_service.rb +46 -0
  182. data/lib/stripe/services/account_login_link_service.rb +9 -0
  183. data/lib/stripe/services/account_notice_service.rb +101 -0
  184. data/lib/stripe/services/account_person_service.rb +875 -0
  185. data/lib/stripe/services/account_service.rb +4441 -0
  186. data/lib/stripe/services/account_session_service.rb +700 -0
  187. data/lib/stripe/services/apple_pay_domain_service.rb +51 -0
  188. data/lib/stripe/services/application_fee_refund_service.rb +54 -0
  189. data/lib/stripe/services/application_fee_service.rb +57 -0
  190. data/lib/stripe/services/apps/secret_service.rb +116 -0
  191. data/lib/stripe/services/balance_service.rb +9 -0
  192. data/lib/stripe/services/balance_transaction_service.rb +69 -0
  193. data/lib/stripe/services/billing/alert_service.rb +113 -0
  194. data/lib/stripe/services/billing/credit_balance_summary_service.rb +48 -0
  195. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +40 -0
  196. data/lib/stripe/services/billing/credit_grant_service.rb +162 -0
  197. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +26 -0
  198. data/lib/stripe/services/billing/meter_event_service.rb +21 -0
  199. data/lib/stripe/services/billing/meter_event_summary_service.rb +39 -0
  200. data/lib/stripe/services/billing/meter_service.rb +130 -0
  201. data/lib/stripe/services/billing_portal/configuration_service.rb +444 -0
  202. data/lib/stripe/services/billing_portal/session_service.rb +173 -0
  203. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  204. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  205. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  206. data/lib/stripe/services/capital_service.rb +15 -0
  207. data/lib/stripe/services/charge_service.rb +1736 -0
  208. data/lib/stripe/services/checkout/session_line_item_service.rb +18 -0
  209. data/lib/stripe/services/checkout/session_service.rb +2485 -0
  210. data/lib/stripe/services/climate/order_service.rb +102 -0
  211. data/lib/stripe/services/climate/product_service.rb +27 -0
  212. data/lib/stripe/services/climate/supplier_service.rb +27 -0
  213. data/lib/stripe/services/confirmation_token_service.rb +9 -0
  214. data/lib/stripe/services/country_spec_service.rb +27 -0
  215. data/lib/stripe/services/coupon_service.rb +152 -0
  216. data/lib/stripe/services/credit_note_line_item_service.rb +18 -0
  217. data/lib/stripe/services/credit_note_preview_lines_service.rb +156 -0
  218. data/lib/stripe/services/credit_note_service.rb +373 -0
  219. data/lib/stripe/services/customer_balance_transaction_service.rb +63 -0
  220. data/lib/stripe/services/customer_cash_balance_service.rb +29 -0
  221. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +27 -0
  222. data/lib/stripe/services/customer_funding_instructions_service.rb +42 -0
  223. data/lib/stripe/services/customer_payment_method_service.rb +40 -0
  224. data/lib/stripe/services/customer_payment_source_service.rb +179 -0
  225. data/lib/stripe/services/customer_service.rb +593 -0
  226. data/lib/stripe/services/customer_session_service.rb +96 -0
  227. data/lib/stripe/services/customer_tax_id_service.rb +45 -0
  228. data/lib/stripe/services/dispute_service.rb +374 -0
  229. data/lib/stripe/services/entitlements/active_entitlement_service.rb +36 -0
  230. data/lib/stripe/services/entitlements/feature_service.rb +76 -0
  231. data/lib/stripe/services/ephemeral_key_service.rb +36 -0
  232. data/lib/stripe/services/event_service.rb +65 -0
  233. data/lib/stripe/services/exchange_rate_service.rb +27 -0
  234. data/lib/stripe/services/file_link_service.rb +94 -0
  235. data/lib/stripe/services/file_service.rb +89 -0
  236. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +37 -0
  237. data/lib/stripe/services/financial_connections/account_owner_service.rb +27 -0
  238. data/lib/stripe/services/financial_connections/account_service.rb +99 -1
  239. data/lib/stripe/services/financial_connections/institution_service.rb +57 -0
  240. data/lib/stripe/services/financial_connections/session_service.rb +97 -0
  241. data/lib/stripe/services/financial_connections/transaction_service.rb +70 -0
  242. data/lib/stripe/services/financial_connections_service.rb +2 -1
  243. data/lib/stripe/services/forwarding/request_service.rb +106 -0
  244. data/lib/stripe/services/gift_cards/card_service.rb +170 -0
  245. data/lib/stripe/services/gift_cards/transaction_service.rb +209 -0
  246. data/lib/stripe/services/gift_cards_service.rb +14 -0
  247. data/lib/stripe/services/identity/verification_report_service.rb +65 -0
  248. data/lib/stripe/services/identity/verification_session_service.rb +231 -0
  249. data/lib/stripe/services/invoice_item_service.rb +388 -0
  250. data/lib/stripe/services/invoice_line_item_service.rb +237 -0
  251. data/lib/stripe/services/invoice_payment_service.rb +55 -0
  252. data/lib/stripe/services/invoice_rendering_template_service.rb +51 -0
  253. data/lib/stripe/services/invoice_service.rb +5567 -1
  254. data/lib/stripe/services/invoice_upcoming_lines_service.rb +1864 -0
  255. data/lib/stripe/services/issuing/authorization_service.rb +104 -0
  256. data/lib/stripe/services/issuing/card_service.rb +455 -0
  257. data/lib/stripe/services/issuing/cardholder_service.rb +526 -0
  258. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  259. data/lib/stripe/services/issuing/dispute_service.rb +633 -0
  260. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  261. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  262. data/lib/stripe/services/issuing/personalization_design_service.rb +193 -0
  263. data/lib/stripe/services/issuing/physical_bundle_service.rb +40 -0
  264. data/lib/stripe/services/issuing/token_service.rb +73 -0
  265. data/lib/stripe/services/issuing/transaction_service.rb +81 -0
  266. data/lib/stripe/services/issuing_service.rb +5 -1
  267. data/lib/stripe/services/mandate_service.rb +9 -0
  268. data/lib/stripe/services/margin_service.rb +119 -0
  269. data/lib/stripe/services/order_line_item_service.rb +35 -0
  270. data/lib/stripe/services/order_service.rb +2254 -0
  271. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  272. data/lib/stripe/services/payment_intent_service.rb +10936 -0
  273. data/lib/stripe/services/payment_link_line_item_service.rb +18 -0
  274. data/lib/stripe/services/payment_link_service.rb +1223 -0
  275. data/lib/stripe/services/payment_method_configuration_service.rb +2088 -0
  276. data/lib/stripe/services/payment_method_domain_service.rb +76 -0
  277. data/lib/stripe/services/payment_method_service.rb +878 -0
  278. data/lib/stripe/services/payment_record_service.rb +542 -0
  279. data/lib/stripe/services/payout_service.rb +159 -0
  280. data/lib/stripe/services/plan_service.rb +253 -0
  281. data/lib/stripe/services/price_service.rb +516 -0
  282. data/lib/stripe/services/product_feature_service.rb +42 -0
  283. data/lib/stripe/services/product_service.rb +459 -0
  284. data/lib/stripe/services/promotion_code_service.rb +178 -0
  285. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +18 -0
  286. data/lib/stripe/services/quote_line_item_service.rb +18 -0
  287. data/lib/stripe/services/quote_line_service.rb +35 -0
  288. data/lib/stripe/services/quote_preview_invoice_service.rb +35 -0
  289. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  290. data/lib/stripe/services/quote_service.rb +2319 -1
  291. data/lib/stripe/services/radar/early_fraud_warning_service.rb +61 -0
  292. data/lib/stripe/services/radar/value_list_item_service.rb +79 -0
  293. data/lib/stripe/services/radar/value_list_service.rb +103 -0
  294. data/lib/stripe/services/refund_service.rb +137 -0
  295. data/lib/stripe/services/reporting/report_run_service.rb +106 -0
  296. data/lib/stripe/services/reporting/report_type_service.rb +18 -0
  297. data/lib/stripe/services/review_service.rb +56 -0
  298. data/lib/stripe/services/setup_attempt_service.rb +51 -0
  299. data/lib/stripe/services/setup_intent_service.rb +3497 -0
  300. data/lib/stripe/services/shipping_rate_service.rb +200 -0
  301. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +27 -0
  302. data/lib/stripe/services/source_service.rb +601 -0
  303. data/lib/stripe/services/source_transaction_service.rb +18 -0
  304. data/lib/stripe/services/subscription_item_service.rb +383 -0
  305. data/lib/stripe/services/subscription_item_usage_record_service.rb +18 -0
  306. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +18 -0
  307. data/lib/stripe/services/subscription_schedule_service.rb +2053 -0
  308. data/lib/stripe/services/subscription_service.rb +1722 -0
  309. data/lib/stripe/services/tax/association_service.rb +31 -0
  310. data/lib/stripe/services/tax/calculation_line_item_service.rb +18 -0
  311. data/lib/stripe/services/tax/calculation_service.rb +205 -0
  312. data/lib/stripe/services/tax/form_service.rb +100 -0
  313. data/lib/stripe/services/tax/registration_service.rb +1564 -0
  314. data/lib/stripe/services/tax/settings_service.rb +74 -0
  315. data/lib/stripe/services/tax/transaction_line_item_service.rb +18 -0
  316. data/lib/stripe/services/tax/transaction_service.rb +111 -0
  317. data/lib/stripe/services/tax_code_service.rb +27 -0
  318. data/lib/stripe/services/tax_id_service.rb +79 -0
  319. data/lib/stripe/services/tax_rate_service.rb +155 -0
  320. data/lib/stripe/services/tax_service.rb +3 -1
  321. data/lib/stripe/services/terminal/configuration_service.rb +831 -0
  322. data/lib/stripe/services/terminal/connection_token_service.rb +12 -0
  323. data/lib/stripe/services/terminal/location_service.rb +144 -0
  324. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  325. data/lib/stripe/services/terminal/reader_service.rb +443 -0
  326. data/lib/stripe/services/terminal_service.rb +2 -1
  327. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +680 -0
  328. data/lib/stripe/services/test_helpers/customer_service.rb +18 -0
  329. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +745 -0
  330. data/lib/stripe/services/test_helpers/issuing/card_service.rb +45 -0
  331. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +41 -0
  332. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +632 -0
  333. data/lib/stripe/services/test_helpers/refund_service.rb +9 -0
  334. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +44 -0
  335. data/lib/stripe/services/test_helpers/test_clock_service.rb +57 -0
  336. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +38 -0
  337. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +87 -0
  338. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +87 -0
  339. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +84 -0
  340. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +84 -0
  341. data/lib/stripe/services/token_service.rb +1140 -0
  342. data/lib/stripe/services/topup_service.rb +142 -0
  343. data/lib/stripe/services/transfer_reversal_service.rb +66 -0
  344. data/lib/stripe/services/transfer_service.rb +119 -0
  345. data/lib/stripe/services/treasury/credit_reversal_service.rb +59 -0
  346. data/lib/stripe/services/treasury/debit_reversal_service.rb +63 -0
  347. data/lib/stripe/services/treasury/financial_account_features_service.rb +169 -0
  348. data/lib/stripe/services/treasury/financial_account_service.rb +498 -0
  349. data/lib/stripe/services/treasury/inbound_transfer_service.rb +88 -0
  350. data/lib/stripe/services/treasury/outbound_payment_service.rb +258 -0
  351. data/lib/stripe/services/treasury/outbound_transfer_service.rb +148 -0
  352. data/lib/stripe/services/treasury/received_credit_service.rb +52 -0
  353. data/lib/stripe/services/treasury/received_debit_service.rb +40 -0
  354. data/lib/stripe/services/treasury/transaction_entry_service.rb +87 -0
  355. data/lib/stripe/services/treasury/transaction_service.rb +95 -0
  356. data/lib/stripe/services/v1_services.rb +8 -1
  357. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +23 -0
  358. data/lib/stripe/services/v2/billing/meter_event_service.rb +25 -0
  359. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +3 -0
  360. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +33 -0
  361. data/lib/stripe/services/v2/core/event_destination_service.rb +146 -0
  362. data/lib/stripe/services/v2/core/event_service.rb +18 -0
  363. data/lib/stripe/services/webhook_endpoint_service.rb +96 -0
  364. data/lib/stripe/services.rb +25 -0
  365. data/lib/stripe/stripe_client.rb +1 -1
  366. data/lib/stripe/stripe_configuration.rb +3 -1
  367. data/lib/stripe/stripe_object.rb +5 -0
  368. data/lib/stripe/util.rb +7 -1
  369. data/lib/stripe/version.rb +1 -1
  370. data/lib/stripe.rb +46 -0
  371. data/rbi/stripe/resources/account.rbi +5188 -0
  372. data/rbi/stripe/resources/account_link.rbi +74 -0
  373. data/rbi/stripe/resources/account_notice.rbi +139 -0
  374. data/rbi/stripe/resources/account_session.rbi +1143 -0
  375. data/rbi/stripe/resources/apple_pay_domain.rbi +97 -0
  376. data/rbi/stripe/resources/application.rbi +20 -0
  377. data/rbi/stripe/resources/application_fee.rbi +123 -0
  378. data/rbi/stripe/resources/application_fee_refund.rbi +37 -0
  379. data/rbi/stripe/resources/apps/secret.rbi +195 -0
  380. data/rbi/stripe/resources/balance.rbi +187 -0
  381. data/rbi/stripe/resources/balance_transaction.rbi +149 -0
  382. data/rbi/stripe/resources/bank_account.rbi +127 -0
  383. data/rbi/stripe/resources/billing/alert.rbi +206 -0
  384. data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
  385. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +116 -0
  386. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +154 -0
  387. data/rbi/stripe/resources/billing/credit_grant.rbi +291 -0
  388. data/rbi/stripe/resources/billing/meter.rbi +233 -0
  389. data/rbi/stripe/resources/billing/meter_error_report.rbi +71 -0
  390. data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
  391. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
  392. data/rbi/stripe/resources/billing/meter_event_summary.rbi +35 -0
  393. data/rbi/stripe/resources/billing_portal/configuration.rbi +640 -0
  394. data/rbi/stripe/resources/billing_portal/session.rbi +341 -0
  395. data/rbi/stripe/resources/capability.rbi +125 -0
  396. data/rbi/stripe/resources/capital/financing_offer.rbi +190 -0
  397. data/rbi/stripe/resources/capital/financing_summary.rbi +74 -0
  398. data/rbi/stripe/resources/capital/financing_transaction.rbi +130 -0
  399. data/rbi/stripe/resources/card.rbi +128 -0
  400. data/rbi/stripe/resources/cash_balance.rbi +32 -0
  401. data/rbi/stripe/resources/charge.rbi +3494 -0
  402. data/rbi/stripe/resources/checkout/session.rbi +4036 -0
  403. data/rbi/stripe/resources/climate/order.rbi +250 -0
  404. data/rbi/stripe/resources/climate/product.rbi +82 -0
  405. data/rbi/stripe/resources/climate/supplier.rbi +79 -0
  406. data/rbi/stripe/resources/confirmation_token.rbi +1787 -0
  407. data/rbi/stripe/resources/connect_collection_transfer.rbi +26 -0
  408. data/rbi/stripe/resources/country_spec.rbi +92 -0
  409. data/rbi/stripe/resources/coupon.rbi +257 -0
  410. data/rbi/stripe/resources/credit_note.rbi +759 -0
  411. data/rbi/stripe/resources/credit_note_line_item.rbi +99 -0
  412. data/rbi/stripe/resources/customer.rbi +1001 -0
  413. data/rbi/stripe/resources/customer_balance_transaction.rbi +53 -0
  414. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
  415. data/rbi/stripe/resources/customer_session.rbi +196 -0
  416. data/rbi/stripe/resources/discount.rbi +53 -0
  417. data/rbi/stripe/resources/dispute.rbi +764 -0
  418. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +65 -0
  419. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
  420. data/rbi/stripe/resources/entitlements/feature.rbi +124 -0
  421. data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
  422. data/rbi/stripe/resources/event.rbi +190 -0
  423. data/rbi/stripe/resources/exchange_rate.rbi +73 -0
  424. data/rbi/stripe/resources/file.rbi +148 -0
  425. data/rbi/stripe/resources/file_link.rbi +146 -0
  426. data/rbi/stripe/resources/financial_connections/account.rbi +358 -0
  427. data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +27 -0
  428. data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
  429. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
  430. data/rbi/stripe/resources/financial_connections/institution.rbi +99 -0
  431. data/rbi/stripe/resources/financial_connections/session.rbi +186 -0
  432. data/rbi/stripe/resources/financial_connections/transaction.rbi +127 -0
  433. data/rbi/stripe/resources/forwarding/request.rbi +219 -0
  434. data/rbi/stripe/resources/funding_instructions.rbi +437 -0
  435. data/rbi/stripe/resources/gift_cards/card.rbi +206 -0
  436. data/rbi/stripe/resources/gift_cards/transaction.rbi +257 -0
  437. data/rbi/stripe/resources/identity/verification_report.rbi +354 -0
  438. data/rbi/stripe/resources/identity/verification_session.rbi +518 -0
  439. data/rbi/stripe/resources/invoice.rbi +8928 -0
  440. data/rbi/stripe/resources/invoice_item.rbi +514 -0
  441. data/rbi/stripe/resources/invoice_line_item.rbi +400 -0
  442. data/rbi/stripe/resources/invoice_payment.rbi +70 -0
  443. data/rbi/stripe/resources/invoice_rendering_template.rbi +114 -0
  444. data/rbi/stripe/resources/issuing/authorization.rbi +1266 -0
  445. data/rbi/stripe/resources/issuing/card.rbi +738 -0
  446. data/rbi/stripe/resources/issuing/cardholder.rbi +732 -0
  447. data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +622 -0
  448. data/rbi/stripe/resources/issuing/dispute.rbi +900 -0
  449. data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +83 -0
  450. data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +90 -0
  451. data/rbi/stripe/resources/issuing/personalization_design.rbi +333 -0
  452. data/rbi/stripe/resources/issuing/physical_bundle.rbi +86 -0
  453. data/rbi/stripe/resources/issuing/settlement.rbi +62 -0
  454. data/rbi/stripe/resources/issuing/token.rbi +231 -0
  455. data/rbi/stripe/resources/issuing/transaction.rbi +1057 -0
  456. data/rbi/stripe/resources/line_item.rbi +108 -0
  457. data/rbi/stripe/resources/login_link.rbi +18 -0
  458. data/rbi/stripe/resources/mandate.rbi +219 -0
  459. data/rbi/stripe/resources/margin.rbi +127 -0
  460. data/rbi/stripe/resources/order.rbi +3016 -0
  461. data/rbi/stripe/resources/payment_attempt_record.rbi +215 -0
  462. data/rbi/stripe/resources/payment_intent.rbi +13895 -0
  463. data/rbi/stripe/resources/payment_link.rbi +1666 -0
  464. data/rbi/stripe/resources/payment_method.rbi +1926 -0
  465. data/rbi/stripe/resources/payment_method_configuration.rbi +3237 -0
  466. data/rbi/stripe/resources/payment_method_domain.rbi +217 -0
  467. data/rbi/stripe/resources/payment_record.rbi +722 -0
  468. data/rbi/stripe/resources/payout.rbi +299 -0
  469. data/rbi/stripe/resources/person.rbi +371 -0
  470. data/rbi/stripe/resources/plan.rbi +385 -0
  471. data/rbi/stripe/resources/price.rbi +731 -0
  472. data/rbi/stripe/resources/product.rbi +615 -0
  473. data/rbi/stripe/resources/product_feature.rbi +26 -0
  474. data/rbi/stripe/resources/promotion_code.rbi +266 -0
  475. data/rbi/stripe/resources/quote.rbi +3186 -0
  476. data/rbi/stripe/resources/quote_line.rbi +350 -0
  477. data/rbi/stripe/resources/quote_preview_invoice.rbi +850 -0
  478. data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +474 -0
  479. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +101 -0
  480. data/rbi/stripe/resources/radar/value_list.rbi +175 -0
  481. data/rbi/stripe/resources/radar/value_list_item.rbi +134 -0
  482. data/rbi/stripe/resources/refund.rbi +515 -0
  483. data/rbi/stripe/resources/reporting/report_run.rbi +194 -0
  484. data/rbi/stripe/resources/reporting/report_type.rbi +64 -0
  485. data/rbi/stripe/resources/reserve_transaction.rbi +23 -0
  486. data/rbi/stripe/resources/reversal.rbi +51 -0
  487. data/rbi/stripe/resources/review.rbi +159 -0
  488. data/rbi/stripe/resources/setup_attempt.rbi +484 -0
  489. data/rbi/stripe/resources/setup_intent.rbi +4062 -0
  490. data/rbi/stripe/resources/shipping_rate.rbi +310 -0
  491. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +82 -0
  492. data/rbi/stripe/resources/source.rbi +1543 -0
  493. data/rbi/stripe/resources/source_mandate_notification.rbi +77 -0
  494. data/rbi/stripe/resources/source_transaction.rbi +127 -0
  495. data/rbi/stripe/resources/subscription.rbi +2308 -0
  496. data/rbi/stripe/resources/subscription_item.rbi +478 -0
  497. data/rbi/stripe/resources/subscription_schedule.rbi +2653 -0
  498. data/rbi/stripe/resources/tax/association.rbi +94 -0
  499. data/rbi/stripe/resources/tax/calculation.rbi +479 -0
  500. data/rbi/stripe/resources/tax/calculation_line_item.rbi +88 -0
  501. data/rbi/stripe/resources/tax/form.rbi +224 -0
  502. data/rbi/stripe/resources/tax/registration.rbi +2438 -0
  503. data/rbi/stripe/resources/tax/settings.rbi +148 -0
  504. data/rbi/stripe/resources/tax/transaction.rbi +356 -0
  505. data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
  506. data/rbi/stripe/resources/tax_code.rbi +51 -0
  507. data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
  508. data/rbi/stripe/resources/tax_id.rbi +174 -0
  509. data/rbi/stripe/resources/tax_rate.rbi +244 -0
  510. data/rbi/stripe/resources/terminal/configuration.rbi +1143 -0
  511. data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
  512. data/rbi/stripe/resources/terminal/location.rbi +231 -0
  513. data/rbi/stripe/resources/terminal/reader.rbi +940 -0
  514. data/rbi/stripe/resources/terminal/reader_collected_data.rbi +41 -0
  515. data/rbi/stripe/resources/test_helpers/test_clock.rbi +139 -0
  516. data/rbi/stripe/resources/token.rbi +1192 -0
  517. data/rbi/stripe/resources/topup.rbi +225 -0
  518. data/rbi/stripe/resources/transfer.rbi +204 -0
  519. data/rbi/stripe/resources/treasury/credit_reversal.rbi +126 -0
  520. data/rbi/stripe/resources/treasury/debit_reversal.rbi +138 -0
  521. data/rbi/stripe/resources/treasury/financial_account.rbi +870 -0
  522. data/rbi/stripe/resources/treasury/financial_account_features.rbi +263 -0
  523. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +302 -0
  524. data/rbi/stripe/resources/treasury/outbound_payment.rbi +589 -0
  525. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +473 -0
  526. data/rbi/stripe/resources/treasury/received_credit.rbi +348 -0
  527. data/rbi/stripe/resources/treasury/received_debit.rbi +305 -0
  528. data/rbi/stripe/resources/treasury/transaction.rbi +216 -0
  529. data/rbi/stripe/resources/treasury/transaction_entry.rbi +193 -0
  530. data/rbi/stripe/resources/usage_record.rbi +32 -0
  531. data/rbi/stripe/resources/usage_record_summary.rbi +38 -0
  532. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  533. data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
  534. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
  535. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
  536. data/rbi/stripe/resources/v2/event.rbi +47 -0
  537. data/rbi/stripe/resources/v2/event_destination.rbi +90 -0
  538. data/rbi/stripe/resources/webhook_endpoint.rbi +177 -0
  539. data/rbi/stripe/services/account_capability_service.rbi +51 -0
  540. data/rbi/stripe/services/account_external_account_service.rbi +306 -0
  541. data/rbi/stripe/services/account_link_service.rbi +58 -0
  542. data/rbi/stripe/services/account_login_link_service.rbi +22 -0
  543. data/rbi/stripe/services/account_notice_service.rbi +90 -0
  544. data/rbi/stripe/services/account_person_service.rbi +903 -0
  545. data/rbi/stripe/services/account_service.rbi +4267 -0
  546. data/rbi/stripe/services/account_session_service.rbi +803 -0
  547. data/rbi/stripe/services/apple_pay_domain_service.rbi +78 -0
  548. data/rbi/stripe/services/application_fee_refund_service.rbi +91 -0
  549. data/rbi/stripe/services/application_fee_service.rbi +74 -0
  550. data/rbi/stripe/services/apps/secret_service.rbi +151 -0
  551. data/rbi/stripe/services/apps_service.rbi +9 -0
  552. data/rbi/stripe/services/balance_service.rbi +21 -0
  553. data/rbi/stripe/services/balance_transaction_service.rbi +89 -0
  554. data/rbi/stripe/services/billing/alert_service.rbi +152 -0
  555. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +68 -0
  556. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
  557. data/rbi/stripe/services/billing/credit_grant_service.rbi +205 -0
  558. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +40 -0
  559. data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
  560. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
  561. data/rbi/stripe/services/billing/meter_service.rbi +163 -0
  562. data/rbi/stripe/services/billing_portal/configuration_service.rbi +497 -0
  563. data/rbi/stripe/services/billing_portal/session_service.rbi +202 -0
  564. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  565. data/rbi/stripe/services/billing_service.rbi +15 -0
  566. data/rbi/stripe/services/capital/financing_offer_service.rbi +95 -0
  567. data/rbi/stripe/services/capital/financing_summary_service.rbi +22 -0
  568. data/rbi/stripe/services/capital/financing_transaction_service.rbi +68 -0
  569. data/rbi/stripe/services/capital_service.rbi +11 -0
  570. data/rbi/stripe/services/charge_service.rbi +1816 -0
  571. data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
  572. data/rbi/stripe/services/checkout/session_service.rbi +2604 -0
  573. data/rbi/stripe/services/checkout_service.rbi +9 -0
  574. data/rbi/stripe/services/climate/order_service.rbi +140 -0
  575. data/rbi/stripe/services/climate/product_service.rbi +46 -0
  576. data/rbi/stripe/services/climate/supplier_service.rbi +46 -0
  577. data/rbi/stripe/services/climate_service.rbi +11 -0
  578. data/rbi/stripe/services/confirmation_token_service.rbi +20 -0
  579. data/rbi/stripe/services/country_spec_service.rbi +44 -0
  580. data/rbi/stripe/services/coupon_service.rbi +190 -0
  581. data/rbi/stripe/services/credit_note_line_item_service.rbi +31 -0
  582. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +167 -0
  583. data/rbi/stripe/services/credit_note_service.rbi +420 -0
  584. data/rbi/stripe/services/customer_balance_transaction_service.rbi +92 -0
  585. data/rbi/stripe/services/customer_cash_balance_service.rbi +45 -0
  586. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +44 -0
  587. data/rbi/stripe/services/customer_funding_instructions_service.rbi +59 -0
  588. data/rbi/stripe/services/customer_payment_method_service.rbi +57 -0
  589. data/rbi/stripe/services/customer_payment_source_service.rbi +228 -0
  590. data/rbi/stripe/services/customer_service.rbi +647 -0
  591. data/rbi/stripe/services/customer_session_service.rbi +110 -0
  592. data/rbi/stripe/services/customer_tax_id_service.rbi +72 -0
  593. data/rbi/stripe/services/dispute_service.rbi +422 -0
  594. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
  595. data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
  596. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  597. data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
  598. data/rbi/stripe/services/event_service.rbi +81 -0
  599. data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
  600. data/rbi/stripe/services/file_link_service.rbi +122 -0
  601. data/rbi/stripe/services/file_service.rbi +114 -0
  602. data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +33 -0
  603. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
  604. data/rbi/stripe/services/financial_connections/account_service.rbi +132 -0
  605. data/rbi/stripe/services/financial_connections/institution_service.rbi +46 -0
  606. data/rbi/stripe/services/financial_connections/session_service.rbi +111 -0
  607. data/rbi/stripe/services/financial_connections/transaction_service.rbi +90 -0
  608. data/rbi/stripe/services/financial_connections_service.rbi +12 -0
  609. data/rbi/stripe/services/forwarding/request_service.rbi +132 -0
  610. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  611. data/rbi/stripe/services/gift_cards/card_service.rbi +142 -0
  612. data/rbi/stripe/services/gift_cards/transaction_service.rbi +174 -0
  613. data/rbi/stripe/services/gift_cards_service.rbi +10 -0
  614. data/rbi/stripe/services/identity/verification_report_service.rbi +85 -0
  615. data/rbi/stripe/services/identity/verification_session_service.rbi +317 -0
  616. data/rbi/stripe/services/identity_service.rbi +10 -0
  617. data/rbi/stripe/services/invoice_item_service.rbi +424 -0
  618. data/rbi/stripe/services/invoice_line_item_service.rbi +270 -0
  619. data/rbi/stripe/services/invoice_payment_service.rbi +44 -0
  620. data/rbi/stripe/services/invoice_rendering_template_service.rbi +82 -0
  621. data/rbi/stripe/services/invoice_service.rbi +6040 -0
  622. data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +2023 -0
  623. data/rbi/stripe/services/issuing/authorization_service.rbi +140 -0
  624. data/rbi/stripe/services/issuing/card_service.rbi +479 -0
  625. data/rbi/stripe/services/issuing/cardholder_service.rbi +568 -0
  626. data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +498 -0
  627. data/rbi/stripe/services/issuing/dispute_service.rbi +701 -0
  628. data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +55 -0
  629. data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +73 -0
  630. data/rbi/stripe/services/issuing/personalization_design_service.rbi +233 -0
  631. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
  632. data/rbi/stripe/services/issuing/token_service.rbi +95 -0
  633. data/rbi/stripe/services/issuing/transaction_service.rbi +103 -0
  634. data/rbi/stripe/services/issuing_service.rbi +19 -0
  635. data/rbi/stripe/services/mandate_service.rbi +20 -0
  636. data/rbi/stripe/services/margin_service.rbi +104 -0
  637. data/rbi/stripe/services/order_line_item_service.rbi +31 -0
  638. data/rbi/stripe/services/order_service.rbi +2306 -0
  639. data/rbi/stripe/services/payment_attempt_record_service.rbi +36 -0
  640. data/rbi/stripe/services/payment_intent_service.rbi +11477 -0
  641. data/rbi/stripe/services/payment_link_line_item_service.rbi +31 -0
  642. data/rbi/stripe/services/payment_link_service.rbi +1250 -0
  643. data/rbi/stripe/services/payment_method_configuration_service.rbi +2215 -0
  644. data/rbi/stripe/services/payment_method_domain_service.rbi +110 -0
  645. data/rbi/stripe/services/payment_method_service.rbi +897 -0
  646. data/rbi/stripe/services/payment_record_service.rbi +521 -0
  647. data/rbi/stripe/services/payout_service.rbi +197 -0
  648. data/rbi/stripe/services/plan_service.rbi +286 -0
  649. data/rbi/stripe/services/price_service.rbi +551 -0
  650. data/rbi/stripe/services/product_feature_service.rbi +69 -0
  651. data/rbi/stripe/services/product_service.rbi +503 -0
  652. data/rbi/stripe/services/promotion_code_service.rbi +210 -0
  653. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
  654. data/rbi/stripe/services/quote_line_item_service.rbi +31 -0
  655. data/rbi/stripe/services/quote_line_service.rbi +31 -0
  656. data/rbi/stripe/services/quote_preview_invoice_service.rbi +31 -0
  657. data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +31 -0
  658. data/rbi/stripe/services/quote_service.rbi +2390 -0
  659. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +83 -0
  660. data/rbi/stripe/services/radar/value_list_item_service.rbi +107 -0
  661. data/rbi/stripe/services/radar/value_list_service.rbi +139 -0
  662. data/rbi/stripe/services/radar_service.rbi +11 -0
  663. data/rbi/stripe/services/refund_service.rbi +181 -0
  664. data/rbi/stripe/services/reporting/report_run_service.rbi +131 -0
  665. data/rbi/stripe/services/reporting/report_type_service.rbi +35 -0
  666. data/rbi/stripe/services/reporting_service.rbi +10 -0
  667. data/rbi/stripe/services/review_service.rbi +82 -0
  668. data/rbi/stripe/services/setup_attempt_service.rbi +63 -0
  669. data/rbi/stripe/services/setup_intent_service.rbi +3630 -0
  670. data/rbi/stripe/services/shipping_rate_service.rbi +235 -0
  671. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +46 -0
  672. data/rbi/stripe/services/sigma_service.rbi +9 -0
  673. data/rbi/stripe/services/source_service.rbi +647 -0
  674. data/rbi/stripe/services/source_transaction_service.rbi +31 -0
  675. data/rbi/stripe/services/subscription_item_service.rbi +422 -0
  676. data/rbi/stripe/services/subscription_item_usage_record_service.rbi +37 -0
  677. data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +33 -0
  678. data/rbi/stripe/services/subscription_schedule_service.rbi +2208 -0
  679. data/rbi/stripe/services/subscription_service.rbi +1870 -0
  680. data/rbi/stripe/services/tax/association_service.rbi +25 -0
  681. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +33 -0
  682. data/rbi/stripe/services/tax/calculation_service.rbi +228 -0
  683. data/rbi/stripe/services/tax/form_service.rbi +85 -0
  684. data/rbi/stripe/services/tax/registration_service.rbi +1517 -0
  685. data/rbi/stripe/services/tax/settings_service.rbi +93 -0
  686. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +33 -0
  687. data/rbi/stripe/services/tax/transaction_service.rbi +142 -0
  688. data/rbi/stripe/services/tax_code_service.rbi +44 -0
  689. data/rbi/stripe/services/tax_id_service.rbi +112 -0
  690. data/rbi/stripe/services/tax_rate_service.rbi +183 -0
  691. data/rbi/stripe/services/tax_service.rbi +14 -0
  692. data/rbi/stripe/services/terminal/configuration_service.rbi +860 -0
  693. data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
  694. data/rbi/stripe/services/terminal/location_service.rbi +184 -0
  695. data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +22 -0
  696. data/rbi/stripe/services/terminal/reader_service.rbi +513 -0
  697. data/rbi/stripe/services/terminal_service.rbi +13 -0
  698. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +787 -0
  699. data/rbi/stripe/services/test_helpers/customer_service.rbi +33 -0
  700. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +836 -0
  701. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +76 -0
  702. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +67 -0
  703. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +705 -0
  704. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  705. data/rbi/stripe/services/test_helpers/refund_service.rbi +22 -0
  706. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +62 -0
  707. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  708. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +90 -0
  709. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
  710. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +123 -0
  711. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +123 -0
  712. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +114 -0
  713. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +114 -0
  714. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  715. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  716. data/rbi/stripe/services/token_service.rbi +1155 -0
  717. data/rbi/stripe/services/topup_service.rbi +172 -0
  718. data/rbi/stripe/services/transfer_reversal_service.rbi +99 -0
  719. data/rbi/stripe/services/transfer_service.rbi +150 -0
  720. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
  721. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
  722. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +201 -0
  723. data/rbi/stripe/services/treasury/financial_account_service.rbi +566 -0
  724. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
  725. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +300 -0
  726. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +182 -0
  727. data/rbi/stripe/services/treasury/received_credit_service.rbi +70 -0
  728. data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
  729. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +107 -0
  730. data/rbi/stripe/services/treasury/transaction_service.rbi +114 -0
  731. data/rbi/stripe/services/treasury_service.rbi +18 -0
  732. data/rbi/stripe/services/v1_services.rbi +83 -0
  733. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
  734. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
  735. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +20 -0
  736. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +55 -0
  737. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  738. data/rbi/stripe/services/v2/core/event_destination_service.rbi +203 -0
  739. data/rbi/stripe/services/v2/core/event_service.rbi +39 -0
  740. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  741. data/rbi/stripe/services/v2_services.rbi +10 -0
  742. data/rbi/stripe/services/webhook_endpoint_service.rbi +131 -0
  743. metadata +435 -4
@@ -0,0 +1,4036 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # typed: true
5
+ module Stripe
6
+ module Checkout
7
+ # A Checkout Session represents your customer's session as they pay for
8
+ # one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)
9
+ # or [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a
10
+ # new Session each time your customer attempts to pay.
11
+ #
12
+ # Once payment is successful, the Checkout Session will contain a reference
13
+ # to the [Customer](https://stripe.com/docs/api/customers), and either the successful
14
+ # [PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active
15
+ # [Subscription](https://stripe.com/docs/api/subscriptions).
16
+ #
17
+ # You can create a Checkout Session on your server and redirect to its URL
18
+ # to begin Checkout.
19
+ #
20
+ # Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)
21
+ class Session < APIResource
22
+ class AdaptivePricing < Stripe::StripeObject
23
+ # Whether Adaptive Pricing is enabled.
24
+ sig { returns(T::Boolean) }
25
+ attr_reader :enabled
26
+ end
27
+ class AfterExpiration < Stripe::StripeObject
28
+ class Recovery < Stripe::StripeObject
29
+ # Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
30
+ sig { returns(T::Boolean) }
31
+ attr_reader :allow_promotion_codes
32
+ # If `true`, a recovery url will be generated to recover this Checkout Session if it
33
+ # expires before a transaction is completed. It will be attached to the
34
+ # Checkout Session object upon expiration.
35
+ sig { returns(T::Boolean) }
36
+ attr_reader :enabled
37
+ # The timestamp at which the recovery URL will expire.
38
+ sig { returns(T.nilable(Integer)) }
39
+ attr_reader :expires_at
40
+ # URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session
41
+ sig { returns(T.nilable(String)) }
42
+ attr_reader :url
43
+ end
44
+ # When set, configuration used to recover the Checkout Session on expiry.
45
+ sig { returns(T.nilable(Recovery)) }
46
+ attr_reader :recovery
47
+ end
48
+ class AutomaticTax < Stripe::StripeObject
49
+ class Liability < Stripe::StripeObject
50
+ # The connected account being referenced when `type` is `account`.
51
+ sig { returns(T.any(String, Stripe::Account)) }
52
+ attr_reader :account
53
+ # Type of the account referenced.
54
+ sig { returns(String) }
55
+ attr_reader :type
56
+ end
57
+ # Indicates whether automatic tax is enabled for the session
58
+ sig { returns(T::Boolean) }
59
+ attr_reader :enabled
60
+ # 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.
61
+ sig { returns(T.nilable(Liability)) }
62
+ attr_reader :liability
63
+ # The status of the most recent automated tax calculation for this session.
64
+ sig { returns(T.nilable(String)) }
65
+ attr_reader :status
66
+ end
67
+ class CollectedInformation < Stripe::StripeObject
68
+ class ShippingDetails < Stripe::StripeObject
69
+ class Address < Stripe::StripeObject
70
+ # City, district, suburb, town, or village.
71
+ sig { returns(T.nilable(String)) }
72
+ attr_reader :city
73
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
74
+ sig { returns(T.nilable(String)) }
75
+ attr_reader :country
76
+ # Address line 1 (e.g., street, PO Box, or company name).
77
+ sig { returns(T.nilable(String)) }
78
+ attr_reader :line1
79
+ # Address line 2 (e.g., apartment, suite, unit, or building).
80
+ sig { returns(T.nilable(String)) }
81
+ attr_reader :line2
82
+ # ZIP or postal code.
83
+ sig { returns(T.nilable(String)) }
84
+ attr_reader :postal_code
85
+ # State, county, province, or region.
86
+ sig { returns(T.nilable(String)) }
87
+ attr_reader :state
88
+ end
89
+ # Attribute for field address
90
+ sig { returns(Address) }
91
+ attr_reader :address
92
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
93
+ sig { returns(T.nilable(String)) }
94
+ attr_reader :carrier
95
+ # Recipient name.
96
+ sig { returns(String) }
97
+ attr_reader :name
98
+ # Recipient phone (including extension).
99
+ sig { returns(T.nilable(String)) }
100
+ attr_reader :phone
101
+ # 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.
102
+ sig { returns(T.nilable(String)) }
103
+ attr_reader :tracking_number
104
+ end
105
+ class TaxId < Stripe::StripeObject
106
+ # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`
107
+ sig { returns(String) }
108
+ attr_reader :type
109
+ # The value of the tax ID.
110
+ sig { returns(T.nilable(String)) }
111
+ attr_reader :value
112
+ end
113
+ # Customer’s business name for this Checkout Session
114
+ sig { returns(T.nilable(String)) }
115
+ attr_reader :business_name
116
+ # Customer’s email for this Checkout Session
117
+ sig { returns(T.nilable(String)) }
118
+ attr_reader :email
119
+ # Customer’s phone number for this Checkout Session
120
+ sig { returns(T.nilable(String)) }
121
+ attr_reader :phone
122
+ # Shipping information for this Checkout Session.
123
+ sig { returns(T.nilable(ShippingDetails)) }
124
+ attr_reader :shipping_details
125
+ # Customer’s tax ids for this Checkout Session.
126
+ sig { returns(T.nilable(T::Array[TaxId])) }
127
+ attr_reader :tax_ids
128
+ end
129
+ class Consent < Stripe::StripeObject
130
+ # If `opt_in`, the customer consents to receiving promotional communications
131
+ # from the merchant about this Checkout Session.
132
+ sig { returns(T.nilable(String)) }
133
+ attr_reader :promotions
134
+ # If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.
135
+ sig { returns(T.nilable(String)) }
136
+ attr_reader :terms_of_service
137
+ end
138
+ class ConsentCollection < Stripe::StripeObject
139
+ class PaymentMethodReuseAgreement < Stripe::StripeObject
140
+ # Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.
141
+ #
142
+ # When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
143
+ sig { returns(String) }
144
+ attr_reader :position
145
+ end
146
+ # If set to `hidden`, it will hide legal text related to the reuse of a payment method.
147
+ sig { returns(T.nilable(PaymentMethodReuseAgreement)) }
148
+ attr_reader :payment_method_reuse_agreement
149
+ # If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
150
+ # Session will determine whether to display an option to opt into promotional communication
151
+ # from the merchant depending on the customer's locale. Only available to US merchants.
152
+ sig { returns(T.nilable(String)) }
153
+ attr_reader :promotions
154
+ # If set to `required`, it requires customers to accept the terms of service before being able to pay.
155
+ sig { returns(T.nilable(String)) }
156
+ attr_reader :terms_of_service
157
+ end
158
+ class CurrencyConversion < Stripe::StripeObject
159
+ # Total of all items in source currency before discounts or taxes are applied.
160
+ sig { returns(Integer) }
161
+ attr_reader :amount_subtotal
162
+ # Total of all items in source currency after discounts and taxes are applied.
163
+ sig { returns(Integer) }
164
+ attr_reader :amount_total
165
+ # Exchange rate used to convert source currency amounts to customer currency amounts
166
+ sig { returns(String) }
167
+ attr_reader :fx_rate
168
+ # Creation currency of the CheckoutSession before localization
169
+ sig { returns(String) }
170
+ attr_reader :source_currency
171
+ end
172
+ class CustomField < Stripe::StripeObject
173
+ class Dropdown < Stripe::StripeObject
174
+ class Option < Stripe::StripeObject
175
+ # The label for the option, displayed to the customer. Up to 100 characters.
176
+ sig { returns(String) }
177
+ attr_reader :label
178
+ # 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.
179
+ sig { returns(String) }
180
+ attr_reader :value
181
+ end
182
+ # The value that will pre-fill on the payment page.
183
+ sig { returns(T.nilable(String)) }
184
+ attr_reader :default_value
185
+ # The options available for the customer to select. Up to 200 options allowed.
186
+ sig { returns(T::Array[Option]) }
187
+ attr_reader :options
188
+ # The option selected by the customer. This will be the `value` for the option.
189
+ sig { returns(T.nilable(String)) }
190
+ attr_reader :value
191
+ end
192
+ class Label < Stripe::StripeObject
193
+ # Custom text for the label, displayed to the customer. Up to 50 characters.
194
+ sig { returns(T.nilable(String)) }
195
+ attr_reader :custom
196
+ # The type of the label.
197
+ sig { returns(String) }
198
+ attr_reader :type
199
+ end
200
+ class Numeric < Stripe::StripeObject
201
+ # The value that will pre-fill the field on the payment page.
202
+ sig { returns(T.nilable(String)) }
203
+ attr_reader :default_value
204
+ # The maximum character length constraint for the customer's input.
205
+ sig { returns(T.nilable(Integer)) }
206
+ attr_reader :maximum_length
207
+ # The minimum character length requirement for the customer's input.
208
+ sig { returns(T.nilable(Integer)) }
209
+ attr_reader :minimum_length
210
+ # The value entered by the customer, containing only digits.
211
+ sig { returns(T.nilable(String)) }
212
+ attr_reader :value
213
+ end
214
+ class Text < Stripe::StripeObject
215
+ # The value that will pre-fill the field on the payment page.
216
+ sig { returns(T.nilable(String)) }
217
+ attr_reader :default_value
218
+ # The maximum character length constraint for the customer's input.
219
+ sig { returns(T.nilable(Integer)) }
220
+ attr_reader :maximum_length
221
+ # The minimum character length requirement for the customer's input.
222
+ sig { returns(T.nilable(Integer)) }
223
+ attr_reader :minimum_length
224
+ # The value entered by the customer.
225
+ sig { returns(T.nilable(String)) }
226
+ attr_reader :value
227
+ end
228
+ # Attribute for field dropdown
229
+ sig { returns(Dropdown) }
230
+ attr_reader :dropdown
231
+ # 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.
232
+ sig { returns(String) }
233
+ attr_reader :key
234
+ # Attribute for field label
235
+ sig { returns(Label) }
236
+ attr_reader :label
237
+ # Attribute for field numeric
238
+ sig { returns(Numeric) }
239
+ attr_reader :numeric
240
+ # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
241
+ sig { returns(T::Boolean) }
242
+ attr_reader :optional
243
+ # Attribute for field text
244
+ sig { returns(Text) }
245
+ attr_reader :text
246
+ # The type of the field.
247
+ sig { returns(String) }
248
+ attr_reader :type
249
+ end
250
+ class CustomText < Stripe::StripeObject
251
+ class AfterSubmit < Stripe::StripeObject
252
+ # Text may be up to 1200 characters in length.
253
+ sig { returns(String) }
254
+ attr_reader :message
255
+ end
256
+ class ShippingAddress < Stripe::StripeObject
257
+ # Text may be up to 1200 characters in length.
258
+ sig { returns(String) }
259
+ attr_reader :message
260
+ end
261
+ class Submit < Stripe::StripeObject
262
+ # Text may be up to 1200 characters in length.
263
+ sig { returns(String) }
264
+ attr_reader :message
265
+ end
266
+ class TermsOfServiceAcceptance < Stripe::StripeObject
267
+ # Text may be up to 1200 characters in length.
268
+ sig { returns(String) }
269
+ attr_reader :message
270
+ end
271
+ # Custom text that should be displayed after the payment confirmation button.
272
+ sig { returns(T.nilable(AfterSubmit)) }
273
+ attr_reader :after_submit
274
+ # Custom text that should be displayed alongside shipping address collection.
275
+ sig { returns(T.nilable(ShippingAddress)) }
276
+ attr_reader :shipping_address
277
+ # Custom text that should be displayed alongside the payment confirmation button.
278
+ sig { returns(T.nilable(Submit)) }
279
+ attr_reader :submit
280
+ # Custom text that should be displayed in place of the default terms of service agreement text.
281
+ sig { returns(T.nilable(TermsOfServiceAcceptance)) }
282
+ attr_reader :terms_of_service_acceptance
283
+ end
284
+ class CustomerDetails < Stripe::StripeObject
285
+ class Address < Stripe::StripeObject
286
+ # City, district, suburb, town, or village.
287
+ sig { returns(T.nilable(String)) }
288
+ attr_reader :city
289
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
290
+ sig { returns(T.nilable(String)) }
291
+ attr_reader :country
292
+ # Address line 1 (e.g., street, PO Box, or company name).
293
+ sig { returns(T.nilable(String)) }
294
+ attr_reader :line1
295
+ # Address line 2 (e.g., apartment, suite, unit, or building).
296
+ sig { returns(T.nilable(String)) }
297
+ attr_reader :line2
298
+ # ZIP or postal code.
299
+ sig { returns(T.nilable(String)) }
300
+ attr_reader :postal_code
301
+ # State, county, province, or region.
302
+ sig { returns(T.nilable(String)) }
303
+ attr_reader :state
304
+ end
305
+ class TaxId < Stripe::StripeObject
306
+ # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`
307
+ sig { returns(String) }
308
+ attr_reader :type
309
+ # The value of the tax ID.
310
+ sig { returns(T.nilable(String)) }
311
+ attr_reader :value
312
+ end
313
+ # The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
314
+ sig { returns(T.nilable(Address)) }
315
+ attr_reader :address
316
+ # The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.
317
+ # Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.
318
+ sig { returns(T.nilable(String)) }
319
+ attr_reader :email
320
+ # The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
321
+ sig { returns(T.nilable(String)) }
322
+ attr_reader :name
323
+ # The customer's phone number after a completed Checkout Session.
324
+ sig { returns(T.nilable(String)) }
325
+ attr_reader :phone
326
+ # The customer’s tax exempt status after a completed Checkout Session.
327
+ sig { returns(T.nilable(String)) }
328
+ attr_reader :tax_exempt
329
+ # The customer’s tax IDs after a completed Checkout Session.
330
+ sig { returns(T.nilable(T::Array[TaxId])) }
331
+ attr_reader :tax_ids
332
+ end
333
+ class Discount < Stripe::StripeObject
334
+ # Coupon attached to the Checkout Session.
335
+ sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
336
+ attr_reader :coupon
337
+ # Promotion code attached to the Checkout Session.
338
+ sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
339
+ attr_reader :promotion_code
340
+ end
341
+ class InvoiceCreation < Stripe::StripeObject
342
+ class InvoiceData < Stripe::StripeObject
343
+ class CustomField < Stripe::StripeObject
344
+ # The name of the custom field.
345
+ sig { returns(String) }
346
+ attr_reader :name
347
+ # The value of the custom field.
348
+ sig { returns(String) }
349
+ attr_reader :value
350
+ end
351
+ class Issuer < Stripe::StripeObject
352
+ # The connected account being referenced when `type` is `account`.
353
+ sig { returns(T.any(String, Stripe::Account)) }
354
+ attr_reader :account
355
+ # Type of the account referenced.
356
+ sig { returns(String) }
357
+ attr_reader :type
358
+ end
359
+ class RenderingOptions < Stripe::StripeObject
360
+ # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
361
+ sig { returns(T.nilable(String)) }
362
+ attr_reader :amount_tax_display
363
+ end
364
+ # The account tax IDs associated with the invoice.
365
+ sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
366
+ attr_reader :account_tax_ids
367
+ # Custom fields displayed on the invoice.
368
+ sig { returns(T.nilable(T::Array[CustomField])) }
369
+ attr_reader :custom_fields
370
+ # An arbitrary string attached to the object. Often useful for displaying to users.
371
+ sig { returns(T.nilable(String)) }
372
+ attr_reader :description
373
+ # Footer displayed on the invoice.
374
+ sig { returns(T.nilable(String)) }
375
+ attr_reader :footer
376
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
377
+ sig { returns(T.nilable(Issuer)) }
378
+ attr_reader :issuer
379
+ # 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.
380
+ sig { returns(T.nilable(T::Hash[String, String])) }
381
+ attr_reader :metadata
382
+ # Options for invoice PDF rendering.
383
+ sig { returns(T.nilable(RenderingOptions)) }
384
+ attr_reader :rendering_options
385
+ end
386
+ # Indicates whether invoice creation is enabled for the Checkout Session.
387
+ sig { returns(T::Boolean) }
388
+ attr_reader :enabled
389
+ # Attribute for field invoice_data
390
+ sig { returns(InvoiceData) }
391
+ attr_reader :invoice_data
392
+ end
393
+ class PaymentMethodConfigurationDetails < Stripe::StripeObject
394
+ # ID of the payment method configuration used.
395
+ sig { returns(String) }
396
+ attr_reader :id
397
+ # ID of the parent payment method configuration used.
398
+ sig { returns(T.nilable(String)) }
399
+ attr_reader :parent
400
+ end
401
+ class PaymentMethodOptions < Stripe::StripeObject
402
+ class AcssDebit < Stripe::StripeObject
403
+ class MandateOptions < Stripe::StripeObject
404
+ # A URL for custom mandate text
405
+ sig { returns(String) }
406
+ attr_reader :custom_mandate_url
407
+ # List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.
408
+ sig { returns(T::Array[String]) }
409
+ attr_reader :default_for
410
+ # Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
411
+ sig { returns(T.nilable(String)) }
412
+ attr_reader :interval_description
413
+ # Payment schedule for the mandate.
414
+ sig { returns(T.nilable(String)) }
415
+ attr_reader :payment_schedule
416
+ # Transaction type of the mandate.
417
+ sig { returns(T.nilable(String)) }
418
+ attr_reader :transaction_type
419
+ end
420
+ # Currency supported by the bank account. Returned when the Session is in `setup` mode.
421
+ sig { returns(String) }
422
+ attr_reader :currency
423
+ # Attribute for field mandate_options
424
+ sig { returns(MandateOptions) }
425
+ attr_reader :mandate_options
426
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
427
+ #
428
+ # 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.
429
+ #
430
+ # 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.
431
+ #
432
+ # 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).
433
+ sig { returns(String) }
434
+ attr_reader :setup_future_usage
435
+ # Bank account verification method.
436
+ sig { returns(String) }
437
+ attr_reader :verification_method
438
+ end
439
+ class Affirm < Stripe::StripeObject
440
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
441
+ #
442
+ # 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.
443
+ #
444
+ # 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.
445
+ #
446
+ # 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).
447
+ sig { returns(String) }
448
+ attr_reader :setup_future_usage
449
+ end
450
+ class AfterpayClearpay < Stripe::StripeObject
451
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
452
+ #
453
+ # 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.
454
+ #
455
+ # 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.
456
+ #
457
+ # 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).
458
+ sig { returns(String) }
459
+ attr_reader :setup_future_usage
460
+ end
461
+ class Alipay < Stripe::StripeObject
462
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
463
+ #
464
+ # 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.
465
+ #
466
+ # 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.
467
+ #
468
+ # 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).
469
+ sig { returns(String) }
470
+ attr_reader :setup_future_usage
471
+ end
472
+ class AmazonPay < Stripe::StripeObject
473
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
474
+ #
475
+ # 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.
476
+ #
477
+ # 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.
478
+ #
479
+ # 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).
480
+ sig { returns(String) }
481
+ attr_reader :setup_future_usage
482
+ end
483
+ class AuBecsDebit < Stripe::StripeObject
484
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
485
+ #
486
+ # 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.
487
+ #
488
+ # 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.
489
+ #
490
+ # 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).
491
+ sig { returns(String) }
492
+ attr_reader :setup_future_usage
493
+ end
494
+ class BacsDebit < Stripe::StripeObject
495
+ class MandateOptions < Stripe::StripeObject
496
+ # 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'.
497
+ sig { returns(String) }
498
+ attr_reader :reference_prefix
499
+ end
500
+ # Attribute for field mandate_options
501
+ sig { returns(MandateOptions) }
502
+ attr_reader :mandate_options
503
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
504
+ #
505
+ # 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.
506
+ #
507
+ # 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.
508
+ #
509
+ # 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).
510
+ sig { returns(String) }
511
+ attr_reader :setup_future_usage
512
+ end
513
+ class Bancontact < Stripe::StripeObject
514
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
515
+ #
516
+ # 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.
517
+ #
518
+ # 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.
519
+ #
520
+ # 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).
521
+ sig { returns(String) }
522
+ attr_reader :setup_future_usage
523
+ end
524
+ class Boleto < Stripe::StripeObject
525
+ # 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 voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.
526
+ sig { returns(Integer) }
527
+ attr_reader :expires_after_days
528
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
529
+ #
530
+ # 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.
531
+ #
532
+ # 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.
533
+ #
534
+ # 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).
535
+ sig { returns(String) }
536
+ attr_reader :setup_future_usage
537
+ end
538
+ class Card < Stripe::StripeObject
539
+ class Installments < Stripe::StripeObject
540
+ # Indicates if installments are enabled
541
+ sig { returns(T::Boolean) }
542
+ attr_reader :enabled
543
+ end
544
+ class Restrictions < Stripe::StripeObject
545
+ # 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.
546
+ sig { returns(T::Array[String]) }
547
+ attr_reader :brands_blocked
548
+ end
549
+ # Attribute for field installments
550
+ sig { returns(Installments) }
551
+ attr_reader :installments
552
+ # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
553
+ sig { returns(String) }
554
+ attr_reader :request_decremental_authorization
555
+ # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
556
+ sig { returns(String) }
557
+ attr_reader :request_extended_authorization
558
+ # Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
559
+ sig { returns(String) }
560
+ attr_reader :request_incremental_authorization
561
+ # Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
562
+ sig { returns(String) }
563
+ attr_reader :request_multicapture
564
+ # Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
565
+ sig { returns(String) }
566
+ attr_reader :request_overcapture
567
+ # 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.
568
+ sig { returns(String) }
569
+ attr_reader :request_three_d_secure
570
+ # Attribute for field restrictions
571
+ sig { returns(Restrictions) }
572
+ attr_reader :restrictions
573
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
574
+ #
575
+ # 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.
576
+ #
577
+ # 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.
578
+ #
579
+ # 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).
580
+ sig { returns(String) }
581
+ attr_reader :setup_future_usage
582
+ # 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.
583
+ sig { returns(String) }
584
+ attr_reader :statement_descriptor_suffix_kana
585
+ # 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.
586
+ sig { returns(String) }
587
+ attr_reader :statement_descriptor_suffix_kanji
588
+ end
589
+ class Cashapp < Stripe::StripeObject
590
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
591
+ #
592
+ # 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.
593
+ #
594
+ # 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.
595
+ #
596
+ # 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).
597
+ sig { returns(String) }
598
+ attr_reader :setup_future_usage
599
+ end
600
+ class CustomerBalance < Stripe::StripeObject
601
+ class BankTransfer < Stripe::StripeObject
602
+ class EuBankTransfer < Stripe::StripeObject
603
+ # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
604
+ sig { returns(String) }
605
+ attr_reader :country
606
+ end
607
+ # Attribute for field eu_bank_transfer
608
+ sig { returns(EuBankTransfer) }
609
+ attr_reader :eu_bank_transfer
610
+ # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
611
+ #
612
+ # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
613
+ sig { returns(T::Array[String]) }
614
+ attr_reader :requested_address_types
615
+ # The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
616
+ sig { returns(T.nilable(String)) }
617
+ attr_reader :type
618
+ end
619
+ # Attribute for field bank_transfer
620
+ sig { returns(BankTransfer) }
621
+ attr_reader :bank_transfer
622
+ # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
623
+ sig { returns(T.nilable(String)) }
624
+ attr_reader :funding_type
625
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
626
+ #
627
+ # 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.
628
+ #
629
+ # 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.
630
+ #
631
+ # 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).
632
+ sig { returns(String) }
633
+ attr_reader :setup_future_usage
634
+ end
635
+ class Eps < Stripe::StripeObject
636
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
637
+ #
638
+ # 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.
639
+ #
640
+ # 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.
641
+ #
642
+ # 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).
643
+ sig { returns(String) }
644
+ attr_reader :setup_future_usage
645
+ end
646
+ class Fpx < Stripe::StripeObject
647
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
648
+ #
649
+ # 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.
650
+ #
651
+ # 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.
652
+ #
653
+ # 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).
654
+ sig { returns(String) }
655
+ attr_reader :setup_future_usage
656
+ end
657
+ class Giropay < Stripe::StripeObject
658
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
659
+ #
660
+ # 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.
661
+ #
662
+ # 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.
663
+ #
664
+ # 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).
665
+ sig { returns(String) }
666
+ attr_reader :setup_future_usage
667
+ end
668
+ class Grabpay < Stripe::StripeObject
669
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
670
+ #
671
+ # 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.
672
+ #
673
+ # 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.
674
+ #
675
+ # 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).
676
+ sig { returns(String) }
677
+ attr_reader :setup_future_usage
678
+ end
679
+ class Ideal < Stripe::StripeObject
680
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
681
+ #
682
+ # 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.
683
+ #
684
+ # 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.
685
+ #
686
+ # 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).
687
+ sig { returns(String) }
688
+ attr_reader :setup_future_usage
689
+ end
690
+ class KakaoPay < Stripe::StripeObject
691
+ # Controls when the funds will be captured from the customer's account.
692
+ sig { returns(String) }
693
+ attr_reader :capture_method
694
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
695
+ #
696
+ # 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.
697
+ #
698
+ # 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.
699
+ #
700
+ # 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).
701
+ sig { returns(String) }
702
+ attr_reader :setup_future_usage
703
+ end
704
+ class Klarna < Stripe::StripeObject
705
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
706
+ #
707
+ # 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.
708
+ #
709
+ # 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.
710
+ #
711
+ # 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).
712
+ sig { returns(String) }
713
+ attr_reader :setup_future_usage
714
+ end
715
+ class Konbini < Stripe::StripeObject
716
+ # 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.
717
+ sig { returns(T.nilable(Integer)) }
718
+ attr_reader :expires_after_days
719
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
720
+ #
721
+ # 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.
722
+ #
723
+ # 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.
724
+ #
725
+ # 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).
726
+ sig { returns(String) }
727
+ attr_reader :setup_future_usage
728
+ end
729
+ class KrCard < Stripe::StripeObject
730
+ # Controls when the funds will be captured from the customer's account.
731
+ sig { returns(String) }
732
+ attr_reader :capture_method
733
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
734
+ #
735
+ # 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.
736
+ #
737
+ # 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.
738
+ #
739
+ # 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).
740
+ sig { returns(String) }
741
+ attr_reader :setup_future_usage
742
+ end
743
+ class Link < Stripe::StripeObject
744
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
745
+ #
746
+ # 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.
747
+ #
748
+ # 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.
749
+ #
750
+ # 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).
751
+ sig { returns(String) }
752
+ attr_reader :setup_future_usage
753
+ end
754
+ class Mobilepay < Stripe::StripeObject
755
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
756
+ #
757
+ # 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.
758
+ #
759
+ # 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.
760
+ #
761
+ # 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).
762
+ sig { returns(String) }
763
+ attr_reader :setup_future_usage
764
+ end
765
+ class Multibanco < Stripe::StripeObject
766
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
767
+ #
768
+ # 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.
769
+ #
770
+ # 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.
771
+ #
772
+ # 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).
773
+ sig { returns(String) }
774
+ attr_reader :setup_future_usage
775
+ end
776
+ class NaverPay < Stripe::StripeObject
777
+ # Controls when the funds will be captured from the customer's account.
778
+ sig { returns(String) }
779
+ attr_reader :capture_method
780
+ end
781
+ class Oxxo < Stripe::StripeObject
782
+ # The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
783
+ sig { returns(Integer) }
784
+ attr_reader :expires_after_days
785
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
786
+ #
787
+ # 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.
788
+ #
789
+ # 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.
790
+ #
791
+ # 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).
792
+ sig { returns(String) }
793
+ attr_reader :setup_future_usage
794
+ end
795
+ class P24 < Stripe::StripeObject
796
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
797
+ #
798
+ # 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.
799
+ #
800
+ # 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.
801
+ #
802
+ # 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).
803
+ sig { returns(String) }
804
+ attr_reader :setup_future_usage
805
+ end
806
+ class Payco < Stripe::StripeObject
807
+ # Controls when the funds will be captured from the customer's account.
808
+ sig { returns(String) }
809
+ attr_reader :capture_method
810
+ end
811
+ class Paynow < Stripe::StripeObject
812
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
813
+ #
814
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
815
+ #
816
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
817
+ #
818
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
819
+ sig { returns(String) }
820
+ attr_reader :setup_future_usage
821
+ end
822
+ class Paypal < Stripe::StripeObject
823
+ # Controls when the funds will be captured from the customer's account.
824
+ sig { returns(String) }
825
+ attr_reader :capture_method
826
+ # Preferred locale of the PayPal checkout page that the customer is redirected to.
827
+ sig { returns(T.nilable(String)) }
828
+ attr_reader :preferred_locale
829
+ # 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.
830
+ sig { returns(T.nilable(String)) }
831
+ attr_reader :reference
832
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
833
+ #
834
+ # 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.
835
+ #
836
+ # 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.
837
+ #
838
+ # 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).
839
+ sig { returns(String) }
840
+ attr_reader :setup_future_usage
841
+ # 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.
842
+ sig { returns(T::Array[String]) }
843
+ attr_reader :subsellers
844
+ end
845
+ class Payto < Stripe::StripeObject
846
+ class MandateOptions < Stripe::StripeObject
847
+ # Amount that will be collected. It is required when `amount_type` is `fixed`.
848
+ sig { returns(T.nilable(Integer)) }
849
+ attr_reader :amount
850
+ # 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.
851
+ sig { returns(T.nilable(String)) }
852
+ attr_reader :amount_type
853
+ # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
854
+ sig { returns(T.nilable(String)) }
855
+ attr_reader :end_date
856
+ # The periodicity at which payments will be collected.
857
+ sig { returns(T.nilable(String)) }
858
+ attr_reader :payment_schedule
859
+ # 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.
860
+ sig { returns(T.nilable(Integer)) }
861
+ attr_reader :payments_per_period
862
+ # The purpose for which payments are made. Defaults to retail.
863
+ sig { returns(T.nilable(String)) }
864
+ attr_reader :purpose
865
+ # Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
866
+ sig { returns(T.nilable(String)) }
867
+ attr_reader :start_date
868
+ end
869
+ # Attribute for field mandate_options
870
+ sig { returns(MandateOptions) }
871
+ attr_reader :mandate_options
872
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
873
+ #
874
+ # 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.
875
+ #
876
+ # 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.
877
+ #
878
+ # 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).
879
+ sig { returns(String) }
880
+ attr_reader :setup_future_usage
881
+ end
882
+ class Pix < Stripe::StripeObject
883
+ # The number of seconds after which Pix payment will expire.
884
+ sig { returns(T.nilable(Integer)) }
885
+ attr_reader :expires_after_seconds
886
+ end
887
+ class RevolutPay < Stripe::StripeObject
888
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
889
+ #
890
+ # 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.
891
+ #
892
+ # 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.
893
+ #
894
+ # 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).
895
+ sig { returns(String) }
896
+ attr_reader :setup_future_usage
897
+ end
898
+ class SamsungPay < Stripe::StripeObject
899
+ # Controls when the funds will be captured from the customer's account.
900
+ sig { returns(String) }
901
+ attr_reader :capture_method
902
+ end
903
+ class SepaDebit < Stripe::StripeObject
904
+ class MandateOptions < Stripe::StripeObject
905
+ # 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'.
906
+ sig { returns(String) }
907
+ attr_reader :reference_prefix
908
+ end
909
+ # Attribute for field mandate_options
910
+ sig { returns(MandateOptions) }
911
+ attr_reader :mandate_options
912
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
913
+ #
914
+ # 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.
915
+ #
916
+ # 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.
917
+ #
918
+ # 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).
919
+ sig { returns(String) }
920
+ attr_reader :setup_future_usage
921
+ end
922
+ class Sofort < Stripe::StripeObject
923
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
924
+ #
925
+ # 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.
926
+ #
927
+ # 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.
928
+ #
929
+ # 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).
930
+ sig { returns(String) }
931
+ attr_reader :setup_future_usage
932
+ end
933
+ class Swish < Stripe::StripeObject
934
+ # The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
935
+ sig { returns(T.nilable(String)) }
936
+ attr_reader :reference
937
+ end
938
+ class UsBankAccount < Stripe::StripeObject
939
+ class FinancialConnections < Stripe::StripeObject
940
+ class Filters < Stripe::StripeObject
941
+ # The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
942
+ sig { returns(T::Array[String]) }
943
+ attr_reader :account_subcategories
944
+ # The institution to use to filter for possible accounts to link.
945
+ sig { returns(String) }
946
+ attr_reader :institution
947
+ end
948
+ class ManualEntry < Stripe::StripeObject
949
+ # Settings for configuring manual entry of account details.
950
+ sig { returns(String) }
951
+ attr_reader :mode
952
+ end
953
+ # Attribute for field filters
954
+ sig { returns(Filters) }
955
+ attr_reader :filters
956
+ # Attribute for field manual_entry
957
+ sig { returns(ManualEntry) }
958
+ attr_reader :manual_entry
959
+ # The list of permissions to request. The `payment_method` permission must be included.
960
+ sig { returns(T::Array[String]) }
961
+ attr_reader :permissions
962
+ # Data features requested to be retrieved upon account creation.
963
+ sig { returns(T.nilable(T::Array[String])) }
964
+ attr_reader :prefetch
965
+ # For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
966
+ sig { returns(String) }
967
+ attr_reader :return_url
968
+ end
969
+ # Attribute for field financial_connections
970
+ sig { returns(FinancialConnections) }
971
+ attr_reader :financial_connections
972
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
973
+ #
974
+ # 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.
975
+ #
976
+ # 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.
977
+ #
978
+ # 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).
979
+ sig { returns(String) }
980
+ attr_reader :setup_future_usage
981
+ # Bank account verification method.
982
+ sig { returns(String) }
983
+ attr_reader :verification_method
984
+ end
985
+ # Attribute for field acss_debit
986
+ sig { returns(AcssDebit) }
987
+ attr_reader :acss_debit
988
+ # Attribute for field affirm
989
+ sig { returns(Affirm) }
990
+ attr_reader :affirm
991
+ # Attribute for field afterpay_clearpay
992
+ sig { returns(AfterpayClearpay) }
993
+ attr_reader :afterpay_clearpay
994
+ # Attribute for field alipay
995
+ sig { returns(Alipay) }
996
+ attr_reader :alipay
997
+ # Attribute for field amazon_pay
998
+ sig { returns(AmazonPay) }
999
+ attr_reader :amazon_pay
1000
+ # Attribute for field au_becs_debit
1001
+ sig { returns(AuBecsDebit) }
1002
+ attr_reader :au_becs_debit
1003
+ # Attribute for field bacs_debit
1004
+ sig { returns(BacsDebit) }
1005
+ attr_reader :bacs_debit
1006
+ # Attribute for field bancontact
1007
+ sig { returns(Bancontact) }
1008
+ attr_reader :bancontact
1009
+ # Attribute for field boleto
1010
+ sig { returns(Boleto) }
1011
+ attr_reader :boleto
1012
+ # Attribute for field card
1013
+ sig { returns(Card) }
1014
+ attr_reader :card
1015
+ # Attribute for field cashapp
1016
+ sig { returns(Cashapp) }
1017
+ attr_reader :cashapp
1018
+ # Attribute for field customer_balance
1019
+ sig { returns(CustomerBalance) }
1020
+ attr_reader :customer_balance
1021
+ # Attribute for field eps
1022
+ sig { returns(Eps) }
1023
+ attr_reader :eps
1024
+ # Attribute for field fpx
1025
+ sig { returns(Fpx) }
1026
+ attr_reader :fpx
1027
+ # Attribute for field giropay
1028
+ sig { returns(Giropay) }
1029
+ attr_reader :giropay
1030
+ # Attribute for field grabpay
1031
+ sig { returns(Grabpay) }
1032
+ attr_reader :grabpay
1033
+ # Attribute for field ideal
1034
+ sig { returns(Ideal) }
1035
+ attr_reader :ideal
1036
+ # Attribute for field kakao_pay
1037
+ sig { returns(KakaoPay) }
1038
+ attr_reader :kakao_pay
1039
+ # Attribute for field klarna
1040
+ sig { returns(Klarna) }
1041
+ attr_reader :klarna
1042
+ # Attribute for field konbini
1043
+ sig { returns(Konbini) }
1044
+ attr_reader :konbini
1045
+ # Attribute for field kr_card
1046
+ sig { returns(KrCard) }
1047
+ attr_reader :kr_card
1048
+ # Attribute for field link
1049
+ sig { returns(Link) }
1050
+ attr_reader :link
1051
+ # Attribute for field mobilepay
1052
+ sig { returns(Mobilepay) }
1053
+ attr_reader :mobilepay
1054
+ # Attribute for field multibanco
1055
+ sig { returns(Multibanco) }
1056
+ attr_reader :multibanco
1057
+ # Attribute for field naver_pay
1058
+ sig { returns(NaverPay) }
1059
+ attr_reader :naver_pay
1060
+ # Attribute for field oxxo
1061
+ sig { returns(Oxxo) }
1062
+ attr_reader :oxxo
1063
+ # Attribute for field p24
1064
+ sig { returns(P24) }
1065
+ attr_reader :p24
1066
+ # Attribute for field payco
1067
+ sig { returns(Payco) }
1068
+ attr_reader :payco
1069
+ # Attribute for field paynow
1070
+ sig { returns(Paynow) }
1071
+ attr_reader :paynow
1072
+ # Attribute for field paypal
1073
+ sig { returns(Paypal) }
1074
+ attr_reader :paypal
1075
+ # Attribute for field payto
1076
+ sig { returns(Payto) }
1077
+ attr_reader :payto
1078
+ # Attribute for field pix
1079
+ sig { returns(Pix) }
1080
+ attr_reader :pix
1081
+ # Attribute for field revolut_pay
1082
+ sig { returns(RevolutPay) }
1083
+ attr_reader :revolut_pay
1084
+ # Attribute for field samsung_pay
1085
+ sig { returns(SamsungPay) }
1086
+ attr_reader :samsung_pay
1087
+ # Attribute for field sepa_debit
1088
+ sig { returns(SepaDebit) }
1089
+ attr_reader :sepa_debit
1090
+ # Attribute for field sofort
1091
+ sig { returns(Sofort) }
1092
+ attr_reader :sofort
1093
+ # Attribute for field swish
1094
+ sig { returns(Swish) }
1095
+ attr_reader :swish
1096
+ # Attribute for field us_bank_account
1097
+ sig { returns(UsBankAccount) }
1098
+ attr_reader :us_bank_account
1099
+ end
1100
+ class Permissions < Stripe::StripeObject
1101
+ class Update < Stripe::StripeObject
1102
+ # Determines which entity is allowed to update the line items.
1103
+ #
1104
+ # 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.
1105
+ #
1106
+ # 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.
1107
+ sig { returns(T.nilable(String)) }
1108
+ attr_reader :line_items
1109
+ # Determines which entity is allowed to update the shipping details.
1110
+ #
1111
+ # 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.
1112
+ #
1113
+ # 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.
1114
+ sig { returns(T.nilable(String)) }
1115
+ attr_reader :shipping_details
1116
+ end
1117
+ # Permissions for updating the Checkout Session.
1118
+ sig { returns(T.nilable(Update)) }
1119
+ attr_reader :update
1120
+ end
1121
+ class PhoneNumberCollection < Stripe::StripeObject
1122
+ # Indicates whether phone number collection is enabled for the session
1123
+ sig { returns(T::Boolean) }
1124
+ attr_reader :enabled
1125
+ end
1126
+ class SavedPaymentMethodOptions < Stripe::StripeObject
1127
+ # 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.
1128
+ sig { returns(T.nilable(T::Array[String])) }
1129
+ attr_reader :allow_redisplay_filters
1130
+ # Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
1131
+ sig { returns(T.nilable(String)) }
1132
+ attr_reader :payment_method_remove
1133
+ # Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
1134
+ sig { returns(T.nilable(String)) }
1135
+ attr_reader :payment_method_save
1136
+ end
1137
+ class ShippingAddressCollection < Stripe::StripeObject
1138
+ # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
1139
+ # shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`.
1140
+ sig { returns(T::Array[String]) }
1141
+ attr_reader :allowed_countries
1142
+ end
1143
+ class ShippingCost < Stripe::StripeObject
1144
+ class Tax < Stripe::StripeObject
1145
+ # Amount of tax applied for this rate.
1146
+ sig { returns(Integer) }
1147
+ attr_reader :amount
1148
+ # Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
1149
+ #
1150
+ # Related guide: [Tax rates](/billing/taxes/tax-rates)
1151
+ sig { returns(Stripe::TaxRate) }
1152
+ attr_reader :rate
1153
+ # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
1154
+ sig { returns(T.nilable(String)) }
1155
+ attr_reader :taxability_reason
1156
+ # The amount on which tax is calculated, in cents (or local equivalent).
1157
+ sig { returns(T.nilable(Integer)) }
1158
+ attr_reader :taxable_amount
1159
+ end
1160
+ # Total shipping cost before any discounts or taxes are applied.
1161
+ sig { returns(Integer) }
1162
+ attr_reader :amount_subtotal
1163
+ # Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
1164
+ sig { returns(Integer) }
1165
+ attr_reader :amount_tax
1166
+ # Total shipping cost after discounts and taxes are applied.
1167
+ sig { returns(Integer) }
1168
+ attr_reader :amount_total
1169
+ # The ID of the ShippingRate for this order.
1170
+ sig { returns(T.nilable(T.any(String, Stripe::ShippingRate))) }
1171
+ attr_reader :shipping_rate
1172
+ # The taxes applied to the shipping rate.
1173
+ sig { returns(T::Array[Tax]) }
1174
+ attr_reader :taxes
1175
+ end
1176
+ class ShippingDetails < Stripe::StripeObject
1177
+ class Address < Stripe::StripeObject
1178
+ # City, district, suburb, town, or village.
1179
+ sig { returns(T.nilable(String)) }
1180
+ attr_reader :city
1181
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1182
+ sig { returns(T.nilable(String)) }
1183
+ attr_reader :country
1184
+ # Address line 1 (e.g., street, PO Box, or company name).
1185
+ sig { returns(T.nilable(String)) }
1186
+ attr_reader :line1
1187
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1188
+ sig { returns(T.nilable(String)) }
1189
+ attr_reader :line2
1190
+ # ZIP or postal code.
1191
+ sig { returns(T.nilable(String)) }
1192
+ attr_reader :postal_code
1193
+ # State, county, province, or region.
1194
+ sig { returns(T.nilable(String)) }
1195
+ attr_reader :state
1196
+ end
1197
+ # Attribute for field address
1198
+ sig { returns(Address) }
1199
+ attr_reader :address
1200
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1201
+ sig { returns(T.nilable(String)) }
1202
+ attr_reader :carrier
1203
+ # Recipient name.
1204
+ sig { returns(String) }
1205
+ attr_reader :name
1206
+ # Recipient phone (including extension).
1207
+ sig { returns(T.nilable(String)) }
1208
+ attr_reader :phone
1209
+ # 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.
1210
+ sig { returns(T.nilable(String)) }
1211
+ attr_reader :tracking_number
1212
+ end
1213
+ class ShippingOption < Stripe::StripeObject
1214
+ # A non-negative integer in cents representing how much to charge.
1215
+ sig { returns(Integer) }
1216
+ attr_reader :shipping_amount
1217
+ # The shipping rate.
1218
+ sig { returns(T.any(String, Stripe::ShippingRate)) }
1219
+ attr_reader :shipping_rate
1220
+ end
1221
+ class TaxIdCollection < Stripe::StripeObject
1222
+ # Indicates whether tax ID collection is enabled for the session
1223
+ sig { returns(T::Boolean) }
1224
+ attr_reader :enabled
1225
+ # Indicates whether a tax ID is required on the payment page
1226
+ sig { returns(String) }
1227
+ attr_reader :required
1228
+ end
1229
+ class TotalDetails < Stripe::StripeObject
1230
+ class Breakdown < Stripe::StripeObject
1231
+ class Discount < Stripe::StripeObject
1232
+ # The amount discounted.
1233
+ sig { returns(Integer) }
1234
+ attr_reader :amount
1235
+ # A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
1236
+ # It contains information about when the discount began, when it will end, and what it is applied to.
1237
+ #
1238
+ # Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)
1239
+ sig { returns(Stripe::Discount) }
1240
+ attr_reader :discount
1241
+ end
1242
+ class Tax < Stripe::StripeObject
1243
+ # Amount of tax applied for this rate.
1244
+ sig { returns(Integer) }
1245
+ attr_reader :amount
1246
+ # Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
1247
+ #
1248
+ # Related guide: [Tax rates](/billing/taxes/tax-rates)
1249
+ sig { returns(Stripe::TaxRate) }
1250
+ attr_reader :rate
1251
+ # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
1252
+ sig { returns(T.nilable(String)) }
1253
+ attr_reader :taxability_reason
1254
+ # The amount on which tax is calculated, in cents (or local equivalent).
1255
+ sig { returns(T.nilable(Integer)) }
1256
+ attr_reader :taxable_amount
1257
+ end
1258
+ # The aggregated discounts.
1259
+ sig { returns(T::Array[Discount]) }
1260
+ attr_reader :discounts
1261
+ # The aggregated tax amounts by rate.
1262
+ sig { returns(T::Array[Tax]) }
1263
+ attr_reader :taxes
1264
+ end
1265
+ # This is the sum of all the discounts.
1266
+ sig { returns(Integer) }
1267
+ attr_reader :amount_discount
1268
+ # This is the sum of all the shipping amounts.
1269
+ sig { returns(T.nilable(Integer)) }
1270
+ attr_reader :amount_shipping
1271
+ # This is the sum of all the tax amounts.
1272
+ sig { returns(Integer) }
1273
+ attr_reader :amount_tax
1274
+ # Attribute for field breakdown
1275
+ sig { returns(Breakdown) }
1276
+ attr_reader :breakdown
1277
+ end
1278
+ # Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
1279
+ sig { returns(T.nilable(AdaptivePricing)) }
1280
+ attr_reader :adaptive_pricing
1281
+ # When set, provides configuration for actions to take if this Checkout Session expires.
1282
+ sig { returns(T.nilable(AfterExpiration)) }
1283
+ attr_reader :after_expiration
1284
+ # Enables user redeemable promotion codes.
1285
+ sig { returns(T.nilable(T::Boolean)) }
1286
+ attr_reader :allow_promotion_codes
1287
+ # Total of all items before discounts or taxes are applied.
1288
+ sig { returns(T.nilable(Integer)) }
1289
+ attr_reader :amount_subtotal
1290
+ # Total of all items after discounts and taxes are applied.
1291
+ sig { returns(T.nilable(Integer)) }
1292
+ attr_reader :amount_total
1293
+ # Attribute for field automatic_tax
1294
+ sig { returns(AutomaticTax) }
1295
+ attr_reader :automatic_tax
1296
+ # Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.
1297
+ sig { returns(T.nilable(String)) }
1298
+ attr_reader :billing_address_collection
1299
+ # 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.
1300
+ sig { returns(T.nilable(String)) }
1301
+ attr_reader :cancel_url
1302
+ # A unique string to reference the Checkout Session. This can be a
1303
+ # customer ID, a cart ID, or similar, and can be used to reconcile the
1304
+ # Session with your internal systems.
1305
+ sig { returns(T.nilable(String)) }
1306
+ attr_reader :client_reference_id
1307
+ # The client secret of the Session. Use this with [initCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end.
1308
+ sig { returns(T.nilable(String)) }
1309
+ attr_reader :client_secret
1310
+ # Information about the customer collected within the Checkout Session.
1311
+ sig { returns(T.nilable(CollectedInformation)) }
1312
+ attr_reader :collected_information
1313
+ # Results of `consent_collection` for this session.
1314
+ sig { returns(T.nilable(Consent)) }
1315
+ attr_reader :consent
1316
+ # When set, provides configuration for the Checkout Session to gather active consent from customers.
1317
+ sig { returns(T.nilable(ConsentCollection)) }
1318
+ attr_reader :consent_collection
1319
+ # Time at which the object was created. Measured in seconds since the Unix epoch.
1320
+ sig { returns(Integer) }
1321
+ attr_reader :created
1322
+ # 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).
1323
+ sig { returns(T.nilable(String)) }
1324
+ attr_reader :currency
1325
+ # Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions
1326
+ sig { returns(T.nilable(CurrencyConversion)) }
1327
+ attr_reader :currency_conversion
1328
+ # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
1329
+ sig { returns(T::Array[CustomField]) }
1330
+ attr_reader :custom_fields
1331
+ # Attribute for field custom_text
1332
+ sig { returns(CustomText) }
1333
+ attr_reader :custom_text
1334
+ # The ID of the customer for this Session.
1335
+ # For Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout
1336
+ # will create a new customer object based on information provided
1337
+ # during the payment flow unless an existing customer was provided when
1338
+ # the Session was created.
1339
+ sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
1340
+ attr_reader :customer
1341
+ # Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
1342
+ sig { returns(T.nilable(String)) }
1343
+ attr_reader :customer_creation
1344
+ # The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.
1345
+ sig { returns(T.nilable(CustomerDetails)) }
1346
+ attr_reader :customer_details
1347
+ # If provided, this value will be used when the Customer object is created.
1348
+ # If not provided, customers will be asked to enter their email address.
1349
+ # Use this parameter to prefill customer data if you already have an email
1350
+ # on file. To access information about the customer once the payment flow is
1351
+ # complete, use the `customer` attribute.
1352
+ sig { returns(T.nilable(String)) }
1353
+ attr_reader :customer_email
1354
+ # List of coupons and promotion codes attached to the Checkout Session.
1355
+ sig { returns(T.nilable(T::Array[Discount])) }
1356
+ attr_reader :discounts
1357
+ # The timestamp at which the Checkout Session will expire.
1358
+ sig { returns(Integer) }
1359
+ attr_reader :expires_at
1360
+ # Unique identifier for the object.
1361
+ sig { returns(String) }
1362
+ attr_reader :id
1363
+ # ID of the invoice created by the Checkout Session, if it exists.
1364
+ sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
1365
+ attr_reader :invoice
1366
+ # Details on the state of invoice creation for the Checkout Session.
1367
+ sig { returns(T.nilable(InvoiceCreation)) }
1368
+ attr_reader :invoice_creation
1369
+ # The line items purchased by the customer.
1370
+ sig { returns(Stripe::ListObject) }
1371
+ attr_reader :line_items
1372
+ # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
1373
+ sig { returns(T::Boolean) }
1374
+ attr_reader :livemode
1375
+ # The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
1376
+ sig { returns(T.nilable(String)) }
1377
+ attr_reader :locale
1378
+ # 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.
1379
+ sig { returns(T.nilable(T::Hash[String, String])) }
1380
+ attr_reader :metadata
1381
+ # The mode of the Checkout Session.
1382
+ sig { returns(String) }
1383
+ attr_reader :mode
1384
+ # String representing the object's type. Objects of the same type share the same value.
1385
+ sig { returns(String) }
1386
+ attr_reader :object
1387
+ # The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
1388
+ sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
1389
+ attr_reader :payment_intent
1390
+ # The ID of the Payment Link that created this Session.
1391
+ sig { returns(T.nilable(T.any(String, Stripe::PaymentLink))) }
1392
+ attr_reader :payment_link
1393
+ # Configure whether a Checkout Session should collect a payment method. Defaults to `always`.
1394
+ sig { returns(T.nilable(String)) }
1395
+ attr_reader :payment_method_collection
1396
+ # Information about the payment method configuration used for this Checkout session if using dynamic payment methods.
1397
+ sig { returns(T.nilable(PaymentMethodConfigurationDetails)) }
1398
+ attr_reader :payment_method_configuration_details
1399
+ # Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
1400
+ sig { returns(T.nilable(PaymentMethodOptions)) }
1401
+ attr_reader :payment_method_options
1402
+ # A list of the types of payment methods (e.g. card) this Checkout
1403
+ # Session is allowed to accept.
1404
+ sig { returns(T::Array[String]) }
1405
+ attr_reader :payment_method_types
1406
+ # The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.
1407
+ # You can use this value to decide when to fulfill your customer's order.
1408
+ sig { returns(String) }
1409
+ attr_reader :payment_status
1410
+ # This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
1411
+ #
1412
+ # For specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.
1413
+ sig { returns(T.nilable(Permissions)) }
1414
+ attr_reader :permissions
1415
+ # Attribute for field phone_number_collection
1416
+ sig { returns(PhoneNumberCollection) }
1417
+ attr_reader :phone_number_collection
1418
+ # The ID of the original expired Checkout Session that triggered the recovery flow.
1419
+ sig { returns(T.nilable(String)) }
1420
+ attr_reader :recovered_from
1421
+ # 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`.
1422
+ sig { returns(String) }
1423
+ attr_reader :redirect_on_completion
1424
+ # Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
1425
+ sig { returns(String) }
1426
+ attr_reader :return_url
1427
+ # Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
1428
+ sig { returns(T.nilable(SavedPaymentMethodOptions)) }
1429
+ attr_reader :saved_payment_method_options
1430
+ # The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
1431
+ sig { returns(T.nilable(T.any(String, Stripe::SetupIntent))) }
1432
+ attr_reader :setup_intent
1433
+ # When set, provides configuration for Checkout to collect a shipping address from a customer.
1434
+ sig { returns(T.nilable(ShippingAddressCollection)) }
1435
+ attr_reader :shipping_address_collection
1436
+ # The details of the customer cost of shipping, including the customer chosen ShippingRate.
1437
+ sig { returns(T.nilable(ShippingCost)) }
1438
+ attr_reader :shipping_cost
1439
+ # Shipping information for this Checkout Session.
1440
+ sig { returns(T.nilable(ShippingDetails)) }
1441
+ attr_reader :shipping_details
1442
+ # The shipping rate options applied to this Session.
1443
+ sig { returns(T::Array[ShippingOption]) }
1444
+ attr_reader :shipping_options
1445
+ # The status of the Checkout Session, one of `open`, `complete`, or `expired`.
1446
+ sig { returns(T.nilable(String)) }
1447
+ attr_reader :status
1448
+ # Describes the type of transaction being performed by Checkout in order to customize
1449
+ # relevant text on the page, such as the submit button. `submit_type` can only be
1450
+ # specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
1451
+ sig { returns(T.nilable(String)) }
1452
+ attr_reader :submit_type
1453
+ # The ID of the subscription for Checkout Sessions in `subscription` mode.
1454
+ sig { returns(T.nilable(T.any(String, Stripe::Subscription))) }
1455
+ attr_reader :subscription
1456
+ # The URL the customer will be directed to after the payment or
1457
+ # subscription creation is successful.
1458
+ sig { returns(T.nilable(String)) }
1459
+ attr_reader :success_url
1460
+ # Attribute for field tax_id_collection
1461
+ sig { returns(TaxIdCollection) }
1462
+ attr_reader :tax_id_collection
1463
+ # Tax and discount details for the computed total amount.
1464
+ sig { returns(T.nilable(TotalDetails)) }
1465
+ attr_reader :total_details
1466
+ # The UI mode of the Session. Defaults to `hosted`.
1467
+ sig { returns(T.nilable(String)) }
1468
+ attr_reader :ui_mode
1469
+ # The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`
1470
+ # This value is only present when the session is active.
1471
+ sig { returns(T.nilable(String)) }
1472
+ attr_reader :url
1473
+ class ListParams < Stripe::RequestParams
1474
+ class Created < Stripe::RequestParams
1475
+ # Minimum value to filter by (exclusive)
1476
+ sig { returns(Integer) }
1477
+ attr_accessor :gt
1478
+ # Minimum value to filter by (inclusive)
1479
+ sig { returns(Integer) }
1480
+ attr_accessor :gte
1481
+ # Maximum value to filter by (exclusive)
1482
+ sig { returns(Integer) }
1483
+ attr_accessor :lt
1484
+ # Maximum value to filter by (inclusive)
1485
+ sig { returns(Integer) }
1486
+ attr_accessor :lte
1487
+ sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
1488
+ def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
1489
+ end
1490
+ class CustomerDetails < Stripe::RequestParams
1491
+ # Customer's email address.
1492
+ sig { returns(String) }
1493
+ attr_accessor :email
1494
+ sig { params(email: String).void }
1495
+ def initialize(email: nil); end
1496
+ end
1497
+ # Only return Checkout Sessions that were created during the given date interval.
1498
+ sig { returns(T.any(::Stripe::Checkout::Session::ListParams::Created, Integer)) }
1499
+ attr_accessor :created
1500
+ # Only return the Checkout Sessions for the Customer specified.
1501
+ sig { returns(String) }
1502
+ attr_accessor :customer
1503
+ # Only return the Checkout Sessions for the Customer details specified.
1504
+ sig { returns(::Stripe::Checkout::Session::ListParams::CustomerDetails) }
1505
+ attr_accessor :customer_details
1506
+ # 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.
1507
+ sig { returns(String) }
1508
+ attr_accessor :ending_before
1509
+ # Specifies which fields in the response should be expanded.
1510
+ sig { returns(T::Array[String]) }
1511
+ attr_accessor :expand
1512
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1513
+ sig { returns(Integer) }
1514
+ attr_accessor :limit
1515
+ # Only return the Checkout Session for the PaymentIntent specified.
1516
+ sig { returns(String) }
1517
+ attr_accessor :payment_intent
1518
+ # Only return the Checkout Sessions for the Payment Link specified.
1519
+ sig { returns(String) }
1520
+ attr_accessor :payment_link
1521
+ # 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.
1522
+ sig { returns(String) }
1523
+ attr_accessor :starting_after
1524
+ # Only return the Checkout Sessions matching the given status.
1525
+ sig { returns(String) }
1526
+ attr_accessor :status
1527
+ # Only return the Checkout Session for the subscription specified.
1528
+ sig { returns(String) }
1529
+ attr_accessor :subscription
1530
+ sig {
1531
+ params(created: T.any(::Stripe::Checkout::Session::ListParams::Created, Integer), customer: String, customer_details: ::Stripe::Checkout::Session::ListParams::CustomerDetails, ending_before: String, expand: T::Array[String], limit: Integer, payment_intent: String, payment_link: String, starting_after: String, status: String, subscription: String).void
1532
+ }
1533
+ def initialize(
1534
+ created: nil,
1535
+ customer: nil,
1536
+ customer_details: nil,
1537
+ ending_before: nil,
1538
+ expand: nil,
1539
+ limit: nil,
1540
+ payment_intent: nil,
1541
+ payment_link: nil,
1542
+ starting_after: nil,
1543
+ status: nil,
1544
+ subscription: nil
1545
+ ); end
1546
+ end
1547
+ class CreateParams < Stripe::RequestParams
1548
+ class AdaptivePricing < Stripe::RequestParams
1549
+ # 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).
1550
+ sig { returns(T::Boolean) }
1551
+ attr_accessor :enabled
1552
+ sig { params(enabled: T::Boolean).void }
1553
+ def initialize(enabled: nil); end
1554
+ end
1555
+ class AfterExpiration < Stripe::RequestParams
1556
+ class Recovery < Stripe::RequestParams
1557
+ # Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
1558
+ sig { returns(T::Boolean) }
1559
+ attr_accessor :allow_promotion_codes
1560
+ # If `true`, a recovery URL will be generated to recover this Checkout Session if it
1561
+ # expires before a successful transaction is completed. It will be attached to the
1562
+ # Checkout Session object upon expiration.
1563
+ sig { returns(T::Boolean) }
1564
+ attr_accessor :enabled
1565
+ sig { params(allow_promotion_codes: T::Boolean, enabled: T::Boolean).void }
1566
+ def initialize(allow_promotion_codes: nil, enabled: nil); end
1567
+ end
1568
+ # Configure a Checkout Session that can be used to recover an expired session.
1569
+ sig { returns(::Stripe::Checkout::Session::CreateParams::AfterExpiration::Recovery) }
1570
+ attr_accessor :recovery
1571
+ sig {
1572
+ params(recovery: ::Stripe::Checkout::Session::CreateParams::AfterExpiration::Recovery).void
1573
+ }
1574
+ def initialize(recovery: nil); end
1575
+ end
1576
+ class AutomaticTax < Stripe::RequestParams
1577
+ class Liability < Stripe::RequestParams
1578
+ # The connected account being referenced when `type` is `account`.
1579
+ sig { returns(String) }
1580
+ attr_accessor :account
1581
+ # Type of the account referenced in the request.
1582
+ sig { returns(String) }
1583
+ attr_accessor :type
1584
+ sig { params(account: String, type: String).void }
1585
+ def initialize(account: nil, type: nil); end
1586
+ end
1587
+ # Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
1588
+ #
1589
+ # Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.
1590
+ sig { returns(T::Boolean) }
1591
+ attr_accessor :enabled
1592
+ # 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.
1593
+ sig { returns(::Stripe::Checkout::Session::CreateParams::AutomaticTax::Liability) }
1594
+ attr_accessor :liability
1595
+ sig {
1596
+ params(enabled: T::Boolean, liability: ::Stripe::Checkout::Session::CreateParams::AutomaticTax::Liability).void
1597
+ }
1598
+ def initialize(enabled: nil, liability: nil); end
1599
+ end
1600
+ class ConsentCollection < Stripe::RequestParams
1601
+ class PaymentMethodReuseAgreement < Stripe::RequestParams
1602
+ # Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
1603
+ # defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
1604
+ sig { returns(String) }
1605
+ attr_accessor :position
1606
+ sig { params(position: String).void }
1607
+ def initialize(position: nil); end
1608
+ end
1609
+ # 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.
1610
+ sig {
1611
+ returns(::Stripe::Checkout::Session::CreateParams::ConsentCollection::PaymentMethodReuseAgreement)
1612
+ }
1613
+ attr_accessor :payment_method_reuse_agreement
1614
+ # If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
1615
+ # Session will determine whether to display an option to opt into promotional communication
1616
+ # from the merchant depending on the customer's locale. Only available to US merchants.
1617
+ sig { returns(String) }
1618
+ attr_accessor :promotions
1619
+ # If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
1620
+ # There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
1621
+ sig { returns(String) }
1622
+ attr_accessor :terms_of_service
1623
+ sig {
1624
+ params(payment_method_reuse_agreement: ::Stripe::Checkout::Session::CreateParams::ConsentCollection::PaymentMethodReuseAgreement, promotions: String, terms_of_service: String).void
1625
+ }
1626
+ def initialize(
1627
+ payment_method_reuse_agreement: nil,
1628
+ promotions: nil,
1629
+ terms_of_service: nil
1630
+ ); end
1631
+ end
1632
+ class CustomField < Stripe::RequestParams
1633
+ class Dropdown < Stripe::RequestParams
1634
+ class Option < Stripe::RequestParams
1635
+ # The label for the option, displayed to the customer. Up to 100 characters.
1636
+ sig { returns(String) }
1637
+ attr_accessor :label
1638
+ # 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.
1639
+ sig { returns(String) }
1640
+ attr_accessor :value
1641
+ sig { params(label: String, value: String).void }
1642
+ def initialize(label: nil, value: nil); end
1643
+ end
1644
+ # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
1645
+ sig { returns(String) }
1646
+ attr_accessor :default_value
1647
+ # The options available for the customer to select. Up to 200 options allowed.
1648
+ sig {
1649
+ returns(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown::Option])
1650
+ }
1651
+ attr_accessor :options
1652
+ sig {
1653
+ params(default_value: String, options: T::Array[::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown::Option]).void
1654
+ }
1655
+ def initialize(default_value: nil, options: nil); end
1656
+ end
1657
+ class Label < Stripe::RequestParams
1658
+ # Custom text for the label, displayed to the customer. Up to 50 characters.
1659
+ sig { returns(String) }
1660
+ attr_accessor :custom
1661
+ # The type of the label.
1662
+ sig { returns(String) }
1663
+ attr_accessor :type
1664
+ sig { params(custom: String, type: String).void }
1665
+ def initialize(custom: nil, type: nil); end
1666
+ end
1667
+ class Numeric < Stripe::RequestParams
1668
+ # The value that will pre-fill the field on the payment page.
1669
+ sig { returns(String) }
1670
+ attr_accessor :default_value
1671
+ # The maximum character length constraint for the customer's input.
1672
+ sig { returns(Integer) }
1673
+ attr_accessor :maximum_length
1674
+ # The minimum character length requirement for the customer's input.
1675
+ sig { returns(Integer) }
1676
+ attr_accessor :minimum_length
1677
+ sig {
1678
+ params(default_value: String, maximum_length: Integer, minimum_length: Integer).void
1679
+ }
1680
+ def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
1681
+ end
1682
+ class Text < Stripe::RequestParams
1683
+ # The value that will pre-fill the field on the payment page.
1684
+ sig { returns(String) }
1685
+ attr_accessor :default_value
1686
+ # The maximum character length constraint for the customer's input.
1687
+ sig { returns(Integer) }
1688
+ attr_accessor :maximum_length
1689
+ # The minimum character length requirement for the customer's input.
1690
+ sig { returns(Integer) }
1691
+ attr_accessor :minimum_length
1692
+ sig {
1693
+ params(default_value: String, maximum_length: Integer, minimum_length: Integer).void
1694
+ }
1695
+ def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
1696
+ end
1697
+ # Configuration for `type=dropdown` fields.
1698
+ sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown) }
1699
+ attr_accessor :dropdown
1700
+ # 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.
1701
+ sig { returns(String) }
1702
+ attr_accessor :key
1703
+ # The label for the field, displayed to the customer.
1704
+ sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Label) }
1705
+ attr_accessor :label
1706
+ # Configuration for `type=numeric` fields.
1707
+ sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Numeric) }
1708
+ attr_accessor :numeric
1709
+ # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
1710
+ sig { returns(T::Boolean) }
1711
+ attr_accessor :optional
1712
+ # Configuration for `type=text` fields.
1713
+ sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Text) }
1714
+ attr_accessor :text
1715
+ # The type of the field.
1716
+ sig { returns(String) }
1717
+ attr_accessor :type
1718
+ sig {
1719
+ params(dropdown: ::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown, key: String, label: ::Stripe::Checkout::Session::CreateParams::CustomField::Label, numeric: ::Stripe::Checkout::Session::CreateParams::CustomField::Numeric, optional: T::Boolean, text: ::Stripe::Checkout::Session::CreateParams::CustomField::Text, type: String).void
1720
+ }
1721
+ def initialize(
1722
+ dropdown: nil,
1723
+ key: nil,
1724
+ label: nil,
1725
+ numeric: nil,
1726
+ optional: nil,
1727
+ text: nil,
1728
+ type: nil
1729
+ ); end
1730
+ end
1731
+ class CustomText < Stripe::RequestParams
1732
+ class AfterSubmit < Stripe::RequestParams
1733
+ # Text may be up to 1200 characters in length.
1734
+ sig { returns(String) }
1735
+ attr_accessor :message
1736
+ sig { params(message: String).void }
1737
+ def initialize(message: nil); end
1738
+ end
1739
+ class ShippingAddress < Stripe::RequestParams
1740
+ # Text may be up to 1200 characters in length.
1741
+ sig { returns(String) }
1742
+ attr_accessor :message
1743
+ sig { params(message: String).void }
1744
+ def initialize(message: nil); end
1745
+ end
1746
+ class Submit < Stripe::RequestParams
1747
+ # Text may be up to 1200 characters in length.
1748
+ sig { returns(String) }
1749
+ attr_accessor :message
1750
+ sig { params(message: String).void }
1751
+ def initialize(message: nil); end
1752
+ end
1753
+ class TermsOfServiceAcceptance < Stripe::RequestParams
1754
+ # Text may be up to 1200 characters in length.
1755
+ sig { returns(String) }
1756
+ attr_accessor :message
1757
+ sig { params(message: String).void }
1758
+ def initialize(message: nil); end
1759
+ end
1760
+ # Custom text that should be displayed after the payment confirmation button.
1761
+ sig {
1762
+ returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::AfterSubmit))
1763
+ }
1764
+ attr_accessor :after_submit
1765
+ # Custom text that should be displayed alongside shipping address collection.
1766
+ sig {
1767
+ returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::ShippingAddress))
1768
+ }
1769
+ attr_accessor :shipping_address
1770
+ # Custom text that should be displayed alongside the payment confirmation button.
1771
+ sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::Submit)) }
1772
+ attr_accessor :submit
1773
+ # Custom text that should be displayed in place of the default terms of service agreement text.
1774
+ sig {
1775
+ returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::TermsOfServiceAcceptance))
1776
+ }
1777
+ attr_accessor :terms_of_service_acceptance
1778
+ sig {
1779
+ params(after_submit: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::AfterSubmit), shipping_address: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::ShippingAddress), submit: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::Submit), terms_of_service_acceptance: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::TermsOfServiceAcceptance)).void
1780
+ }
1781
+ def initialize(
1782
+ after_submit: nil,
1783
+ shipping_address: nil,
1784
+ submit: nil,
1785
+ terms_of_service_acceptance: nil
1786
+ ); end
1787
+ end
1788
+ class CustomerUpdate < Stripe::RequestParams
1789
+ # Describes whether Checkout saves the billing address onto `customer.address`.
1790
+ # To always collect a full billing address, use `billing_address_collection`. Defaults to `never`.
1791
+ sig { returns(String) }
1792
+ attr_accessor :address
1793
+ # Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.
1794
+ sig { returns(String) }
1795
+ attr_accessor :name
1796
+ # Describes whether Checkout saves shipping information onto `customer.shipping`.
1797
+ # To collect shipping information, use `shipping_address_collection`. Defaults to `never`.
1798
+ sig { returns(String) }
1799
+ attr_accessor :shipping
1800
+ sig { params(address: String, name: String, shipping: String).void }
1801
+ def initialize(address: nil, name: nil, shipping: nil); end
1802
+ end
1803
+ class Discount < Stripe::RequestParams
1804
+ # The ID of the coupon to apply to this Session.
1805
+ sig { returns(String) }
1806
+ attr_accessor :coupon
1807
+ # The ID of a promotion code to apply to this Session.
1808
+ sig { returns(String) }
1809
+ attr_accessor :promotion_code
1810
+ sig { params(coupon: String, promotion_code: String).void }
1811
+ def initialize(coupon: nil, promotion_code: nil); end
1812
+ end
1813
+ class InvoiceCreation < Stripe::RequestParams
1814
+ class InvoiceData < Stripe::RequestParams
1815
+ class CustomField < Stripe::RequestParams
1816
+ # The name of the custom field. This may be up to 40 characters.
1817
+ sig { returns(String) }
1818
+ attr_accessor :name
1819
+ # The value of the custom field. This may be up to 140 characters.
1820
+ sig { returns(String) }
1821
+ attr_accessor :value
1822
+ sig { params(name: String, value: String).void }
1823
+ def initialize(name: nil, value: nil); end
1824
+ end
1825
+ class Issuer < Stripe::RequestParams
1826
+ # The connected account being referenced when `type` is `account`.
1827
+ sig { returns(String) }
1828
+ attr_accessor :account
1829
+ # Type of the account referenced in the request.
1830
+ sig { returns(String) }
1831
+ attr_accessor :type
1832
+ sig { params(account: String, type: String).void }
1833
+ def initialize(account: nil, type: nil); end
1834
+ end
1835
+ class RenderingOptions < Stripe::RequestParams
1836
+ # 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.
1837
+ sig { returns(T.nilable(String)) }
1838
+ attr_accessor :amount_tax_display
1839
+ sig { params(amount_tax_display: T.nilable(String)).void }
1840
+ def initialize(amount_tax_display: nil); end
1841
+ end
1842
+ # The account tax IDs associated with the invoice.
1843
+ sig { returns(T.nilable(T::Array[String])) }
1844
+ attr_accessor :account_tax_ids
1845
+ # Default custom fields to be displayed on invoices for this customer.
1846
+ sig {
1847
+ returns(T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::CustomField]))
1848
+ }
1849
+ attr_accessor :custom_fields
1850
+ # An arbitrary string attached to the object. Often useful for displaying to users.
1851
+ sig { returns(String) }
1852
+ attr_accessor :description
1853
+ # Default footer to be displayed on invoices for this customer.
1854
+ sig { returns(String) }
1855
+ attr_accessor :footer
1856
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1857
+ sig {
1858
+ returns(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::Issuer)
1859
+ }
1860
+ attr_accessor :issuer
1861
+ # 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`.
1862
+ sig { returns(T::Hash[String, String]) }
1863
+ attr_accessor :metadata
1864
+ # Default options for invoice PDF rendering for this customer.
1865
+ sig {
1866
+ returns(T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))
1867
+ }
1868
+ attr_accessor :rendering_options
1869
+ sig {
1870
+ params(account_tax_ids: T.nilable(T::Array[String]), custom_fields: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::CustomField]), description: String, footer: String, issuer: ::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::Issuer, metadata: T::Hash[String, String], rendering_options: T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)).void
1871
+ }
1872
+ def initialize(
1873
+ account_tax_ids: nil,
1874
+ custom_fields: nil,
1875
+ description: nil,
1876
+ footer: nil,
1877
+ issuer: nil,
1878
+ metadata: nil,
1879
+ rendering_options: nil
1880
+ ); end
1881
+ end
1882
+ # Set to `true` to enable invoice creation.
1883
+ sig { returns(T::Boolean) }
1884
+ attr_accessor :enabled
1885
+ # Parameters passed when creating invoices for payment-mode Checkout Sessions.
1886
+ sig { returns(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData) }
1887
+ attr_accessor :invoice_data
1888
+ sig {
1889
+ params(enabled: T::Boolean, invoice_data: ::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData).void
1890
+ }
1891
+ def initialize(enabled: nil, invoice_data: nil); end
1892
+ end
1893
+ class LineItem < Stripe::RequestParams
1894
+ class AdjustableQuantity < Stripe::RequestParams
1895
+ # Set to true if the quantity can be adjusted to any non-negative integer.
1896
+ sig { returns(T::Boolean) }
1897
+ attr_accessor :enabled
1898
+ # 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.
1899
+ sig { returns(Integer) }
1900
+ attr_accessor :maximum
1901
+ # The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
1902
+ sig { returns(Integer) }
1903
+ attr_accessor :minimum
1904
+ sig { params(enabled: T::Boolean, maximum: Integer, minimum: Integer).void }
1905
+ def initialize(enabled: nil, maximum: nil, minimum: nil); end
1906
+ end
1907
+ class PriceData < Stripe::RequestParams
1908
+ class ProductData < Stripe::RequestParams
1909
+ # 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.
1910
+ sig { returns(String) }
1911
+ attr_accessor :description
1912
+ # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
1913
+ sig { returns(T::Array[String]) }
1914
+ attr_accessor :images
1915
+ # 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`.
1916
+ sig { returns(T::Hash[String, String]) }
1917
+ attr_accessor :metadata
1918
+ # The product's name, meant to be displayable to the customer.
1919
+ sig { returns(String) }
1920
+ attr_accessor :name
1921
+ # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
1922
+ sig { returns(String) }
1923
+ attr_accessor :tax_code
1924
+ sig {
1925
+ params(description: String, images: T::Array[String], metadata: T::Hash[String, String], name: String, tax_code: String).void
1926
+ }
1927
+ def initialize(
1928
+ description: nil,
1929
+ images: nil,
1930
+ metadata: nil,
1931
+ name: nil,
1932
+ tax_code: nil
1933
+ ); end
1934
+ end
1935
+ class Recurring < Stripe::RequestParams
1936
+ # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
1937
+ sig { returns(String) }
1938
+ attr_accessor :interval
1939
+ # 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).
1940
+ sig { returns(Integer) }
1941
+ attr_accessor :interval_count
1942
+ sig { params(interval: String, interval_count: Integer).void }
1943
+ def initialize(interval: nil, interval_count: nil); end
1944
+ end
1945
+ # 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).
1946
+ sig { returns(String) }
1947
+ attr_accessor :currency
1948
+ # The ID of the product that this price will belong to. One of `product` or `product_data` is required.
1949
+ sig { returns(String) }
1950
+ attr_accessor :product
1951
+ # Data used to generate a new product object inline. One of `product` or `product_data` is required.
1952
+ sig {
1953
+ returns(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::ProductData)
1954
+ }
1955
+ attr_accessor :product_data
1956
+ # The recurring components of a price such as `interval` and `interval_count`.
1957
+ sig {
1958
+ returns(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::Recurring)
1959
+ }
1960
+ attr_accessor :recurring
1961
+ # 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.
1962
+ sig { returns(String) }
1963
+ attr_accessor :tax_behavior
1964
+ # A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
1965
+ sig { returns(Integer) }
1966
+ attr_accessor :unit_amount
1967
+ # 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.
1968
+ sig { returns(String) }
1969
+ attr_accessor :unit_amount_decimal
1970
+ sig {
1971
+ params(currency: String, product: String, product_data: ::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::ProductData, recurring: ::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
1972
+ }
1973
+ def initialize(
1974
+ currency: nil,
1975
+ product: nil,
1976
+ product_data: nil,
1977
+ recurring: nil,
1978
+ tax_behavior: nil,
1979
+ unit_amount: nil,
1980
+ unit_amount_decimal: nil
1981
+ ); end
1982
+ end
1983
+ # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
1984
+ sig { returns(::Stripe::Checkout::Session::CreateParams::LineItem::AdjustableQuantity) }
1985
+ attr_accessor :adjustable_quantity
1986
+ # 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.
1987
+ sig { returns(T::Array[String]) }
1988
+ attr_accessor :dynamic_tax_rates
1989
+ # 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`.
1990
+ sig { returns(T::Hash[String, String]) }
1991
+ attr_accessor :metadata
1992
+ # 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.
1993
+ sig { returns(String) }
1994
+ attr_accessor :price
1995
+ # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
1996
+ sig { returns(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData) }
1997
+ attr_accessor :price_data
1998
+ # The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
1999
+ sig { returns(Integer) }
2000
+ attr_accessor :quantity
2001
+ # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
2002
+ sig { returns(T::Array[String]) }
2003
+ attr_accessor :tax_rates
2004
+ sig {
2005
+ params(adjustable_quantity: ::Stripe::Checkout::Session::CreateParams::LineItem::AdjustableQuantity, dynamic_tax_rates: T::Array[String], metadata: T::Hash[String, String], price: String, price_data: ::Stripe::Checkout::Session::CreateParams::LineItem::PriceData, quantity: Integer, tax_rates: T::Array[String]).void
2006
+ }
2007
+ def initialize(
2008
+ adjustable_quantity: nil,
2009
+ dynamic_tax_rates: nil,
2010
+ metadata: nil,
2011
+ price: nil,
2012
+ price_data: nil,
2013
+ quantity: nil,
2014
+ tax_rates: nil
2015
+ ); end
2016
+ end
2017
+ class PaymentIntentData < Stripe::RequestParams
2018
+ class Shipping < Stripe::RequestParams
2019
+ class Address < Stripe::RequestParams
2020
+ # City, district, suburb, town, or village.
2021
+ sig { returns(String) }
2022
+ attr_accessor :city
2023
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2024
+ sig { returns(String) }
2025
+ attr_accessor :country
2026
+ # Address line 1 (e.g., street, PO Box, or company name).
2027
+ sig { returns(String) }
2028
+ attr_accessor :line1
2029
+ # Address line 2 (e.g., apartment, suite, unit, or building).
2030
+ sig { returns(String) }
2031
+ attr_accessor :line2
2032
+ # ZIP or postal code.
2033
+ sig { returns(String) }
2034
+ attr_accessor :postal_code
2035
+ # State, county, province, or region.
2036
+ sig { returns(String) }
2037
+ attr_accessor :state
2038
+ sig {
2039
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
2040
+ }
2041
+ def initialize(
2042
+ city: nil,
2043
+ country: nil,
2044
+ line1: nil,
2045
+ line2: nil,
2046
+ postal_code: nil,
2047
+ state: nil
2048
+ ); end
2049
+ end
2050
+ # Shipping address.
2051
+ sig {
2052
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping::Address)
2053
+ }
2054
+ attr_accessor :address
2055
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
2056
+ sig { returns(String) }
2057
+ attr_accessor :carrier
2058
+ # Recipient name.
2059
+ sig { returns(String) }
2060
+ attr_accessor :name
2061
+ # Recipient phone (including extension).
2062
+ sig { returns(String) }
2063
+ attr_accessor :phone
2064
+ # 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.
2065
+ sig { returns(String) }
2066
+ attr_accessor :tracking_number
2067
+ sig {
2068
+ params(address: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping::Address, carrier: String, name: String, phone: String, tracking_number: String).void
2069
+ }
2070
+ def initialize(
2071
+ address: nil,
2072
+ carrier: nil,
2073
+ name: nil,
2074
+ phone: nil,
2075
+ tracking_number: nil
2076
+ ); end
2077
+ end
2078
+ class TransferData < Stripe::RequestParams
2079
+ # The amount that will be transferred automatically when a charge succeeds.
2080
+ sig { returns(Integer) }
2081
+ attr_accessor :amount
2082
+ # If specified, successful charges will be attributed to the destination
2083
+ # account for tax reporting, and the funds from charges will be transferred
2084
+ # to the destination account. The ID of the resulting transfer will be
2085
+ # returned on the successful charge's `transfer` field.
2086
+ sig { returns(String) }
2087
+ attr_accessor :destination
2088
+ sig { params(amount: Integer, destination: String).void }
2089
+ def initialize(amount: nil, destination: nil); end
2090
+ end
2091
+ # 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).
2092
+ sig { returns(Integer) }
2093
+ attr_accessor :application_fee_amount
2094
+ # Controls when the funds will be captured from the customer's account.
2095
+ sig { returns(String) }
2096
+ attr_accessor :capture_method
2097
+ # An arbitrary string attached to the object. Often useful for displaying to users.
2098
+ sig { returns(String) }
2099
+ attr_accessor :description
2100
+ # 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`.
2101
+ sig { returns(T::Hash[String, String]) }
2102
+ attr_accessor :metadata
2103
+ # The Stripe account ID for which these funds are intended. For details,
2104
+ # see the PaymentIntents [use case for connected
2105
+ # accounts](/docs/payments/connected-accounts).
2106
+ sig { returns(String) }
2107
+ attr_accessor :on_behalf_of
2108
+ # 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).
2109
+ sig { returns(String) }
2110
+ attr_accessor :receipt_email
2111
+ # Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment
2112
+ # method collected by this Checkout Session.
2113
+ #
2114
+ # When setting this to `on_session`, Checkout will show a notice to the
2115
+ # customer that their payment details will be saved.
2116
+ #
2117
+ # When setting this to `off_session`, Checkout will show a notice to the
2118
+ # customer that their payment details will be saved and used for future
2119
+ # payments.
2120
+ #
2121
+ # If a Customer has been provided or Checkout creates a new Customer,
2122
+ # Checkout will attach the payment method to the Customer.
2123
+ #
2124
+ # If Checkout does not create a Customer, the payment method is not attached
2125
+ # to a Customer. To reuse the payment method, you can retrieve it from the
2126
+ # Checkout Session's PaymentIntent.
2127
+ #
2128
+ # When processing card payments, Checkout also uses `setup_future_usage`
2129
+ # to dynamically optimize your payment flow and comply with regional
2130
+ # legislation and network rules, such as SCA.
2131
+ sig { returns(String) }
2132
+ attr_accessor :setup_future_usage
2133
+ # Shipping information for this payment.
2134
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping) }
2135
+ attr_accessor :shipping
2136
+ # 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).
2137
+ #
2138
+ # 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.
2139
+ sig { returns(String) }
2140
+ attr_accessor :statement_descriptor
2141
+ # 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.
2142
+ sig { returns(String) }
2143
+ attr_accessor :statement_descriptor_suffix
2144
+ # The parameters used to automatically create a Transfer when the payment succeeds.
2145
+ # For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
2146
+ sig {
2147
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::TransferData)
2148
+ }
2149
+ attr_accessor :transfer_data
2150
+ # 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.
2151
+ sig { returns(String) }
2152
+ attr_accessor :transfer_group
2153
+ sig {
2154
+ params(application_fee_amount: Integer, capture_method: String, description: String, metadata: T::Hash[String, String], on_behalf_of: String, receipt_email: String, setup_future_usage: String, shipping: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping, statement_descriptor: String, statement_descriptor_suffix: String, transfer_data: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData::TransferData, transfer_group: String).void
2155
+ }
2156
+ def initialize(
2157
+ application_fee_amount: nil,
2158
+ capture_method: nil,
2159
+ description: nil,
2160
+ metadata: nil,
2161
+ on_behalf_of: nil,
2162
+ receipt_email: nil,
2163
+ setup_future_usage: nil,
2164
+ shipping: nil,
2165
+ statement_descriptor: nil,
2166
+ statement_descriptor_suffix: nil,
2167
+ transfer_data: nil,
2168
+ transfer_group: nil
2169
+ ); end
2170
+ end
2171
+ class PaymentMethodData < Stripe::RequestParams
2172
+ # 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.
2173
+ sig { returns(String) }
2174
+ attr_accessor :allow_redisplay
2175
+ sig { params(allow_redisplay: String).void }
2176
+ def initialize(allow_redisplay: nil); end
2177
+ end
2178
+ class PaymentMethodOptions < Stripe::RequestParams
2179
+ class AcssDebit < Stripe::RequestParams
2180
+ class MandateOptions < Stripe::RequestParams
2181
+ # A URL for custom mandate text to render during confirmation step.
2182
+ # The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
2183
+ # or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
2184
+ sig { returns(T.nilable(String)) }
2185
+ attr_accessor :custom_mandate_url
2186
+ # List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.
2187
+ sig { returns(T::Array[String]) }
2188
+ attr_accessor :default_for
2189
+ # Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
2190
+ sig { returns(String) }
2191
+ attr_accessor :interval_description
2192
+ # Payment schedule for the mandate.
2193
+ sig { returns(String) }
2194
+ attr_accessor :payment_schedule
2195
+ # Transaction type of the mandate.
2196
+ sig { returns(String) }
2197
+ attr_accessor :transaction_type
2198
+ sig {
2199
+ params(custom_mandate_url: T.nilable(String), default_for: T::Array[String], interval_description: String, payment_schedule: String, transaction_type: String).void
2200
+ }
2201
+ def initialize(
2202
+ custom_mandate_url: nil,
2203
+ default_for: nil,
2204
+ interval_description: nil,
2205
+ payment_schedule: nil,
2206
+ transaction_type: nil
2207
+ ); end
2208
+ end
2209
+ # 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.
2210
+ sig { returns(String) }
2211
+ attr_accessor :currency
2212
+ # Additional fields for Mandate creation
2213
+ sig {
2214
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions)
2215
+ }
2216
+ attr_accessor :mandate_options
2217
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2218
+ #
2219
+ # 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.
2220
+ #
2221
+ # 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.
2222
+ #
2223
+ # 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).
2224
+ sig { returns(String) }
2225
+ attr_accessor :setup_future_usage
2226
+ # Verification method for the intent
2227
+ sig { returns(String) }
2228
+ attr_accessor :verification_method
2229
+ sig {
2230
+ params(currency: String, mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: String, verification_method: String).void
2231
+ }
2232
+ def initialize(
2233
+ currency: nil,
2234
+ mandate_options: nil,
2235
+ setup_future_usage: nil,
2236
+ verification_method: nil
2237
+ ); end
2238
+ end
2239
+ class Affirm < Stripe::RequestParams
2240
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2241
+ #
2242
+ # 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.
2243
+ #
2244
+ # 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.
2245
+ #
2246
+ # 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).
2247
+ sig { returns(String) }
2248
+ attr_accessor :setup_future_usage
2249
+ sig { params(setup_future_usage: String).void }
2250
+ def initialize(setup_future_usage: nil); end
2251
+ end
2252
+ class AfterpayClearpay < Stripe::RequestParams
2253
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2254
+ #
2255
+ # 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.
2256
+ #
2257
+ # 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.
2258
+ #
2259
+ # 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).
2260
+ sig { returns(String) }
2261
+ attr_accessor :setup_future_usage
2262
+ sig { params(setup_future_usage: String).void }
2263
+ def initialize(setup_future_usage: nil); end
2264
+ end
2265
+ class Alipay < Stripe::RequestParams
2266
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2267
+ #
2268
+ # 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.
2269
+ #
2270
+ # 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.
2271
+ #
2272
+ # 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).
2273
+ sig { returns(String) }
2274
+ attr_accessor :setup_future_usage
2275
+ sig { params(setup_future_usage: String).void }
2276
+ def initialize(setup_future_usage: nil); end
2277
+ end
2278
+ class AmazonPay < Stripe::RequestParams
2279
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2280
+ #
2281
+ # 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.
2282
+ #
2283
+ # 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.
2284
+ #
2285
+ # 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).
2286
+ sig { returns(String) }
2287
+ attr_accessor :setup_future_usage
2288
+ sig { params(setup_future_usage: String).void }
2289
+ def initialize(setup_future_usage: nil); end
2290
+ end
2291
+ class AuBecsDebit < Stripe::RequestParams
2292
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2293
+ #
2294
+ # 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.
2295
+ #
2296
+ # 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.
2297
+ #
2298
+ # 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).
2299
+ sig { returns(String) }
2300
+ attr_accessor :setup_future_usage
2301
+ sig { params(setup_future_usage: String).void }
2302
+ def initialize(setup_future_usage: nil); end
2303
+ end
2304
+ class BacsDebit < Stripe::RequestParams
2305
+ class MandateOptions < Stripe::RequestParams
2306
+ # 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'.
2307
+ sig { returns(T.nilable(String)) }
2308
+ attr_accessor :reference_prefix
2309
+ sig { params(reference_prefix: T.nilable(String)).void }
2310
+ def initialize(reference_prefix: nil); end
2311
+ end
2312
+ # Additional fields for Mandate creation
2313
+ sig {
2314
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions)
2315
+ }
2316
+ attr_accessor :mandate_options
2317
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2318
+ #
2319
+ # 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.
2320
+ #
2321
+ # 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.
2322
+ #
2323
+ # 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).
2324
+ sig { returns(String) }
2325
+ attr_accessor :setup_future_usage
2326
+ sig {
2327
+ params(mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions, setup_future_usage: String).void
2328
+ }
2329
+ def initialize(mandate_options: nil, setup_future_usage: nil); end
2330
+ end
2331
+ class Bancontact < Stripe::RequestParams
2332
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2333
+ #
2334
+ # 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.
2335
+ #
2336
+ # 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.
2337
+ #
2338
+ # 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).
2339
+ sig { returns(String) }
2340
+ attr_accessor :setup_future_usage
2341
+ sig { params(setup_future_usage: String).void }
2342
+ def initialize(setup_future_usage: nil); end
2343
+ end
2344
+ class Boleto < Stripe::RequestParams
2345
+ # 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.
2346
+ sig { returns(Integer) }
2347
+ attr_accessor :expires_after_days
2348
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2349
+ #
2350
+ # 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.
2351
+ #
2352
+ # 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.
2353
+ #
2354
+ # 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).
2355
+ sig { returns(String) }
2356
+ attr_accessor :setup_future_usage
2357
+ sig { params(expires_after_days: Integer, setup_future_usage: String).void }
2358
+ def initialize(expires_after_days: nil, setup_future_usage: nil); end
2359
+ end
2360
+ class Card < Stripe::RequestParams
2361
+ class Installments < Stripe::RequestParams
2362
+ # Setting to true enables installments for this Checkout Session.
2363
+ # Setting to false will prevent any installment plan from applying to a payment.
2364
+ sig { returns(T::Boolean) }
2365
+ attr_accessor :enabled
2366
+ sig { params(enabled: T::Boolean).void }
2367
+ def initialize(enabled: nil); end
2368
+ end
2369
+ class Restrictions < Stripe::RequestParams
2370
+ # 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.
2371
+ sig { returns(T::Array[String]) }
2372
+ attr_accessor :brands_blocked
2373
+ sig { params(brands_blocked: T::Array[String]).void }
2374
+ def initialize(brands_blocked: nil); end
2375
+ end
2376
+ # Installment options for card payments
2377
+ sig {
2378
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Installments)
2379
+ }
2380
+ attr_accessor :installments
2381
+ # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
2382
+ sig { returns(String) }
2383
+ attr_accessor :request_decremental_authorization
2384
+ # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
2385
+ sig { returns(String) }
2386
+ attr_accessor :request_extended_authorization
2387
+ # Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
2388
+ sig { returns(String) }
2389
+ attr_accessor :request_incremental_authorization
2390
+ # Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
2391
+ sig { returns(String) }
2392
+ attr_accessor :request_multicapture
2393
+ # Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
2394
+ sig { returns(String) }
2395
+ attr_accessor :request_overcapture
2396
+ # 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.
2397
+ sig { returns(String) }
2398
+ attr_accessor :request_three_d_secure
2399
+ # Restrictions to apply to the card payment method. For example, you can block specific card brands.
2400
+ sig {
2401
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Restrictions)
2402
+ }
2403
+ attr_accessor :restrictions
2404
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2405
+ #
2406
+ # 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.
2407
+ #
2408
+ # 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.
2409
+ #
2410
+ # 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).
2411
+ sig { returns(String) }
2412
+ attr_accessor :setup_future_usage
2413
+ # 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.
2414
+ sig { returns(String) }
2415
+ attr_accessor :statement_descriptor_suffix_kana
2416
+ # 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.
2417
+ sig { returns(String) }
2418
+ attr_accessor :statement_descriptor_suffix_kanji
2419
+ sig {
2420
+ params(installments: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Installments, request_decremental_authorization: String, request_extended_authorization: String, request_incremental_authorization: String, request_multicapture: String, request_overcapture: String, request_three_d_secure: String, restrictions: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Restrictions, setup_future_usage: String, statement_descriptor_suffix_kana: String, statement_descriptor_suffix_kanji: String).void
2421
+ }
2422
+ def initialize(
2423
+ installments: nil,
2424
+ request_decremental_authorization: nil,
2425
+ request_extended_authorization: nil,
2426
+ request_incremental_authorization: nil,
2427
+ request_multicapture: nil,
2428
+ request_overcapture: nil,
2429
+ request_three_d_secure: nil,
2430
+ restrictions: nil,
2431
+ setup_future_usage: nil,
2432
+ statement_descriptor_suffix_kana: nil,
2433
+ statement_descriptor_suffix_kanji: nil
2434
+ ); end
2435
+ end
2436
+ class Cashapp < Stripe::RequestParams
2437
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2438
+ #
2439
+ # 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.
2440
+ #
2441
+ # 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.
2442
+ #
2443
+ # 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).
2444
+ sig { returns(String) }
2445
+ attr_accessor :setup_future_usage
2446
+ sig { params(setup_future_usage: String).void }
2447
+ def initialize(setup_future_usage: nil); end
2448
+ end
2449
+ class CustomerBalance < Stripe::RequestParams
2450
+ class BankTransfer < Stripe::RequestParams
2451
+ class EuBankTransfer < Stripe::RequestParams
2452
+ # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
2453
+ sig { returns(String) }
2454
+ attr_accessor :country
2455
+ sig { params(country: String).void }
2456
+ def initialize(country: nil); end
2457
+ end
2458
+ # Configuration for eu_bank_transfer funding type.
2459
+ sig {
2460
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)
2461
+ }
2462
+ attr_accessor :eu_bank_transfer
2463
+ # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
2464
+ #
2465
+ # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
2466
+ sig { returns(T::Array[String]) }
2467
+ attr_accessor :requested_address_types
2468
+ # The list of bank transfer types that this PaymentIntent is allowed to use for funding.
2469
+ sig { returns(String) }
2470
+ attr_accessor :type
2471
+ sig {
2472
+ params(eu_bank_transfer: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer, requested_address_types: T::Array[String], type: String).void
2473
+ }
2474
+ def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
2475
+ end
2476
+ # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
2477
+ sig {
2478
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer)
2479
+ }
2480
+ attr_accessor :bank_transfer
2481
+ # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
2482
+ sig { returns(String) }
2483
+ attr_accessor :funding_type
2484
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2485
+ #
2486
+ # 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.
2487
+ #
2488
+ # 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.
2489
+ #
2490
+ # 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).
2491
+ sig { returns(String) }
2492
+ attr_accessor :setup_future_usage
2493
+ sig {
2494
+ params(bank_transfer: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer, funding_type: String, setup_future_usage: String).void
2495
+ }
2496
+ def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
2497
+ end
2498
+ class Eps < Stripe::RequestParams
2499
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2500
+ #
2501
+ # 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.
2502
+ #
2503
+ # 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.
2504
+ #
2505
+ # 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).
2506
+ sig { returns(String) }
2507
+ attr_accessor :setup_future_usage
2508
+ sig { params(setup_future_usage: String).void }
2509
+ def initialize(setup_future_usage: nil); end
2510
+ end
2511
+ class Fpx < Stripe::RequestParams
2512
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2513
+ #
2514
+ # 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.
2515
+ #
2516
+ # 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.
2517
+ #
2518
+ # 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).
2519
+ sig { returns(String) }
2520
+ attr_accessor :setup_future_usage
2521
+ sig { params(setup_future_usage: String).void }
2522
+ def initialize(setup_future_usage: nil); end
2523
+ end
2524
+ class Giropay < Stripe::RequestParams
2525
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2526
+ #
2527
+ # 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.
2528
+ #
2529
+ # 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.
2530
+ #
2531
+ # 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).
2532
+ sig { returns(String) }
2533
+ attr_accessor :setup_future_usage
2534
+ sig { params(setup_future_usage: String).void }
2535
+ def initialize(setup_future_usage: nil); end
2536
+ end
2537
+ class Grabpay < Stripe::RequestParams
2538
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2539
+ #
2540
+ # 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.
2541
+ #
2542
+ # 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.
2543
+ #
2544
+ # 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).
2545
+ sig { returns(String) }
2546
+ attr_accessor :setup_future_usage
2547
+ sig { params(setup_future_usage: String).void }
2548
+ def initialize(setup_future_usage: nil); end
2549
+ end
2550
+ class Ideal < Stripe::RequestParams
2551
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2552
+ #
2553
+ # 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.
2554
+ #
2555
+ # 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.
2556
+ #
2557
+ # 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).
2558
+ sig { returns(String) }
2559
+ attr_accessor :setup_future_usage
2560
+ sig { params(setup_future_usage: String).void }
2561
+ def initialize(setup_future_usage: nil); end
2562
+ end
2563
+ class KakaoPay < Stripe::RequestParams
2564
+ # Controls when the funds will be captured from the customer's account.
2565
+ sig { returns(String) }
2566
+ attr_accessor :capture_method
2567
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2568
+ #
2569
+ # 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.
2570
+ #
2571
+ # 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.
2572
+ #
2573
+ # 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).
2574
+ sig { returns(String) }
2575
+ attr_accessor :setup_future_usage
2576
+ sig { params(capture_method: String, setup_future_usage: String).void }
2577
+ def initialize(capture_method: nil, setup_future_usage: nil); end
2578
+ end
2579
+ class Klarna < Stripe::RequestParams
2580
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2581
+ #
2582
+ # 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.
2583
+ #
2584
+ # 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.
2585
+ #
2586
+ # 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).
2587
+ sig { returns(String) }
2588
+ attr_accessor :setup_future_usage
2589
+ sig { params(setup_future_usage: String).void }
2590
+ def initialize(setup_future_usage: nil); end
2591
+ end
2592
+ class Konbini < Stripe::RequestParams
2593
+ # 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.
2594
+ sig { returns(Integer) }
2595
+ attr_accessor :expires_after_days
2596
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2597
+ #
2598
+ # 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.
2599
+ #
2600
+ # 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.
2601
+ #
2602
+ # 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).
2603
+ sig { returns(String) }
2604
+ attr_accessor :setup_future_usage
2605
+ sig { params(expires_after_days: Integer, setup_future_usage: String).void }
2606
+ def initialize(expires_after_days: nil, setup_future_usage: nil); end
2607
+ end
2608
+ class KrCard < Stripe::RequestParams
2609
+ # Controls when the funds will be captured from the customer's account.
2610
+ sig { returns(String) }
2611
+ attr_accessor :capture_method
2612
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2613
+ #
2614
+ # 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.
2615
+ #
2616
+ # 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.
2617
+ #
2618
+ # 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).
2619
+ sig { returns(String) }
2620
+ attr_accessor :setup_future_usage
2621
+ sig { params(capture_method: String, setup_future_usage: String).void }
2622
+ def initialize(capture_method: nil, setup_future_usage: nil); end
2623
+ end
2624
+ class Link < Stripe::RequestParams
2625
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2626
+ #
2627
+ # 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.
2628
+ #
2629
+ # 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.
2630
+ #
2631
+ # 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).
2632
+ sig { returns(String) }
2633
+ attr_accessor :setup_future_usage
2634
+ sig { params(setup_future_usage: String).void }
2635
+ def initialize(setup_future_usage: nil); end
2636
+ end
2637
+ class Mobilepay < Stripe::RequestParams
2638
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2639
+ #
2640
+ # 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.
2641
+ #
2642
+ # 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.
2643
+ #
2644
+ # 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).
2645
+ sig { returns(String) }
2646
+ attr_accessor :setup_future_usage
2647
+ sig { params(setup_future_usage: String).void }
2648
+ def initialize(setup_future_usage: nil); end
2649
+ end
2650
+ class Multibanco < Stripe::RequestParams
2651
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2652
+ #
2653
+ # 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.
2654
+ #
2655
+ # 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.
2656
+ #
2657
+ # 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).
2658
+ sig { returns(String) }
2659
+ attr_accessor :setup_future_usage
2660
+ sig { params(setup_future_usage: String).void }
2661
+ def initialize(setup_future_usage: nil); end
2662
+ end
2663
+ class NaverPay < Stripe::RequestParams
2664
+ # Controls when the funds will be captured from the customer's account.
2665
+ sig { returns(String) }
2666
+ attr_accessor :capture_method
2667
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2668
+ #
2669
+ # 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.
2670
+ #
2671
+ # 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.
2672
+ #
2673
+ # 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).
2674
+ sig { returns(String) }
2675
+ attr_accessor :setup_future_usage
2676
+ sig { params(capture_method: String, setup_future_usage: String).void }
2677
+ def initialize(capture_method: nil, setup_future_usage: nil); end
2678
+ end
2679
+ class Oxxo < Stripe::RequestParams
2680
+ # 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.
2681
+ sig { returns(Integer) }
2682
+ attr_accessor :expires_after_days
2683
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2684
+ #
2685
+ # 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.
2686
+ #
2687
+ # 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.
2688
+ #
2689
+ # 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).
2690
+ sig { returns(String) }
2691
+ attr_accessor :setup_future_usage
2692
+ sig { params(expires_after_days: Integer, setup_future_usage: String).void }
2693
+ def initialize(expires_after_days: nil, setup_future_usage: nil); end
2694
+ end
2695
+ class P24 < Stripe::RequestParams
2696
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2697
+ #
2698
+ # 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.
2699
+ #
2700
+ # 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.
2701
+ #
2702
+ # 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).
2703
+ sig { returns(String) }
2704
+ attr_accessor :setup_future_usage
2705
+ # Confirm that the payer has accepted the P24 terms and conditions.
2706
+ sig { returns(T::Boolean) }
2707
+ attr_accessor :tos_shown_and_accepted
2708
+ sig { params(setup_future_usage: String, tos_shown_and_accepted: T::Boolean).void }
2709
+ def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
2710
+ end
2711
+ class PayByBank < Stripe::RequestParams
2712
+
2713
+ end
2714
+ class Payco < Stripe::RequestParams
2715
+ # Controls when the funds will be captured from the customer's account.
2716
+ sig { returns(String) }
2717
+ attr_accessor :capture_method
2718
+ sig { params(capture_method: String).void }
2719
+ def initialize(capture_method: nil); end
2720
+ end
2721
+ class Paynow < Stripe::RequestParams
2722
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2723
+ #
2724
+ # 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.
2725
+ #
2726
+ # 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.
2727
+ #
2728
+ # 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).
2729
+ sig { returns(String) }
2730
+ attr_accessor :setup_future_usage
2731
+ sig { params(setup_future_usage: String).void }
2732
+ def initialize(setup_future_usage: nil); end
2733
+ end
2734
+ class Paypal < Stripe::RequestParams
2735
+ # Controls when the funds will be captured from the customer's account.
2736
+ sig { returns(T.nilable(String)) }
2737
+ attr_accessor :capture_method
2738
+ # [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
2739
+ sig { returns(String) }
2740
+ attr_accessor :preferred_locale
2741
+ # 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.
2742
+ sig { returns(String) }
2743
+ attr_accessor :reference
2744
+ # 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.
2745
+ sig { returns(String) }
2746
+ attr_accessor :reference_id
2747
+ # The risk correlation ID for an on-session payment using a saved PayPal payment method.
2748
+ sig { returns(String) }
2749
+ attr_accessor :risk_correlation_id
2750
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2751
+ #
2752
+ # 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.
2753
+ #
2754
+ # 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.
2755
+ #
2756
+ # 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).
2757
+ #
2758
+ # 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`.
2759
+ sig { returns(T.nilable(String)) }
2760
+ attr_accessor :setup_future_usage
2761
+ # 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.
2762
+ sig { returns(T::Array[String]) }
2763
+ attr_accessor :subsellers
2764
+ sig {
2765
+ params(capture_method: T.nilable(String), preferred_locale: String, reference: String, reference_id: String, risk_correlation_id: String, setup_future_usage: T.nilable(String), subsellers: T::Array[String]).void
2766
+ }
2767
+ def initialize(
2768
+ capture_method: nil,
2769
+ preferred_locale: nil,
2770
+ reference: nil,
2771
+ reference_id: nil,
2772
+ risk_correlation_id: nil,
2773
+ setup_future_usage: nil,
2774
+ subsellers: nil
2775
+ ); end
2776
+ end
2777
+ class Payto < Stripe::RequestParams
2778
+ class MandateOptions < Stripe::RequestParams
2779
+ # Amount that will be collected. It is required when `amount_type` is `fixed`.
2780
+ sig { returns(Integer) }
2781
+ attr_accessor :amount
2782
+ # 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.
2783
+ sig { returns(String) }
2784
+ attr_accessor :amount_type
2785
+ # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
2786
+ sig { returns(String) }
2787
+ attr_accessor :end_date
2788
+ # The periodicity at which payments will be collected.
2789
+ sig { returns(String) }
2790
+ attr_accessor :payment_schedule
2791
+ # 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.
2792
+ sig { returns(Integer) }
2793
+ attr_accessor :payments_per_period
2794
+ # The purpose for which payments are made. Defaults to retail.
2795
+ sig { returns(String) }
2796
+ attr_accessor :purpose
2797
+ # Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
2798
+ sig { returns(String) }
2799
+ attr_accessor :start_date
2800
+ sig {
2801
+ params(amount: Integer, amount_type: String, end_date: String, payment_schedule: String, payments_per_period: Integer, purpose: String, start_date: String).void
2802
+ }
2803
+ def initialize(
2804
+ amount: nil,
2805
+ amount_type: nil,
2806
+ end_date: nil,
2807
+ payment_schedule: nil,
2808
+ payments_per_period: nil,
2809
+ purpose: nil,
2810
+ start_date: nil
2811
+ ); end
2812
+ end
2813
+ # Additional fields for Mandate creation
2814
+ sig {
2815
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto::MandateOptions)
2816
+ }
2817
+ attr_accessor :mandate_options
2818
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2819
+ #
2820
+ # 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.
2821
+ #
2822
+ # 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.
2823
+ #
2824
+ # 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).
2825
+ sig { returns(String) }
2826
+ attr_accessor :setup_future_usage
2827
+ sig {
2828
+ params(mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto::MandateOptions, setup_future_usage: String).void
2829
+ }
2830
+ def initialize(mandate_options: nil, setup_future_usage: nil); end
2831
+ end
2832
+ class Pix < Stripe::RequestParams
2833
+ # The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
2834
+ sig { returns(Integer) }
2835
+ attr_accessor :expires_after_seconds
2836
+ sig { params(expires_after_seconds: Integer).void }
2837
+ def initialize(expires_after_seconds: nil); end
2838
+ end
2839
+ class RevolutPay < Stripe::RequestParams
2840
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2841
+ #
2842
+ # 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.
2843
+ #
2844
+ # 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.
2845
+ #
2846
+ # 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).
2847
+ sig { returns(String) }
2848
+ attr_accessor :setup_future_usage
2849
+ sig { params(setup_future_usage: String).void }
2850
+ def initialize(setup_future_usage: nil); end
2851
+ end
2852
+ class SamsungPay < Stripe::RequestParams
2853
+ # Controls when the funds will be captured from the customer's account.
2854
+ sig { returns(String) }
2855
+ attr_accessor :capture_method
2856
+ sig { params(capture_method: String).void }
2857
+ def initialize(capture_method: nil); end
2858
+ end
2859
+ class SepaDebit < Stripe::RequestParams
2860
+ class MandateOptions < Stripe::RequestParams
2861
+ # 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'.
2862
+ sig { returns(T.nilable(String)) }
2863
+ attr_accessor :reference_prefix
2864
+ sig { params(reference_prefix: T.nilable(String)).void }
2865
+ def initialize(reference_prefix: nil); end
2866
+ end
2867
+ # Additional fields for Mandate creation
2868
+ sig {
2869
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)
2870
+ }
2871
+ attr_accessor :mandate_options
2872
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2873
+ #
2874
+ # 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.
2875
+ #
2876
+ # 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.
2877
+ #
2878
+ # 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).
2879
+ sig { returns(String) }
2880
+ attr_accessor :setup_future_usage
2881
+ sig {
2882
+ params(mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: String).void
2883
+ }
2884
+ def initialize(mandate_options: nil, setup_future_usage: nil); end
2885
+ end
2886
+ class Sofort < Stripe::RequestParams
2887
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2888
+ #
2889
+ # 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.
2890
+ #
2891
+ # 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.
2892
+ #
2893
+ # 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).
2894
+ sig { returns(String) }
2895
+ attr_accessor :setup_future_usage
2896
+ sig { params(setup_future_usage: String).void }
2897
+ def initialize(setup_future_usage: nil); end
2898
+ end
2899
+ class Swish < Stripe::RequestParams
2900
+ # The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
2901
+ sig { returns(String) }
2902
+ attr_accessor :reference
2903
+ sig { params(reference: String).void }
2904
+ def initialize(reference: nil); end
2905
+ end
2906
+ class UsBankAccount < Stripe::RequestParams
2907
+ class FinancialConnections < Stripe::RequestParams
2908
+ # 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`.
2909
+ sig { returns(T::Array[String]) }
2910
+ attr_accessor :permissions
2911
+ # List of data features that you would like to retrieve upon account creation.
2912
+ sig { returns(T::Array[String]) }
2913
+ attr_accessor :prefetch
2914
+ sig { params(permissions: T::Array[String], prefetch: T::Array[String]).void }
2915
+ def initialize(permissions: nil, prefetch: nil); end
2916
+ end
2917
+ # Additional fields for Financial Connections Session creation
2918
+ sig {
2919
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)
2920
+ }
2921
+ attr_accessor :financial_connections
2922
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2923
+ #
2924
+ # 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.
2925
+ #
2926
+ # 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.
2927
+ #
2928
+ # 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).
2929
+ sig { returns(String) }
2930
+ attr_accessor :setup_future_usage
2931
+ # Verification method for the intent
2932
+ sig { returns(String) }
2933
+ attr_accessor :verification_method
2934
+ sig {
2935
+ params(financial_connections: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections, setup_future_usage: String, verification_method: String).void
2936
+ }
2937
+ def initialize(
2938
+ financial_connections: nil,
2939
+ setup_future_usage: nil,
2940
+ verification_method: nil
2941
+ ); end
2942
+ end
2943
+ class WechatPay < Stripe::RequestParams
2944
+ # The app ID registered with WeChat Pay. Only required when client is ios or android.
2945
+ sig { returns(String) }
2946
+ attr_accessor :app_id
2947
+ # The client type that the end customer will pay from
2948
+ sig { returns(String) }
2949
+ attr_accessor :client
2950
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2951
+ #
2952
+ # 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.
2953
+ #
2954
+ # 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.
2955
+ #
2956
+ # 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).
2957
+ sig { returns(String) }
2958
+ attr_accessor :setup_future_usage
2959
+ sig { params(app_id: String, client: String, setup_future_usage: String).void }
2960
+ def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
2961
+ end
2962
+ # contains details about the ACSS Debit payment method options.
2963
+ sig {
2964
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit)
2965
+ }
2966
+ attr_accessor :acss_debit
2967
+ # contains details about the Affirm payment method options.
2968
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Affirm) }
2969
+ attr_accessor :affirm
2970
+ # contains details about the Afterpay Clearpay payment method options.
2971
+ sig {
2972
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AfterpayClearpay)
2973
+ }
2974
+ attr_accessor :afterpay_clearpay
2975
+ # contains details about the Alipay payment method options.
2976
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Alipay) }
2977
+ attr_accessor :alipay
2978
+ # contains details about the AmazonPay payment method options.
2979
+ sig {
2980
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AmazonPay)
2981
+ }
2982
+ attr_accessor :amazon_pay
2983
+ # contains details about the AU Becs Debit payment method options.
2984
+ sig {
2985
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AuBecsDebit)
2986
+ }
2987
+ attr_accessor :au_becs_debit
2988
+ # contains details about the Bacs Debit payment method options.
2989
+ sig {
2990
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit)
2991
+ }
2992
+ attr_accessor :bacs_debit
2993
+ # contains details about the Bancontact payment method options.
2994
+ sig {
2995
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Bancontact)
2996
+ }
2997
+ attr_accessor :bancontact
2998
+ # contains details about the Boleto payment method options.
2999
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Boleto) }
3000
+ attr_accessor :boleto
3001
+ # contains details about the Card payment method options.
3002
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card) }
3003
+ attr_accessor :card
3004
+ # contains details about the Cashapp Pay payment method options.
3005
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Cashapp) }
3006
+ attr_accessor :cashapp
3007
+ # contains details about the Customer Balance payment method options.
3008
+ sig {
3009
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance)
3010
+ }
3011
+ attr_accessor :customer_balance
3012
+ # contains details about the EPS payment method options.
3013
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Eps) }
3014
+ attr_accessor :eps
3015
+ # contains details about the FPX payment method options.
3016
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Fpx) }
3017
+ attr_accessor :fpx
3018
+ # contains details about the Giropay payment method options.
3019
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Giropay) }
3020
+ attr_accessor :giropay
3021
+ # contains details about the Grabpay payment method options.
3022
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Grabpay) }
3023
+ attr_accessor :grabpay
3024
+ # contains details about the Ideal payment method options.
3025
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Ideal) }
3026
+ attr_accessor :ideal
3027
+ # contains details about the Kakao Pay payment method options.
3028
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KakaoPay) }
3029
+ attr_accessor :kakao_pay
3030
+ # contains details about the Klarna payment method options.
3031
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna) }
3032
+ attr_accessor :klarna
3033
+ # contains details about the Konbini payment method options.
3034
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Konbini) }
3035
+ attr_accessor :konbini
3036
+ # contains details about the Korean card payment method options.
3037
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KrCard) }
3038
+ attr_accessor :kr_card
3039
+ # contains details about the Link payment method options.
3040
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Link) }
3041
+ attr_accessor :link
3042
+ # contains details about the Mobilepay payment method options.
3043
+ sig {
3044
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Mobilepay)
3045
+ }
3046
+ attr_accessor :mobilepay
3047
+ # contains details about the Multibanco payment method options.
3048
+ sig {
3049
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Multibanco)
3050
+ }
3051
+ attr_accessor :multibanco
3052
+ # contains details about the Naver Pay payment method options.
3053
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::NaverPay) }
3054
+ attr_accessor :naver_pay
3055
+ # contains details about the OXXO payment method options.
3056
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Oxxo) }
3057
+ attr_accessor :oxxo
3058
+ # contains details about the P24 payment method options.
3059
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::P24) }
3060
+ attr_accessor :p24
3061
+ # contains details about the Pay By Bank payment method options.
3062
+ sig {
3063
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::PayByBank)
3064
+ }
3065
+ attr_accessor :pay_by_bank
3066
+ # contains details about the PAYCO payment method options.
3067
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payco) }
3068
+ attr_accessor :payco
3069
+ # contains details about the PayNow payment method options.
3070
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paynow) }
3071
+ attr_accessor :paynow
3072
+ # contains details about the PayPal payment method options.
3073
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paypal) }
3074
+ attr_accessor :paypal
3075
+ # contains details about the PayTo payment method options.
3076
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto) }
3077
+ attr_accessor :payto
3078
+ # contains details about the Pix payment method options.
3079
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix) }
3080
+ attr_accessor :pix
3081
+ # contains details about the RevolutPay payment method options.
3082
+ sig {
3083
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::RevolutPay)
3084
+ }
3085
+ attr_accessor :revolut_pay
3086
+ # contains details about the Samsung Pay payment method options.
3087
+ sig {
3088
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SamsungPay)
3089
+ }
3090
+ attr_accessor :samsung_pay
3091
+ # contains details about the Sepa Debit payment method options.
3092
+ sig {
3093
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit)
3094
+ }
3095
+ attr_accessor :sepa_debit
3096
+ # contains details about the Sofort payment method options.
3097
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Sofort) }
3098
+ attr_accessor :sofort
3099
+ # contains details about the Swish payment method options.
3100
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Swish) }
3101
+ attr_accessor :swish
3102
+ # contains details about the Us Bank Account payment method options.
3103
+ sig {
3104
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount)
3105
+ }
3106
+ attr_accessor :us_bank_account
3107
+ # contains details about the WeChat Pay payment method options.
3108
+ sig {
3109
+ returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::WechatPay)
3110
+ }
3111
+ attr_accessor :wechat_pay
3112
+ sig {
3113
+ params(acss_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit, affirm: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Affirm, afterpay_clearpay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AfterpayClearpay, alipay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Alipay, amazon_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AmazonPay, au_becs_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AuBecsDebit, bacs_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit, bancontact: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Bancontact, boleto: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Boleto, card: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card, cashapp: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Cashapp, customer_balance: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance, eps: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Eps, fpx: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Fpx, giropay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Giropay, grabpay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Grabpay, ideal: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Ideal, kakao_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KakaoPay, klarna: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna, konbini: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Konbini, kr_card: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KrCard, link: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Link, mobilepay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Mobilepay, multibanco: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Multibanco, naver_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::NaverPay, oxxo: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Oxxo, p24: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::P24, pay_by_bank: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::PayByBank, payco: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payco, paynow: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paynow, paypal: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paypal, payto: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto, pix: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix, revolut_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::RevolutPay, samsung_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SamsungPay, sepa_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit, sofort: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Sofort, swish: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Swish, us_bank_account: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount, wechat_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::WechatPay).void
3114
+ }
3115
+ def initialize(
3116
+ acss_debit: nil,
3117
+ affirm: nil,
3118
+ afterpay_clearpay: nil,
3119
+ alipay: nil,
3120
+ amazon_pay: nil,
3121
+ au_becs_debit: nil,
3122
+ bacs_debit: nil,
3123
+ bancontact: nil,
3124
+ boleto: nil,
3125
+ card: nil,
3126
+ cashapp: nil,
3127
+ customer_balance: nil,
3128
+ eps: nil,
3129
+ fpx: nil,
3130
+ giropay: nil,
3131
+ grabpay: nil,
3132
+ ideal: nil,
3133
+ kakao_pay: nil,
3134
+ klarna: nil,
3135
+ konbini: nil,
3136
+ kr_card: nil,
3137
+ link: nil,
3138
+ mobilepay: nil,
3139
+ multibanco: nil,
3140
+ naver_pay: nil,
3141
+ oxxo: nil,
3142
+ p24: nil,
3143
+ pay_by_bank: nil,
3144
+ payco: nil,
3145
+ paynow: nil,
3146
+ paypal: nil,
3147
+ payto: nil,
3148
+ pix: nil,
3149
+ revolut_pay: nil,
3150
+ samsung_pay: nil,
3151
+ sepa_debit: nil,
3152
+ sofort: nil,
3153
+ swish: nil,
3154
+ us_bank_account: nil,
3155
+ wechat_pay: nil
3156
+ ); end
3157
+ end
3158
+ class Permissions < Stripe::RequestParams
3159
+ class Update < Stripe::RequestParams
3160
+ # Determines which entity is allowed to update the line items.
3161
+ #
3162
+ # 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.
3163
+ #
3164
+ # 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.
3165
+ sig { returns(String) }
3166
+ attr_accessor :line_items
3167
+ # Determines which entity is allowed to update the shipping details.
3168
+ #
3169
+ # 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.
3170
+ #
3171
+ # 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.
3172
+ sig { returns(String) }
3173
+ attr_accessor :shipping_details
3174
+ sig { params(line_items: String, shipping_details: String).void }
3175
+ def initialize(line_items: nil, shipping_details: nil); end
3176
+ end
3177
+ # Permissions for updating the Checkout Session.
3178
+ sig { returns(::Stripe::Checkout::Session::CreateParams::Permissions::Update) }
3179
+ attr_accessor :update
3180
+ sig {
3181
+ params(update: ::Stripe::Checkout::Session::CreateParams::Permissions::Update).void
3182
+ }
3183
+ def initialize(update: nil); end
3184
+ end
3185
+ class PhoneNumberCollection < Stripe::RequestParams
3186
+ # Set to `true` to enable phone number collection.
3187
+ #
3188
+ # Can only be set in `payment` and `subscription` mode.
3189
+ sig { returns(T::Boolean) }
3190
+ attr_accessor :enabled
3191
+ sig { params(enabled: T::Boolean).void }
3192
+ def initialize(enabled: nil); end
3193
+ end
3194
+ class SavedPaymentMethodOptions < Stripe::RequestParams
3195
+ # 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.
3196
+ sig { returns(T::Array[String]) }
3197
+ attr_accessor :allow_redisplay_filters
3198
+ # Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
3199
+ sig { returns(String) }
3200
+ attr_accessor :payment_method_save
3201
+ sig {
3202
+ params(allow_redisplay_filters: T::Array[String], payment_method_save: String).void
3203
+ }
3204
+ def initialize(allow_redisplay_filters: nil, payment_method_save: nil); end
3205
+ end
3206
+ class SetupIntentData < Stripe::RequestParams
3207
+ # An arbitrary string attached to the object. Often useful for displaying to users.
3208
+ sig { returns(String) }
3209
+ attr_accessor :description
3210
+ # 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`.
3211
+ sig { returns(T::Hash[String, String]) }
3212
+ attr_accessor :metadata
3213
+ # The Stripe account for which the setup is intended.
3214
+ sig { returns(String) }
3215
+ attr_accessor :on_behalf_of
3216
+ sig {
3217
+ params(description: String, metadata: T::Hash[String, String], on_behalf_of: String).void
3218
+ }
3219
+ def initialize(description: nil, metadata: nil, on_behalf_of: nil); end
3220
+ end
3221
+ class ShippingAddressCollection < Stripe::RequestParams
3222
+ # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
3223
+ # shipping locations.
3224
+ sig { returns(T::Array[String]) }
3225
+ attr_accessor :allowed_countries
3226
+ sig { params(allowed_countries: T::Array[String]).void }
3227
+ def initialize(allowed_countries: nil); end
3228
+ end
3229
+ class ShippingOption < Stripe::RequestParams
3230
+ class ShippingRateData < Stripe::RequestParams
3231
+ class DeliveryEstimate < Stripe::RequestParams
3232
+ class Maximum < Stripe::RequestParams
3233
+ # A unit of time.
3234
+ sig { returns(String) }
3235
+ attr_accessor :unit
3236
+ # Must be greater than 0.
3237
+ sig { returns(Integer) }
3238
+ attr_accessor :value
3239
+ sig { params(unit: String, value: Integer).void }
3240
+ def initialize(unit: nil, value: nil); end
3241
+ end
3242
+ class Minimum < Stripe::RequestParams
3243
+ # A unit of time.
3244
+ sig { returns(String) }
3245
+ attr_accessor :unit
3246
+ # Must be greater than 0.
3247
+ sig { returns(Integer) }
3248
+ attr_accessor :value
3249
+ sig { params(unit: String, value: Integer).void }
3250
+ def initialize(unit: nil, value: nil); end
3251
+ end
3252
+ # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
3253
+ sig {
3254
+ returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)
3255
+ }
3256
+ attr_accessor :maximum
3257
+ # The lower bound of the estimated range. If empty, represents no lower bound.
3258
+ sig {
3259
+ returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)
3260
+ }
3261
+ attr_accessor :minimum
3262
+ sig {
3263
+ params(maximum: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum, minimum: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum).void
3264
+ }
3265
+ def initialize(maximum: nil, minimum: nil); end
3266
+ end
3267
+ class FixedAmount < Stripe::RequestParams
3268
+ class CurrencyOptions < Stripe::RequestParams
3269
+ # A non-negative integer in cents representing how much to charge.
3270
+ sig { returns(Integer) }
3271
+ attr_accessor :amount
3272
+ # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
3273
+ sig { returns(String) }
3274
+ attr_accessor :tax_behavior
3275
+ sig { params(amount: Integer, tax_behavior: String).void }
3276
+ def initialize(amount: nil, tax_behavior: nil); end
3277
+ end
3278
+ # A non-negative integer in cents representing how much to charge.
3279
+ sig { returns(Integer) }
3280
+ attr_accessor :amount
3281
+ # 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).
3282
+ sig { returns(String) }
3283
+ attr_accessor :currency
3284
+ # 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).
3285
+ sig {
3286
+ returns(T::Hash[String, ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])
3287
+ }
3288
+ attr_accessor :currency_options
3289
+ sig {
3290
+ params(amount: Integer, currency: String, currency_options: T::Hash[String, ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]).void
3291
+ }
3292
+ def initialize(amount: nil, currency: nil, currency_options: nil); end
3293
+ end
3294
+ # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
3295
+ sig {
3296
+ returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate)
3297
+ }
3298
+ attr_accessor :delivery_estimate
3299
+ # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
3300
+ sig { returns(String) }
3301
+ attr_accessor :display_name
3302
+ # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
3303
+ sig {
3304
+ returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount)
3305
+ }
3306
+ attr_accessor :fixed_amount
3307
+ # 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`.
3308
+ sig { returns(T::Hash[String, String]) }
3309
+ attr_accessor :metadata
3310
+ # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
3311
+ sig { returns(String) }
3312
+ attr_accessor :tax_behavior
3313
+ # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
3314
+ sig { returns(String) }
3315
+ attr_accessor :tax_code
3316
+ # The type of calculation to use on the shipping rate.
3317
+ sig { returns(String) }
3318
+ attr_accessor :type
3319
+ sig {
3320
+ params(delivery_estimate: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate, display_name: String, fixed_amount: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount, metadata: T::Hash[String, String], tax_behavior: String, tax_code: String, type: String).void
3321
+ }
3322
+ def initialize(
3323
+ delivery_estimate: nil,
3324
+ display_name: nil,
3325
+ fixed_amount: nil,
3326
+ metadata: nil,
3327
+ tax_behavior: nil,
3328
+ tax_code: nil,
3329
+ type: nil
3330
+ ); end
3331
+ end
3332
+ # The ID of the Shipping Rate to use for this shipping option.
3333
+ sig { returns(String) }
3334
+ attr_accessor :shipping_rate
3335
+ # Parameters to be passed to Shipping Rate creation for this shipping option.
3336
+ sig {
3337
+ returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData)
3338
+ }
3339
+ attr_accessor :shipping_rate_data
3340
+ sig {
3341
+ params(shipping_rate: String, shipping_rate_data: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData).void
3342
+ }
3343
+ def initialize(shipping_rate: nil, shipping_rate_data: nil); end
3344
+ end
3345
+ class SubscriptionData < Stripe::RequestParams
3346
+ class InvoiceSettings < Stripe::RequestParams
3347
+ class Issuer < Stripe::RequestParams
3348
+ # The connected account being referenced when `type` is `account`.
3349
+ sig { returns(String) }
3350
+ attr_accessor :account
3351
+ # Type of the account referenced in the request.
3352
+ sig { returns(String) }
3353
+ attr_accessor :type
3354
+ sig { params(account: String, type: String).void }
3355
+ def initialize(account: nil, type: nil); end
3356
+ end
3357
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
3358
+ sig {
3359
+ returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings::Issuer)
3360
+ }
3361
+ attr_accessor :issuer
3362
+ sig {
3363
+ params(issuer: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings::Issuer).void
3364
+ }
3365
+ def initialize(issuer: nil); end
3366
+ end
3367
+ class TransferData < Stripe::RequestParams
3368
+ # 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.
3369
+ sig { returns(Float) }
3370
+ attr_accessor :amount_percent
3371
+ # ID of an existing, connected Stripe account.
3372
+ sig { returns(String) }
3373
+ attr_accessor :destination
3374
+ sig { params(amount_percent: Float, destination: String).void }
3375
+ def initialize(amount_percent: nil, destination: nil); end
3376
+ end
3377
+ class TrialSettings < Stripe::RequestParams
3378
+ class EndBehavior < Stripe::RequestParams
3379
+ # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
3380
+ sig { returns(String) }
3381
+ attr_accessor :missing_payment_method
3382
+ sig { params(missing_payment_method: String).void }
3383
+ def initialize(missing_payment_method: nil); end
3384
+ end
3385
+ # Defines how the subscription should behave when the user's free trial ends.
3386
+ sig {
3387
+ returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
3388
+ }
3389
+ attr_accessor :end_behavior
3390
+ sig {
3391
+ params(end_behavior: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings::EndBehavior).void
3392
+ }
3393
+ def initialize(end_behavior: nil); end
3394
+ end
3395
+ # 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).
3396
+ sig { returns(Float) }
3397
+ attr_accessor :application_fee_percent
3398
+ # A future timestamp to anchor the subscription's billing cycle for new subscriptions.
3399
+ sig { returns(Integer) }
3400
+ attr_accessor :billing_cycle_anchor
3401
+ # The tax rates that will apply to any subscription item that does not have
3402
+ # `tax_rates` set. Invoices created will have their `default_tax_rates` populated
3403
+ # from the subscription.
3404
+ sig { returns(T::Array[String]) }
3405
+ attr_accessor :default_tax_rates
3406
+ # The subscription's description, meant to be displayable to the customer.
3407
+ # Use this field to optionally store an explanation of the subscription
3408
+ # for rendering in the [customer portal](https://stripe.com/docs/customer-management).
3409
+ sig { returns(String) }
3410
+ attr_accessor :description
3411
+ # All invoices will be billed using the specified settings.
3412
+ sig {
3413
+ returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings)
3414
+ }
3415
+ attr_accessor :invoice_settings
3416
+ # 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`.
3417
+ sig { returns(T::Hash[String, String]) }
3418
+ attr_accessor :metadata
3419
+ # The account on behalf of which to charge, for each of the subscription's invoices.
3420
+ sig { returns(String) }
3421
+ attr_accessor :on_behalf_of
3422
+ # Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
3423
+ sig { returns(String) }
3424
+ attr_accessor :proration_behavior
3425
+ # 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.
3426
+ sig { returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TransferData) }
3427
+ attr_accessor :transfer_data
3428
+ # Unix timestamp representing the end of the trial period the customer
3429
+ # will get before being charged for the first time. Has to be at least
3430
+ # 48 hours in the future.
3431
+ sig { returns(Integer) }
3432
+ attr_accessor :trial_end
3433
+ # Integer representing the number of trial period days before the
3434
+ # customer is charged for the first time. Has to be at least 1.
3435
+ sig { returns(Integer) }
3436
+ attr_accessor :trial_period_days
3437
+ # Settings related to subscription trials.
3438
+ sig {
3439
+ returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings)
3440
+ }
3441
+ attr_accessor :trial_settings
3442
+ sig {
3443
+ params(application_fee_percent: Float, billing_cycle_anchor: Integer, default_tax_rates: T::Array[String], description: String, invoice_settings: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings, metadata: T::Hash[String, String], on_behalf_of: String, proration_behavior: String, transfer_data: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::TransferData, trial_end: Integer, trial_period_days: Integer, trial_settings: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings).void
3444
+ }
3445
+ def initialize(
3446
+ application_fee_percent: nil,
3447
+ billing_cycle_anchor: nil,
3448
+ default_tax_rates: nil,
3449
+ description: nil,
3450
+ invoice_settings: nil,
3451
+ metadata: nil,
3452
+ on_behalf_of: nil,
3453
+ proration_behavior: nil,
3454
+ transfer_data: nil,
3455
+ trial_end: nil,
3456
+ trial_period_days: nil,
3457
+ trial_settings: nil
3458
+ ); end
3459
+ end
3460
+ class TaxIdCollection < Stripe::RequestParams
3461
+ # Enable tax ID collection during checkout. Defaults to `false`.
3462
+ sig { returns(T::Boolean) }
3463
+ attr_accessor :enabled
3464
+ # Describes whether a tax ID is required during checkout. Defaults to `never`.
3465
+ sig { returns(String) }
3466
+ attr_accessor :required
3467
+ sig { params(enabled: T::Boolean, required: String).void }
3468
+ def initialize(enabled: nil, required: nil); end
3469
+ end
3470
+ # Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
3471
+ sig { returns(::Stripe::Checkout::Session::CreateParams::AdaptivePricing) }
3472
+ attr_accessor :adaptive_pricing
3473
+ # Configure actions after a Checkout Session has expired.
3474
+ sig { returns(::Stripe::Checkout::Session::CreateParams::AfterExpiration) }
3475
+ attr_accessor :after_expiration
3476
+ # Enables user redeemable promotion codes.
3477
+ sig { returns(T::Boolean) }
3478
+ attr_accessor :allow_promotion_codes
3479
+ # Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
3480
+ sig { returns(::Stripe::Checkout::Session::CreateParams::AutomaticTax) }
3481
+ attr_accessor :automatic_tax
3482
+ # Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
3483
+ sig { returns(String) }
3484
+ attr_accessor :billing_address_collection
3485
+ # 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`.
3486
+ sig { returns(String) }
3487
+ attr_accessor :cancel_url
3488
+ # A unique string to reference the Checkout Session. This can be a
3489
+ # customer ID, a cart ID, or similar, and can be used to reconcile the
3490
+ # session with your internal systems.
3491
+ sig { returns(String) }
3492
+ attr_accessor :client_reference_id
3493
+ # Configure fields for the Checkout Session to gather active consent from customers.
3494
+ sig { returns(::Stripe::Checkout::Session::CreateParams::ConsentCollection) }
3495
+ attr_accessor :consent_collection
3496
+ # 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.
3497
+ sig { returns(String) }
3498
+ attr_accessor :currency
3499
+ # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
3500
+ sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField]) }
3501
+ attr_accessor :custom_fields
3502
+ # Display additional text for your customers using custom text.
3503
+ sig { returns(::Stripe::Checkout::Session::CreateParams::CustomText) }
3504
+ attr_accessor :custom_text
3505
+ # ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card
3506
+ # payment method will be used to prefill the email, name, card details, and billing address
3507
+ # 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)
3508
+ # 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.
3509
+ #
3510
+ # 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.
3511
+ # If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
3512
+ #
3513
+ # 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.
3514
+ #
3515
+ # 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.
3516
+ sig { returns(String) }
3517
+ attr_accessor :customer
3518
+ # Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
3519
+ #
3520
+ # When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
3521
+ # with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).
3522
+ #
3523
+ # Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)
3524
+ # in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
3525
+ #
3526
+ # Can only be set in `payment` and `setup` mode.
3527
+ sig { returns(String) }
3528
+ attr_accessor :customer_creation
3529
+ # If provided, this value will be used when the Customer object is created.
3530
+ # If not provided, customers will be asked to enter their email address.
3531
+ # Use this parameter to prefill customer data if you already have an email
3532
+ # on file. To access information about the customer once a session is
3533
+ # complete, use the `customer` field.
3534
+ sig { returns(String) }
3535
+ attr_accessor :customer_email
3536
+ # Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
3537
+ sig { returns(::Stripe::Checkout::Session::CreateParams::CustomerUpdate) }
3538
+ attr_accessor :customer_update
3539
+ # The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
3540
+ sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::Discount]) }
3541
+ attr_accessor :discounts
3542
+ # Specifies which fields in the response should be expanded.
3543
+ sig { returns(T::Array[String]) }
3544
+ attr_accessor :expand
3545
+ # 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.
3546
+ sig { returns(Integer) }
3547
+ attr_accessor :expires_at
3548
+ # Generate a post-purchase Invoice for one-time payments.
3549
+ sig { returns(::Stripe::Checkout::Session::CreateParams::InvoiceCreation) }
3550
+ attr_accessor :invoice_creation
3551
+ # A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
3552
+ #
3553
+ # 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.
3554
+ #
3555
+ # 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.
3556
+ sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::LineItem]) }
3557
+ attr_accessor :line_items
3558
+ # The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
3559
+ sig { returns(String) }
3560
+ attr_accessor :locale
3561
+ # 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`.
3562
+ sig { returns(T::Hash[String, String]) }
3563
+ attr_accessor :metadata
3564
+ # The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
3565
+ sig { returns(String) }
3566
+ attr_accessor :mode
3567
+ # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
3568
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData) }
3569
+ attr_accessor :payment_intent_data
3570
+ # 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.
3571
+ # This may occur if the Checkout Session includes a free trial or a discount.
3572
+ #
3573
+ # Can only be set in `subscription` mode. Defaults to `always`.
3574
+ #
3575
+ # 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).
3576
+ sig { returns(String) }
3577
+ attr_accessor :payment_method_collection
3578
+ # The ID of the payment method configuration to use with this Checkout session.
3579
+ sig { returns(String) }
3580
+ attr_accessor :payment_method_configuration
3581
+ # This parameter allows you to set some attributes on the payment method created during a Checkout session.
3582
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodData) }
3583
+ attr_accessor :payment_method_data
3584
+ # Payment-method-specific configuration.
3585
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions) }
3586
+ attr_accessor :payment_method_options
3587
+ # A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
3588
+ #
3589
+ # You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
3590
+ # See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.
3591
+ #
3592
+ # Read more about the supported payment methods and their requirements in our [payment
3593
+ # method details guide](/docs/payments/checkout/payment-methods).
3594
+ #
3595
+ # If multiple payment methods are passed, Checkout will dynamically reorder them to
3596
+ # prioritize the most relevant payment methods based on the customer's location and
3597
+ # other characteristics.
3598
+ sig { returns(T::Array[String]) }
3599
+ attr_accessor :payment_method_types
3600
+ # This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
3601
+ #
3602
+ # For specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.
3603
+ sig { returns(::Stripe::Checkout::Session::CreateParams::Permissions) }
3604
+ attr_accessor :permissions
3605
+ # Controls phone number collection settings for the session.
3606
+ #
3607
+ # We recommend that you review your privacy policy and check with your legal contacts
3608
+ # before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).
3609
+ sig { returns(::Stripe::Checkout::Session::CreateParams::PhoneNumberCollection) }
3610
+ attr_accessor :phone_number_collection
3611
+ # 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`.
3612
+ sig { returns(String) }
3613
+ attr_accessor :redirect_on_completion
3614
+ # The URL to redirect your customer back to after they authenticate or cancel their payment on the
3615
+ # payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
3616
+ # and redirect-based payment methods are enabled on the session.
3617
+ sig { returns(String) }
3618
+ attr_accessor :return_url
3619
+ # Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
3620
+ sig { returns(::Stripe::Checkout::Session::CreateParams::SavedPaymentMethodOptions) }
3621
+ attr_accessor :saved_payment_method_options
3622
+ # A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
3623
+ sig { returns(::Stripe::Checkout::Session::CreateParams::SetupIntentData) }
3624
+ attr_accessor :setup_intent_data
3625
+ # When set, provides configuration for Checkout to collect a shipping address from a customer.
3626
+ sig { returns(::Stripe::Checkout::Session::CreateParams::ShippingAddressCollection) }
3627
+ attr_accessor :shipping_address_collection
3628
+ # The shipping rate options to apply to this Session. Up to a maximum of 5.
3629
+ sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::ShippingOption]) }
3630
+ attr_accessor :shipping_options
3631
+ # Describes the type of transaction being performed by Checkout in order to customize
3632
+ # relevant text on the page, such as the submit button. `submit_type` can only be
3633
+ # specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
3634
+ sig { returns(String) }
3635
+ attr_accessor :submit_type
3636
+ # A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
3637
+ sig { returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData) }
3638
+ attr_accessor :subscription_data
3639
+ # The URL to which Stripe should send customers when payment or setup
3640
+ # is complete.
3641
+ # This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
3642
+ # information from the successful Checkout Session on your page, read the
3643
+ # guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
3644
+ sig { returns(String) }
3645
+ attr_accessor :success_url
3646
+ # Controls tax ID collection during checkout.
3647
+ sig { returns(::Stripe::Checkout::Session::CreateParams::TaxIdCollection) }
3648
+ attr_accessor :tax_id_collection
3649
+ # The UI mode of the Session. Defaults to `hosted`.
3650
+ sig { returns(String) }
3651
+ attr_accessor :ui_mode
3652
+ sig {
3653
+ params(adaptive_pricing: ::Stripe::Checkout::Session::CreateParams::AdaptivePricing, after_expiration: ::Stripe::Checkout::Session::CreateParams::AfterExpiration, allow_promotion_codes: T::Boolean, automatic_tax: ::Stripe::Checkout::Session::CreateParams::AutomaticTax, billing_address_collection: String, cancel_url: String, client_reference_id: String, consent_collection: ::Stripe::Checkout::Session::CreateParams::ConsentCollection, currency: String, custom_fields: T::Array[::Stripe::Checkout::Session::CreateParams::CustomField], custom_text: ::Stripe::Checkout::Session::CreateParams::CustomText, customer: String, customer_creation: String, customer_email: String, customer_update: ::Stripe::Checkout::Session::CreateParams::CustomerUpdate, discounts: T::Array[::Stripe::Checkout::Session::CreateParams::Discount], expand: T::Array[String], expires_at: Integer, invoice_creation: ::Stripe::Checkout::Session::CreateParams::InvoiceCreation, line_items: T::Array[::Stripe::Checkout::Session::CreateParams::LineItem], locale: String, metadata: T::Hash[String, String], mode: String, payment_intent_data: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData, payment_method_collection: String, payment_method_configuration: String, payment_method_data: ::Stripe::Checkout::Session::CreateParams::PaymentMethodData, payment_method_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions, payment_method_types: T::Array[String], permissions: ::Stripe::Checkout::Session::CreateParams::Permissions, phone_number_collection: ::Stripe::Checkout::Session::CreateParams::PhoneNumberCollection, redirect_on_completion: String, return_url: String, saved_payment_method_options: ::Stripe::Checkout::Session::CreateParams::SavedPaymentMethodOptions, setup_intent_data: ::Stripe::Checkout::Session::CreateParams::SetupIntentData, shipping_address_collection: ::Stripe::Checkout::Session::CreateParams::ShippingAddressCollection, shipping_options: T::Array[::Stripe::Checkout::Session::CreateParams::ShippingOption], submit_type: String, subscription_data: ::Stripe::Checkout::Session::CreateParams::SubscriptionData, success_url: String, tax_id_collection: ::Stripe::Checkout::Session::CreateParams::TaxIdCollection, ui_mode: String).void
3654
+ }
3655
+ def initialize(
3656
+ adaptive_pricing: nil,
3657
+ after_expiration: nil,
3658
+ allow_promotion_codes: nil,
3659
+ automatic_tax: nil,
3660
+ billing_address_collection: nil,
3661
+ cancel_url: nil,
3662
+ client_reference_id: nil,
3663
+ consent_collection: nil,
3664
+ currency: nil,
3665
+ custom_fields: nil,
3666
+ custom_text: nil,
3667
+ customer: nil,
3668
+ customer_creation: nil,
3669
+ customer_email: nil,
3670
+ customer_update: nil,
3671
+ discounts: nil,
3672
+ expand: nil,
3673
+ expires_at: nil,
3674
+ invoice_creation: nil,
3675
+ line_items: nil,
3676
+ locale: nil,
3677
+ metadata: nil,
3678
+ mode: nil,
3679
+ payment_intent_data: nil,
3680
+ payment_method_collection: nil,
3681
+ payment_method_configuration: nil,
3682
+ payment_method_data: nil,
3683
+ payment_method_options: nil,
3684
+ payment_method_types: nil,
3685
+ permissions: nil,
3686
+ phone_number_collection: nil,
3687
+ redirect_on_completion: nil,
3688
+ return_url: nil,
3689
+ saved_payment_method_options: nil,
3690
+ setup_intent_data: nil,
3691
+ shipping_address_collection: nil,
3692
+ shipping_options: nil,
3693
+ submit_type: nil,
3694
+ subscription_data: nil,
3695
+ success_url: nil,
3696
+ tax_id_collection: nil,
3697
+ ui_mode: nil
3698
+ ); end
3699
+ end
3700
+ class RetrieveParams < Stripe::RequestParams
3701
+ # Specifies which fields in the response should be expanded.
3702
+ sig { returns(T::Array[String]) }
3703
+ attr_accessor :expand
3704
+ sig { params(expand: T::Array[String]).void }
3705
+ def initialize(expand: nil); end
3706
+ end
3707
+ class UpdateParams < Stripe::RequestParams
3708
+ class CollectedInformation < Stripe::RequestParams
3709
+ class ShippingDetails < Stripe::RequestParams
3710
+ class Address < Stripe::RequestParams
3711
+ # City, district, suburb, town, or village.
3712
+ sig { returns(String) }
3713
+ attr_accessor :city
3714
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
3715
+ sig { returns(String) }
3716
+ attr_accessor :country
3717
+ # Address line 1 (e.g., street, PO Box, or company name).
3718
+ sig { returns(String) }
3719
+ attr_accessor :line1
3720
+ # Address line 2 (e.g., apartment, suite, unit, or building).
3721
+ sig { returns(String) }
3722
+ attr_accessor :line2
3723
+ # ZIP or postal code.
3724
+ sig { returns(String) }
3725
+ attr_accessor :postal_code
3726
+ # State, county, province, or region.
3727
+ sig { returns(String) }
3728
+ attr_accessor :state
3729
+ sig {
3730
+ params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
3731
+ }
3732
+ def initialize(
3733
+ city: nil,
3734
+ country: nil,
3735
+ line1: nil,
3736
+ line2: nil,
3737
+ postal_code: nil,
3738
+ state: nil
3739
+ ); end
3740
+ end
3741
+ # The address of the customer
3742
+ sig {
3743
+ returns(::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails::Address)
3744
+ }
3745
+ attr_accessor :address
3746
+ # The name of customer
3747
+ sig { returns(String) }
3748
+ attr_accessor :name
3749
+ sig {
3750
+ params(address: ::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails::Address, name: String).void
3751
+ }
3752
+ def initialize(address: nil, name: nil); end
3753
+ end
3754
+ # The shipping details to apply to this Session.
3755
+ sig {
3756
+ returns(::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails)
3757
+ }
3758
+ attr_accessor :shipping_details
3759
+ sig {
3760
+ params(shipping_details: ::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails).void
3761
+ }
3762
+ def initialize(shipping_details: nil); end
3763
+ end
3764
+ class LineItem < Stripe::RequestParams
3765
+ class AdjustableQuantity < Stripe::RequestParams
3766
+ # Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.
3767
+ sig { returns(T::Boolean) }
3768
+ attr_accessor :enabled
3769
+ # 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.
3770
+ sig { returns(Integer) }
3771
+ attr_accessor :maximum
3772
+ # The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
3773
+ sig { returns(Integer) }
3774
+ attr_accessor :minimum
3775
+ sig { params(enabled: T::Boolean, maximum: Integer, minimum: Integer).void }
3776
+ def initialize(enabled: nil, maximum: nil, minimum: nil); end
3777
+ end
3778
+ # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
3779
+ sig { returns(::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity) }
3780
+ attr_accessor :adjustable_quantity
3781
+ # ID of an existing line item.
3782
+ sig { returns(String) }
3783
+ attr_accessor :id
3784
+ # 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`.
3785
+ sig { returns(T.nilable(T::Hash[String, String])) }
3786
+ attr_accessor :metadata
3787
+ # The ID of the [Price](https://stripe.com/docs/api/prices).
3788
+ sig { returns(String) }
3789
+ attr_accessor :price
3790
+ # The quantity of the line item being purchased.
3791
+ sig { returns(Integer) }
3792
+ attr_accessor :quantity
3793
+ # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
3794
+ sig { returns(T.nilable(T::Array[String])) }
3795
+ attr_accessor :tax_rates
3796
+ sig {
3797
+ params(adjustable_quantity: ::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity, id: String, metadata: T.nilable(T::Hash[String, String]), price: String, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
3798
+ }
3799
+ def initialize(
3800
+ adjustable_quantity: nil,
3801
+ id: nil,
3802
+ metadata: nil,
3803
+ price: nil,
3804
+ quantity: nil,
3805
+ tax_rates: nil
3806
+ ); end
3807
+ end
3808
+ class ShippingOption < Stripe::RequestParams
3809
+ class ShippingRateData < Stripe::RequestParams
3810
+ class DeliveryEstimate < Stripe::RequestParams
3811
+ class Maximum < Stripe::RequestParams
3812
+ # A unit of time.
3813
+ sig { returns(String) }
3814
+ attr_accessor :unit
3815
+ # Must be greater than 0.
3816
+ sig { returns(Integer) }
3817
+ attr_accessor :value
3818
+ sig { params(unit: String, value: Integer).void }
3819
+ def initialize(unit: nil, value: nil); end
3820
+ end
3821
+ class Minimum < Stripe::RequestParams
3822
+ # A unit of time.
3823
+ sig { returns(String) }
3824
+ attr_accessor :unit
3825
+ # Must be greater than 0.
3826
+ sig { returns(Integer) }
3827
+ attr_accessor :value
3828
+ sig { params(unit: String, value: Integer).void }
3829
+ def initialize(unit: nil, value: nil); end
3830
+ end
3831
+ # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
3832
+ sig {
3833
+ returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)
3834
+ }
3835
+ attr_accessor :maximum
3836
+ # The lower bound of the estimated range. If empty, represents no lower bound.
3837
+ sig {
3838
+ returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)
3839
+ }
3840
+ attr_accessor :minimum
3841
+ sig {
3842
+ params(maximum: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum, minimum: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum).void
3843
+ }
3844
+ def initialize(maximum: nil, minimum: nil); end
3845
+ end
3846
+ class FixedAmount < Stripe::RequestParams
3847
+ class CurrencyOptions < Stripe::RequestParams
3848
+ # A non-negative integer in cents representing how much to charge.
3849
+ sig { returns(Integer) }
3850
+ attr_accessor :amount
3851
+ # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
3852
+ sig { returns(String) }
3853
+ attr_accessor :tax_behavior
3854
+ sig { params(amount: Integer, tax_behavior: String).void }
3855
+ def initialize(amount: nil, tax_behavior: nil); end
3856
+ end
3857
+ # A non-negative integer in cents representing how much to charge.
3858
+ sig { returns(Integer) }
3859
+ attr_accessor :amount
3860
+ # 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).
3861
+ sig { returns(String) }
3862
+ attr_accessor :currency
3863
+ # 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).
3864
+ sig {
3865
+ returns(T::Hash[String, ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])
3866
+ }
3867
+ attr_accessor :currency_options
3868
+ sig {
3869
+ params(amount: Integer, currency: String, currency_options: T::Hash[String, ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]).void
3870
+ }
3871
+ def initialize(amount: nil, currency: nil, currency_options: nil); end
3872
+ end
3873
+ # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
3874
+ sig {
3875
+ returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate)
3876
+ }
3877
+ attr_accessor :delivery_estimate
3878
+ # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
3879
+ sig { returns(String) }
3880
+ attr_accessor :display_name
3881
+ # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
3882
+ sig {
3883
+ returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount)
3884
+ }
3885
+ attr_accessor :fixed_amount
3886
+ # 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`.
3887
+ sig { returns(T::Hash[String, String]) }
3888
+ attr_accessor :metadata
3889
+ # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
3890
+ sig { returns(String) }
3891
+ attr_accessor :tax_behavior
3892
+ # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
3893
+ sig { returns(String) }
3894
+ attr_accessor :tax_code
3895
+ # The type of calculation to use on the shipping rate.
3896
+ sig { returns(String) }
3897
+ attr_accessor :type
3898
+ sig {
3899
+ params(delivery_estimate: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate, display_name: String, fixed_amount: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount, metadata: T::Hash[String, String], tax_behavior: String, tax_code: String, type: String).void
3900
+ }
3901
+ def initialize(
3902
+ delivery_estimate: nil,
3903
+ display_name: nil,
3904
+ fixed_amount: nil,
3905
+ metadata: nil,
3906
+ tax_behavior: nil,
3907
+ tax_code: nil,
3908
+ type: nil
3909
+ ); end
3910
+ end
3911
+ # The ID of the Shipping Rate to use for this shipping option.
3912
+ sig { returns(String) }
3913
+ attr_accessor :shipping_rate
3914
+ # Parameters to be passed to Shipping Rate creation for this shipping option.
3915
+ sig {
3916
+ returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData)
3917
+ }
3918
+ attr_accessor :shipping_rate_data
3919
+ sig {
3920
+ params(shipping_rate: String, shipping_rate_data: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData).void
3921
+ }
3922
+ def initialize(shipping_rate: nil, shipping_rate_data: nil); end
3923
+ end
3924
+ # Information about the customer collected within the Checkout Session.
3925
+ sig { returns(::Stripe::Checkout::Session::UpdateParams::CollectedInformation) }
3926
+ attr_accessor :collected_information
3927
+ # Specifies which fields in the response should be expanded.
3928
+ sig { returns(T::Array[String]) }
3929
+ attr_accessor :expand
3930
+ # A list of items the customer is purchasing.
3931
+ #
3932
+ # When updating line items, you must retransmit the entire array of line items.
3933
+ #
3934
+ # To retain an existing line item, specify its `id`.
3935
+ #
3936
+ # To update an existing line item, specify its `id` along with the new values of the fields to update.
3937
+ #
3938
+ # To add a new line item, specify a `price` and `quantity`. We don't currently support recurring prices.
3939
+ #
3940
+ # To remove an existing line item, omit the line item's ID from the retransmitted array.
3941
+ #
3942
+ # To reorder a line item, specify it at the desired position in the retransmitted array.
3943
+ sig { returns(T::Array[::Stripe::Checkout::Session::UpdateParams::LineItem]) }
3944
+ attr_accessor :line_items
3945
+ # 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`.
3946
+ sig { returns(T.nilable(T::Hash[String, String])) }
3947
+ attr_accessor :metadata
3948
+ # The shipping rate options to apply to this Session. Up to a maximum of 5.
3949
+ sig {
3950
+ returns(T.nilable(T::Array[::Stripe::Checkout::Session::UpdateParams::ShippingOption]))
3951
+ }
3952
+ attr_accessor :shipping_options
3953
+ sig {
3954
+ params(collected_information: ::Stripe::Checkout::Session::UpdateParams::CollectedInformation, expand: T::Array[String], line_items: T::Array[::Stripe::Checkout::Session::UpdateParams::LineItem], metadata: T.nilable(T::Hash[String, String]), shipping_options: T.nilable(T::Array[::Stripe::Checkout::Session::UpdateParams::ShippingOption])).void
3955
+ }
3956
+ def initialize(
3957
+ collected_information: nil,
3958
+ expand: nil,
3959
+ line_items: nil,
3960
+ metadata: nil,
3961
+ shipping_options: nil
3962
+ ); end
3963
+ end
3964
+ class ListLineItemsParams < Stripe::RequestParams
3965
+ # 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.
3966
+ sig { returns(String) }
3967
+ attr_accessor :ending_before
3968
+ # Specifies which fields in the response should be expanded.
3969
+ sig { returns(T::Array[String]) }
3970
+ attr_accessor :expand
3971
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
3972
+ sig { returns(Integer) }
3973
+ attr_accessor :limit
3974
+ # 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.
3975
+ sig { returns(String) }
3976
+ attr_accessor :starting_after
3977
+ sig {
3978
+ params(ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String).void
3979
+ }
3980
+ def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
3981
+ end
3982
+ class ExpireParams < Stripe::RequestParams
3983
+ # Specifies which fields in the response should be expanded.
3984
+ sig { returns(T::Array[String]) }
3985
+ attr_accessor :expand
3986
+ sig { params(expand: T::Array[String]).void }
3987
+ def initialize(expand: nil); end
3988
+ end
3989
+ # Creates a Session object.
3990
+ sig {
3991
+ params(params: T.any(::Stripe::Checkout::Session::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
3992
+ }
3993
+ def self.create(params = {}, opts = {}); end
3994
+
3995
+ # A Session can be expired when it is in one of these statuses: open
3996
+ #
3997
+ # After it expires, a customer can't complete a Session and customers loading the Session see a message saying the Session is expired.
3998
+ sig {
3999
+ params(params: T.any(::Stripe::Checkout::Session::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
4000
+ }
4001
+ def expire(params = {}, opts = {}); end
4002
+
4003
+ # A Session can be expired when it is in one of these statuses: open
4004
+ #
4005
+ # After it expires, a customer can't complete a Session and customers loading the Session see a message saying the Session is expired.
4006
+ sig {
4007
+ params(session: String, params: T.any(::Stripe::Checkout::Session::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
4008
+ }
4009
+ def self.expire(session, params = {}, opts = {}); end
4010
+
4011
+ # Returns a list of Checkout Sessions.
4012
+ sig {
4013
+ params(params: T.any(::Stripe::Checkout::Session::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
4014
+ }
4015
+ def self.list(params = {}, opts = {}); end
4016
+
4017
+ # When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
4018
+ sig {
4019
+ params(params: T.any(::Stripe::Checkout::Session::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
4020
+ }
4021
+ def list_line_items(params = {}, opts = {}); end
4022
+
4023
+ # When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
4024
+ sig {
4025
+ params(session: String, params: T.any(::Stripe::Checkout::Session::ListLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
4026
+ }
4027
+ def self.list_line_items(session, params = {}, opts = {}); end
4028
+
4029
+ # Updates a Session object.
4030
+ sig {
4031
+ params(session: String, params: T.any(::Stripe::Checkout::Session::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
4032
+ }
4033
+ def self.update(session, params = {}, opts = {}); end
4034
+ end
4035
+ end
4036
+ end