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