stripe 13.5.0 → 13.6.0.pre.beta.1

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