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