stripe 15.4.0.pre.beta.1 → 15.4.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 (603) hide show
  1. checksums.yaml +4 -4
  2. data/API_VERSION +1 -1
  3. data/CHANGELOG.md +686 -1593
  4. data/OPENAPI_VERSION +1 -1
  5. data/README.md +1 -1
  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/object_types.rb +0 -50
  12. data/lib/stripe/resources/account.rb +6 -658
  13. data/lib/stripe/resources/account_link.rb +3 -1
  14. data/lib/stripe/resources/account_session.rb +52 -256
  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 +1 -11
  18. data/lib/stripe/resources/billing_portal/configuration.rb +46 -2
  19. data/lib/stripe/resources/billing_portal/session.rb +0 -6
  20. data/lib/stripe/resources/card.rb +0 -2
  21. data/lib/stripe/resources/cash_balance.rb +0 -2
  22. data/lib/stripe/resources/charge.rb +7 -1543
  23. data/lib/stripe/resources/checkout/session.rb +24 -320
  24. data/lib/stripe/resources/confirmation_token.rb +3 -173
  25. data/lib/stripe/resources/coupon.rb +1 -30
  26. data/lib/stripe/resources/credit_note.rb +0 -6
  27. data/lib/stripe/resources/credit_note_line_item.rb +0 -9
  28. data/lib/stripe/resources/customer.rb +1 -3
  29. data/lib/stripe/resources/customer_balance_transaction.rb +0 -2
  30. data/lib/stripe/resources/customer_cash_balance_transaction.rb +0 -2
  31. data/lib/stripe/resources/customer_session.rb +1 -6
  32. data/lib/stripe/resources/discount.rb +0 -2
  33. data/lib/stripe/resources/dispute.rb +1 -3
  34. data/lib/stripe/resources/event.rb +14 -57
  35. data/lib/stripe/resources/financial_connections/account.rb +1 -22
  36. data/lib/stripe/resources/financial_connections/session.rb +2 -62
  37. data/lib/stripe/resources/identity/verification_session.rb +0 -10
  38. data/lib/stripe/resources/invoice.rb +40 -1071
  39. data/lib/stripe/resources/invoice_item.rb +3 -79
  40. data/lib/stripe/resources/invoice_line_item.rb +1 -55
  41. data/lib/stripe/resources/invoice_payment.rb +53 -2
  42. data/lib/stripe/resources/issuing/cardholder.rb +1 -2
  43. data/lib/stripe/resources/issuing/transaction.rb +0 -6
  44. data/lib/stripe/resources/line_item.rb +0 -37
  45. data/lib/stripe/resources/mandate.rb +0 -24
  46. data/lib/stripe/resources/payment_intent.rb +297 -5243
  47. data/lib/stripe/resources/payment_link.rb +83 -5
  48. data/lib/stripe/resources/payment_method.rb +5 -196
  49. data/lib/stripe/resources/payment_method_configuration.rb +0 -295
  50. data/lib/stripe/resources/payout.rb +0 -6
  51. data/lib/stripe/resources/price.rb +0 -30
  52. data/lib/stripe/resources/promotion_code.rb +0 -10
  53. data/lib/stripe/resources/quote.rb +8 -2039
  54. data/lib/stripe/resources/radar/value_list.rb +2 -2
  55. data/lib/stripe/resources/refund.rb +1 -10
  56. data/lib/stripe/resources/review.rb +2 -2
  57. data/lib/stripe/resources/setup_attempt.rb +1 -22
  58. data/lib/stripe/resources/setup_intent.rb +9 -578
  59. data/lib/stripe/resources/source.rb +0 -29
  60. data/lib/stripe/resources/subscription.rb +11 -290
  61. data/lib/stripe/resources/subscription_item.rb +5 -86
  62. data/lib/stripe/resources/subscription_schedule.rb +45 -1010
  63. data/lib/stripe/resources/tax/registration.rb +408 -30
  64. data/lib/stripe/resources/tax_id.rb +2 -12
  65. data/lib/stripe/resources/terminal/configuration.rb +196 -0
  66. data/lib/stripe/resources/terminal/reader.rb +0 -8
  67. data/lib/stripe/resources/transfer.rb +0 -6
  68. data/lib/stripe/resources/treasury/financial_account.rb +3 -22
  69. data/lib/stripe/resources/treasury/financial_account_features.rb +0 -2
  70. data/lib/stripe/resources/treasury/outbound_transfer.rb +0 -37
  71. data/lib/stripe/resources/treasury/received_credit.rb +1 -38
  72. data/lib/stripe/resources/treasury/received_debit.rb +1 -40
  73. data/lib/stripe/resources.rb +0 -104
  74. data/lib/stripe/services/account_link_service.rb +3 -1
  75. data/lib/stripe/services/account_service.rb +4 -565
  76. data/lib/stripe/services/account_session_service.rb +35 -226
  77. data/lib/stripe/services/billing/credit_balance_summary_service.rb +1 -4
  78. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -4
  79. data/lib/stripe/services/billing/credit_grant_service.rb +1 -9
  80. data/lib/stripe/services/billing_portal/configuration_service.rb +36 -2
  81. data/lib/stripe/services/billing_portal/session_service.rb +0 -4
  82. data/lib/stripe/services/charge_service.rb +0 -1418
  83. data/lib/stripe/services/checkout/session_service.rb +16 -241
  84. data/lib/stripe/services/coupon_service.rb +1 -17
  85. data/lib/stripe/services/credit_note_service.rb +0 -4
  86. data/lib/stripe/services/customer_session_service.rb +1 -4
  87. data/lib/stripe/services/financial_connections/account_service.rb +2 -7
  88. data/lib/stripe/services/financial_connections/session_service.rb +2 -34
  89. data/lib/stripe/services/financial_connections_service.rb +1 -2
  90. data/lib/stripe/services/identity/verification_session_service.rb +0 -8
  91. data/lib/stripe/services/invoice_item_service.rb +3 -75
  92. data/lib/stripe/services/invoice_line_item_service.rb +1 -33
  93. data/lib/stripe/services/invoice_payment_service.rb +83 -0
  94. data/lib/stripe/services/invoice_service.rb +40 -1022
  95. data/lib/stripe/services/issuing/cardholder_service.rb +1 -2
  96. data/lib/stripe/services/issuing/transaction_service.rb +0 -4
  97. data/lib/stripe/services/issuing_service.rb +1 -5
  98. data/lib/stripe/services/payment_intent_service.rb +399 -4882
  99. data/lib/stripe/services/payment_link_service.rb +81 -5
  100. data/lib/stripe/services/payment_method_configuration_service.rb +0 -210
  101. data/lib/stripe/services/payment_method_service.rb +2 -121
  102. data/lib/stripe/services/payout_service.rb +0 -4
  103. data/lib/stripe/services/price_service.rb +0 -19
  104. data/lib/stripe/services/promotion_code_service.rb +0 -8
  105. data/lib/stripe/services/quote_service.rb +9 -1724
  106. data/lib/stripe/services/radar/value_list_service.rb +1 -1
  107. data/lib/stripe/services/setup_intent_service.rb +9 -538
  108. data/lib/stripe/services/subscription_item_service.rb +5 -77
  109. data/lib/stripe/services/subscription_schedule_service.rb +45 -914
  110. data/lib/stripe/services/subscription_service.rb +11 -251
  111. data/lib/stripe/services/tax/registration_service.rb +360 -30
  112. data/lib/stripe/services/tax_id_service.rb +2 -8
  113. data/lib/stripe/services/tax_service.rb +1 -3
  114. data/lib/stripe/services/terminal/configuration_service.rb +152 -0
  115. data/lib/stripe/services/terminal_service.rb +1 -2
  116. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +0 -97
  117. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +1 -25
  118. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +1 -25
  119. data/lib/stripe/services/transfer_service.rb +0 -4
  120. data/lib/stripe/services/treasury/financial_account_features_service.rb +1 -4
  121. data/lib/stripe/services/treasury/financial_account_service.rb +2 -16
  122. data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -24
  123. data/lib/stripe/services/v1_services.rb +2 -11
  124. data/lib/stripe/services/v2/core_service.rb +1 -4
  125. data/lib/stripe/services/v2_services.rb +1 -4
  126. data/lib/stripe/services.rb +1 -53
  127. data/lib/stripe/stripe_configuration.rb +1 -3
  128. data/lib/stripe/stripe_object.rb +1 -1
  129. data/lib/stripe/util.rb +1 -7
  130. data/lib/stripe/version.rb +1 -1
  131. data/lib/stripe.rb +0 -53
  132. data/rbi/stripe/resources/account.rbi +4995 -0
  133. data/rbi/stripe/resources/account_link.rbi +76 -0
  134. data/rbi/stripe/resources/account_session.rbi +1074 -0
  135. data/rbi/stripe/resources/apple_pay_domain.rbi +88 -0
  136. data/rbi/stripe/resources/application.rbi +20 -0
  137. data/rbi/stripe/resources/application_fee.rbi +118 -0
  138. data/rbi/stripe/resources/application_fee_refund.rbi +37 -0
  139. data/rbi/stripe/resources/apps/secret.rbi +195 -0
  140. data/rbi/stripe/resources/balance.rbi +235 -0
  141. data/rbi/stripe/resources/balance_transaction.rbi +147 -0
  142. data/rbi/stripe/resources/bank_account.rbi +127 -0
  143. data/rbi/stripe/resources/billing/alert.rbi +201 -0
  144. data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
  145. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +63 -0
  146. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +147 -0
  147. data/rbi/stripe/resources/billing/credit_grant.rbi +291 -0
  148. data/rbi/stripe/resources/billing/meter.rbi +226 -0
  149. data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
  150. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
  151. data/rbi/stripe/resources/billing/meter_event_summary.rbi +35 -0
  152. data/rbi/stripe/resources/billing_portal/configuration.rbi +703 -0
  153. data/rbi/stripe/resources/billing_portal/session.rbi +345 -0
  154. data/rbi/stripe/resources/capability.rbi +125 -0
  155. data/rbi/stripe/resources/card.rbi +125 -0
  156. data/rbi/stripe/resources/cash_balance.rbi +32 -0
  157. data/rbi/stripe/resources/charge.rbi +2089 -0
  158. data/rbi/stripe/resources/checkout/session.rbi +4095 -0
  159. data/rbi/stripe/resources/climate/order.rbi +245 -0
  160. data/rbi/stripe/resources/climate/product.rbi +75 -0
  161. data/rbi/stripe/resources/climate/supplier.rbi +72 -0
  162. data/rbi/stripe/resources/confirmation_token.rbi +1818 -0
  163. data/rbi/stripe/resources/connect_collection_transfer.rbi +26 -0
  164. data/rbi/stripe/resources/country_spec.rbi +85 -0
  165. data/rbi/stripe/resources/coupon.rbi +250 -0
  166. data/rbi/stripe/resources/credit_note.rbi +752 -0
  167. data/rbi/stripe/resources/credit_note_line_item.rbi +101 -0
  168. data/rbi/stripe/resources/customer.rbi +1005 -0
  169. data/rbi/stripe/resources/customer_balance_transaction.rbi +56 -0
  170. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
  171. data/rbi/stripe/resources/customer_session.rbi +200 -0
  172. data/rbi/stripe/resources/discount.rbi +53 -0
  173. data/rbi/stripe/resources/dispute.rbi +761 -0
  174. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +58 -0
  175. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
  176. data/rbi/stripe/resources/entitlements/feature.rbi +117 -0
  177. data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
  178. data/rbi/stripe/resources/event.rbi +137 -0
  179. data/rbi/stripe/resources/exchange_rate.rbi +66 -0
  180. data/rbi/stripe/resources/file.rbi +143 -0
  181. data/rbi/stripe/resources/file_link.rbi +141 -0
  182. data/rbi/stripe/resources/financial_connections/account.rbi +339 -0
  183. data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
  184. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
  185. data/rbi/stripe/resources/financial_connections/session.rbi +123 -0
  186. data/rbi/stripe/resources/financial_connections/transaction.rbi +124 -0
  187. data/rbi/stripe/resources/forwarding/request.rbi +216 -0
  188. data/rbi/stripe/resources/funding_instructions.rbi +437 -0
  189. data/rbi/stripe/resources/identity/verification_report.rbi +360 -0
  190. data/rbi/stripe/resources/identity/verification_session.rbi +564 -0
  191. data/rbi/stripe/resources/invoice.rbi +3858 -0
  192. data/rbi/stripe/resources/invoice_item.rbi +470 -0
  193. data/rbi/stripe/resources/invoice_line_item.rbi +432 -0
  194. data/rbi/stripe/resources/invoice_payment.rbi +121 -0
  195. data/rbi/stripe/resources/invoice_rendering_template.rbi +104 -0
  196. data/rbi/stripe/resources/issuing/authorization.rbi +1283 -0
  197. data/rbi/stripe/resources/issuing/card.rbi +741 -0
  198. data/rbi/stripe/resources/issuing/cardholder.rbi +744 -0
  199. data/rbi/stripe/resources/issuing/dispute.rbi +913 -0
  200. data/rbi/stripe/resources/issuing/personalization_design.rbi +338 -0
  201. data/rbi/stripe/resources/issuing/physical_bundle.rbi +79 -0
  202. data/rbi/stripe/resources/issuing/token.rbi +226 -0
  203. data/rbi/stripe/resources/issuing/transaction.rbi +1061 -0
  204. data/rbi/stripe/resources/line_item.rbi +72 -0
  205. data/rbi/stripe/resources/login_link.rbi +19 -0
  206. data/rbi/stripe/resources/mandate.rbi +191 -0
  207. data/rbi/stripe/resources/payment_intent.rbi +9997 -0
  208. data/rbi/stripe/resources/payment_link.rbi +1893 -0
  209. data/rbi/stripe/resources/payment_method.rbi +1770 -0
  210. data/rbi/stripe/resources/payment_method_configuration.rbi +3550 -0
  211. data/rbi/stripe/resources/payment_method_domain.rbi +228 -0
  212. data/rbi/stripe/resources/payout.rbi +300 -0
  213. data/rbi/stripe/resources/person.rbi +401 -0
  214. data/rbi/stripe/resources/plan.rbi +371 -0
  215. data/rbi/stripe/resources/price.rbi +694 -0
  216. data/rbi/stripe/resources/product.rbi +555 -0
  217. data/rbi/stripe/resources/product_feature.rbi +26 -0
  218. data/rbi/stripe/resources/promotion_code.rbi +261 -0
  219. data/rbi/stripe/resources/quote.rbi +1145 -0
  220. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +98 -0
  221. data/rbi/stripe/resources/radar/value_list.rbi +168 -0
  222. data/rbi/stripe/resources/radar/value_list_item.rbi +129 -0
  223. data/rbi/stripe/resources/refund.rbi +523 -0
  224. data/rbi/stripe/resources/reporting/report_run.rbi +191 -0
  225. data/rbi/stripe/resources/reporting/report_type.rbi +57 -0
  226. data/rbi/stripe/resources/reserve_transaction.rbi +23 -0
  227. data/rbi/stripe/resources/reversal.rbi +51 -0
  228. data/rbi/stripe/resources/review.rbi +154 -0
  229. data/rbi/stripe/resources/setup_attempt.rbi +477 -0
  230. data/rbi/stripe/resources/setup_intent.rbi +3978 -0
  231. data/rbi/stripe/resources/shipping_rate.rbi +305 -0
  232. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +75 -0
  233. data/rbi/stripe/resources/source.rbi +1496 -0
  234. data/rbi/stripe/resources/source_mandate_notification.rbi +77 -0
  235. data/rbi/stripe/resources/source_transaction.rbi +127 -0
  236. data/rbi/stripe/resources/subscription.rbi +2080 -0
  237. data/rbi/stripe/resources/subscription_item.rbi +404 -0
  238. data/rbi/stripe/resources/subscription_schedule.rbi +1673 -0
  239. data/rbi/stripe/resources/tax/calculation.rbi +478 -0
  240. data/rbi/stripe/resources/tax/calculation_line_item.rbi +91 -0
  241. data/rbi/stripe/resources/tax/registration.rbi +3216 -0
  242. data/rbi/stripe/resources/tax/settings.rbi +141 -0
  243. data/rbi/stripe/resources/tax/transaction.rbi +351 -0
  244. data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
  245. data/rbi/stripe/resources/tax_code.rbi +44 -0
  246. data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
  247. data/rbi/stripe/resources/tax_id.rbi +165 -0
  248. data/rbi/stripe/resources/tax_rate.rbi +239 -0
  249. data/rbi/stripe/resources/terminal/configuration.rbi +1595 -0
  250. data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
  251. data/rbi/stripe/resources/terminal/location.rbi +222 -0
  252. data/rbi/stripe/resources/terminal/reader.rbi +994 -0
  253. data/rbi/stripe/resources/test_helpers/test_clock.rbi +132 -0
  254. data/rbi/stripe/resources/token.rbi +1283 -0
  255. data/rbi/stripe/resources/topup.rbi +222 -0
  256. data/rbi/stripe/resources/transfer.rbi +199 -0
  257. data/rbi/stripe/resources/treasury/credit_reversal.rbi +119 -0
  258. data/rbi/stripe/resources/treasury/debit_reversal.rbi +131 -0
  259. data/rbi/stripe/resources/treasury/financial_account.rbi +869 -0
  260. data/rbi/stripe/resources/treasury/financial_account_features.rbi +260 -0
  261. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +295 -0
  262. data/rbi/stripe/resources/treasury/outbound_payment.rbi +592 -0
  263. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +431 -0
  264. data/rbi/stripe/resources/treasury/received_credit.rbi +302 -0
  265. data/rbi/stripe/resources/treasury/received_debit.rbi +256 -0
  266. data/rbi/stripe/resources/treasury/transaction.rbi +215 -0
  267. data/rbi/stripe/resources/treasury/transaction_entry.rbi +192 -0
  268. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  269. data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
  270. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
  271. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
  272. data/rbi/stripe/resources/v2/event.rbi +48 -0
  273. data/rbi/stripe/resources/v2/event_destination.rbi +91 -0
  274. data/rbi/stripe/resources/webhook_endpoint.rbi +168 -0
  275. data/rbi/stripe/services/account_capability_service.rbi +51 -0
  276. data/{lib/stripe/services/external_account_service.rb → rbi/stripe/services/account_external_account_service.rbi} +122 -135
  277. data/rbi/stripe/services/account_link_service.rbi +60 -0
  278. data/rbi/stripe/services/account_login_link_service.rbi +22 -0
  279. data/rbi/stripe/services/account_person_service.rbi +1011 -0
  280. data/rbi/stripe/services/account_service.rbi +4281 -0
  281. data/rbi/stripe/services/account_session_service.rbi +685 -0
  282. data/rbi/stripe/services/apple_pay_domain_service.rbi +76 -0
  283. data/rbi/stripe/services/application_fee_refund_service.rbi +93 -0
  284. data/rbi/stripe/services/application_fee_service.rbi +78 -0
  285. data/rbi/stripe/services/apps/secret_service.rbi +151 -0
  286. data/rbi/stripe/services/apps_service.rbi +9 -0
  287. data/rbi/stripe/services/balance_service.rbi +21 -0
  288. data/rbi/stripe/services/balance_transaction_service.rbi +93 -0
  289. data/rbi/stripe/services/billing/alert_service.rbi +152 -0
  290. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +68 -0
  291. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
  292. data/rbi/stripe/services/billing/credit_grant_service.rbi +211 -0
  293. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +42 -0
  294. data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
  295. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
  296. data/rbi/stripe/services/billing/meter_service.rbi +163 -0
  297. data/rbi/stripe/services/billing_portal/configuration_service.rbi +555 -0
  298. data/rbi/stripe/services/billing_portal/session_service.rbi +204 -0
  299. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  300. data/rbi/stripe/services/billing_service.rbi +15 -0
  301. data/rbi/stripe/services/charge_service.rbi +448 -0
  302. data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
  303. data/rbi/stripe/services/checkout/session_service.rbi +2690 -0
  304. data/rbi/stripe/services/checkout_service.rbi +9 -0
  305. data/rbi/stripe/services/climate/order_service.rbi +142 -0
  306. data/rbi/stripe/services/climate/product_service.rbi +46 -0
  307. data/{lib/stripe/services/financial_connections/institution_service.rb → rbi/stripe/services/climate/supplier_service.rbi} +25 -36
  308. data/rbi/stripe/services/climate_service.rbi +11 -0
  309. data/rbi/stripe/services/confirmation_token_service.rbi +20 -0
  310. data/rbi/stripe/services/country_spec_service.rbi +44 -0
  311. data/rbi/stripe/services/coupon_service.rbi +194 -0
  312. data/{lib/stripe/services/quote_preview_invoice_service.rb → rbi/stripe/services/credit_note_line_item_service.rbi} +16 -20
  313. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +167 -0
  314. data/rbi/stripe/services/credit_note_service.rbi +415 -0
  315. data/rbi/stripe/services/customer_balance_transaction_service.rbi +92 -0
  316. data/rbi/stripe/services/customer_cash_balance_service.rbi +45 -0
  317. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +44 -0
  318. data/rbi/stripe/services/customer_funding_instructions_service.rbi +59 -0
  319. data/rbi/stripe/services/customer_payment_method_service.rbi +57 -0
  320. data/rbi/stripe/services/customer_payment_source_service.rbi +232 -0
  321. data/rbi/stripe/services/customer_service.rbi +647 -0
  322. data/rbi/stripe/services/customer_session_service.rbi +116 -0
  323. data/rbi/stripe/services/customer_tax_id_service.rbi +70 -0
  324. data/rbi/stripe/services/dispute_service.rbi +424 -0
  325. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
  326. data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
  327. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  328. data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
  329. data/rbi/stripe/services/event_service.rbi +83 -0
  330. data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
  331. data/rbi/stripe/services/file_link_service.rbi +124 -0
  332. data/rbi/stripe/services/file_service.rbi +116 -0
  333. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
  334. data/rbi/stripe/services/financial_connections/account_service.rbi +133 -0
  335. data/rbi/stripe/services/financial_connections/session_service.rbi +88 -0
  336. data/rbi/stripe/services/financial_connections/transaction_service.rbi +92 -0
  337. data/rbi/stripe/services/financial_connections_service.rbi +11 -0
  338. data/rbi/stripe/services/forwarding/request_service.rbi +134 -0
  339. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  340. data/rbi/stripe/services/identity/verification_report_service.rbi +87 -0
  341. data/rbi/stripe/services/identity/verification_session_service.rbi +339 -0
  342. data/rbi/stripe/services/identity_service.rbi +10 -0
  343. data/rbi/stripe/services/invoice_item_service.rbi +366 -0
  344. data/rbi/stripe/services/invoice_line_item_service.rbi +259 -0
  345. data/rbi/stripe/services/invoice_payment_service.rbi +71 -0
  346. data/rbi/stripe/services/invoice_rendering_template_service.rbi +82 -0
  347. data/rbi/stripe/services/invoice_service.rbi +3027 -0
  348. data/rbi/stripe/services/issuing/authorization_service.rbi +146 -0
  349. data/rbi/stripe/services/issuing/card_service.rbi +495 -0
  350. data/rbi/stripe/services/issuing/cardholder_service.rbi +587 -0
  351. data/rbi/stripe/services/issuing/dispute_service.rbi +707 -0
  352. data/rbi/stripe/services/issuing/personalization_design_service.rbi +243 -0
  353. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
  354. data/rbi/stripe/services/issuing/token_service.rbi +99 -0
  355. data/rbi/stripe/services/issuing/transaction_service.rbi +105 -0
  356. data/rbi/stripe/services/issuing_service.rbi +16 -0
  357. data/rbi/stripe/services/mandate_service.rbi +20 -0
  358. data/rbi/stripe/services/payment_intent_service.rbi +7994 -0
  359. data/{lib/stripe/services/payment_intent_amount_details_line_item_service.rb → rbi/stripe/services/payment_link_line_item_service.rbi} +16 -20
  360. data/rbi/stripe/services/payment_link_service.rbi +1441 -0
  361. data/rbi/stripe/services/payment_method_configuration_service.rbi +2487 -0
  362. data/rbi/stripe/services/payment_method_domain_service.rbi +112 -0
  363. data/rbi/stripe/services/payment_method_service.rbi +781 -0
  364. data/rbi/stripe/services/payout_service.rbi +205 -0
  365. data/rbi/stripe/services/plan_service.rbi +282 -0
  366. data/rbi/stripe/services/price_service.rbi +546 -0
  367. data/rbi/stripe/services/product_feature_service.rbi +67 -0
  368. data/rbi/stripe/services/product_service.rbi +477 -0
  369. data/rbi/stripe/services/promotion_code_service.rbi +214 -0
  370. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
  371. data/{lib/stripe/services/order_line_item_service.rb → rbi/stripe/services/quote_line_item_service.rbi} +16 -20
  372. data/rbi/stripe/services/quote_service.rbi +699 -0
  373. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +85 -0
  374. data/rbi/stripe/services/radar/value_list_item_service.rbi +109 -0
  375. data/rbi/stripe/services/radar/value_list_service.rbi +141 -0
  376. data/rbi/stripe/services/radar_service.rbi +11 -0
  377. data/rbi/stripe/services/refund_service.rbi +185 -0
  378. data/rbi/stripe/services/reporting/report_run_service.rbi +135 -0
  379. data/rbi/stripe/services/reporting/report_type_service.rbi +35 -0
  380. data/rbi/stripe/services/reporting_service.rbi +10 -0
  381. data/rbi/stripe/services/review_service.rbi +84 -0
  382. data/rbi/stripe/services/setup_attempt_service.rbi +65 -0
  383. data/rbi/stripe/services/setup_intent_service.rbi +3709 -0
  384. data/rbi/stripe/services/shipping_rate_service.rbi +241 -0
  385. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +46 -0
  386. data/rbi/stripe/services/sigma_service.rbi +9 -0
  387. data/rbi/stripe/services/source_service.rbi +663 -0
  388. data/{lib/stripe/services/quote_line_service.rb → rbi/stripe/services/source_transaction_service.rbi} +16 -20
  389. data/rbi/stripe/services/subscription_item_service.rbi +350 -0
  390. data/rbi/stripe/services/subscription_schedule_service.rbi +1333 -0
  391. data/rbi/stripe/services/subscription_service.rbi +1684 -0
  392. data/{lib/stripe/services/financial_connections/account_inferred_balance_service.rb → rbi/stripe/services/tax/calculation_line_item_service.rbi} +17 -21
  393. data/rbi/stripe/services/tax/calculation_service.rbi +234 -0
  394. data/rbi/stripe/services/tax/registration_service.rbi +2278 -0
  395. data/rbi/stripe/services/tax/settings_service.rbi +93 -0
  396. data/{lib/stripe/services/privacy/redaction_job_validation_error_service.rb → rbi/stripe/services/tax/transaction_line_item_service.rbi} +17 -21
  397. data/rbi/stripe/services/tax/transaction_service.rbi +146 -0
  398. data/rbi/stripe/services/tax_code_service.rbi +44 -0
  399. data/rbi/stripe/services/tax_id_service.rbi +110 -0
  400. data/rbi/stripe/services/tax_rate_service.rbi +185 -0
  401. data/rbi/stripe/services/tax_service.rbi +12 -0
  402. data/rbi/stripe/services/terminal/configuration_service.rbi +1286 -0
  403. data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
  404. data/rbi/stripe/services/terminal/location_service.rbi +182 -0
  405. data/rbi/stripe/services/terminal/reader_service.rbi +540 -0
  406. data/rbi/stripe/services/terminal_service.rbi +12 -0
  407. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +746 -0
  408. data/rbi/stripe/services/test_helpers/customer_service.rbi +33 -0
  409. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +848 -0
  410. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +76 -0
  411. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +69 -0
  412. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +711 -0
  413. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  414. data/rbi/stripe/services/test_helpers/refund_service.rbi +22 -0
  415. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +93 -0
  416. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  417. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +90 -0
  418. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
  419. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +125 -0
  420. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +125 -0
  421. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +87 -0
  422. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +87 -0
  423. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  424. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  425. data/rbi/stripe/services/token_service.rbi +1257 -0
  426. data/rbi/stripe/services/topup_service.rbi +176 -0
  427. data/rbi/stripe/services/transfer_reversal_service.rbi +101 -0
  428. data/rbi/stripe/services/transfer_service.rbi +152 -0
  429. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
  430. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
  431. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +198 -0
  432. data/rbi/stripe/services/treasury/financial_account_service.rbi +566 -0
  433. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
  434. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +304 -0
  435. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +157 -0
  436. data/rbi/stripe/services/treasury/received_credit_service.rbi +72 -0
  437. data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
  438. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +111 -0
  439. data/rbi/stripe/services/treasury/transaction_service.rbi +122 -0
  440. data/rbi/stripe/services/treasury_service.rbi +18 -0
  441. data/rbi/stripe/services/v1_services.rbi +77 -0
  442. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
  443. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
  444. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +18 -0
  445. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +55 -0
  446. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  447. data/rbi/stripe/services/v2/core/event_destination_service.rbi +192 -0
  448. data/rbi/stripe/services/v2/core/event_service.rbi +36 -0
  449. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  450. data/rbi/stripe/services/v2_services.rbi +10 -0
  451. data/rbi/stripe/services/webhook_endpoint_service.rbi +129 -0
  452. data/stripe.gemspec +1 -4
  453. metadata +325 -162
  454. data/lib/stripe/events/v2_core_account_closed_event.rb +0 -21
  455. data/lib/stripe/events/v2_core_account_created_event.rb +0 -21
  456. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +0 -23
  457. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +0 -21
  458. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +0 -23
  459. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +0 -21
  460. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +0 -23
  461. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +0 -21
  462. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +0 -21
  463. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +0 -21
  464. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +0 -21
  465. data/lib/stripe/events/v2_core_account_link_completed_event.rb +0 -13
  466. data/lib/stripe/events/v2_core_account_person_created_event.rb +0 -23
  467. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +0 -23
  468. data/lib/stripe/events/v2_core_account_person_updated_event.rb +0 -23
  469. data/lib/stripe/events/v2_core_account_updated_event.rb +0 -21
  470. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +0 -21
  471. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +0 -21
  472. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +0 -21
  473. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +0 -21
  474. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +0 -21
  475. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +0 -23
  476. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +0 -21
  477. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +0 -21
  478. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +0 -21
  479. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +0 -21
  480. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +0 -21
  481. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +0 -21
  482. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +0 -21
  483. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +0 -21
  484. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +0 -21
  485. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +0 -21
  486. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +0 -21
  487. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +0 -21
  488. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +0 -21
  489. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +0 -21
  490. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +0 -21
  491. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +0 -21
  492. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +0 -21
  493. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +0 -23
  494. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +0 -21
  495. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +0 -21
  496. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +0 -21
  497. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +0 -21
  498. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +0 -21
  499. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +0 -21
  500. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +0 -21
  501. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +0 -21
  502. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +0 -21
  503. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +0 -21
  504. data/lib/stripe/events/v2_off_session_payment_requires_capture_event.rb +0 -21
  505. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +0 -21
  506. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +0 -21
  507. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +0 -21
  508. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +0 -21
  509. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +0 -21
  510. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +0 -21
  511. data/lib/stripe/resources/account_notice.rb +0 -123
  512. data/lib/stripe/resources/balance_settings.rb +0 -105
  513. data/lib/stripe/resources/capital/financing_offer.rb +0 -179
  514. data/lib/stripe/resources/capital/financing_summary.rb +0 -55
  515. data/lib/stripe/resources/capital/financing_transaction.rb +0 -114
  516. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
  517. data/lib/stripe/resources/financial_connections/institution.rb +0 -92
  518. data/lib/stripe/resources/fx_quote.rb +0 -184
  519. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -602
  520. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -82
  521. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -86
  522. data/lib/stripe/resources/issuing/settlement.rb +0 -53
  523. data/lib/stripe/resources/margin.rb +0 -115
  524. data/lib/stripe/resources/order.rb +0 -2958
  525. data/lib/stripe/resources/payment_attempt_record.rb +0 -1099
  526. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +0 -72
  527. data/lib/stripe/resources/payment_record.rb +0 -1628
  528. data/lib/stripe/resources/privacy/redaction_job.rb +0 -298
  529. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +0 -33
  530. data/lib/stripe/resources/quote_line.rb +0 -274
  531. data/lib/stripe/resources/quote_preview_invoice.rb +0 -663
  532. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -371
  533. data/lib/stripe/resources/tax/association.rb +0 -66
  534. data/lib/stripe/resources/tax/form.rb +0 -211
  535. data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -31
  536. data/lib/stripe/resources/v2/core/account.rb +0 -1755
  537. data/lib/stripe/resources/v2/core/account_link.rb +0 -56
  538. data/lib/stripe/resources/v2/core/person.rb +0 -276
  539. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +0 -74
  540. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +0 -39
  541. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +0 -20
  542. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +0 -22
  543. data/lib/stripe/resources/v2/money_management/adjustment.rb +0 -51
  544. data/lib/stripe/resources/v2/money_management/financial_account.rb +0 -58
  545. data/lib/stripe/resources/v2/money_management/financial_address.rb +0 -68
  546. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +0 -94
  547. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +0 -129
  548. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +0 -82
  549. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +0 -45
  550. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +0 -117
  551. data/lib/stripe/resources/v2/money_management/payout_method.rb +0 -75
  552. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +0 -49
  553. data/lib/stripe/resources/v2/money_management/received_credit.rb +0 -122
  554. data/lib/stripe/resources/v2/money_management/received_debit.rb +0 -84
  555. data/lib/stripe/resources/v2/money_management/transaction.rb +0 -78
  556. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +0 -68
  557. data/lib/stripe/resources/v2/payments/off_session_payment.rb +0 -72
  558. data/lib/stripe/services/account_notice_service.rb +0 -101
  559. data/lib/stripe/services/balance_settings_service.rb +0 -96
  560. data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
  561. data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
  562. data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
  563. data/lib/stripe/services/capital_service.rb +0 -15
  564. data/lib/stripe/services/fx_quote_service.rb +0 -123
  565. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
  566. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
  567. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
  568. data/lib/stripe/services/margin_service.rb +0 -119
  569. data/lib/stripe/services/order_service.rb +0 -2388
  570. data/lib/stripe/services/payment_attempt_record_service.rb +0 -49
  571. data/lib/stripe/services/payment_record_service.rb +0 -542
  572. data/lib/stripe/services/privacy/redaction_job_service.rb +0 -240
  573. data/lib/stripe/services/privacy_service.rb +0 -13
  574. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -35
  575. data/lib/stripe/services/tax/association_service.rb +0 -31
  576. data/lib/stripe/services/tax/form_service.rb +0 -100
  577. data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
  578. data/lib/stripe/services/v2/core/account_link_service.rb +0 -76
  579. data/lib/stripe/services/v2/core/account_service.rb +0 -4170
  580. data/lib/stripe/services/v2/core/accounts/person_service.rb +0 -1045
  581. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +0 -130
  582. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +0 -107
  583. data/lib/stripe/services/v2/core/vault_service.rb +0 -18
  584. data/lib/stripe/services/v2/money_management/adjustment_service.rb +0 -74
  585. data/lib/stripe/services/v2/money_management/financial_account_service.rb +0 -43
  586. data/lib/stripe/services/v2/money_management/financial_address_service.rb +0 -82
  587. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +0 -125
  588. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +0 -95
  589. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +0 -199
  590. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +0 -235
  591. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +0 -172
  592. data/lib/stripe/services/v2/money_management/payout_method_service.rb +0 -90
  593. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +0 -32
  594. data/lib/stripe/services/v2/money_management/received_credit_service.rb +0 -70
  595. data/lib/stripe/services/v2/money_management/received_debit_service.rb +0 -43
  596. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +0 -69
  597. data/lib/stripe/services/v2/money_management/transaction_service.rb +0 -73
  598. data/lib/stripe/services/v2/money_management_service.rb +0 -31
  599. data/lib/stripe/services/v2/payment_service.rb +0 -15
  600. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +0 -137
  601. data/lib/stripe/services/v2/test_helper_service.rb +0 -15
  602. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +0 -49
  603. data/rbi/stripe.rbi +0 -193855
