stripe 15.5.0.pre.beta.2 → 15.5.0

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