stripe 13.3.0 → 13.4.0.pre.beta.2

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