stripe 15.3.0.pre.beta.1 → 15.3.0

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