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