@@ -0,0 +1,2690 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # typed: true
5
+ module Stripe
6
+ module Checkout
7
+ class SessionService < StripeService
8
+ attr_reader :line_items
9
+ class ListParams < Stripe::RequestParams
10
+ class Created < Stripe::RequestParams
11
+ # Minimum value to filter by (exclusive)
12
+ sig { returns(T.nilable(Integer)) }
13
+ attr_accessor :gt
14
+ # Minimum value to filter by (inclusive)
15
+ sig { returns(T.nilable(Integer)) }
16
+ attr_accessor :gte
17
+ # Maximum value to filter by (exclusive)
18
+ sig { returns(T.nilable(Integer)) }
19
+ attr_accessor :lt
20
+ # Maximum value to filter by (inclusive)
21
+ sig { returns(T.nilable(Integer)) }
22
+ attr_accessor :lte
23
+ sig {
24
+ params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
25
+ }
26
+ def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
27
+ end
28
+ class CustomerDetails < Stripe::RequestParams
29
+ # Customer's email address.
30
+ sig { returns(String) }
31
+ attr_accessor :email
32
+ sig { params(email: String).void }
33
+ def initialize(email: nil); end
34
+ end
35
+ # Only return Checkout Sessions that were created during the given date interval.
36
+ sig {
37
+ returns(T.nilable(T.any(::Stripe::Checkout::SessionService::ListParams::Created, Integer)))
38
+ }
39
+ attr_accessor :created
40
+ # Only return the Checkout Sessions for the Customer specified.
41
+ sig { returns(T.nilable(String)) }
42
+ attr_accessor :customer
43
+ # Only return the Checkout Sessions for the Customer details specified.
44
+ sig { returns(T.nilable(::Stripe::Checkout::SessionService::ListParams::CustomerDetails)) }
45
+ attr_accessor :customer_details
46
+ # 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.
47
+ sig { returns(T.nilable(String)) }
48
+ attr_accessor :ending_before
49
+ # Specifies which fields in the response should be expanded.
50
+ sig { returns(T.nilable(T::Array[String])) }
51
+ attr_accessor :expand
52
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
53
+ sig { returns(T.nilable(Integer)) }
54
+ attr_accessor :limit
55
+ # Only return the Checkout Session for the PaymentIntent specified.
56
+ sig { returns(T.nilable(String)) }
57
+ attr_accessor :payment_intent
58
+ # Only return the Checkout Sessions for the Payment Link specified.
59
+ sig { returns(T.nilable(String)) }
60
+ attr_accessor :payment_link
61
+ # 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.
62
+ sig { returns(T.nilable(String)) }
63
+ attr_accessor :starting_after
64
+ # Only return the Checkout Sessions matching the given status.
65
+ sig { returns(T.nilable(String)) }
66
+ attr_accessor :status
67
+ # Only return the Checkout Session for the subscription specified.
68
+ sig { returns(T.nilable(String)) }
69
+ attr_accessor :subscription
70
+ sig {
71
+ params(created: T.nilable(T.any(::Stripe::Checkout::SessionService::ListParams::Created, Integer)), customer: T.nilable(String), customer_details: T.nilable(::Stripe::Checkout::SessionService::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
72
+ }
73
+ def initialize(
74
+ created: nil,
75
+ customer: nil,
76
+ customer_details: nil,
77
+ ending_before: nil,
78
+ expand: nil,
79
+ limit: nil,
80
+ payment_intent: nil,
81
+ payment_link: nil,
82
+ starting_after: nil,
83
+ status: nil,
84
+ subscription: nil
85
+ ); end
86
+ end
87
+ class CreateParams < Stripe::RequestParams
88
+ class AdaptivePricing < Stripe::RequestParams
89
+ # 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).
90
+ sig { returns(T.nilable(T::Boolean)) }
91
+ attr_accessor :enabled
92
+ sig { params(enabled: T.nilable(T::Boolean)).void }
93
+ def initialize(enabled: nil); end
94
+ end
95
+ class AfterExpiration < Stripe::RequestParams
96
+ class Recovery < Stripe::RequestParams
97
+ # Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
98
+ sig { returns(T.nilable(T::Boolean)) }
99
+ attr_accessor :allow_promotion_codes
100
+ # If `true`, a recovery URL will be generated to recover this Checkout Session if it
101
+ # expires before a successful transaction is completed. It will be attached to the
102
+ # Checkout Session object upon expiration.
103
+ sig { returns(T::Boolean) }
104
+ attr_accessor :enabled
105
+ sig { params(allow_promotion_codes: T.nilable(T::Boolean), enabled: T::Boolean).void }
106
+ def initialize(allow_promotion_codes: nil, enabled: nil); end
107
+ end
108
+ # Configure a Checkout Session that can be used to recover an expired session.
109
+ sig {
110
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration::Recovery))
111
+ }
112
+ attr_accessor :recovery
113
+ sig {
114
+ params(recovery: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration::Recovery)).void
115
+ }
116
+ def initialize(recovery: nil); end
117
+ end
118
+ class AutomaticTax < Stripe::RequestParams
119
+ class Liability < Stripe::RequestParams
120
+ # The connected account being referenced when `type` is `account`.
121
+ sig { returns(T.nilable(String)) }
122
+ attr_accessor :account
123
+ # Type of the account referenced in the request.
124
+ sig { returns(String) }
125
+ attr_accessor :type
126
+ sig { params(account: T.nilable(String), type: String).void }
127
+ def initialize(account: nil, type: nil); end
128
+ end
129
+ # Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
130
+ #
131
+ # Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.
132
+ sig { returns(T::Boolean) }
133
+ attr_accessor :enabled
134
+ # 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.
135
+ sig {
136
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax::Liability))
137
+ }
138
+ attr_accessor :liability
139
+ sig {
140
+ params(enabled: T::Boolean, liability: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax::Liability)).void
141
+ }
142
+ def initialize(enabled: nil, liability: nil); end
143
+ end
144
+ class ConsentCollection < Stripe::RequestParams
145
+ class PaymentMethodReuseAgreement < Stripe::RequestParams
146
+ # Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
147
+ # defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
148
+ sig { returns(String) }
149
+ attr_accessor :position
150
+ sig { params(position: String).void }
151
+ def initialize(position: nil); end
152
+ end
153
+ # 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.
154
+ sig {
155
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement))
156
+ }
157
+ attr_accessor :payment_method_reuse_agreement
158
+ # If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
159
+ # Session will determine whether to display an option to opt into promotional communication
160
+ # from the merchant depending on the customer's locale. Only available to US merchants.
161
+ sig { returns(T.nilable(String)) }
162
+ attr_accessor :promotions
163
+ # If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
164
+ # There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
165
+ sig { returns(T.nilable(String)) }
166
+ attr_accessor :terms_of_service
167
+ sig {
168
+ params(payment_method_reuse_agreement: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement), promotions: T.nilable(String), terms_of_service: T.nilable(String)).void
169
+ }
170
+ def initialize(
171
+ payment_method_reuse_agreement: nil,
172
+ promotions: nil,
173
+ terms_of_service: nil
174
+ ); end
175
+ end
176
+ class CustomField < Stripe::RequestParams
177
+ class Dropdown < Stripe::RequestParams
178
+ class Option < Stripe::RequestParams
179
+ # The label for the option, displayed to the customer. Up to 100 characters.
180
+ sig { returns(String) }
181
+ attr_accessor :label
182
+ # 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.
183
+ sig { returns(String) }
184
+ attr_accessor :value
185
+ sig { params(label: String, value: String).void }
186
+ def initialize(label: nil, value: nil); end
187
+ end
188
+ # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
189
+ sig { returns(T.nilable(String)) }
190
+ attr_accessor :default_value
191
+ # The options available for the customer to select. Up to 200 options allowed.
192
+ sig {
193
+ returns(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown::Option])
194
+ }
195
+ attr_accessor :options
196
+ sig {
197
+ params(default_value: T.nilable(String), options: T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown::Option]).void
198
+ }
199
+ def initialize(default_value: nil, options: nil); end
200
+ end
201
+ class Label < Stripe::RequestParams
202
+ # Custom text for the label, displayed to the customer. Up to 50 characters.
203
+ sig { returns(String) }
204
+ attr_accessor :custom
205
+ # The type of the label.
206
+ sig { returns(String) }
207
+ attr_accessor :type
208
+ sig { params(custom: String, type: String).void }
209
+ def initialize(custom: nil, type: nil); end
210
+ end
211
+ class Numeric < Stripe::RequestParams
212
+ # The value that will pre-fill the field on the payment page.
213
+ sig { returns(T.nilable(String)) }
214
+ attr_accessor :default_value
215
+ # The maximum character length constraint for the customer's input.
216
+ sig { returns(T.nilable(Integer)) }
217
+ attr_accessor :maximum_length
218
+ # The minimum character length requirement for the customer's input.
219
+ sig { returns(T.nilable(Integer)) }
220
+ attr_accessor :minimum_length
221
+ sig {
222
+ params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
223
+ }
224
+ def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
225
+ end
226
+ class Text < Stripe::RequestParams
227
+ # The value that will pre-fill the field on the payment page.
228
+ sig { returns(T.nilable(String)) }
229
+ attr_accessor :default_value
230
+ # The maximum character length constraint for the customer's input.
231
+ sig { returns(T.nilable(Integer)) }
232
+ attr_accessor :maximum_length
233
+ # The minimum character length requirement for the customer's input.
234
+ sig { returns(T.nilable(Integer)) }
235
+ attr_accessor :minimum_length
236
+ sig {
237
+ params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
238
+ }
239
+ def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
240
+ end
241
+ # Configuration for `type=dropdown` fields.
242
+ sig {
243
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown))
244
+ }
245
+ attr_accessor :dropdown
246
+ # 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.
247
+ sig { returns(String) }
248
+ attr_accessor :key
249
+ # The label for the field, displayed to the customer.
250
+ sig { returns(::Stripe::Checkout::SessionService::CreateParams::CustomField::Label) }
251
+ attr_accessor :label
252
+ # Configuration for `type=numeric` fields.
253
+ sig {
254
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Numeric))
255
+ }
256
+ attr_accessor :numeric
257
+ # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
258
+ sig { returns(T.nilable(T::Boolean)) }
259
+ attr_accessor :optional
260
+ # Configuration for `type=text` fields.
261
+ sig {
262
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Text))
263
+ }
264
+ attr_accessor :text
265
+ # The type of the field.
266
+ sig { returns(String) }
267
+ attr_accessor :type
268
+ sig {
269
+ params(dropdown: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Dropdown), key: String, label: ::Stripe::Checkout::SessionService::CreateParams::CustomField::Label, numeric: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Numeric), optional: T.nilable(T::Boolean), text: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomField::Text), type: String).void
270
+ }
271
+ def initialize(
272
+ dropdown: nil,
273
+ key: nil,
274
+ label: nil,
275
+ numeric: nil,
276
+ optional: nil,
277
+ text: nil,
278
+ type: nil
279
+ ); end
280
+ end
281
+ class CustomText < Stripe::RequestParams
282
+ class AfterSubmit < Stripe::RequestParams
283
+ # Text may be up to 1200 characters in length.
284
+ sig { returns(String) }
285
+ attr_accessor :message
286
+ sig { params(message: String).void }
287
+ def initialize(message: nil); end
288
+ end
289
+ class ShippingAddress < Stripe::RequestParams
290
+ # Text may be up to 1200 characters in length.
291
+ sig { returns(String) }
292
+ attr_accessor :message
293
+ sig { params(message: String).void }
294
+ def initialize(message: nil); end
295
+ end
296
+ class Submit < Stripe::RequestParams
297
+ # Text may be up to 1200 characters in length.
298
+ sig { returns(String) }
299
+ attr_accessor :message
300
+ sig { params(message: String).void }
301
+ def initialize(message: nil); end
302
+ end
303
+ class TermsOfServiceAcceptance < Stripe::RequestParams
304
+ # Text may be up to 1200 characters in length.
305
+ sig { returns(String) }
306
+ attr_accessor :message
307
+ sig { params(message: String).void }
308
+ def initialize(message: nil); end
309
+ end
310
+ # Custom text that should be displayed after the payment confirmation button.
311
+ sig {
312
+ returns(T.nilable(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::AfterSubmit))))
313
+ }
314
+ attr_accessor :after_submit
315
+ # Custom text that should be displayed alongside shipping address collection.
316
+ sig {
317
+ returns(T.nilable(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::ShippingAddress))))
318
+ }
319
+ attr_accessor :shipping_address
320
+ # Custom text that should be displayed alongside the payment confirmation button.
321
+ sig {
322
+ returns(T.nilable(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::Submit))))
323
+ }
324
+ attr_accessor :submit
325
+ # Custom text that should be displayed in place of the default terms of service agreement text.
326
+ sig {
327
+ returns(T.nilable(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::TermsOfServiceAcceptance))))
328
+ }
329
+ attr_accessor :terms_of_service_acceptance
330
+ sig {
331
+ params(after_submit: T.nilable(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::AfterSubmit))), shipping_address: T.nilable(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::ShippingAddress))), submit: T.nilable(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::Submit))), terms_of_service_acceptance: T.nilable(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::CustomText::TermsOfServiceAcceptance)))).void
332
+ }
333
+ def initialize(
334
+ after_submit: nil,
335
+ shipping_address: nil,
336
+ submit: nil,
337
+ terms_of_service_acceptance: nil
338
+ ); end
339
+ end
340
+ class CustomerUpdate < Stripe::RequestParams
341
+ # Describes whether Checkout saves the billing address onto `customer.address`.
342
+ # To always collect a full billing address, use `billing_address_collection`. Defaults to `never`.
343
+ sig { returns(T.nilable(String)) }
344
+ attr_accessor :address
345
+ # Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.
346
+ sig { returns(T.nilable(String)) }
347
+ attr_accessor :name
348
+ # Describes whether Checkout saves shipping information onto `customer.shipping`.
349
+ # To collect shipping information, use `shipping_address_collection`. Defaults to `never`.
350
+ sig { returns(T.nilable(String)) }
351
+ attr_accessor :shipping
352
+ sig {
353
+ params(address: T.nilable(String), name: T.nilable(String), shipping: T.nilable(String)).void
354
+ }
355
+ def initialize(address: nil, name: nil, shipping: nil); end
356
+ end
357
+ class Discount < Stripe::RequestParams
358
+ # The ID of the coupon to apply to this Session.
359
+ sig { returns(T.nilable(String)) }
360
+ attr_accessor :coupon
361
+ # The ID of a promotion code to apply to this Session.
362
+ sig { returns(T.nilable(String)) }
363
+ attr_accessor :promotion_code
364
+ sig { params(coupon: T.nilable(String), promotion_code: T.nilable(String)).void }
365
+ def initialize(coupon: nil, promotion_code: nil); end
366
+ end
367
+ class InvoiceCreation < Stripe::RequestParams
368
+ class InvoiceData < Stripe::RequestParams
369
+ class CustomField < Stripe::RequestParams
370
+ # The name of the custom field. This may be up to 40 characters.
371
+ sig { returns(String) }
372
+ attr_accessor :name
373
+ # The value of the custom field. This may be up to 140 characters.
374
+ sig { returns(String) }
375
+ attr_accessor :value
376
+ sig { params(name: String, value: String).void }
377
+ def initialize(name: nil, value: nil); end
378
+ end
379
+ class Issuer < Stripe::RequestParams
380
+ # The connected account being referenced when `type` is `account`.
381
+ sig { returns(T.nilable(String)) }
382
+ attr_accessor :account
383
+ # Type of the account referenced in the request.
384
+ sig { returns(String) }
385
+ attr_accessor :type
386
+ sig { params(account: T.nilable(String), type: String).void }
387
+ def initialize(account: nil, type: nil); end
388
+ end
389
+ class RenderingOptions < Stripe::RequestParams
390
+ # 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.
391
+ sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
392
+ attr_accessor :amount_tax_display
393
+ # ID of the invoice rendering template to use for this invoice.
394
+ sig { returns(T.nilable(String)) }
395
+ attr_accessor :template
396
+ sig {
397
+ params(amount_tax_display: T.nilable(T.nilable(T.any(String, String))), template: T.nilable(String)).void
398
+ }
399
+ def initialize(amount_tax_display: nil, template: nil); end
400
+ end
401
+ # The account tax IDs associated with the invoice.
402
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
403
+ attr_accessor :account_tax_ids
404
+ # Default custom fields to be displayed on invoices for this customer.
405
+ sig {
406
+ returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::CustomField]))))
407
+ }
408
+ attr_accessor :custom_fields
409
+ # An arbitrary string attached to the object. Often useful for displaying to users.
410
+ sig { returns(T.nilable(String)) }
411
+ attr_accessor :description
412
+ # Default footer to be displayed on invoices for this customer.
413
+ sig { returns(T.nilable(String)) }
414
+ attr_accessor :footer
415
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
416
+ sig {
417
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::Issuer))
418
+ }
419
+ attr_accessor :issuer
420
+ # 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`.
421
+ sig { returns(T.nilable(T::Hash[String, String])) }
422
+ attr_accessor :metadata
423
+ # Default options for invoice PDF rendering for this customer.
424
+ sig {
425
+ returns(T.nilable(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))))
426
+ }
427
+ attr_accessor :rendering_options
428
+ sig {
429
+ 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::SessionService::CreateParams::InvoiceCreation::InvoiceData::CustomField]))), description: T.nilable(String), footer: T.nilable(String), issuer: T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::Issuer), metadata: T.nilable(T::Hash[String, String]), rendering_options: T.nilable(T.nilable(T.any(String, ::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)))).void
430
+ }
431
+ def initialize(
432
+ account_tax_ids: nil,
433
+ custom_fields: nil,
434
+ description: nil,
435
+ footer: nil,
436
+ issuer: nil,
437
+ metadata: nil,
438
+ rendering_options: nil
439
+ ); end
440
+ end
441
+ # Set to `true` to enable invoice creation.
442
+ sig { returns(T::Boolean) }
443
+ attr_accessor :enabled
444
+ # Parameters passed when creating invoices for payment-mode Checkout Sessions.
445
+ sig {
446
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData))
447
+ }
448
+ attr_accessor :invoice_data
449
+ sig {
450
+ params(enabled: T::Boolean, invoice_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation::InvoiceData)).void
451
+ }
452
+ def initialize(enabled: nil, invoice_data: nil); end
453
+ end
454
+ class LineItem < Stripe::RequestParams
455
+ class AdjustableQuantity < Stripe::RequestParams
456
+ # Set to true if the quantity can be adjusted to any non-negative integer.
457
+ sig { returns(T::Boolean) }
458
+ attr_accessor :enabled
459
+ # 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.
460
+ sig { returns(T.nilable(Integer)) }
461
+ attr_accessor :maximum
462
+ # The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
463
+ sig { returns(T.nilable(Integer)) }
464
+ attr_accessor :minimum
465
+ sig {
466
+ params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
467
+ }
468
+ def initialize(enabled: nil, maximum: nil, minimum: nil); end
469
+ end
470
+ class PriceData < Stripe::RequestParams
471
+ class ProductData < Stripe::RequestParams
472
+ # 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.
473
+ sig { returns(T.nilable(String)) }
474
+ attr_accessor :description
475
+ # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
476
+ sig { returns(T.nilable(T::Array[String])) }
477
+ attr_accessor :images
478
+ # 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`.
479
+ sig { returns(T.nilable(T::Hash[String, String])) }
480
+ attr_accessor :metadata
481
+ # The product's name, meant to be displayable to the customer.
482
+ sig { returns(String) }
483
+ attr_accessor :name
484
+ # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
485
+ sig { returns(T.nilable(String)) }
486
+ attr_accessor :tax_code
487
+ sig {
488
+ 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
489
+ }
490
+ def initialize(
491
+ description: nil,
492
+ images: nil,
493
+ metadata: nil,
494
+ name: nil,
495
+ tax_code: nil
496
+ ); end
497
+ end
498
+ class Recurring < Stripe::RequestParams
499
+ # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
500
+ sig { returns(String) }
501
+ attr_accessor :interval
502
+ # 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).
503
+ sig { returns(T.nilable(Integer)) }
504
+ attr_accessor :interval_count
505
+ sig { params(interval: String, interval_count: T.nilable(Integer)).void }
506
+ def initialize(interval: nil, interval_count: nil); end
507
+ end
508
+ # 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).
509
+ sig { returns(String) }
510
+ attr_accessor :currency
511
+ # 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.
512
+ sig { returns(T.nilable(String)) }
513
+ attr_accessor :product
514
+ # Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
515
+ sig {
516
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::ProductData))
517
+ }
518
+ attr_accessor :product_data
519
+ # The recurring components of a price such as `interval` and `interval_count`.
520
+ sig {
521
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::Recurring))
522
+ }
523
+ attr_accessor :recurring
524
+ # 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.
525
+ sig { returns(T.nilable(String)) }
526
+ attr_accessor :tax_behavior
527
+ # A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
528
+ sig { returns(T.nilable(Integer)) }
529
+ attr_accessor :unit_amount
530
+ # 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.
531
+ sig { returns(T.nilable(String)) }
532
+ attr_accessor :unit_amount_decimal
533
+ sig {
534
+ params(currency: String, product: T.nilable(String), product_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::ProductData), recurring: T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
535
+ }
536
+ def initialize(
537
+ currency: nil,
538
+ product: nil,
539
+ product_data: nil,
540
+ recurring: nil,
541
+ tax_behavior: nil,
542
+ unit_amount: nil,
543
+ unit_amount_decimal: nil
544
+ ); end
545
+ end
546
+ # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
547
+ sig {
548
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::AdjustableQuantity))
549
+ }
550
+ attr_accessor :adjustable_quantity
551
+ # 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.
552
+ sig { returns(T.nilable(T::Array[String])) }
553
+ attr_accessor :dynamic_tax_rates
554
+ # 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.
555
+ sig { returns(T.nilable(String)) }
556
+ attr_accessor :price
557
+ # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
558
+ sig {
559
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData))
560
+ }
561
+ attr_accessor :price_data
562
+ # The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
563
+ sig { returns(T.nilable(Integer)) }
564
+ attr_accessor :quantity
565
+ # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
566
+ sig { returns(T.nilable(T::Array[String])) }
567
+ attr_accessor :tax_rates
568
+ sig {
569
+ params(adjustable_quantity: T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::AdjustableQuantity), dynamic_tax_rates: T.nilable(T::Array[String]), price: T.nilable(String), price_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::LineItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T::Array[String])).void
570
+ }
571
+ def initialize(
572
+ adjustable_quantity: nil,
573
+ dynamic_tax_rates: nil,
574
+ price: nil,
575
+ price_data: nil,
576
+ quantity: nil,
577
+ tax_rates: nil
578
+ ); end
579
+ end
580
+ class OptionalItem < Stripe::RequestParams
581
+ class AdjustableQuantity < Stripe::RequestParams
582
+ # Set to true if the quantity can be adjusted to any non-negative integer.
583
+ sig { returns(T::Boolean) }
584
+ attr_accessor :enabled
585
+ # The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.
586
+ sig { returns(T.nilable(Integer)) }
587
+ attr_accessor :maximum
588
+ # 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.
589
+ sig { returns(T.nilable(Integer)) }
590
+ attr_accessor :minimum
591
+ sig {
592
+ params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
593
+ }
594
+ def initialize(enabled: nil, maximum: nil, minimum: nil); end
595
+ end
596
+ # 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.
597
+ sig {
598
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::OptionalItem::AdjustableQuantity))
599
+ }
600
+ attr_accessor :adjustable_quantity
601
+ # The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
602
+ sig { returns(String) }
603
+ attr_accessor :price
604
+ # The initial quantity of the line item created when a customer chooses to add this optional item to their order.
605
+ sig { returns(Integer) }
606
+ attr_accessor :quantity
607
+ sig {
608
+ params(adjustable_quantity: T.nilable(::Stripe::Checkout::SessionService::CreateParams::OptionalItem::AdjustableQuantity), price: String, quantity: Integer).void
609
+ }
610
+ def initialize(adjustable_quantity: nil, price: nil, quantity: nil); end
611
+ end
612
+ class PaymentIntentData < Stripe::RequestParams
613
+ class Shipping < Stripe::RequestParams
614
+ class Address < Stripe::RequestParams
615
+ # City, district, suburb, town, or village.
616
+ sig { returns(T.nilable(String)) }
617
+ attr_accessor :city
618
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
619
+ sig { returns(T.nilable(String)) }
620
+ attr_accessor :country
621
+ # Address line 1 (e.g., street, PO Box, or company name).
622
+ sig { returns(String) }
623
+ attr_accessor :line1
624
+ # Address line 2 (e.g., apartment, suite, unit, or building).
625
+ sig { returns(T.nilable(String)) }
626
+ attr_accessor :line2
627
+ # ZIP or postal code.
628
+ sig { returns(T.nilable(String)) }
629
+ attr_accessor :postal_code
630
+ # State, county, province, or region.
631
+ sig { returns(T.nilable(String)) }
632
+ attr_accessor :state
633
+ sig {
634
+ 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
635
+ }
636
+ def initialize(
637
+ city: nil,
638
+ country: nil,
639
+ line1: nil,
640
+ line2: nil,
641
+ postal_code: nil,
642
+ state: nil
643
+ ); end
644
+ end
645
+ # Shipping address.
646
+ sig {
647
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping::Address)
648
+ }
649
+ attr_accessor :address
650
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
651
+ sig { returns(T.nilable(String)) }
652
+ attr_accessor :carrier
653
+ # Recipient name.
654
+ sig { returns(String) }
655
+ attr_accessor :name
656
+ # Recipient phone (including extension).
657
+ sig { returns(T.nilable(String)) }
658
+ attr_accessor :phone
659
+ # 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.
660
+ sig { returns(T.nilable(String)) }
661
+ attr_accessor :tracking_number
662
+ sig {
663
+ params(address: ::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
664
+ }
665
+ def initialize(
666
+ address: nil,
667
+ carrier: nil,
668
+ name: nil,
669
+ phone: nil,
670
+ tracking_number: nil
671
+ ); end
672
+ end
673
+ class TransferData < Stripe::RequestParams
674
+ # The amount that will be transferred automatically when a charge succeeds.
675
+ sig { returns(T.nilable(Integer)) }
676
+ attr_accessor :amount
677
+ # If specified, successful charges will be attributed to the destination
678
+ # account for tax reporting, and the funds from charges will be transferred
679
+ # to the destination account. The ID of the resulting transfer will be
680
+ # returned on the successful charge's `transfer` field.
681
+ sig { returns(String) }
682
+ attr_accessor :destination
683
+ sig { params(amount: T.nilable(Integer), destination: String).void }
684
+ def initialize(amount: nil, destination: nil); end
685
+ end
686
+ # 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).
687
+ sig { returns(T.nilable(Integer)) }
688
+ attr_accessor :application_fee_amount
689
+ # Controls when the funds will be captured from the customer's account.
690
+ sig { returns(T.nilable(String)) }
691
+ attr_accessor :capture_method
692
+ # An arbitrary string attached to the object. Often useful for displaying to users.
693
+ sig { returns(T.nilable(String)) }
694
+ attr_accessor :description
695
+ # 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`.
696
+ sig { returns(T.nilable(T::Hash[String, String])) }
697
+ attr_accessor :metadata
698
+ # The Stripe account ID for which these funds are intended. For details,
699
+ # see the PaymentIntents [use case for connected
700
+ # accounts](/docs/payments/connected-accounts).
701
+ sig { returns(T.nilable(String)) }
702
+ attr_accessor :on_behalf_of
703
+ # 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).
704
+ sig { returns(T.nilable(String)) }
705
+ attr_accessor :receipt_email
706
+ # Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment
707
+ # method collected by this Checkout Session.
708
+ #
709
+ # When setting this to `on_session`, Checkout will show a notice to the
710
+ # customer that their payment details will be saved.
711
+ #
712
+ # When setting this to `off_session`, Checkout will show a notice to the
713
+ # customer that their payment details will be saved and used for future
714
+ # payments.
715
+ #
716
+ # If a Customer has been provided or Checkout creates a new Customer,
717
+ # Checkout will attach the payment method to the Customer.
718
+ #
719
+ # If Checkout does not create a Customer, the payment method is not attached
720
+ # to a Customer. To reuse the payment method, you can retrieve it from the
721
+ # Checkout Session's PaymentIntent.
722
+ #
723
+ # When processing card payments, Checkout also uses `setup_future_usage`
724
+ # to dynamically optimize your payment flow and comply with regional
725
+ # legislation and network rules, such as SCA.
726
+ sig { returns(T.nilable(String)) }
727
+ attr_accessor :setup_future_usage
728
+ # Shipping information for this payment.
729
+ sig {
730
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::Shipping))
731
+ }
732
+ attr_accessor :shipping
733
+ # 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).
734
+ #
735
+ # 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.
736
+ sig { returns(T.nilable(String)) }
737
+ attr_accessor :statement_descriptor
738
+ # 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.
739
+ sig { returns(T.nilable(String)) }
740
+ attr_accessor :statement_descriptor_suffix
741
+ # The parameters used to automatically create a Transfer when the payment succeeds.
742
+ # For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
743
+ sig {
744
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::TransferData))
745
+ }
746
+ attr_accessor :transfer_data
747
+ # 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.
748
+ sig { returns(T.nilable(String)) }
749
+ attr_accessor :transfer_group
750
+ sig {
751
+ 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::SessionService::CreateParams::PaymentIntentData::Shipping), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData::TransferData), transfer_group: T.nilable(String)).void
752
+ }
753
+ def initialize(
754
+ application_fee_amount: nil,
755
+ capture_method: nil,
756
+ description: nil,
757
+ metadata: nil,
758
+ on_behalf_of: nil,
759
+ receipt_email: nil,
760
+ setup_future_usage: nil,
761
+ shipping: nil,
762
+ statement_descriptor: nil,
763
+ statement_descriptor_suffix: nil,
764
+ transfer_data: nil,
765
+ transfer_group: nil
766
+ ); end
767
+ end
768
+ class PaymentMethodData < Stripe::RequestParams
769
+ # 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.
770
+ sig { returns(T.nilable(String)) }
771
+ attr_accessor :allow_redisplay
772
+ sig { params(allow_redisplay: T.nilable(String)).void }
773
+ def initialize(allow_redisplay: nil); end
774
+ end
775
+ class PaymentMethodOptions < Stripe::RequestParams
776
+ class AcssDebit < Stripe::RequestParams
777
+ class MandateOptions < Stripe::RequestParams
778
+ # A URL for custom mandate text to render during confirmation step.
779
+ # The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
780
+ # or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
781
+ sig { returns(T.nilable(T.nilable(String))) }
782
+ attr_accessor :custom_mandate_url
783
+ # List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.
784
+ sig { returns(T.nilable(T::Array[String])) }
785
+ attr_accessor :default_for
786
+ # Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
787
+ sig { returns(T.nilable(String)) }
788
+ attr_accessor :interval_description
789
+ # Payment schedule for the mandate.
790
+ sig { returns(T.nilable(String)) }
791
+ attr_accessor :payment_schedule
792
+ # Transaction type of the mandate.
793
+ sig { returns(T.nilable(String)) }
794
+ attr_accessor :transaction_type
795
+ sig {
796
+ 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
797
+ }
798
+ def initialize(
799
+ custom_mandate_url: nil,
800
+ default_for: nil,
801
+ interval_description: nil,
802
+ payment_schedule: nil,
803
+ transaction_type: nil
804
+ ); end
805
+ end
806
+ # 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.
807
+ sig { returns(T.nilable(String)) }
808
+ attr_accessor :currency
809
+ # Additional fields for Mandate creation
810
+ sig {
811
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
812
+ }
813
+ attr_accessor :mandate_options
814
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
815
+ #
816
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
817
+ #
818
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
819
+ #
820
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
821
+ sig { returns(T.nilable(String)) }
822
+ attr_accessor :setup_future_usage
823
+ # 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.
824
+ sig { returns(T.nilable(String)) }
825
+ attr_accessor :target_date
826
+ # Verification method for the intent
827
+ sig { returns(T.nilable(String)) }
828
+ attr_accessor :verification_method
829
+ sig {
830
+ params(currency: T.nilable(String), mandate_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions), setup_future_usage: T.nilable(String), target_date: T.nilable(String), verification_method: T.nilable(String)).void
831
+ }
832
+ def initialize(
833
+ currency: nil,
834
+ mandate_options: nil,
835
+ setup_future_usage: nil,
836
+ target_date: nil,
837
+ verification_method: nil
838
+ ); end
839
+ end
840
+ class Affirm < Stripe::RequestParams
841
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
842
+ #
843
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
844
+ #
845
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
846
+ #
847
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
848
+ sig { returns(T.nilable(String)) }
849
+ attr_accessor :setup_future_usage
850
+ sig { params(setup_future_usage: T.nilable(String)).void }
851
+ def initialize(setup_future_usage: nil); end
852
+ end
853
+ class AfterpayClearpay < Stripe::RequestParams
854
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
855
+ #
856
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
857
+ #
858
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
859
+ #
860
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
861
+ sig { returns(T.nilable(String)) }
862
+ attr_accessor :setup_future_usage
863
+ sig { params(setup_future_usage: T.nilable(String)).void }
864
+ def initialize(setup_future_usage: nil); end
865
+ end
866
+ class Alipay < Stripe::RequestParams
867
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
868
+ #
869
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
870
+ #
871
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
872
+ #
873
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
874
+ sig { returns(T.nilable(String)) }
875
+ attr_accessor :setup_future_usage
876
+ sig { params(setup_future_usage: T.nilable(String)).void }
877
+ def initialize(setup_future_usage: nil); end
878
+ end
879
+ class AmazonPay < Stripe::RequestParams
880
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
881
+ #
882
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
883
+ #
884
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
885
+ #
886
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
887
+ sig { returns(T.nilable(String)) }
888
+ attr_accessor :setup_future_usage
889
+ sig { params(setup_future_usage: T.nilable(String)).void }
890
+ def initialize(setup_future_usage: nil); end
891
+ end
892
+ class AuBecsDebit < Stripe::RequestParams
893
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
894
+ #
895
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
896
+ #
897
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
898
+ #
899
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
900
+ sig { returns(T.nilable(String)) }
901
+ attr_accessor :setup_future_usage
902
+ # 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.
903
+ sig { returns(T.nilable(String)) }
904
+ attr_accessor :target_date
905
+ sig {
906
+ params(setup_future_usage: T.nilable(String), target_date: T.nilable(String)).void
907
+ }
908
+ def initialize(setup_future_usage: nil, target_date: nil); end
909
+ end
910
+ class BacsDebit < Stripe::RequestParams
911
+ class MandateOptions < Stripe::RequestParams
912
+ # 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'.
913
+ sig { returns(T.nilable(T.nilable(String))) }
914
+ attr_accessor :reference_prefix
915
+ sig { params(reference_prefix: T.nilable(T.nilable(String))).void }
916
+ def initialize(reference_prefix: nil); end
917
+ end
918
+ # Additional fields for Mandate creation
919
+ sig {
920
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
921
+ }
922
+ attr_accessor :mandate_options
923
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
924
+ #
925
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
926
+ #
927
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
928
+ #
929
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
930
+ sig { returns(T.nilable(String)) }
931
+ attr_accessor :setup_future_usage
932
+ # 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.
933
+ sig { returns(T.nilable(String)) }
934
+ attr_accessor :target_date
935
+ sig {
936
+ params(mandate_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions), setup_future_usage: T.nilable(String), target_date: T.nilable(String)).void
937
+ }
938
+ def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
939
+ end
940
+ class Bancontact < Stripe::RequestParams
941
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
942
+ #
943
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
944
+ #
945
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
946
+ #
947
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
948
+ sig { returns(T.nilable(String)) }
949
+ attr_accessor :setup_future_usage
950
+ sig { params(setup_future_usage: T.nilable(String)).void }
951
+ def initialize(setup_future_usage: nil); end
952
+ end
953
+ class Boleto < Stripe::RequestParams
954
+ # 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.
955
+ sig { returns(T.nilable(Integer)) }
956
+ attr_accessor :expires_after_days
957
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
958
+ #
959
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
960
+ #
961
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
962
+ #
963
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
964
+ sig { returns(T.nilable(String)) }
965
+ attr_accessor :setup_future_usage
966
+ sig {
967
+ params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
968
+ }
969
+ def initialize(expires_after_days: nil, setup_future_usage: nil); end
970
+ end
971
+ class Card < Stripe::RequestParams
972
+ class Installments < Stripe::RequestParams
973
+ # Setting to true enables installments for this Checkout Session.
974
+ # Setting to false will prevent any installment plan from applying to a payment.
975
+ sig { returns(T.nilable(T::Boolean)) }
976
+ attr_accessor :enabled
977
+ sig { params(enabled: T.nilable(T::Boolean)).void }
978
+ def initialize(enabled: nil); end
979
+ end
980
+ class Restrictions < Stripe::RequestParams
981
+ # 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.
982
+ sig { returns(T.nilable(T::Array[String])) }
983
+ attr_accessor :brands_blocked
984
+ sig { params(brands_blocked: T.nilable(T::Array[String])).void }
985
+ def initialize(brands_blocked: nil); end
986
+ end
987
+ # Installment options for card payments
988
+ sig {
989
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Installments))
990
+ }
991
+ attr_accessor :installments
992
+ # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
993
+ sig { returns(T.nilable(String)) }
994
+ attr_accessor :request_extended_authorization
995
+ # Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
996
+ sig { returns(T.nilable(String)) }
997
+ attr_accessor :request_incremental_authorization
998
+ # Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
999
+ sig { returns(T.nilable(String)) }
1000
+ attr_accessor :request_multicapture
1001
+ # Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
1002
+ sig { returns(T.nilable(String)) }
1003
+ attr_accessor :request_overcapture
1004
+ # 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.
1005
+ sig { returns(T.nilable(String)) }
1006
+ attr_accessor :request_three_d_secure
1007
+ # Restrictions to apply to the card payment method. For example, you can block specific card brands.
1008
+ sig {
1009
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card::Restrictions))
1010
+ }
1011
+ attr_accessor :restrictions
1012
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1013
+ #
1014
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1015
+ #
1016
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1017
+ #
1018
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1019
+ sig { returns(T.nilable(String)) }
1020
+ attr_accessor :setup_future_usage
1021
+ # 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.
1022
+ sig { returns(T.nilable(String)) }
1023
+ attr_accessor :statement_descriptor_suffix_kana
1024
+ # 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.
1025
+ sig { returns(T.nilable(String)) }
1026
+ attr_accessor :statement_descriptor_suffix_kanji
1027
+ sig {
1028
+ params(installments: T.nilable(::Stripe::Checkout::SessionService::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::SessionService::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
1029
+ }
1030
+ def initialize(
1031
+ installments: nil,
1032
+ request_extended_authorization: nil,
1033
+ request_incremental_authorization: nil,
1034
+ request_multicapture: nil,
1035
+ request_overcapture: nil,
1036
+ request_three_d_secure: nil,
1037
+ restrictions: nil,
1038
+ setup_future_usage: nil,
1039
+ statement_descriptor_suffix_kana: nil,
1040
+ statement_descriptor_suffix_kanji: nil
1041
+ ); end
1042
+ end
1043
+ class Cashapp < Stripe::RequestParams
1044
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1045
+ #
1046
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1047
+ #
1048
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1049
+ #
1050
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1051
+ sig { returns(T.nilable(String)) }
1052
+ attr_accessor :setup_future_usage
1053
+ sig { params(setup_future_usage: T.nilable(String)).void }
1054
+ def initialize(setup_future_usage: nil); end
1055
+ end
1056
+ class CustomerBalance < Stripe::RequestParams
1057
+ class BankTransfer < Stripe::RequestParams
1058
+ class EuBankTransfer < Stripe::RequestParams
1059
+ # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
1060
+ sig { returns(String) }
1061
+ attr_accessor :country
1062
+ sig { params(country: String).void }
1063
+ def initialize(country: nil); end
1064
+ end
1065
+ # Configuration for eu_bank_transfer funding type.
1066
+ sig {
1067
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer))
1068
+ }
1069
+ attr_accessor :eu_bank_transfer
1070
+ # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
1071
+ #
1072
+ # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
1073
+ sig { returns(T.nilable(T::Array[String])) }
1074
+ attr_accessor :requested_address_types
1075
+ # The list of bank transfer types that this PaymentIntent is allowed to use for funding.
1076
+ sig { returns(String) }
1077
+ attr_accessor :type
1078
+ sig {
1079
+ params(eu_bank_transfer: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer), requested_address_types: T.nilable(T::Array[String]), type: String).void
1080
+ }
1081
+ def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil); end
1082
+ end
1083
+ # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
1084
+ sig {
1085
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer))
1086
+ }
1087
+ attr_accessor :bank_transfer
1088
+ # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
1089
+ sig { returns(T.nilable(String)) }
1090
+ attr_accessor :funding_type
1091
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1092
+ #
1093
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1094
+ #
1095
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1096
+ #
1097
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1098
+ sig { returns(T.nilable(String)) }
1099
+ attr_accessor :setup_future_usage
1100
+ sig {
1101
+ params(bank_transfer: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer), funding_type: T.nilable(String), setup_future_usage: T.nilable(String)).void
1102
+ }
1103
+ def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil); end
1104
+ end
1105
+ class Eps < Stripe::RequestParams
1106
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1107
+ #
1108
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1109
+ #
1110
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1111
+ #
1112
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1113
+ sig { returns(T.nilable(String)) }
1114
+ attr_accessor :setup_future_usage
1115
+ sig { params(setup_future_usage: T.nilable(String)).void }
1116
+ def initialize(setup_future_usage: nil); end
1117
+ end
1118
+ class Fpx < Stripe::RequestParams
1119
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1120
+ #
1121
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1122
+ #
1123
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1124
+ #
1125
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1126
+ sig { returns(T.nilable(String)) }
1127
+ attr_accessor :setup_future_usage
1128
+ sig { params(setup_future_usage: T.nilable(String)).void }
1129
+ def initialize(setup_future_usage: nil); end
1130
+ end
1131
+ class Giropay < Stripe::RequestParams
1132
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1133
+ #
1134
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1135
+ #
1136
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1137
+ #
1138
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1139
+ sig { returns(T.nilable(String)) }
1140
+ attr_accessor :setup_future_usage
1141
+ sig { params(setup_future_usage: T.nilable(String)).void }
1142
+ def initialize(setup_future_usage: nil); end
1143
+ end
1144
+ class Grabpay < Stripe::RequestParams
1145
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1146
+ #
1147
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1148
+ #
1149
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1150
+ #
1151
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1152
+ sig { returns(T.nilable(String)) }
1153
+ attr_accessor :setup_future_usage
1154
+ sig { params(setup_future_usage: T.nilable(String)).void }
1155
+ def initialize(setup_future_usage: nil); end
1156
+ end
1157
+ class Ideal < Stripe::RequestParams
1158
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1159
+ #
1160
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1161
+ #
1162
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1163
+ #
1164
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1165
+ sig { returns(T.nilable(String)) }
1166
+ attr_accessor :setup_future_usage
1167
+ sig { params(setup_future_usage: T.nilable(String)).void }
1168
+ def initialize(setup_future_usage: nil); end
1169
+ end
1170
+ class KakaoPay < Stripe::RequestParams
1171
+ # Controls when the funds will be captured from the customer's account.
1172
+ sig { returns(T.nilable(String)) }
1173
+ attr_accessor :capture_method
1174
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1175
+ #
1176
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1177
+ #
1178
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1179
+ #
1180
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1181
+ sig { returns(T.nilable(String)) }
1182
+ attr_accessor :setup_future_usage
1183
+ sig {
1184
+ params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
1185
+ }
1186
+ def initialize(capture_method: nil, setup_future_usage: nil); end
1187
+ end
1188
+ class Klarna < Stripe::RequestParams
1189
+ class Subscription < Stripe::RequestParams
1190
+ class NextBilling < Stripe::RequestParams
1191
+ # The amount of the next charge for the subscription.
1192
+ sig { returns(Integer) }
1193
+ attr_accessor :amount
1194
+ # The date of the next charge for the subscription in YYYY-MM-DD format.
1195
+ sig { returns(String) }
1196
+ attr_accessor :date
1197
+ sig { params(amount: Integer, date: String).void }
1198
+ def initialize(amount: nil, date: nil); end
1199
+ end
1200
+ # Unit of time between subscription charges.
1201
+ sig { returns(String) }
1202
+ attr_accessor :interval
1203
+ # The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
1204
+ sig { returns(T.nilable(Integer)) }
1205
+ attr_accessor :interval_count
1206
+ # Name for subscription.
1207
+ sig { returns(T.nilable(String)) }
1208
+ attr_accessor :name
1209
+ # Describes the upcoming charge for this subscription.
1210
+ sig {
1211
+ returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
1212
+ }
1213
+ attr_accessor :next_billing
1214
+ # A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
1215
+ sig { returns(String) }
1216
+ attr_accessor :reference
1217
+ sig {
1218
+ params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling, reference: String).void
1219
+ }
1220
+ def initialize(
1221
+ interval: nil,
1222
+ interval_count: nil,
1223
+ name: nil,
1224
+ next_billing: nil,
1225
+ reference: nil
1226
+ ); end
1227
+ end
1228
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1229
+ #
1230
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1231
+ #
1232
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1233
+ #
1234
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1235
+ sig { returns(T.nilable(String)) }
1236
+ attr_accessor :setup_future_usage
1237
+ # Subscription details if the Checkout Session sets up a future subscription.
1238
+ sig {
1239
+ returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription]))))
1240
+ }
1241
+ attr_accessor :subscriptions
1242
+ sig {
1243
+ params(setup_future_usage: T.nilable(String), subscriptions: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription])))).void
1244
+ }
1245
+ def initialize(setup_future_usage: nil, subscriptions: nil); end
1246
+ end
1247
+ class Konbini < Stripe::RequestParams
1248
+ # 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.
1249
+ sig { returns(T.nilable(Integer)) }
1250
+ attr_accessor :expires_after_days
1251
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1252
+ #
1253
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1254
+ #
1255
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1256
+ #
1257
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1258
+ sig { returns(T.nilable(String)) }
1259
+ attr_accessor :setup_future_usage
1260
+ sig {
1261
+ params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
1262
+ }
1263
+ def initialize(expires_after_days: nil, setup_future_usage: nil); end
1264
+ end
1265
+ class KrCard < Stripe::RequestParams
1266
+ # Controls when the funds will be captured from the customer's account.
1267
+ sig { returns(T.nilable(String)) }
1268
+ attr_accessor :capture_method
1269
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1270
+ #
1271
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1272
+ #
1273
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1274
+ #
1275
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1276
+ sig { returns(T.nilable(String)) }
1277
+ attr_accessor :setup_future_usage
1278
+ sig {
1279
+ params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
1280
+ }
1281
+ def initialize(capture_method: nil, setup_future_usage: nil); end
1282
+ end
1283
+ class Link < Stripe::RequestParams
1284
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1285
+ #
1286
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1287
+ #
1288
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1289
+ #
1290
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1291
+ sig { returns(T.nilable(String)) }
1292
+ attr_accessor :setup_future_usage
1293
+ sig { params(setup_future_usage: T.nilable(String)).void }
1294
+ def initialize(setup_future_usage: nil); end
1295
+ end
1296
+ class Mobilepay < Stripe::RequestParams
1297
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1298
+ #
1299
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1300
+ #
1301
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1302
+ #
1303
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1304
+ sig { returns(T.nilable(String)) }
1305
+ attr_accessor :setup_future_usage
1306
+ sig { params(setup_future_usage: T.nilable(String)).void }
1307
+ def initialize(setup_future_usage: nil); end
1308
+ end
1309
+ class Multibanco < Stripe::RequestParams
1310
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1311
+ #
1312
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1313
+ #
1314
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1315
+ #
1316
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1317
+ sig { returns(T.nilable(String)) }
1318
+ attr_accessor :setup_future_usage
1319
+ sig { params(setup_future_usage: T.nilable(String)).void }
1320
+ def initialize(setup_future_usage: nil); end
1321
+ end
1322
+ class NaverPay < Stripe::RequestParams
1323
+ # Controls when the funds will be captured from the customer's account.
1324
+ sig { returns(T.nilable(String)) }
1325
+ attr_accessor :capture_method
1326
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1327
+ #
1328
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1329
+ #
1330
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1331
+ #
1332
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1333
+ sig { returns(T.nilable(String)) }
1334
+ attr_accessor :setup_future_usage
1335
+ sig {
1336
+ params(capture_method: T.nilable(String), setup_future_usage: T.nilable(String)).void
1337
+ }
1338
+ def initialize(capture_method: nil, setup_future_usage: nil); end
1339
+ end
1340
+ class Oxxo < Stripe::RequestParams
1341
+ # 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.
1342
+ sig { returns(T.nilable(Integer)) }
1343
+ attr_accessor :expires_after_days
1344
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1345
+ #
1346
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1347
+ #
1348
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1349
+ #
1350
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1351
+ sig { returns(T.nilable(String)) }
1352
+ attr_accessor :setup_future_usage
1353
+ sig {
1354
+ params(expires_after_days: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
1355
+ }
1356
+ def initialize(expires_after_days: nil, setup_future_usage: nil); end
1357
+ end
1358
+ class P24 < Stripe::RequestParams
1359
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1360
+ #
1361
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1362
+ #
1363
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1364
+ #
1365
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1366
+ sig { returns(T.nilable(String)) }
1367
+ attr_accessor :setup_future_usage
1368
+ # Confirm that the payer has accepted the P24 terms and conditions.
1369
+ sig { returns(T.nilable(T::Boolean)) }
1370
+ attr_accessor :tos_shown_and_accepted
1371
+ sig {
1372
+ params(setup_future_usage: T.nilable(String), tos_shown_and_accepted: T.nilable(T::Boolean)).void
1373
+ }
1374
+ def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
1375
+ end
1376
+ class PayByBank < Stripe::RequestParams; end
1377
+ class Payco < Stripe::RequestParams
1378
+ # Controls when the funds will be captured from the customer's account.
1379
+ sig { returns(T.nilable(String)) }
1380
+ attr_accessor :capture_method
1381
+ sig { params(capture_method: T.nilable(String)).void }
1382
+ def initialize(capture_method: nil); end
1383
+ end
1384
+ class Paynow < Stripe::RequestParams
1385
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1386
+ #
1387
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1388
+ #
1389
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1390
+ #
1391
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1392
+ sig { returns(T.nilable(String)) }
1393
+ attr_accessor :setup_future_usage
1394
+ sig { params(setup_future_usage: T.nilable(String)).void }
1395
+ def initialize(setup_future_usage: nil); end
1396
+ end
1397
+ class Paypal < Stripe::RequestParams
1398
+ # Controls when the funds will be captured from the customer's account.
1399
+ sig { returns(T.nilable(T.nilable(String))) }
1400
+ attr_accessor :capture_method
1401
+ # [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
1402
+ sig { returns(T.nilable(String)) }
1403
+ attr_accessor :preferred_locale
1404
+ # 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.
1405
+ sig { returns(T.nilable(String)) }
1406
+ attr_accessor :reference
1407
+ # The risk correlation ID for an on-session payment using a saved PayPal payment method.
1408
+ sig { returns(T.nilable(String)) }
1409
+ attr_accessor :risk_correlation_id
1410
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1411
+ #
1412
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1413
+ #
1414
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1415
+ #
1416
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1417
+ #
1418
+ # 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`.
1419
+ sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
1420
+ attr_accessor :setup_future_usage
1421
+ sig {
1422
+ 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
1423
+ }
1424
+ def initialize(
1425
+ capture_method: nil,
1426
+ preferred_locale: nil,
1427
+ reference: nil,
1428
+ risk_correlation_id: nil,
1429
+ setup_future_usage: nil
1430
+ ); end
1431
+ end
1432
+ class Pix < Stripe::RequestParams
1433
+ # The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
1434
+ sig { returns(T.nilable(Integer)) }
1435
+ attr_accessor :expires_after_seconds
1436
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1437
+ #
1438
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1439
+ #
1440
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1441
+ #
1442
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1443
+ sig { returns(T.nilable(String)) }
1444
+ attr_accessor :setup_future_usage
1445
+ sig {
1446
+ params(expires_after_seconds: T.nilable(Integer), setup_future_usage: T.nilable(String)).void
1447
+ }
1448
+ def initialize(expires_after_seconds: nil, setup_future_usage: nil); end
1449
+ end
1450
+ class RevolutPay < Stripe::RequestParams
1451
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1452
+ #
1453
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1454
+ #
1455
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1456
+ #
1457
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1458
+ sig { returns(T.nilable(String)) }
1459
+ attr_accessor :setup_future_usage
1460
+ sig { params(setup_future_usage: T.nilable(String)).void }
1461
+ def initialize(setup_future_usage: nil); end
1462
+ end
1463
+ class SamsungPay < Stripe::RequestParams
1464
+ # Controls when the funds will be captured from the customer's account.
1465
+ sig { returns(T.nilable(String)) }
1466
+ attr_accessor :capture_method
1467
+ sig { params(capture_method: T.nilable(String)).void }
1468
+ def initialize(capture_method: nil); end
1469
+ end
1470
+ class SepaDebit < Stripe::RequestParams
1471
+ class MandateOptions < Stripe::RequestParams
1472
+ # 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'.
1473
+ sig { returns(T.nilable(T.nilable(String))) }
1474
+ attr_accessor :reference_prefix
1475
+ sig { params(reference_prefix: T.nilable(T.nilable(String))).void }
1476
+ def initialize(reference_prefix: nil); end
1477
+ end
1478
+ # Additional fields for Mandate creation
1479
+ sig {
1480
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
1481
+ }
1482
+ attr_accessor :mandate_options
1483
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1484
+ #
1485
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1486
+ #
1487
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1488
+ #
1489
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1490
+ sig { returns(T.nilable(String)) }
1491
+ attr_accessor :setup_future_usage
1492
+ # 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.
1493
+ sig { returns(T.nilable(String)) }
1494
+ attr_accessor :target_date
1495
+ sig {
1496
+ params(mandate_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions), setup_future_usage: T.nilable(String), target_date: T.nilable(String)).void
1497
+ }
1498
+ def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
1499
+ end
1500
+ class Sofort < Stripe::RequestParams
1501
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1502
+ #
1503
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1504
+ #
1505
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1506
+ #
1507
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1508
+ sig { returns(T.nilable(String)) }
1509
+ attr_accessor :setup_future_usage
1510
+ sig { params(setup_future_usage: T.nilable(String)).void }
1511
+ def initialize(setup_future_usage: nil); end
1512
+ end
1513
+ class Swish < Stripe::RequestParams
1514
+ # The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
1515
+ sig { returns(T.nilable(String)) }
1516
+ attr_accessor :reference
1517
+ sig { params(reference: T.nilable(String)).void }
1518
+ def initialize(reference: nil); end
1519
+ end
1520
+ class UsBankAccount < Stripe::RequestParams
1521
+ class FinancialConnections < Stripe::RequestParams
1522
+ # 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`.
1523
+ sig { returns(T.nilable(T::Array[String])) }
1524
+ attr_accessor :permissions
1525
+ # List of data features that you would like to retrieve upon account creation.
1526
+ sig { returns(T.nilable(T::Array[String])) }
1527
+ attr_accessor :prefetch
1528
+ sig {
1529
+ params(permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String])).void
1530
+ }
1531
+ def initialize(permissions: nil, prefetch: nil); end
1532
+ end
1533
+ # Additional fields for Financial Connections Session creation
1534
+ sig {
1535
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
1536
+ }
1537
+ attr_accessor :financial_connections
1538
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1539
+ #
1540
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1541
+ #
1542
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1543
+ #
1544
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1545
+ sig { returns(T.nilable(String)) }
1546
+ attr_accessor :setup_future_usage
1547
+ # 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.
1548
+ sig { returns(T.nilable(String)) }
1549
+ attr_accessor :target_date
1550
+ # Verification method for the intent
1551
+ sig { returns(T.nilable(String)) }
1552
+ attr_accessor :verification_method
1553
+ sig {
1554
+ params(financial_connections: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), setup_future_usage: T.nilable(String), target_date: T.nilable(String), verification_method: T.nilable(String)).void
1555
+ }
1556
+ def initialize(
1557
+ financial_connections: nil,
1558
+ setup_future_usage: nil,
1559
+ target_date: nil,
1560
+ verification_method: nil
1561
+ ); end
1562
+ end
1563
+ class WechatPay < Stripe::RequestParams
1564
+ # The app ID registered with WeChat Pay. Only required when client is ios or android.
1565
+ sig { returns(T.nilable(String)) }
1566
+ attr_accessor :app_id
1567
+ # The client type that the end customer will pay from
1568
+ sig { returns(String) }
1569
+ attr_accessor :client
1570
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1571
+ #
1572
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1573
+ #
1574
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1575
+ #
1576
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1577
+ sig { returns(T.nilable(String)) }
1578
+ attr_accessor :setup_future_usage
1579
+ sig {
1580
+ params(app_id: T.nilable(String), client: String, setup_future_usage: T.nilable(String)).void
1581
+ }
1582
+ def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
1583
+ end
1584
+ # contains details about the ACSS Debit payment method options.
1585
+ sig {
1586
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit))
1587
+ }
1588
+ attr_accessor :acss_debit
1589
+ # contains details about the Affirm payment method options.
1590
+ sig {
1591
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Affirm))
1592
+ }
1593
+ attr_accessor :affirm
1594
+ # contains details about the Afterpay Clearpay payment method options.
1595
+ sig {
1596
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AfterpayClearpay))
1597
+ }
1598
+ attr_accessor :afterpay_clearpay
1599
+ # contains details about the Alipay payment method options.
1600
+ sig {
1601
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Alipay))
1602
+ }
1603
+ attr_accessor :alipay
1604
+ # contains details about the AmazonPay payment method options.
1605
+ sig {
1606
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AmazonPay))
1607
+ }
1608
+ attr_accessor :amazon_pay
1609
+ # contains details about the AU Becs Debit payment method options.
1610
+ sig {
1611
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AuBecsDebit))
1612
+ }
1613
+ attr_accessor :au_becs_debit
1614
+ # contains details about the Bacs Debit payment method options.
1615
+ sig {
1616
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit))
1617
+ }
1618
+ attr_accessor :bacs_debit
1619
+ # contains details about the Bancontact payment method options.
1620
+ sig {
1621
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Bancontact))
1622
+ }
1623
+ attr_accessor :bancontact
1624
+ # contains details about the Boleto payment method options.
1625
+ sig {
1626
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Boleto))
1627
+ }
1628
+ attr_accessor :boleto
1629
+ # contains details about the Card payment method options.
1630
+ sig {
1631
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card))
1632
+ }
1633
+ attr_accessor :card
1634
+ # contains details about the Cashapp Pay payment method options.
1635
+ sig {
1636
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Cashapp))
1637
+ }
1638
+ attr_accessor :cashapp
1639
+ # contains details about the Customer Balance payment method options.
1640
+ sig {
1641
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance))
1642
+ }
1643
+ attr_accessor :customer_balance
1644
+ # contains details about the EPS payment method options.
1645
+ sig {
1646
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Eps))
1647
+ }
1648
+ attr_accessor :eps
1649
+ # contains details about the FPX payment method options.
1650
+ sig {
1651
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Fpx))
1652
+ }
1653
+ attr_accessor :fpx
1654
+ # contains details about the Giropay payment method options.
1655
+ sig {
1656
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Giropay))
1657
+ }
1658
+ attr_accessor :giropay
1659
+ # contains details about the Grabpay payment method options.
1660
+ sig {
1661
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Grabpay))
1662
+ }
1663
+ attr_accessor :grabpay
1664
+ # contains details about the Ideal payment method options.
1665
+ sig {
1666
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Ideal))
1667
+ }
1668
+ attr_accessor :ideal
1669
+ # contains details about the Kakao Pay payment method options.
1670
+ sig {
1671
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KakaoPay))
1672
+ }
1673
+ attr_accessor :kakao_pay
1674
+ # contains details about the Klarna payment method options.
1675
+ sig {
1676
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna))
1677
+ }
1678
+ attr_accessor :klarna
1679
+ # contains details about the Konbini payment method options.
1680
+ sig {
1681
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Konbini))
1682
+ }
1683
+ attr_accessor :konbini
1684
+ # contains details about the Korean card payment method options.
1685
+ sig {
1686
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KrCard))
1687
+ }
1688
+ attr_accessor :kr_card
1689
+ # contains details about the Link payment method options.
1690
+ sig {
1691
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Link))
1692
+ }
1693
+ attr_accessor :link
1694
+ # contains details about the Mobilepay payment method options.
1695
+ sig {
1696
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Mobilepay))
1697
+ }
1698
+ attr_accessor :mobilepay
1699
+ # contains details about the Multibanco payment method options.
1700
+ sig {
1701
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Multibanco))
1702
+ }
1703
+ attr_accessor :multibanco
1704
+ # contains details about the Naver Pay payment method options.
1705
+ sig {
1706
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::NaverPay))
1707
+ }
1708
+ attr_accessor :naver_pay
1709
+ # contains details about the OXXO payment method options.
1710
+ sig {
1711
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Oxxo))
1712
+ }
1713
+ attr_accessor :oxxo
1714
+ # contains details about the P24 payment method options.
1715
+ sig {
1716
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::P24))
1717
+ }
1718
+ attr_accessor :p24
1719
+ # contains details about the Pay By Bank payment method options.
1720
+ sig {
1721
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::PayByBank))
1722
+ }
1723
+ attr_accessor :pay_by_bank
1724
+ # contains details about the PAYCO payment method options.
1725
+ sig {
1726
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payco))
1727
+ }
1728
+ attr_accessor :payco
1729
+ # contains details about the PayNow payment method options.
1730
+ sig {
1731
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paynow))
1732
+ }
1733
+ attr_accessor :paynow
1734
+ # contains details about the PayPal payment method options.
1735
+ sig {
1736
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paypal))
1737
+ }
1738
+ attr_accessor :paypal
1739
+ # contains details about the Pix payment method options.
1740
+ sig {
1741
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Pix))
1742
+ }
1743
+ attr_accessor :pix
1744
+ # contains details about the RevolutPay payment method options.
1745
+ sig {
1746
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::RevolutPay))
1747
+ }
1748
+ attr_accessor :revolut_pay
1749
+ # contains details about the Samsung Pay payment method options.
1750
+ sig {
1751
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SamsungPay))
1752
+ }
1753
+ attr_accessor :samsung_pay
1754
+ # contains details about the Sepa Debit payment method options.
1755
+ sig {
1756
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit))
1757
+ }
1758
+ attr_accessor :sepa_debit
1759
+ # contains details about the Sofort payment method options.
1760
+ sig {
1761
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Sofort))
1762
+ }
1763
+ attr_accessor :sofort
1764
+ # contains details about the Swish payment method options.
1765
+ sig {
1766
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Swish))
1767
+ }
1768
+ attr_accessor :swish
1769
+ # contains details about the Us Bank Account payment method options.
1770
+ sig {
1771
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount))
1772
+ }
1773
+ attr_accessor :us_bank_account
1774
+ # contains details about the WeChat Pay payment method options.
1775
+ sig {
1776
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::WechatPay))
1777
+ }
1778
+ attr_accessor :wechat_pay
1779
+ sig {
1780
+ params(acss_debit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit), affirm: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Affirm), afterpay_clearpay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AfterpayClearpay), alipay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Alipay), amazon_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AmazonPay), au_becs_debit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AuBecsDebit), bacs_debit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit), bancontact: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Bancontact), boleto: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Boleto), card: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Card), cashapp: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Cashapp), customer_balance: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::CustomerBalance), eps: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Eps), fpx: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Fpx), giropay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Giropay), grabpay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Grabpay), ideal: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Ideal), kakao_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KakaoPay), klarna: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna), konbini: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Konbini), kr_card: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::KrCard), link: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Link), mobilepay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Mobilepay), multibanco: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Multibanco), naver_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::NaverPay), oxxo: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Oxxo), p24: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::P24), pay_by_bank: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::PayByBank), payco: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Payco), paynow: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paynow), paypal: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Paypal), pix: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Pix), revolut_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::RevolutPay), samsung_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SamsungPay), sepa_debit: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit), sofort: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Sofort), swish: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Swish), us_bank_account: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount), wechat_pay: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::WechatPay)).void
1781
+ }
1782
+ def initialize(
1783
+ acss_debit: nil,
1784
+ affirm: nil,
1785
+ afterpay_clearpay: nil,
1786
+ alipay: nil,
1787
+ amazon_pay: nil,
1788
+ au_becs_debit: nil,
1789
+ bacs_debit: nil,
1790
+ bancontact: nil,
1791
+ boleto: nil,
1792
+ card: nil,
1793
+ cashapp: nil,
1794
+ customer_balance: nil,
1795
+ eps: nil,
1796
+ fpx: nil,
1797
+ giropay: nil,
1798
+ grabpay: nil,
1799
+ ideal: nil,
1800
+ kakao_pay: nil,
1801
+ klarna: nil,
1802
+ konbini: nil,
1803
+ kr_card: nil,
1804
+ link: nil,
1805
+ mobilepay: nil,
1806
+ multibanco: nil,
1807
+ naver_pay: nil,
1808
+ oxxo: nil,
1809
+ p24: nil,
1810
+ pay_by_bank: nil,
1811
+ payco: nil,
1812
+ paynow: nil,
1813
+ paypal: nil,
1814
+ pix: nil,
1815
+ revolut_pay: nil,
1816
+ samsung_pay: nil,
1817
+ sepa_debit: nil,
1818
+ sofort: nil,
1819
+ swish: nil,
1820
+ us_bank_account: nil,
1821
+ wechat_pay: nil
1822
+ ); end
1823
+ end
1824
+ class Permissions < Stripe::RequestParams
1825
+ # Determines which entity is allowed to update the shipping details.
1826
+ #
1827
+ # 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.
1828
+ #
1829
+ # 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.
1830
+ sig { returns(T.nilable(String)) }
1831
+ attr_accessor :update_shipping_details
1832
+ sig { params(update_shipping_details: T.nilable(String)).void }
1833
+ def initialize(update_shipping_details: nil); end
1834
+ end
1835
+ class PhoneNumberCollection < Stripe::RequestParams
1836
+ # Set to `true` to enable phone number collection.
1837
+ #
1838
+ # Can only be set in `payment` and `subscription` mode.
1839
+ sig { returns(T::Boolean) }
1840
+ attr_accessor :enabled
1841
+ sig { params(enabled: T::Boolean).void }
1842
+ def initialize(enabled: nil); end
1843
+ end
1844
+ class SavedPaymentMethodOptions < Stripe::RequestParams
1845
+ # 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.
1846
+ sig { returns(T.nilable(T::Array[String])) }
1847
+ attr_accessor :allow_redisplay_filters
1848
+ # Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
1849
+ sig { returns(T.nilable(String)) }
1850
+ attr_accessor :payment_method_remove
1851
+ # Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
1852
+ sig { returns(T.nilable(String)) }
1853
+ attr_accessor :payment_method_save
1854
+ sig {
1855
+ params(allow_redisplay_filters: T.nilable(T::Array[String]), payment_method_remove: T.nilable(String), payment_method_save: T.nilable(String)).void
1856
+ }
1857
+ def initialize(
1858
+ allow_redisplay_filters: nil,
1859
+ payment_method_remove: nil,
1860
+ payment_method_save: nil
1861
+ ); end
1862
+ end
1863
+ class SetupIntentData < Stripe::RequestParams
1864
+ # An arbitrary string attached to the object. Often useful for displaying to users.
1865
+ sig { returns(T.nilable(String)) }
1866
+ attr_accessor :description
1867
+ # 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`.
1868
+ sig { returns(T.nilable(T::Hash[String, String])) }
1869
+ attr_accessor :metadata
1870
+ # The Stripe account for which the setup is intended.
1871
+ sig { returns(T.nilable(String)) }
1872
+ attr_accessor :on_behalf_of
1873
+ sig {
1874
+ params(description: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String)).void
1875
+ }
1876
+ def initialize(description: nil, metadata: nil, on_behalf_of: nil); end
1877
+ end
1878
+ class ShippingAddressCollection < Stripe::RequestParams
1879
+ # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
1880
+ # shipping locations.
1881
+ sig { returns(T::Array[String]) }
1882
+ attr_accessor :allowed_countries
1883
+ sig { params(allowed_countries: T::Array[String]).void }
1884
+ def initialize(allowed_countries: nil); end
1885
+ end
1886
+ class ShippingOption < Stripe::RequestParams
1887
+ class ShippingRateData < Stripe::RequestParams
1888
+ class DeliveryEstimate < Stripe::RequestParams
1889
+ class Maximum < Stripe::RequestParams
1890
+ # A unit of time.
1891
+ sig { returns(String) }
1892
+ attr_accessor :unit
1893
+ # Must be greater than 0.
1894
+ sig { returns(Integer) }
1895
+ attr_accessor :value
1896
+ sig { params(unit: String, value: Integer).void }
1897
+ def initialize(unit: nil, value: nil); end
1898
+ end
1899
+ class Minimum < Stripe::RequestParams
1900
+ # A unit of time.
1901
+ sig { returns(String) }
1902
+ attr_accessor :unit
1903
+ # Must be greater than 0.
1904
+ sig { returns(Integer) }
1905
+ attr_accessor :value
1906
+ sig { params(unit: String, value: Integer).void }
1907
+ def initialize(unit: nil, value: nil); end
1908
+ end
1909
+ # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
1910
+ sig {
1911
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum))
1912
+ }
1913
+ attr_accessor :maximum
1914
+ # The lower bound of the estimated range. If empty, represents no lower bound.
1915
+ sig {
1916
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum))
1917
+ }
1918
+ attr_accessor :minimum
1919
+ sig {
1920
+ params(maximum: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)).void
1921
+ }
1922
+ def initialize(maximum: nil, minimum: nil); end
1923
+ end
1924
+ class FixedAmount < Stripe::RequestParams
1925
+ class CurrencyOptions < Stripe::RequestParams
1926
+ # A non-negative integer in cents representing how much to charge.
1927
+ sig { returns(Integer) }
1928
+ attr_accessor :amount
1929
+ # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
1930
+ sig { returns(T.nilable(String)) }
1931
+ attr_accessor :tax_behavior
1932
+ sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
1933
+ def initialize(amount: nil, tax_behavior: nil); end
1934
+ end
1935
+ # A non-negative integer in cents representing how much to charge.
1936
+ sig { returns(Integer) }
1937
+ attr_accessor :amount
1938
+ # 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).
1939
+ sig { returns(String) }
1940
+ attr_accessor :currency
1941
+ # 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).
1942
+ sig {
1943
+ returns(T.nilable(T::Hash[String, ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]))
1944
+ }
1945
+ attr_accessor :currency_options
1946
+ sig {
1947
+ params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])).void
1948
+ }
1949
+ def initialize(amount: nil, currency: nil, currency_options: nil); end
1950
+ end
1951
+ # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
1952
+ sig {
1953
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate))
1954
+ }
1955
+ attr_accessor :delivery_estimate
1956
+ # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
1957
+ sig { returns(String) }
1958
+ attr_accessor :display_name
1959
+ # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
1960
+ sig {
1961
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::FixedAmount))
1962
+ }
1963
+ attr_accessor :fixed_amount
1964
+ # 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`.
1965
+ sig { returns(T.nilable(T::Hash[String, String])) }
1966
+ attr_accessor :metadata
1967
+ # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
1968
+ sig { returns(T.nilable(String)) }
1969
+ attr_accessor :tax_behavior
1970
+ # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
1971
+ sig { returns(T.nilable(String)) }
1972
+ attr_accessor :tax_code
1973
+ # The type of calculation to use on the shipping rate.
1974
+ sig { returns(T.nilable(String)) }
1975
+ attr_accessor :type
1976
+ sig {
1977
+ params(delivery_estimate: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate), display_name: String, fixed_amount: T.nilable(::Stripe::Checkout::SessionService::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
1978
+ }
1979
+ def initialize(
1980
+ delivery_estimate: nil,
1981
+ display_name: nil,
1982
+ fixed_amount: nil,
1983
+ metadata: nil,
1984
+ tax_behavior: nil,
1985
+ tax_code: nil,
1986
+ type: nil
1987
+ ); end
1988
+ end
1989
+ # The ID of the Shipping Rate to use for this shipping option.
1990
+ sig { returns(T.nilable(String)) }
1991
+ attr_accessor :shipping_rate
1992
+ # Parameters to be passed to Shipping Rate creation for this shipping option.
1993
+ sig {
1994
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData))
1995
+ }
1996
+ attr_accessor :shipping_rate_data
1997
+ sig {
1998
+ params(shipping_rate: T.nilable(String), shipping_rate_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingOption::ShippingRateData)).void
1999
+ }
2000
+ def initialize(shipping_rate: nil, shipping_rate_data: nil); end
2001
+ end
2002
+ class SubscriptionData < Stripe::RequestParams
2003
+ class BillingMode < Stripe::RequestParams
2004
+ # Controls the calculation and orchestration of prorations and invoices for subscriptions.
2005
+ sig { returns(String) }
2006
+ attr_accessor :type
2007
+ sig { params(type: String).void }
2008
+ def initialize(type: nil); end
2009
+ end
2010
+ class InvoiceSettings < Stripe::RequestParams
2011
+ class Issuer < Stripe::RequestParams
2012
+ # The connected account being referenced when `type` is `account`.
2013
+ sig { returns(T.nilable(String)) }
2014
+ attr_accessor :account
2015
+ # Type of the account referenced in the request.
2016
+ sig { returns(String) }
2017
+ attr_accessor :type
2018
+ sig { params(account: T.nilable(String), type: String).void }
2019
+ def initialize(account: nil, type: nil); end
2020
+ end
2021
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
2022
+ sig {
2023
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings::Issuer))
2024
+ }
2025
+ attr_accessor :issuer
2026
+ sig {
2027
+ params(issuer: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings::Issuer)).void
2028
+ }
2029
+ def initialize(issuer: nil); end
2030
+ end
2031
+ class TransferData < Stripe::RequestParams
2032
+ # 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.
2033
+ sig { returns(T.nilable(Float)) }
2034
+ attr_accessor :amount_percent
2035
+ # ID of an existing, connected Stripe account.
2036
+ sig { returns(String) }
2037
+ attr_accessor :destination
2038
+ sig { params(amount_percent: T.nilable(Float), destination: String).void }
2039
+ def initialize(amount_percent: nil, destination: nil); end
2040
+ end
2041
+ class TrialSettings < Stripe::RequestParams
2042
+ class EndBehavior < Stripe::RequestParams
2043
+ # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
2044
+ sig { returns(String) }
2045
+ attr_accessor :missing_payment_method
2046
+ sig { params(missing_payment_method: String).void }
2047
+ def initialize(missing_payment_method: nil); end
2048
+ end
2049
+ # Defines how the subscription should behave when the user's free trial ends.
2050
+ sig {
2051
+ returns(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
2052
+ }
2053
+ attr_accessor :end_behavior
2054
+ sig {
2055
+ params(end_behavior: ::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings::EndBehavior).void
2056
+ }
2057
+ def initialize(end_behavior: nil); end
2058
+ end
2059
+ # 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).
2060
+ sig { returns(T.nilable(Float)) }
2061
+ attr_accessor :application_fee_percent
2062
+ # A future timestamp to anchor the subscription's billing cycle for new subscriptions.
2063
+ sig { returns(T.nilable(Integer)) }
2064
+ attr_accessor :billing_cycle_anchor
2065
+ # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
2066
+ sig {
2067
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::BillingMode))
2068
+ }
2069
+ attr_accessor :billing_mode
2070
+ # The tax rates that will apply to any subscription item that does not have
2071
+ # `tax_rates` set. Invoices created will have their `default_tax_rates` populated
2072
+ # from the subscription.
2073
+ sig { returns(T.nilable(T::Array[String])) }
2074
+ attr_accessor :default_tax_rates
2075
+ # The subscription's description, meant to be displayable to the customer.
2076
+ # Use this field to optionally store an explanation of the subscription
2077
+ # for rendering in the [customer portal](https://stripe.com/docs/customer-management).
2078
+ sig { returns(T.nilable(String)) }
2079
+ attr_accessor :description
2080
+ # All invoices will be billed using the specified settings.
2081
+ sig {
2082
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings))
2083
+ }
2084
+ attr_accessor :invoice_settings
2085
+ # 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`.
2086
+ sig { returns(T.nilable(T::Hash[String, String])) }
2087
+ attr_accessor :metadata
2088
+ # The account on behalf of which to charge, for each of the subscription's invoices.
2089
+ sig { returns(T.nilable(String)) }
2090
+ attr_accessor :on_behalf_of
2091
+ # Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
2092
+ sig { returns(T.nilable(String)) }
2093
+ attr_accessor :proration_behavior
2094
+ # 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.
2095
+ sig {
2096
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TransferData))
2097
+ }
2098
+ attr_accessor :transfer_data
2099
+ # 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.
2100
+ sig { returns(T.nilable(Integer)) }
2101
+ attr_accessor :trial_end
2102
+ # Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
2103
+ sig { returns(T.nilable(Integer)) }
2104
+ attr_accessor :trial_period_days
2105
+ # Settings related to subscription trials.
2106
+ sig {
2107
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings))
2108
+ }
2109
+ attr_accessor :trial_settings
2110
+ sig {
2111
+ params(application_fee_percent: T.nilable(Float), billing_cycle_anchor: T.nilable(Integer), billing_mode: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::BillingMode), default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), invoice_settings: T.nilable(::Stripe::Checkout::SessionService::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::SessionService::CreateParams::SubscriptionData::TransferData), trial_end: T.nilable(Integer), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings)).void
2112
+ }
2113
+ def initialize(
2114
+ application_fee_percent: nil,
2115
+ billing_cycle_anchor: nil,
2116
+ billing_mode: nil,
2117
+ default_tax_rates: nil,
2118
+ description: nil,
2119
+ invoice_settings: nil,
2120
+ metadata: nil,
2121
+ on_behalf_of: nil,
2122
+ proration_behavior: nil,
2123
+ transfer_data: nil,
2124
+ trial_end: nil,
2125
+ trial_period_days: nil,
2126
+ trial_settings: nil
2127
+ ); end
2128
+ end
2129
+ class TaxIdCollection < Stripe::RequestParams
2130
+ # Enable tax ID collection during checkout. Defaults to `false`.
2131
+ sig { returns(T::Boolean) }
2132
+ attr_accessor :enabled
2133
+ # Describes whether a tax ID is required during checkout. Defaults to `never`.
2134
+ sig { returns(T.nilable(String)) }
2135
+ attr_accessor :required
2136
+ sig { params(enabled: T::Boolean, required: T.nilable(String)).void }
2137
+ def initialize(enabled: nil, required: nil); end
2138
+ end
2139
+ class WalletOptions < Stripe::RequestParams
2140
+ class Link < Stripe::RequestParams
2141
+ # 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.
2142
+ sig { returns(T.nilable(String)) }
2143
+ attr_accessor :display
2144
+ sig { params(display: T.nilable(String)).void }
2145
+ def initialize(display: nil); end
2146
+ end
2147
+ # contains details about the Link wallet options.
2148
+ sig {
2149
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions::Link))
2150
+ }
2151
+ attr_accessor :link
2152
+ sig {
2153
+ params(link: T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions::Link)).void
2154
+ }
2155
+ def initialize(link: nil); end
2156
+ end
2157
+ # Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
2158
+ sig {
2159
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AdaptivePricing))
2160
+ }
2161
+ attr_accessor :adaptive_pricing
2162
+ # Configure actions after a Checkout Session has expired.
2163
+ sig {
2164
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration))
2165
+ }
2166
+ attr_accessor :after_expiration
2167
+ # Enables user redeemable promotion codes.
2168
+ sig { returns(T.nilable(T::Boolean)) }
2169
+ attr_accessor :allow_promotion_codes
2170
+ # Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
2171
+ sig { returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax)) }
2172
+ attr_accessor :automatic_tax
2173
+ # Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
2174
+ sig { returns(T.nilable(String)) }
2175
+ attr_accessor :billing_address_collection
2176
+ # 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`.
2177
+ sig { returns(T.nilable(String)) }
2178
+ attr_accessor :cancel_url
2179
+ # A unique string to reference the Checkout Session. This can be a
2180
+ # customer ID, a cart ID, or similar, and can be used to reconcile the
2181
+ # session with your internal systems.
2182
+ sig { returns(T.nilable(String)) }
2183
+ attr_accessor :client_reference_id
2184
+ # Configure fields for the Checkout Session to gather active consent from customers.
2185
+ sig {
2186
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection))
2187
+ }
2188
+ attr_accessor :consent_collection
2189
+ # 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.
2190
+ sig { returns(T.nilable(String)) }
2191
+ attr_accessor :currency
2192
+ # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
2193
+ sig {
2194
+ returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField]))
2195
+ }
2196
+ attr_accessor :custom_fields
2197
+ # Display additional text for your customers using custom text.
2198
+ sig { returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText)) }
2199
+ attr_accessor :custom_text
2200
+ # ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card
2201
+ # payment method will be used to prefill the email, name, card details, and billing address
2202
+ # 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)
2203
+ # 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.
2204
+ #
2205
+ # 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.
2206
+ # If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
2207
+ #
2208
+ # 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.
2209
+ #
2210
+ # 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.
2211
+ sig { returns(T.nilable(String)) }
2212
+ attr_accessor :customer
2213
+ # Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
2214
+ #
2215
+ # When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
2216
+ # with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).
2217
+ #
2218
+ # Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)
2219
+ # in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
2220
+ #
2221
+ # Can only be set in `payment` and `setup` mode.
2222
+ sig { returns(T.nilable(String)) }
2223
+ attr_accessor :customer_creation
2224
+ # If provided, this value will be used when the Customer object is created.
2225
+ # If not provided, customers will be asked to enter their email address.
2226
+ # Use this parameter to prefill customer data if you already have an email
2227
+ # on file. To access information about the customer once a session is
2228
+ # complete, use the `customer` field.
2229
+ sig { returns(T.nilable(String)) }
2230
+ attr_accessor :customer_email
2231
+ # Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
2232
+ sig { returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomerUpdate)) }
2233
+ attr_accessor :customer_update
2234
+ # The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
2235
+ sig {
2236
+ returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::Discount]))
2237
+ }
2238
+ attr_accessor :discounts
2239
+ # Specifies which fields in the response should be expanded.
2240
+ sig { returns(T.nilable(T::Array[String])) }
2241
+ attr_accessor :expand
2242
+ # 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.
2243
+ sig { returns(T.nilable(Integer)) }
2244
+ attr_accessor :expires_at
2245
+ # Generate a post-purchase Invoice for one-time payments.
2246
+ sig {
2247
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation))
2248
+ }
2249
+ attr_accessor :invoice_creation
2250
+ # 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.
2251
+ #
2252
+ # 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.
2253
+ #
2254
+ # 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.
2255
+ sig {
2256
+ returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::LineItem]))
2257
+ }
2258
+ attr_accessor :line_items
2259
+ # The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
2260
+ sig { returns(T.nilable(String)) }
2261
+ attr_accessor :locale
2262
+ # 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`.
2263
+ sig { returns(T.nilable(T::Hash[String, String])) }
2264
+ attr_accessor :metadata
2265
+ # The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
2266
+ sig { returns(T.nilable(String)) }
2267
+ attr_accessor :mode
2268
+ # 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).
2269
+ #
2270
+ # 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.
2271
+ #
2272
+ # 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.
2273
+ #
2274
+ # 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.
2275
+ sig {
2276
+ returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::OptionalItem]))
2277
+ }
2278
+ attr_accessor :optional_items
2279
+ # Where the user is coming from. This informs the optimizations that are applied to the session. For example, a session originating from a mobile app may behave more like a native app, depending on the platform. This parameter is currently not allowed if `ui_mode` is `custom`.
2280
+ sig { returns(T.nilable(String)) }
2281
+ attr_accessor :origin_context
2282
+ # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
2283
+ sig {
2284
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData))
2285
+ }
2286
+ attr_accessor :payment_intent_data
2287
+ # 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.
2288
+ # This may occur if the Checkout Session includes a free trial or a discount.
2289
+ #
2290
+ # Can only be set in `subscription` mode. Defaults to `always`.
2291
+ #
2292
+ # 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).
2293
+ sig { returns(T.nilable(String)) }
2294
+ attr_accessor :payment_method_collection
2295
+ # The ID of the payment method configuration to use with this Checkout session.
2296
+ sig { returns(T.nilable(String)) }
2297
+ attr_accessor :payment_method_configuration
2298
+ # This parameter allows you to set some attributes on the payment method created during a Checkout session.
2299
+ sig {
2300
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodData))
2301
+ }
2302
+ attr_accessor :payment_method_data
2303
+ # Payment-method-specific configuration.
2304
+ sig {
2305
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions))
2306
+ }
2307
+ attr_accessor :payment_method_options
2308
+ # A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
2309
+ #
2310
+ # You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
2311
+ # See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.
2312
+ #
2313
+ # Read more about the supported payment methods and their requirements in our [payment
2314
+ # method details guide](/docs/payments/checkout/payment-methods).
2315
+ #
2316
+ # If multiple payment methods are passed, Checkout will dynamically reorder them to
2317
+ # prioritize the most relevant payment methods based on the customer's location and
2318
+ # other characteristics.
2319
+ sig { returns(T.nilable(T::Array[String])) }
2320
+ attr_accessor :payment_method_types
2321
+ # 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.
2322
+ #
2323
+ # For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.
2324
+ sig { returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::Permissions)) }
2325
+ attr_accessor :permissions
2326
+ # Controls phone number collection settings for the session.
2327
+ #
2328
+ # We recommend that you review your privacy policy and check with your legal contacts
2329
+ # before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).
2330
+ sig {
2331
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::PhoneNumberCollection))
2332
+ }
2333
+ attr_accessor :phone_number_collection
2334
+ # 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`.
2335
+ sig { returns(T.nilable(String)) }
2336
+ attr_accessor :redirect_on_completion
2337
+ # The URL to redirect your customer back to after they authenticate or cancel their payment on the
2338
+ # payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
2339
+ # and redirect-based payment methods are enabled on the session.
2340
+ sig { returns(T.nilable(String)) }
2341
+ attr_accessor :return_url
2342
+ # Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
2343
+ sig {
2344
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SavedPaymentMethodOptions))
2345
+ }
2346
+ attr_accessor :saved_payment_method_options
2347
+ # A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
2348
+ sig {
2349
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SetupIntentData))
2350
+ }
2351
+ attr_accessor :setup_intent_data
2352
+ # When set, provides configuration for Checkout to collect a shipping address from a customer.
2353
+ sig {
2354
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingAddressCollection))
2355
+ }
2356
+ attr_accessor :shipping_address_collection
2357
+ # The shipping rate options to apply to this Session. Up to a maximum of 5.
2358
+ sig {
2359
+ returns(T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::ShippingOption]))
2360
+ }
2361
+ attr_accessor :shipping_options
2362
+ # Describes the type of transaction being performed by Checkout in order
2363
+ # to customize relevant text on the page, such as the submit button.
2364
+ # `submit_type` can only be specified on Checkout Sessions in
2365
+ # `payment` or `subscription` mode. If blank or `auto`, `pay` is used.
2366
+ sig { returns(T.nilable(String)) }
2367
+ attr_accessor :submit_type
2368
+ # A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
2369
+ sig {
2370
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData))
2371
+ }
2372
+ attr_accessor :subscription_data
2373
+ # The URL to which Stripe should send customers when payment or setup
2374
+ # is complete.
2375
+ # This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
2376
+ # information from the successful Checkout Session on your page, read the
2377
+ # guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
2378
+ sig { returns(T.nilable(String)) }
2379
+ attr_accessor :success_url
2380
+ # Controls tax ID collection during checkout.
2381
+ sig {
2382
+ returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::TaxIdCollection))
2383
+ }
2384
+ attr_accessor :tax_id_collection
2385
+ # The UI mode of the Session. Defaults to `hosted`.
2386
+ sig { returns(T.nilable(String)) }
2387
+ attr_accessor :ui_mode
2388
+ # Wallet-specific configuration.
2389
+ sig { returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions)) }
2390
+ attr_accessor :wallet_options
2391
+ sig {
2392
+ params(adaptive_pricing: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AdaptivePricing), after_expiration: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration), allow_promotion_codes: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::Checkout::SessionService::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::SessionService::CreateParams::ConsentCollection), currency: T.nilable(String), custom_fields: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField]), custom_text: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText), customer: T.nilable(String), customer_creation: T.nilable(String), customer_email: T.nilable(String), customer_update: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomerUpdate), discounts: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::Discount]), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), invoice_creation: T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::Checkout::SessionService::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::SessionService::CreateParams::OptionalItem]), origin_context: T.nilable(String), payment_intent_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), permissions: T.nilable(::Stripe::Checkout::SessionService::CreateParams::Permissions), phone_number_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PhoneNumberCollection), redirect_on_completion: T.nilable(String), return_url: T.nilable(String), saved_payment_method_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SavedPaymentMethodOptions), setup_intent_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SetupIntentData), shipping_address_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingAddressCollection), shipping_options: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::ShippingOption]), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData), success_url: T.nilable(String), tax_id_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::TaxIdCollection), ui_mode: T.nilable(String), wallet_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions)).void
2393
+ }
2394
+ def initialize(
2395
+ adaptive_pricing: nil,
2396
+ after_expiration: nil,
2397
+ allow_promotion_codes: nil,
2398
+ automatic_tax: nil,
2399
+ billing_address_collection: nil,
2400
+ cancel_url: nil,
2401
+ client_reference_id: nil,
2402
+ consent_collection: nil,
2403
+ currency: nil,
2404
+ custom_fields: nil,
2405
+ custom_text: nil,
2406
+ customer: nil,
2407
+ customer_creation: nil,
2408
+ customer_email: nil,
2409
+ customer_update: nil,
2410
+ discounts: nil,
2411
+ expand: nil,
2412
+ expires_at: nil,
2413
+ invoice_creation: nil,
2414
+ line_items: nil,
2415
+ locale: nil,
2416
+ metadata: nil,
2417
+ mode: nil,
2418
+ optional_items: nil,
2419
+ origin_context: nil,
2420
+ payment_intent_data: nil,
2421
+ payment_method_collection: nil,
2422
+ payment_method_configuration: nil,
2423
+ payment_method_data: nil,
2424
+ payment_method_options: nil,
2425
+ payment_method_types: nil,
2426
+ permissions: nil,
2427
+ phone_number_collection: nil,
2428
+ redirect_on_completion: nil,
2429
+ return_url: nil,
2430
+ saved_payment_method_options: nil,
2431
+ setup_intent_data: nil,
2432
+ shipping_address_collection: nil,
2433
+ shipping_options: nil,
2434
+ submit_type: nil,
2435
+ subscription_data: nil,
2436
+ success_url: nil,
2437
+ tax_id_collection: nil,
2438
+ ui_mode: nil,
2439
+ wallet_options: nil
2440
+ ); end
2441
+ end
2442
+ class RetrieveParams < Stripe::RequestParams
2443
+ # Specifies which fields in the response should be expanded.
2444
+ sig { returns(T.nilable(T::Array[String])) }
2445
+ attr_accessor :expand
2446
+ sig { params(expand: T.nilable(T::Array[String])).void }
2447
+ def initialize(expand: nil); end
2448
+ end
2449
+ class UpdateParams < Stripe::RequestParams
2450
+ class CollectedInformation < Stripe::RequestParams
2451
+ class ShippingDetails < Stripe::RequestParams
2452
+ class Address < Stripe::RequestParams
2453
+ # City, district, suburb, town, or village.
2454
+ sig { returns(T.nilable(String)) }
2455
+ attr_accessor :city
2456
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2457
+ sig { returns(String) }
2458
+ attr_accessor :country
2459
+ # Address line 1 (e.g., street, PO Box, or company name).
2460
+ sig { returns(String) }
2461
+ attr_accessor :line1
2462
+ # Address line 2 (e.g., apartment, suite, unit, or building).
2463
+ sig { returns(T.nilable(String)) }
2464
+ attr_accessor :line2
2465
+ # ZIP or postal code.
2466
+ sig { returns(T.nilable(String)) }
2467
+ attr_accessor :postal_code
2468
+ # State, county, province, or region.
2469
+ sig { returns(T.nilable(String)) }
2470
+ attr_accessor :state
2471
+ sig {
2472
+ params(city: T.nilable(String), country: String, line1: String, line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
2473
+ }
2474
+ def initialize(
2475
+ city: nil,
2476
+ country: nil,
2477
+ line1: nil,
2478
+ line2: nil,
2479
+ postal_code: nil,
2480
+ state: nil
2481
+ ); end
2482
+ end
2483
+ # The address of the customer
2484
+ sig {
2485
+ returns(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails::Address)
2486
+ }
2487
+ attr_accessor :address
2488
+ # The name of customer
2489
+ sig { returns(String) }
2490
+ attr_accessor :name
2491
+ sig {
2492
+ params(address: ::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails::Address, name: String).void
2493
+ }
2494
+ def initialize(address: nil, name: nil); end
2495
+ end
2496
+ # The shipping details to apply to this Session.
2497
+ sig {
2498
+ returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails))
2499
+ }
2500
+ attr_accessor :shipping_details
2501
+ sig {
2502
+ params(shipping_details: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation::ShippingDetails)).void
2503
+ }
2504
+ def initialize(shipping_details: nil); end
2505
+ end
2506
+ class ShippingOption < Stripe::RequestParams
2507
+ class ShippingRateData < Stripe::RequestParams
2508
+ class DeliveryEstimate < Stripe::RequestParams
2509
+ class Maximum < Stripe::RequestParams
2510
+ # A unit of time.
2511
+ sig { returns(String) }
2512
+ attr_accessor :unit
2513
+ # Must be greater than 0.
2514
+ sig { returns(Integer) }
2515
+ attr_accessor :value
2516
+ sig { params(unit: String, value: Integer).void }
2517
+ def initialize(unit: nil, value: nil); end
2518
+ end
2519
+ class Minimum < Stripe::RequestParams
2520
+ # A unit of time.
2521
+ sig { returns(String) }
2522
+ attr_accessor :unit
2523
+ # Must be greater than 0.
2524
+ sig { returns(Integer) }
2525
+ attr_accessor :value
2526
+ sig { params(unit: String, value: Integer).void }
2527
+ def initialize(unit: nil, value: nil); end
2528
+ end
2529
+ # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
2530
+ sig {
2531
+ returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum))
2532
+ }
2533
+ attr_accessor :maximum
2534
+ # The lower bound of the estimated range. If empty, represents no lower bound.
2535
+ sig {
2536
+ returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum))
2537
+ }
2538
+ attr_accessor :minimum
2539
+ sig {
2540
+ params(maximum: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum), minimum: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)).void
2541
+ }
2542
+ def initialize(maximum: nil, minimum: nil); end
2543
+ end
2544
+ class FixedAmount < Stripe::RequestParams
2545
+ class CurrencyOptions < Stripe::RequestParams
2546
+ # A non-negative integer in cents representing how much to charge.
2547
+ sig { returns(Integer) }
2548
+ attr_accessor :amount
2549
+ # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
2550
+ sig { returns(T.nilable(String)) }
2551
+ attr_accessor :tax_behavior
2552
+ sig { params(amount: Integer, tax_behavior: T.nilable(String)).void }
2553
+ def initialize(amount: nil, tax_behavior: nil); end
2554
+ end
2555
+ # A non-negative integer in cents representing how much to charge.
2556
+ sig { returns(Integer) }
2557
+ attr_accessor :amount
2558
+ # 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).
2559
+ sig { returns(String) }
2560
+ attr_accessor :currency
2561
+ # 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).
2562
+ sig {
2563
+ returns(T.nilable(T::Hash[String, ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]))
2564
+ }
2565
+ attr_accessor :currency_options
2566
+ sig {
2567
+ params(amount: Integer, currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])).void
2568
+ }
2569
+ def initialize(amount: nil, currency: nil, currency_options: nil); end
2570
+ end
2571
+ # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
2572
+ sig {
2573
+ returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate))
2574
+ }
2575
+ attr_accessor :delivery_estimate
2576
+ # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
2577
+ sig { returns(String) }
2578
+ attr_accessor :display_name
2579
+ # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
2580
+ sig {
2581
+ returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::FixedAmount))
2582
+ }
2583
+ attr_accessor :fixed_amount
2584
+ # 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`.
2585
+ sig { returns(T.nilable(T::Hash[String, String])) }
2586
+ attr_accessor :metadata
2587
+ # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
2588
+ sig { returns(T.nilable(String)) }
2589
+ attr_accessor :tax_behavior
2590
+ # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
2591
+ sig { returns(T.nilable(String)) }
2592
+ attr_accessor :tax_code
2593
+ # The type of calculation to use on the shipping rate.
2594
+ sig { returns(T.nilable(String)) }
2595
+ attr_accessor :type
2596
+ sig {
2597
+ params(delivery_estimate: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate), display_name: String, fixed_amount: T.nilable(::Stripe::Checkout::SessionService::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
2598
+ }
2599
+ def initialize(
2600
+ delivery_estimate: nil,
2601
+ display_name: nil,
2602
+ fixed_amount: nil,
2603
+ metadata: nil,
2604
+ tax_behavior: nil,
2605
+ tax_code: nil,
2606
+ type: nil
2607
+ ); end
2608
+ end
2609
+ # The ID of the Shipping Rate to use for this shipping option.
2610
+ sig { returns(T.nilable(String)) }
2611
+ attr_accessor :shipping_rate
2612
+ # Parameters to be passed to Shipping Rate creation for this shipping option.
2613
+ sig {
2614
+ returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData))
2615
+ }
2616
+ attr_accessor :shipping_rate_data
2617
+ sig {
2618
+ params(shipping_rate: T.nilable(String), shipping_rate_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::ShippingOption::ShippingRateData)).void
2619
+ }
2620
+ def initialize(shipping_rate: nil, shipping_rate_data: nil); end
2621
+ end
2622
+ # Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions.
2623
+ sig {
2624
+ returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation))
2625
+ }
2626
+ attr_accessor :collected_information
2627
+ # Specifies which fields in the response should be expanded.
2628
+ sig { returns(T.nilable(T::Array[String])) }
2629
+ attr_accessor :expand
2630
+ # 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`.
2631
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
2632
+ attr_accessor :metadata
2633
+ # The shipping rate options to apply to this Session. Up to a maximum of 5.
2634
+ sig {
2635
+ returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::UpdateParams::ShippingOption]))))
2636
+ }
2637
+ attr_accessor :shipping_options
2638
+ sig {
2639
+ params(collected_information: T.nilable(::Stripe::Checkout::SessionService::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::SessionService::UpdateParams::ShippingOption])))).void
2640
+ }
2641
+ def initialize(
2642
+ collected_information: nil,
2643
+ expand: nil,
2644
+ metadata: nil,
2645
+ shipping_options: nil
2646
+ ); end
2647
+ end
2648
+ class ExpireParams < Stripe::RequestParams
2649
+ # Specifies which fields in the response should be expanded.
2650
+ sig { returns(T.nilable(T::Array[String])) }
2651
+ attr_accessor :expand
2652
+ sig { params(expand: T.nilable(T::Array[String])).void }
2653
+ def initialize(expand: nil); end
2654
+ end
2655
+ # Creates a Checkout Session object.
2656
+ sig {
2657
+ params(params: T.any(::Stripe::Checkout::SessionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2658
+ }
2659
+ def create(params = {}, opts = {}); end
2660
+
2661
+ # A Checkout Session can be expired when it is in one of these statuses: open
2662
+ #
2663
+ # 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.
2664
+ sig {
2665
+ params(session: String, params: T.any(::Stripe::Checkout::SessionService::ExpireParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2666
+ }
2667
+ def expire(session, params = {}, opts = {}); end
2668
+
2669
+ # Returns a list of Checkout Sessions.
2670
+ sig {
2671
+ params(params: T.any(::Stripe::Checkout::SessionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
2672
+ }
2673
+ def list(params = {}, opts = {}); end
2674
+
2675
+ # Retrieves a Checkout Session object.
2676
+ sig {
2677
+ params(session: String, params: T.any(::Stripe::Checkout::SessionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2678
+ }
2679
+ def retrieve(session, params = {}, opts = {}); end
2680
+
2681
+ # Updates a Checkout Session object.
2682
+ #
2683
+ # Related guide: [Dynamically update Checkout](https://docs.stripe.com/payments/checkout/dynamic-updates)
2684
+ sig {
2685
+ params(session: String, params: T.any(::Stripe::Checkout::SessionService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
2686
+ }
2687
+ def update(session, params = {}, opts = {}); end
2688
+ end
2689
+ end
2690
+ end