stripe 13.3.0 → 13.4.0.pre.beta.2

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