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