stripe 13.3.0 → 13.4.0.pre.beta.1

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