stripe 15.6.0.pre.beta.1 → 16.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1097) hide show
  1. checksums.yaml +4 -4
  2. data/lib/stripe/api_requestor.rb +5 -34
  3. data/lib/stripe/api_resource.rb +3 -0
  4. data/lib/stripe/api_version.rb +2 -1
  5. data/lib/stripe/errors.rb +0 -60
  6. data/lib/stripe/event_types.rb +20 -108
  7. data/lib/stripe/events/unknown_event_notification.rb +19 -0
  8. data/lib/stripe/events/v1_billing_meter_error_report_triggered_event.rb +115 -15
  9. data/lib/stripe/events/v1_billing_meter_no_meter_found_event.rb +93 -6
  10. data/lib/stripe/events/v2_core_event_destination_ping_event.rb +35 -12
  11. data/lib/stripe/object_types.rb +2 -54
  12. data/lib/stripe/params/account_capability_list_params.rb +13 -0
  13. data/lib/stripe/params/account_capability_retrieve_params.rb +13 -0
  14. data/lib/stripe/params/account_capability_update_params.rb +18 -0
  15. data/lib/stripe/params/account_create_params.rb +2083 -0
  16. data/lib/stripe/params/account_delete_params.rb +6 -0
  17. data/lib/stripe/params/account_external_account_create_params.rb +134 -0
  18. data/lib/stripe/params/account_external_account_delete_params.rb +6 -0
  19. data/lib/stripe/params/account_external_account_list_params.rb +25 -0
  20. data/lib/stripe/params/account_external_account_retrieve_params.rb +13 -0
  21. data/lib/stripe/params/account_external_account_update_params.rb +91 -0
  22. data/lib/stripe/params/account_link_create_params.rb +52 -0
  23. data/lib/stripe/params/account_list_params.rb +42 -0
  24. data/lib/stripe/params/account_login_link_create_params.rb +13 -0
  25. data/lib/stripe/params/account_person_create_params.rb +435 -0
  26. data/lib/stripe/params/account_person_delete_params.rb +6 -0
  27. data/lib/stripe/params/account_person_list_params.rb +61 -0
  28. data/lib/stripe/params/account_person_retrieve_params.rb +13 -0
  29. data/lib/stripe/params/account_person_update_params.rb +435 -0
  30. data/lib/stripe/params/account_persons_params.rb +61 -0
  31. data/lib/stripe/params/account_reject_params.rb +16 -0
  32. data/lib/stripe/params/account_retrieve_current_params.rb +13 -0
  33. data/lib/stripe/params/account_retrieve_params.rb +13 -0
  34. data/lib/stripe/params/account_session_create_params.rb +598 -0
  35. data/lib/stripe/params/account_update_params.rb +2030 -0
  36. data/lib/stripe/params/apple_pay_domain_create_params.rb +16 -0
  37. data/lib/stripe/params/apple_pay_domain_delete_params.rb +6 -0
  38. data/lib/stripe/params/apple_pay_domain_list_params.rb +31 -0
  39. data/lib/stripe/params/apple_pay_domain_retrieve_params.rb +13 -0
  40. data/lib/stripe/params/application_fee_list_params.rb +52 -0
  41. data/lib/stripe/params/application_fee_refund_create_params.rb +19 -0
  42. data/lib/stripe/params/application_fee_refund_list_params.rb +22 -0
  43. data/lib/stripe/params/application_fee_refund_retrieve_params.rb +13 -0
  44. data/lib/stripe/params/application_fee_refund_update_params.rb +16 -0
  45. data/lib/stripe/params/application_fee_retrieve_params.rb +13 -0
  46. data/lib/stripe/params/apps/secret_create_params.rb +38 -0
  47. data/lib/stripe/params/apps/secret_delete_where_params.rb +32 -0
  48. data/lib/stripe/params/apps/secret_find_params.rb +32 -0
  49. data/lib/stripe/{services/quote_line_service.rb → params/apps/secret_list_params.rb} +17 -14
  50. data/lib/stripe/params/balance_retrieve_params.rb +13 -0
  51. data/lib/stripe/params/balance_settings_retrieve_params.rb +13 -0
  52. data/lib/stripe/params/balance_settings_update_params.rb +67 -0
  53. data/lib/stripe/params/balance_transaction_list_params.rb +64 -0
  54. data/lib/stripe/params/balance_transaction_retrieve_params.rb +13 -0
  55. data/lib/stripe/params/billing/alert_activate_params.rb +15 -0
  56. data/lib/stripe/params/billing/alert_archive_params.rb +15 -0
  57. data/lib/stripe/params/billing/alert_create_params.rb +52 -0
  58. data/lib/stripe/params/billing/alert_deactivate_params.rb +15 -0
  59. data/lib/stripe/params/billing/alert_list_params.rb +37 -0
  60. data/lib/stripe/params/billing/alert_retrieve_params.rb +15 -0
  61. data/lib/stripe/params/billing/credit_balance_summary_retrieve_params.rb +54 -0
  62. data/lib/stripe/params/billing/credit_balance_transaction_list_params.rb +37 -0
  63. data/lib/stripe/params/billing/credit_balance_transaction_retrieve_params.rb +15 -0
  64. data/lib/stripe/params/billing/credit_grant_create_params.rb +103 -0
  65. data/lib/stripe/params/billing/credit_grant_expire_params.rb +15 -0
  66. data/lib/stripe/params/billing/credit_grant_list_params.rb +33 -0
  67. data/lib/stripe/params/billing/credit_grant_retrieve_params.rb +15 -0
  68. data/lib/stripe/params/billing/credit_grant_update_params.rb +21 -0
  69. data/lib/stripe/params/billing/credit_grant_void_grant_params.rb +15 -0
  70. data/lib/stripe/params/billing/meter_create_params.rb +70 -0
  71. data/lib/stripe/params/billing/meter_deactivate_params.rb +15 -0
  72. data/lib/stripe/params/billing/meter_event_adjustment_create_params.rb +32 -0
  73. data/lib/stripe/params/billing/meter_event_create_params.rb +27 -0
  74. data/lib/stripe/params/billing/meter_event_summary_list_params.rb +45 -0
  75. data/lib/stripe/params/billing/meter_list_params.rb +27 -0
  76. data/lib/stripe/params/billing/meter_reactivate_params.rb +15 -0
  77. data/lib/stripe/params/billing/meter_retrieve_params.rb +15 -0
  78. data/lib/stripe/params/billing/meter_update_params.rb +18 -0
  79. data/lib/stripe/params/billing_portal/configuration_create_params.rb +225 -0
  80. data/lib/stripe/params/billing_portal/configuration_list_params.rb +37 -0
  81. data/lib/stripe/params/billing_portal/configuration_retrieve_params.rb +15 -0
  82. data/lib/stripe/params/billing_portal/configuration_update_params.rb +231 -0
  83. data/lib/stripe/params/billing_portal/session_create_params.rb +179 -0
  84. data/lib/stripe/params/charge_capture_params.rb +57 -0
  85. data/lib/stripe/params/charge_create_params.rb +172 -0
  86. data/lib/stripe/params/charge_list_params.rb +60 -0
  87. data/lib/stripe/params/charge_retrieve_params.rb +13 -0
  88. data/lib/stripe/params/charge_search_params.rb +22 -0
  89. data/lib/stripe/params/charge_update_params.rb +102 -0
  90. data/lib/stripe/params/checkout/session_create_params.rb +2445 -0
  91. data/lib/stripe/params/checkout/session_expire_params.rb +15 -0
  92. data/lib/stripe/{services/quote_preview_subscription_schedule_service.rb → params/checkout/session_line_item_list_params.rb} +2 -13
  93. data/lib/stripe/{services/order_line_item_service.rb → params/checkout/session_list_line_items_params.rb} +2 -13
  94. data/lib/stripe/params/checkout/session_list_params.rb +83 -0
  95. data/lib/stripe/params/checkout/session_retrieve_params.rb +15 -0
  96. data/lib/stripe/params/checkout/session_update_params.rb +179 -0
  97. data/lib/stripe/params/climate/order_cancel_params.rb +15 -0
  98. data/lib/stripe/params/climate/order_create_params.rb +49 -0
  99. data/lib/stripe/params/climate/order_list_params.rb +24 -0
  100. data/lib/stripe/params/climate/order_retrieve_params.rb +15 -0
  101. data/lib/stripe/params/climate/order_update_params.rb +29 -0
  102. data/lib/stripe/params/climate/product_list_params.rb +24 -0
  103. data/lib/stripe/params/climate/product_retrieve_params.rb +15 -0
  104. data/lib/stripe/params/climate/supplier_list_params.rb +24 -0
  105. data/lib/stripe/params/climate/supplier_retrieve_params.rb +15 -0
  106. data/lib/stripe/params/confirmation_token_create_params.rb +650 -0
  107. data/lib/stripe/params/confirmation_token_retrieve_params.rb +13 -0
  108. data/lib/stripe/params/country_spec_list_params.rb +22 -0
  109. data/lib/stripe/params/country_spec_retrieve_params.rb +13 -0
  110. data/lib/stripe/params/coupon_create_params.rb +80 -0
  111. data/lib/stripe/params/coupon_delete_params.rb +6 -0
  112. data/lib/stripe/params/coupon_list_params.rb +42 -0
  113. data/lib/stripe/params/coupon_retrieve_params.rb +13 -0
  114. data/lib/stripe/params/coupon_update_params.rb +30 -0
  115. data/lib/stripe/params/credit_note_create_params.rb +144 -0
  116. data/lib/stripe/params/credit_note_line_item_list_params.rb +22 -0
  117. data/lib/stripe/params/credit_note_list_params.rb +56 -0
  118. data/lib/stripe/params/credit_note_list_preview_line_items_params.rb +156 -0
  119. data/lib/stripe/params/credit_note_preview_lines_list_params.rb +156 -0
  120. data/lib/stripe/params/credit_note_preview_params.rb +144 -0
  121. data/lib/stripe/params/credit_note_retrieve_params.rb +13 -0
  122. data/lib/stripe/params/credit_note_update_params.rb +19 -0
  123. data/lib/stripe/params/credit_note_void_credit_note_params.rb +13 -0
  124. data/lib/stripe/params/customer_balance_transaction_create_params.rb +25 -0
  125. data/lib/stripe/params/customer_balance_transaction_list_params.rb +22 -0
  126. data/lib/stripe/params/customer_balance_transaction_retrieve_params.rb +13 -0
  127. data/lib/stripe/params/customer_balance_transaction_update_params.rb +19 -0
  128. data/lib/stripe/params/customer_cash_balance_retrieve_params.rb +13 -0
  129. data/lib/stripe/params/customer_cash_balance_transaction_list_params.rb +22 -0
  130. data/lib/stripe/params/customer_cash_balance_transaction_retrieve_params.rb +13 -0
  131. data/lib/stripe/params/customer_cash_balance_update_params.rb +24 -0
  132. data/lib/stripe/params/customer_create_funding_instructions_params.rb +46 -0
  133. data/lib/stripe/params/customer_create_params.rb +259 -0
  134. data/lib/stripe/params/customer_delete_discount_params.rb +6 -0
  135. data/lib/stripe/params/customer_delete_params.rb +6 -0
  136. data/lib/stripe/params/customer_fund_cash_balance_params.rb +22 -0
  137. data/lib/stripe/params/customer_funding_instructions_create_params.rb +46 -0
  138. data/lib/stripe/params/customer_list_params.rb +56 -0
  139. data/lib/stripe/params/customer_list_payment_methods_params.rb +35 -0
  140. data/lib/stripe/params/customer_payment_method_list_params.rb +35 -0
  141. data/lib/stripe/params/customer_payment_method_retrieve_params.rb +13 -0
  142. data/lib/stripe/params/customer_payment_source_create_params.rb +22 -0
  143. data/lib/stripe/params/customer_payment_source_delete_params.rb +13 -0
  144. data/lib/stripe/params/customer_payment_source_list_params.rb +25 -0
  145. data/lib/stripe/params/customer_payment_source_retrieve_params.rb +13 -0
  146. data/lib/stripe/params/customer_payment_source_update_params.rb +114 -0
  147. data/lib/stripe/params/customer_payment_source_verify_params.rb +16 -0
  148. data/lib/stripe/params/customer_retrieve_params.rb +13 -0
  149. data/lib/stripe/params/customer_retrieve_payment_method_params.rb +13 -0
  150. data/lib/stripe/params/customer_search_params.rb +22 -0
  151. data/lib/stripe/params/customer_session_create_params.rb +100 -0
  152. data/lib/stripe/params/customer_tax_id_create_params.rb +19 -0
  153. data/lib/stripe/params/customer_tax_id_delete_params.rb +6 -0
  154. data/lib/stripe/params/customer_tax_id_list_params.rb +22 -0
  155. data/lib/stripe/params/customer_tax_id_retrieve_params.rb +13 -0
  156. data/lib/stripe/params/customer_update_params.rb +243 -0
  157. data/lib/stripe/params/dispute_close_params.rb +13 -0
  158. data/lib/stripe/params/dispute_list_params.rb +56 -0
  159. data/lib/stripe/params/dispute_retrieve_params.rb +13 -0
  160. data/lib/stripe/params/dispute_update_params.rb +308 -0
  161. data/lib/stripe/params/entitlements/active_entitlement_list_params.rb +33 -0
  162. data/lib/stripe/params/entitlements/active_entitlement_retrieve_params.rb +15 -0
  163. data/lib/stripe/params/entitlements/feature_create_params.rb +24 -0
  164. data/lib/stripe/params/entitlements/feature_list_params.rb +37 -0
  165. data/lib/stripe/params/entitlements/feature_retrieve_params.rb +15 -0
  166. data/lib/stripe/params/entitlements/feature_update_params.rb +24 -0
  167. data/lib/stripe/params/ephemeral_key_create_params.rb +31 -0
  168. data/lib/stripe/params/ephemeral_key_delete_params.rb +13 -0
  169. data/lib/stripe/params/event_list_params.rb +60 -0
  170. data/lib/stripe/params/event_retrieve_params.rb +13 -0
  171. data/lib/stripe/params/exchange_rate_list_params.rb +22 -0
  172. data/lib/stripe/params/exchange_rate_retrieve_params.rb +13 -0
  173. data/lib/stripe/params/file_create_params.rb +36 -0
  174. data/lib/stripe/params/file_link_create_params.rb +22 -0
  175. data/lib/stripe/params/file_link_list_params.rb +56 -0
  176. data/lib/stripe/params/file_link_retrieve_params.rb +13 -0
  177. data/lib/stripe/params/file_link_update_params.rb +19 -0
  178. data/lib/stripe/params/file_list_params.rb +52 -0
  179. data/lib/stripe/params/file_retrieve_params.rb +13 -0
  180. data/lib/stripe/params/financial_connections/account_disconnect_params.rb +15 -0
  181. data/lib/stripe/params/financial_connections/account_list_owners_params.rb +33 -0
  182. data/lib/stripe/params/financial_connections/account_list_params.rb +48 -0
  183. data/lib/stripe/params/financial_connections/account_owner_list_params.rb +33 -0
  184. data/lib/stripe/params/financial_connections/account_refresh_account_params.rb +18 -0
  185. data/lib/stripe/params/financial_connections/account_refresh_params.rb +18 -0
  186. data/lib/stripe/params/financial_connections/account_retrieve_params.rb +15 -0
  187. data/lib/stripe/params/financial_connections/account_subscribe_params.rb +18 -0
  188. data/lib/stripe/params/financial_connections/account_unsubscribe_params.rb +18 -0
  189. data/lib/stripe/params/financial_connections/session_create_params.rb +65 -0
  190. data/lib/stripe/params/financial_connections/session_retrieve_params.rb +15 -0
  191. data/lib/stripe/params/financial_connections/transaction_list_params.rb +67 -0
  192. data/lib/stripe/params/financial_connections/transaction_retrieve_params.rb +15 -0
  193. data/lib/stripe/params/forwarding/request_create_params.rb +59 -0
  194. data/lib/stripe/params/forwarding/request_list_params.rb +44 -0
  195. data/lib/stripe/params/forwarding/request_retrieve_params.rb +15 -0
  196. data/lib/stripe/params/identity/verification_report_list_params.rb +62 -0
  197. data/lib/stripe/params/identity/verification_report_retrieve_params.rb +15 -0
  198. data/lib/stripe/params/identity/verification_session_cancel_params.rb +15 -0
  199. data/lib/stripe/params/identity/verification_session_create_params.rb +107 -0
  200. data/lib/stripe/params/identity/verification_session_list_params.rb +62 -0
  201. data/lib/stripe/params/identity/verification_session_redact_params.rb +15 -0
  202. data/lib/stripe/params/identity/verification_session_retrieve_params.rb +15 -0
  203. data/lib/stripe/params/identity/verification_session_update_params.rb +69 -0
  204. data/lib/stripe/params/invoice_add_lines_params.rb +231 -0
  205. data/lib/stripe/params/invoice_attach_payment_params.rb +16 -0
  206. data/lib/stripe/params/invoice_create_params.rb +589 -0
  207. data/lib/stripe/params/invoice_create_preview_params.rb +993 -0
  208. data/lib/stripe/params/invoice_delete_params.rb +6 -0
  209. data/lib/stripe/params/invoice_finalize_invoice_params.rb +16 -0
  210. data/lib/stripe/params/invoice_item_create_params.rb +145 -0
  211. data/lib/stripe/params/invoice_item_delete_params.rb +6 -0
  212. data/lib/stripe/params/invoice_item_list_params.rb +60 -0
  213. data/lib/stripe/params/invoice_item_retrieve_params.rb +13 -0
  214. data/lib/stripe/params/invoice_item_update_params.rb +129 -0
  215. data/lib/stripe/params/invoice_line_item_list_params.rb +22 -0
  216. data/lib/stripe/params/invoice_line_item_update_params.rb +217 -0
  217. data/lib/stripe/params/invoice_list_params.rb +86 -0
  218. data/lib/stripe/params/invoice_mark_uncollectible_params.rb +13 -0
  219. data/lib/stripe/params/invoice_pay_params.rb +41 -0
  220. data/lib/stripe/params/invoice_payment_list_params.rb +50 -0
  221. data/lib/stripe/params/invoice_payment_retrieve_params.rb +13 -0
  222. data/lib/stripe/params/invoice_remove_lines_params.rb +30 -0
  223. data/lib/stripe/params/invoice_rendering_template_archive_params.rb +13 -0
  224. data/lib/stripe/params/invoice_rendering_template_list_params.rb +25 -0
  225. data/lib/stripe/params/invoice_rendering_template_retrieve_params.rb +16 -0
  226. data/lib/stripe/params/invoice_rendering_template_unarchive_params.rb +13 -0
  227. data/lib/stripe/params/invoice_retrieve_params.rb +13 -0
  228. data/lib/stripe/params/invoice_search_params.rb +22 -0
  229. data/lib/stripe/params/invoice_send_invoice_params.rb +13 -0
  230. data/lib/stripe/params/invoice_update_lines_params.rb +231 -0
  231. data/lib/stripe/params/invoice_update_params.rb +557 -0
  232. data/lib/stripe/params/invoice_void_invoice_params.rb +13 -0
  233. data/lib/stripe/params/issuing/authorization_approve_params.rb +21 -0
  234. data/lib/stripe/params/issuing/authorization_capture_params.rb +265 -0
  235. data/lib/stripe/params/issuing/authorization_create_params.rb +357 -0
  236. data/lib/stripe/params/issuing/authorization_decline_params.rb +18 -0
  237. data/lib/stripe/params/issuing/authorization_expire_params.rb +15 -0
  238. data/lib/stripe/params/issuing/authorization_finalize_amount_params.rb +143 -0
  239. data/lib/stripe/params/issuing/authorization_increment_params.rb +21 -0
  240. data/lib/stripe/params/issuing/authorization_list_params.rb +62 -0
  241. data/lib/stripe/params/issuing/authorization_respond_params.rb +18 -0
  242. data/lib/stripe/params/issuing/authorization_retrieve_params.rb +15 -0
  243. data/lib/stripe/params/issuing/authorization_reverse_params.rb +18 -0
  244. data/lib/stripe/params/issuing/authorization_update_params.rb +18 -0
  245. data/lib/stripe/params/issuing/card_create_params.rb +213 -0
  246. data/lib/stripe/params/issuing/card_deliver_card_params.rb +15 -0
  247. data/lib/stripe/params/issuing/card_fail_card_params.rb +15 -0
  248. data/lib/stripe/params/issuing/card_list_params.rb +78 -0
  249. data/lib/stripe/params/issuing/card_retrieve_params.rb +15 -0
  250. data/lib/stripe/params/issuing/card_return_card_params.rb +15 -0
  251. data/lib/stripe/params/issuing/card_ship_card_params.rb +15 -0
  252. data/lib/stripe/params/issuing/card_submit_card_params.rb +15 -0
  253. data/lib/stripe/params/issuing/card_update_params.rb +181 -0
  254. data/lib/stripe/params/issuing/cardholder_create_params.rb +238 -0
  255. data/lib/stripe/params/issuing/cardholder_list_params.rb +66 -0
  256. data/lib/stripe/params/issuing/cardholder_retrieve_params.rb +15 -0
  257. data/lib/stripe/params/issuing/cardholder_update_params.rb +230 -0
  258. data/lib/stripe/params/issuing/dispute_create_params.rb +297 -0
  259. data/lib/stripe/params/issuing/dispute_list_params.rb +58 -0
  260. data/lib/stripe/params/issuing/dispute_retrieve_params.rb +15 -0
  261. data/lib/stripe/params/issuing/dispute_submit_params.rb +18 -0
  262. data/lib/stripe/params/issuing/dispute_update_params.rb +275 -0
  263. data/lib/stripe/params/issuing/personalization_design_activate_params.rb +15 -0
  264. data/lib/stripe/params/issuing/personalization_design_create_params.rb +75 -0
  265. data/lib/stripe/params/issuing/personalization_design_deactivate_params.rb +15 -0
  266. data/lib/stripe/params/issuing/personalization_design_list_params.rb +52 -0
  267. data/lib/stripe/params/issuing/personalization_design_reject_params.rb +29 -0
  268. data/lib/stripe/params/issuing/personalization_design_retrieve_params.rb +15 -0
  269. data/lib/stripe/params/issuing/personalization_design_update_params.rb +75 -0
  270. data/lib/stripe/params/issuing/physical_bundle_list_params.rb +37 -0
  271. data/lib/stripe/params/issuing/physical_bundle_retrieve_params.rb +15 -0
  272. data/lib/stripe/params/issuing/token_list_params.rb +58 -0
  273. data/lib/stripe/params/issuing/token_retrieve_params.rb +15 -0
  274. data/lib/stripe/params/issuing/token_update_params.rb +18 -0
  275. data/lib/stripe/params/issuing/transaction_create_force_capture_params.rb +316 -0
  276. data/lib/stripe/params/issuing/transaction_create_unlinked_refund_params.rb +316 -0
  277. data/lib/stripe/params/issuing/transaction_list_params.rb +62 -0
  278. data/lib/stripe/params/issuing/transaction_refund_params.rb +18 -0
  279. data/lib/stripe/params/issuing/transaction_retrieve_params.rb +15 -0
  280. data/lib/stripe/params/issuing/transaction_update_params.rb +18 -0
  281. data/lib/stripe/params/mandate_retrieve_params.rb +13 -0
  282. data/lib/stripe/params/payment_intent_apply_customer_balance_params.rb +23 -0
  283. data/lib/stripe/params/payment_intent_cancel_params.rb +16 -0
  284. data/lib/stripe/params/payment_intent_capture_params.rb +54 -0
  285. data/lib/stripe/params/payment_intent_confirm_params.rb +2379 -0
  286. data/lib/stripe/params/payment_intent_create_params.rb +2480 -0
  287. data/lib/stripe/params/payment_intent_increment_authorization_params.rb +48 -0
  288. data/lib/stripe/params/payment_intent_list_params.rb +52 -0
  289. data/lib/stripe/params/payment_intent_retrieve_params.rb +16 -0
  290. data/lib/stripe/params/payment_intent_search_params.rb +22 -0
  291. data/lib/stripe/params/payment_intent_update_params.rb +2353 -0
  292. data/lib/stripe/params/payment_intent_verify_microdeposits_params.rb +19 -0
  293. data/lib/stripe/params/payment_link_create_params.rb +776 -0
  294. data/lib/stripe/params/payment_link_line_item_list_params.rb +22 -0
  295. data/lib/stripe/params/payment_link_list_line_items_params.rb +22 -0
  296. data/lib/stripe/params/payment_link_list_params.rb +25 -0
  297. data/lib/stripe/params/payment_link_retrieve_params.rb +13 -0
  298. data/lib/stripe/params/payment_link_update_params.rb +564 -0
  299. data/lib/stripe/params/payment_method_attach_params.rb +16 -0
  300. data/lib/stripe/params/payment_method_configuration_create_params.rb +1135 -0
  301. data/lib/stripe/params/payment_method_configuration_list_params.rb +31 -0
  302. data/lib/stripe/params/payment_method_configuration_retrieve_params.rb +13 -0
  303. data/lib/stripe/params/payment_method_configuration_update_params.rb +1135 -0
  304. data/lib/stripe/params/payment_method_create_params.rb +583 -0
  305. data/lib/stripe/params/payment_method_detach_params.rb +13 -0
  306. data/lib/stripe/params/payment_method_domain_create_params.rb +19 -0
  307. data/lib/stripe/params/payment_method_domain_list_params.rb +35 -0
  308. data/lib/stripe/params/payment_method_domain_retrieve_params.rb +13 -0
  309. data/lib/stripe/params/payment_method_domain_update_params.rb +16 -0
  310. data/lib/stripe/params/payment_method_domain_validate_params.rb +13 -0
  311. data/lib/stripe/params/payment_method_list_params.rb +35 -0
  312. data/lib/stripe/params/payment_method_retrieve_params.rb +13 -0
  313. data/lib/stripe/params/payment_method_update_params.rb +120 -0
  314. data/lib/stripe/params/payout_cancel_params.rb +13 -0
  315. data/lib/stripe/params/payout_create_params.rb +51 -0
  316. data/lib/stripe/params/payout_list_params.rb +78 -0
  317. data/lib/stripe/params/payout_retrieve_params.rb +13 -0
  318. data/lib/stripe/params/payout_reverse_params.rb +16 -0
  319. data/lib/stripe/params/payout_update_params.rb +16 -0
  320. data/lib/stripe/params/plan_create_params.rb +158 -0
  321. data/lib/stripe/params/plan_delete_params.rb +6 -0
  322. data/lib/stripe/params/plan_list_params.rb +56 -0
  323. data/lib/stripe/params/plan_retrieve_params.rb +13 -0
  324. data/lib/stripe/params/plan_update_params.rb +35 -0
  325. data/lib/stripe/params/price_create_params.rb +278 -0
  326. data/lib/stripe/params/price_list_params.rb +87 -0
  327. data/lib/stripe/params/price_retrieve_params.rb +13 -0
  328. data/lib/stripe/params/price_search_params.rb +22 -0
  329. data/lib/stripe/params/price_update_params.rb +113 -0
  330. data/lib/stripe/params/product_create_params.rb +243 -0
  331. data/lib/stripe/params/product_delete_params.rb +6 -0
  332. data/lib/stripe/params/product_feature_create_params.rb +16 -0
  333. data/lib/stripe/params/product_feature_delete_params.rb +6 -0
  334. data/lib/stripe/params/product_feature_list_params.rb +22 -0
  335. data/lib/stripe/params/product_feature_retrieve_params.rb +13 -0
  336. data/lib/stripe/params/product_list_params.rb +68 -0
  337. data/lib/stripe/params/product_retrieve_params.rb +13 -0
  338. data/lib/stripe/params/product_search_params.rb +22 -0
  339. data/lib/stripe/params/product_update_params.rb +96 -0
  340. data/lib/stripe/params/promotion_code_create_params.rb +91 -0
  341. data/lib/stripe/params/promotion_code_list_params.rb +64 -0
  342. data/lib/stripe/params/promotion_code_retrieve_params.rb +13 -0
  343. data/lib/stripe/params/promotion_code_update_params.rb +38 -0
  344. data/lib/stripe/params/quote_accept_params.rb +13 -0
  345. data/lib/stripe/params/quote_cancel_params.rb +13 -0
  346. data/lib/stripe/params/quote_computed_upfront_line_items_list_params.rb +22 -0
  347. data/lib/stripe/params/quote_create_params.rb +301 -0
  348. data/lib/stripe/params/quote_finalize_quote_params.rb +16 -0
  349. data/lib/stripe/params/quote_line_item_list_params.rb +22 -0
  350. data/lib/stripe/params/quote_list_computed_upfront_line_items_params.rb +22 -0
  351. data/lib/stripe/params/quote_list_line_items_params.rb +22 -0
  352. data/lib/stripe/params/quote_list_params.rb +39 -0
  353. data/lib/stripe/params/quote_pdf_params.rb +13 -0
  354. data/lib/stripe/params/quote_retrieve_params.rb +13 -0
  355. data/lib/stripe/params/quote_update_params.rb +263 -0
  356. data/lib/stripe/params/radar/early_fraud_warning_list_params.rb +58 -0
  357. data/lib/stripe/params/radar/early_fraud_warning_retrieve_params.rb +15 -0
  358. data/lib/stripe/params/radar/value_list_create_params.rb +27 -0
  359. data/lib/stripe/params/radar/value_list_delete_params.rb +8 -0
  360. data/lib/stripe/params/radar/value_list_item_create_params.rb +21 -0
  361. data/lib/stripe/params/radar/value_list_item_delete_params.rb +8 -0
  362. data/lib/stripe/params/radar/value_list_item_list_params.rb +58 -0
  363. data/lib/stripe/params/radar/value_list_item_retrieve_params.rb +15 -0
  364. data/lib/stripe/params/radar/value_list_list_params.rb +58 -0
  365. data/lib/stripe/params/radar/value_list_retrieve_params.rb +15 -0
  366. data/lib/stripe/params/radar/value_list_update_params.rb +24 -0
  367. data/lib/stripe/params/refund_cancel_params.rb +13 -0
  368. data/lib/stripe/params/refund_create_params.rb +59 -0
  369. data/lib/stripe/params/refund_expire_params.rb +13 -0
  370. data/lib/stripe/params/refund_list_params.rb +56 -0
  371. data/lib/stripe/params/refund_retrieve_params.rb +13 -0
  372. data/lib/stripe/params/refund_update_params.rb +16 -0
  373. data/lib/stripe/params/reporting/report_run_create_params.rb +59 -0
  374. data/lib/stripe/params/reporting/report_run_list_params.rb +44 -0
  375. data/lib/stripe/params/reporting/report_run_retrieve_params.rb +15 -0
  376. data/lib/stripe/params/reporting/report_type_list_params.rb +15 -0
  377. data/lib/stripe/params/reporting/report_type_retrieve_params.rb +15 -0
  378. data/lib/stripe/params/review_approve_params.rb +13 -0
  379. data/lib/stripe/params/review_list_params.rb +42 -0
  380. data/lib/stripe/params/review_retrieve_params.rb +13 -0
  381. data/lib/stripe/params/setup_attempt_list_params.rb +55 -0
  382. data/lib/stripe/params/setup_intent_cancel_params.rb +16 -0
  383. data/lib/stripe/params/setup_intent_confirm_params.rb +1050 -0
  384. data/lib/stripe/params/setup_intent_create_params.rb +1130 -0
  385. data/lib/stripe/params/setup_intent_list_params.rb +62 -0
  386. data/lib/stripe/params/setup_intent_retrieve_params.rb +16 -0
  387. data/lib/stripe/params/setup_intent_update_params.rb +1025 -0
  388. data/lib/stripe/params/setup_intent_verify_microdeposits_params.rb +19 -0
  389. data/lib/stripe/params/shipping_rate_create_params.rb +103 -0
  390. data/lib/stripe/params/shipping_rate_list_params.rb +56 -0
  391. data/lib/stripe/params/shipping_rate_retrieve_params.rb +13 -0
  392. data/lib/stripe/params/shipping_rate_update_params.rb +44 -0
  393. data/lib/stripe/params/sigma/scheduled_query_run_list_params.rb +24 -0
  394. data/lib/stripe/params/sigma/scheduled_query_run_retrieve_params.rb +15 -0
  395. data/lib/stripe/params/source_create_params.rb +317 -0
  396. data/lib/stripe/params/source_detach_params.rb +13 -0
  397. data/lib/stripe/params/source_retrieve_params.rb +16 -0
  398. data/lib/stripe/params/source_transaction_list_params.rb +22 -0
  399. data/lib/stripe/params/source_update_params.rb +259 -0
  400. data/lib/stripe/params/source_verify_params.rb +16 -0
  401. data/lib/stripe/params/subscription_cancel_params.rb +33 -0
  402. data/lib/stripe/params/subscription_create_params.rb +704 -0
  403. data/lib/stripe/params/subscription_delete_discount_params.rb +6 -0
  404. data/lib/stripe/params/subscription_item_create_params.rb +134 -0
  405. data/lib/stripe/params/subscription_item_delete_params.rb +19 -0
  406. data/lib/stripe/params/subscription_item_list_params.rb +31 -0
  407. data/lib/stripe/params/subscription_item_retrieve_params.rb +13 -0
  408. data/lib/stripe/params/subscription_item_update_params.rb +134 -0
  409. data/lib/stripe/params/subscription_list_params.rb +129 -0
  410. data/lib/stripe/params/subscription_migrate_params.rb +35 -0
  411. data/lib/stripe/params/subscription_resume_params.rb +27 -0
  412. data/lib/stripe/params/subscription_retrieve_params.rb +13 -0
  413. data/lib/stripe/params/subscription_schedule_cancel_params.rb +19 -0
  414. data/lib/stripe/params/subscription_schedule_create_params.rb +590 -0
  415. data/lib/stripe/params/subscription_schedule_list_params.rb +122 -0
  416. data/lib/stripe/params/subscription_schedule_release_params.rb +16 -0
  417. data/lib/stripe/params/subscription_schedule_retrieve_params.rb +13 -0
  418. data/lib/stripe/params/subscription_schedule_update_params.rb +562 -0
  419. data/lib/stripe/params/subscription_search_params.rb +22 -0
  420. data/lib/stripe/params/subscription_update_params.rb +683 -0
  421. data/lib/stripe/params/tax/calculation_create_params.rb +206 -0
  422. data/lib/stripe/params/tax/calculation_line_item_list_params.rb +24 -0
  423. data/lib/stripe/{services/quote_preview_invoice_service.rb → params/tax/calculation_list_line_items_params.rb} +2 -13
  424. data/lib/stripe/params/tax/calculation_retrieve_params.rb +15 -0
  425. data/lib/stripe/params/tax/registration_create_params.rb +2018 -0
  426. data/lib/stripe/params/tax/registration_list_params.rb +27 -0
  427. data/lib/stripe/params/tax/registration_retrieve_params.rb +15 -0
  428. data/lib/stripe/params/tax/registration_update_params.rb +21 -0
  429. data/lib/stripe/params/tax/settings_retrieve_params.rb +15 -0
  430. data/lib/stripe/params/tax/settings_update_params.rb +71 -0
  431. data/lib/stripe/params/tax/transaction_create_from_calculation_params.rb +27 -0
  432. data/lib/stripe/params/tax/transaction_create_reversal_params.rb +87 -0
  433. data/lib/stripe/params/tax/transaction_line_item_list_params.rb +24 -0
  434. data/lib/stripe/{services/payment_intent_amount_details_line_item_service.rb → params/tax/transaction_list_line_items_params.rb} +2 -13
  435. data/lib/stripe/params/tax/transaction_retrieve_params.rb +15 -0
  436. data/lib/stripe/params/tax_code_list_params.rb +22 -0
  437. data/lib/stripe/params/tax_code_retrieve_params.rb +13 -0
  438. data/lib/stripe/params/tax_id_create_params.rb +36 -0
  439. data/lib/stripe/params/tax_id_delete_params.rb +6 -0
  440. data/lib/stripe/params/tax_id_list_params.rb +39 -0
  441. data/lib/stripe/params/tax_id_retrieve_params.rb +13 -0
  442. data/lib/stripe/params/tax_rate_create_params.rb +55 -0
  443. data/lib/stripe/params/tax_rate_list_params.rb +56 -0
  444. data/lib/stripe/params/tax_rate_retrieve_params.rb +13 -0
  445. data/lib/stripe/params/tax_rate_update_params.rb +47 -0
  446. data/lib/stripe/params/terminal/configuration_create_params.rb +593 -0
  447. data/lib/stripe/params/terminal/configuration_delete_params.rb +8 -0
  448. data/lib/stripe/params/terminal/configuration_list_params.rb +33 -0
  449. data/lib/stripe/params/terminal/configuration_retrieve_params.rb +15 -0
  450. data/lib/stripe/params/terminal/configuration_update_params.rb +593 -0
  451. data/lib/stripe/params/terminal/connection_token_create_params.rb +18 -0
  452. data/lib/stripe/params/terminal/location_create_params.rb +153 -0
  453. data/lib/stripe/params/terminal/location_delete_params.rb +8 -0
  454. data/lib/stripe/params/terminal/location_list_params.rb +24 -0
  455. data/lib/stripe/params/terminal/location_retrieve_params.rb +15 -0
  456. data/lib/stripe/params/terminal/location_update_params.rb +153 -0
  457. data/lib/stripe/params/terminal/reader_cancel_action_params.rb +15 -0
  458. data/lib/stripe/params/terminal/reader_collect_inputs_params.rb +96 -0
  459. data/lib/stripe/params/terminal/reader_collect_payment_method_params.rb +51 -0
  460. data/lib/stripe/params/terminal/reader_confirm_payment_intent_params.rb +29 -0
  461. data/lib/stripe/params/terminal/reader_create_params.rb +27 -0
  462. data/lib/stripe/params/terminal/reader_delete_params.rb +8 -0
  463. data/lib/stripe/params/terminal/reader_list_params.rb +45 -0
  464. data/lib/stripe/params/terminal/reader_present_payment_method_params.rb +72 -0
  465. data/lib/stripe/params/terminal/reader_process_payment_intent_params.rb +55 -0
  466. data/lib/stripe/params/terminal/reader_process_setup_intent_params.rb +32 -0
  467. data/lib/stripe/params/terminal/reader_refund_payment_params.rb +53 -0
  468. data/lib/stripe/params/terminal/reader_retrieve_params.rb +15 -0
  469. data/lib/stripe/params/terminal/reader_set_reader_display_params.rb +52 -0
  470. data/lib/stripe/params/terminal/reader_succeed_input_collection_params.rb +18 -0
  471. data/lib/stripe/params/terminal/reader_timeout_input_collection_params.rb +15 -0
  472. data/lib/stripe/params/terminal/reader_update_params.rb +21 -0
  473. data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +652 -0
  474. data/lib/stripe/params/test_helpers/customer_fund_cash_balance_params.rb +24 -0
  475. data/lib/stripe/params/test_helpers/issuing/authorization_capture_params.rb +267 -0
  476. data/lib/stripe/params/test_helpers/issuing/authorization_create_params.rb +359 -0
  477. data/lib/stripe/params/test_helpers/issuing/authorization_expire_params.rb +17 -0
  478. data/lib/stripe/params/test_helpers/issuing/authorization_finalize_amount_params.rb +145 -0
  479. data/lib/stripe/params/test_helpers/issuing/authorization_increment_params.rb +23 -0
  480. data/lib/stripe/params/test_helpers/issuing/authorization_respond_params.rb +20 -0
  481. data/lib/stripe/params/test_helpers/issuing/authorization_reverse_params.rb +20 -0
  482. data/lib/stripe/params/test_helpers/issuing/card_deliver_card_params.rb +17 -0
  483. data/lib/stripe/params/test_helpers/issuing/card_fail_card_params.rb +17 -0
  484. data/lib/stripe/params/test_helpers/issuing/card_return_card_params.rb +17 -0
  485. data/lib/stripe/params/test_helpers/issuing/card_ship_card_params.rb +17 -0
  486. data/lib/stripe/params/test_helpers/issuing/card_submit_card_params.rb +17 -0
  487. data/lib/stripe/params/test_helpers/issuing/personalization_design_activate_params.rb +17 -0
  488. data/lib/stripe/params/test_helpers/issuing/personalization_design_deactivate_params.rb +17 -0
  489. data/lib/stripe/params/test_helpers/issuing/personalization_design_reject_params.rb +31 -0
  490. data/lib/stripe/params/test_helpers/issuing/transaction_create_force_capture_params.rb +318 -0
  491. data/lib/stripe/params/test_helpers/issuing/transaction_create_unlinked_refund_params.rb +318 -0
  492. data/lib/stripe/params/test_helpers/issuing/transaction_refund_params.rb +20 -0
  493. data/lib/stripe/params/test_helpers/refund_expire_params.rb +15 -0
  494. data/lib/stripe/params/test_helpers/terminal/reader_present_payment_method_params.rb +74 -0
  495. data/lib/stripe/params/test_helpers/terminal/reader_succeed_input_collection_params.rb +20 -0
  496. data/lib/stripe/params/test_helpers/terminal/reader_timeout_input_collection_params.rb +17 -0
  497. data/lib/stripe/params/test_helpers/test_clock_advance_params.rb +18 -0
  498. data/lib/stripe/params/test_helpers/test_clock_create_params.rb +21 -0
  499. data/lib/stripe/params/test_helpers/test_clock_delete_params.rb +8 -0
  500. data/lib/stripe/params/test_helpers/test_clock_list_params.rb +24 -0
  501. data/lib/stripe/params/test_helpers/test_clock_retrieve_params.rb +15 -0
  502. data/lib/stripe/params/test_helpers/treasury/inbound_transfer_fail_params.rb +28 -0
  503. data/lib/stripe/params/test_helpers/treasury/inbound_transfer_return_inbound_transfer_params.rb +17 -0
  504. data/lib/stripe/params/test_helpers/treasury/inbound_transfer_succeed_params.rb +17 -0
  505. data/lib/stripe/params/test_helpers/treasury/outbound_payment_fail_params.rb +17 -0
  506. data/lib/stripe/params/test_helpers/treasury/outbound_payment_post_params.rb +17 -0
  507. data/lib/stripe/params/test_helpers/treasury/outbound_payment_return_outbound_payment_params.rb +28 -0
  508. data/lib/stripe/params/test_helpers/treasury/outbound_payment_update_params.rb +57 -0
  509. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_fail_params.rb +17 -0
  510. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_post_params.rb +17 -0
  511. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_return_outbound_transfer_params.rb +28 -0
  512. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_update_params.rb +57 -0
  513. data/lib/stripe/params/test_helpers/treasury/received_credit_create_params.rb +68 -0
  514. data/lib/stripe/params/test_helpers/treasury/received_debit_create_params.rb +68 -0
  515. data/lib/stripe/params/token_create_params.rb +1191 -0
  516. data/lib/stripe/params/token_retrieve_params.rb +13 -0
  517. data/lib/stripe/params/topup_cancel_params.rb +13 -0
  518. data/lib/stripe/params/topup_create_params.rb +43 -0
  519. data/lib/stripe/params/topup_list_params.rb +74 -0
  520. data/lib/stripe/params/topup_retrieve_params.rb +13 -0
  521. data/lib/stripe/params/topup_update_params.rb +19 -0
  522. data/lib/stripe/params/transfer_create_params.rb +47 -0
  523. data/lib/stripe/params/transfer_list_params.rb +56 -0
  524. data/lib/stripe/params/transfer_retrieve_params.rb +13 -0
  525. data/lib/stripe/params/transfer_reversal_create_params.rb +31 -0
  526. data/lib/stripe/params/transfer_reversal_list_params.rb +22 -0
  527. data/lib/stripe/params/transfer_reversal_retrieve_params.rb +13 -0
  528. data/lib/stripe/params/transfer_reversal_update_params.rb +16 -0
  529. data/lib/stripe/params/transfer_update_params.rb +19 -0
  530. data/lib/stripe/params/treasury/credit_reversal_create_params.rb +21 -0
  531. data/lib/stripe/params/treasury/credit_reversal_list_params.rb +41 -0
  532. data/lib/stripe/params/treasury/credit_reversal_retrieve_params.rb +15 -0
  533. data/lib/stripe/params/treasury/debit_reversal_create_params.rb +21 -0
  534. data/lib/stripe/params/treasury/debit_reversal_list_params.rb +45 -0
  535. data/lib/stripe/params/treasury/debit_reversal_retrieve_params.rb +15 -0
  536. data/lib/stripe/params/treasury/financial_account_close_params.rb +32 -0
  537. data/lib/stripe/params/treasury/financial_account_create_params.rb +201 -0
  538. data/lib/stripe/params/treasury/financial_account_features_retrieve_params.rb +15 -0
  539. data/lib/stripe/params/treasury/financial_account_features_update_params.rb +163 -0
  540. data/lib/stripe/params/treasury/financial_account_list_params.rb +54 -0
  541. data/lib/stripe/params/treasury/financial_account_retrieve_features_params.rb +15 -0
  542. data/lib/stripe/params/treasury/financial_account_retrieve_params.rb +15 -0
  543. data/lib/stripe/params/treasury/financial_account_update_features_params.rb +163 -0
  544. data/lib/stripe/params/treasury/financial_account_update_params.rb +216 -0
  545. data/lib/stripe/params/treasury/inbound_transfer_cancel_params.rb +15 -0
  546. data/lib/stripe/params/treasury/inbound_transfer_create_params.rb +45 -0
  547. data/lib/stripe/params/treasury/inbound_transfer_fail_params.rb +26 -0
  548. data/lib/stripe/params/treasury/inbound_transfer_list_params.rb +37 -0
  549. data/lib/stripe/params/treasury/inbound_transfer_retrieve_params.rb +15 -0
  550. data/lib/stripe/params/treasury/inbound_transfer_return_inbound_transfer_params.rb +15 -0
  551. data/lib/stripe/params/treasury/inbound_transfer_succeed_params.rb +15 -0
  552. data/lib/stripe/params/treasury/outbound_payment_cancel_params.rb +15 -0
  553. data/lib/stripe/params/treasury/outbound_payment_create_params.rb +190 -0
  554. data/lib/stripe/params/treasury/outbound_payment_fail_params.rb +15 -0
  555. data/lib/stripe/params/treasury/outbound_payment_list_params.rb +62 -0
  556. data/lib/stripe/params/treasury/outbound_payment_post_params.rb +15 -0
  557. data/lib/stripe/params/treasury/outbound_payment_retrieve_params.rb +15 -0
  558. data/lib/stripe/params/treasury/outbound_payment_return_outbound_payment_params.rb +26 -0
  559. data/lib/stripe/params/treasury/outbound_payment_update_params.rb +55 -0
  560. data/lib/stripe/params/treasury/outbound_transfer_cancel_params.rb +15 -0
  561. data/lib/stripe/params/treasury/outbound_transfer_create_params.rb +81 -0
  562. data/lib/stripe/params/treasury/outbound_transfer_fail_params.rb +15 -0
  563. data/lib/stripe/params/treasury/outbound_transfer_list_params.rb +37 -0
  564. data/lib/stripe/params/treasury/outbound_transfer_post_params.rb +15 -0
  565. data/lib/stripe/params/treasury/outbound_transfer_retrieve_params.rb +15 -0
  566. data/lib/stripe/params/treasury/outbound_transfer_return_outbound_transfer_params.rb +26 -0
  567. data/lib/stripe/params/treasury/outbound_transfer_update_params.rb +55 -0
  568. data/lib/stripe/params/treasury/received_credit_create_params.rb +66 -0
  569. data/lib/stripe/params/treasury/received_credit_list_params.rb +49 -0
  570. data/lib/stripe/params/treasury/received_credit_retrieve_params.rb +15 -0
  571. data/lib/stripe/params/treasury/received_debit_create_params.rb +66 -0
  572. data/lib/stripe/params/treasury/received_debit_list_params.rb +37 -0
  573. data/lib/stripe/params/treasury/received_debit_retrieve_params.rb +15 -0
  574. data/lib/stripe/params/treasury/transaction_entry_list_params.rb +84 -0
  575. data/lib/stripe/params/treasury/transaction_entry_retrieve_params.rb +15 -0
  576. data/lib/stripe/params/treasury/transaction_list_params.rb +92 -0
  577. data/lib/stripe/params/treasury/transaction_retrieve_params.rb +15 -0
  578. data/lib/stripe/params/v2/billing/meter_event_adjustment_create_params.rb +31 -0
  579. data/lib/stripe/params/v2/billing/meter_event_create_params.rb +33 -0
  580. data/lib/stripe/params/v2/billing/meter_event_session_create_params.rb +10 -0
  581. data/lib/stripe/params/v2/billing/meter_event_stream_create_params.rb +41 -0
  582. data/lib/stripe/params/v2/core/event_destination_create_params.rb +79 -0
  583. data/lib/stripe/params/v2/core/event_destination_delete_params.rb +10 -0
  584. data/lib/stripe/params/v2/core/event_destination_disable_params.rb +10 -0
  585. data/lib/stripe/params/v2/core/event_destination_enable_params.rb +10 -0
  586. data/lib/stripe/params/v2/core/event_destination_list_params.rb +20 -0
  587. data/lib/stripe/params/v2/core/event_destination_ping_params.rb +10 -0
  588. data/lib/stripe/params/v2/core/event_destination_retrieve_params.rb +17 -0
  589. data/lib/stripe/params/v2/core/event_destination_update_params.rb +47 -0
  590. data/lib/stripe/params/v2/core/event_list_params.rb +22 -0
  591. data/lib/stripe/params/v2/core/event_retrieve_params.rb +10 -0
  592. data/lib/stripe/params/webhook_endpoint_create_params.rb +39 -0
  593. data/lib/stripe/params/webhook_endpoint_delete_params.rb +6 -0
  594. data/lib/stripe/params/webhook_endpoint_list_params.rb +22 -0
  595. data/lib/stripe/params/webhook_endpoint_retrieve_params.rb +13 -0
  596. data/lib/stripe/params/webhook_endpoint_update_params.rb +35 -0
  597. data/lib/stripe/params.rb +588 -0
  598. data/lib/stripe/request_options.rb +14 -5
  599. data/lib/stripe/resources/account.rb +437 -4906
  600. data/lib/stripe/resources/account_link.rb +8 -47
  601. data/lib/stripe/resources/account_session.rb +338 -910
  602. data/lib/stripe/resources/apple_pay_domain.rb +8 -40
  603. data/lib/stripe/resources/application.rb +8 -0
  604. data/lib/stripe/resources/application_fee.rb +12 -44
  605. data/lib/stripe/resources/application_fee_refund.rb +8 -0
  606. data/lib/stripe/resources/apps/secret.rb +12 -112
  607. data/lib/stripe/resources/balance.rb +159 -0
  608. data/lib/stripe/resources/balance_settings.rb +40 -60
  609. data/lib/stripe/resources/balance_transaction.rb +12 -56
  610. data/lib/stripe/resources/bank_account.rb +40 -0
  611. data/lib/stripe/resources/billing/alert.rb +20 -100
  612. data/lib/stripe/resources/billing/alert_triggered.rb +8 -0
  613. data/lib/stripe/resources/billing/credit_balance_summary.rb +48 -2
  614. data/lib/stripe/resources/billing/credit_balance_transaction.rb +73 -33
  615. data/lib/stripe/resources/billing/credit_grant.rb +42 -161
  616. data/lib/stripe/resources/billing/meter.rb +40 -116
  617. data/lib/stripe/resources/billing/meter_event.rb +8 -20
  618. data/lib/stripe/resources/billing/meter_event_adjustment.rb +12 -22
  619. data/lib/stripe/resources/billing/meter_event_summary.rb +8 -0
  620. data/lib/stripe/resources/billing_portal/configuration.rb +120 -473
  621. data/lib/stripe/resources/billing_portal/session.rb +98 -176
  622. data/lib/stripe/resources/capability.rb +56 -0
  623. data/lib/stripe/resources/card.rb +17 -3
  624. data/lib/stripe/resources/cash_balance.rb +16 -2
  625. data/lib/stripe/resources/charge.rb +949 -1945
  626. data/lib/stripe/resources/checkout/session.rb +1038 -2991
  627. data/lib/stripe/resources/climate/order.rb +28 -89
  628. data/lib/stripe/resources/climate/product.rb +13 -15
  629. data/lib/stripe/resources/climate/supplier.rb +13 -15
  630. data/lib/stripe/resources/confirmation_token.rb +883 -841
  631. data/lib/stripe/resources/connect_collection_transfer.rb +8 -0
  632. data/lib/stripe/resources/country_spec.rb +29 -15
  633. data/lib/stripe/resources/coupon.rb +19 -166
  634. data/lib/stripe/resources/credit_note.rb +66 -510
  635. data/lib/stripe/resources/credit_note_line_item.rb +43 -8
  636. data/lib/stripe/resources/customer.rb +81 -677
  637. data/lib/stripe/resources/customer_balance_transaction.rb +8 -2
  638. data/lib/stripe/resources/customer_cash_balance_transaction.rb +108 -2
  639. data/lib/stripe/resources/customer_session.rb +49 -98
  640. data/lib/stripe/resources/discount.rb +24 -6
  641. data/lib/stripe/resources/dispute.rb +159 -376
  642. data/lib/stripe/resources/entitlements/active_entitlement.rb +8 -26
  643. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +8 -0
  644. data/lib/stripe/resources/entitlements/feature.rb +8 -66
  645. data/lib/stripe/resources/ephemeral_key.rb +8 -8
  646. data/lib/stripe/resources/event.rb +16 -79
  647. data/lib/stripe/resources/exchange_rate.rb +18 -17
  648. data/lib/stripe/resources/file.rb +8 -79
  649. data/lib/stripe/resources/file_link.rb +8 -84
  650. data/lib/stripe/resources/financial_connections/account.rb +65 -130
  651. data/lib/stripe/resources/financial_connections/account_owner.rb +8 -0
  652. data/lib/stripe/resources/financial_connections/account_ownership.rb +8 -0
  653. data/lib/stripe/resources/financial_connections/session.rb +20 -115
  654. data/lib/stripe/resources/financial_connections/transaction.rb +12 -57
  655. data/lib/stripe/resources/forwarding/request.rb +48 -93
  656. data/lib/stripe/resources/funding_instructions.rb +217 -24
  657. data/lib/stripe/resources/identity/verification_report.rb +165 -56
  658. data/lib/stripe/resources/identity/verification_session.rb +124 -247
  659. data/lib/stripe/resources/invoice.rb +500 -4017
  660. data/lib/stripe/resources/invoice_item.rb +69 -385
  661. data/lib/stripe/resources/invoice_line_item.rb +124 -251
  662. data/lib/stripe/resources/invoice_payment.rb +20 -47
  663. data/lib/stripe/resources/invoice_rendering_template.rb +8 -38
  664. data/lib/stripe/resources/issuing/authorization.rb +173 -836
  665. data/lib/stripe/resources/issuing/card.rb +98 -499
  666. data/lib/stripe/resources/issuing/cardholder.rb +108 -515
  667. data/lib/stripe/resources/issuing/dispute.rb +93 -620
  668. data/lib/stripe/resources/issuing/personalization_design.rb +32 -221
  669. data/lib/stripe/resources/issuing/physical_bundle.rb +13 -28
  670. data/lib/stripe/resources/issuing/token.rb +57 -60
  671. data/lib/stripe/resources/issuing/transaction.rb +147 -702
  672. data/lib/stripe/resources/line_item.rb +22 -35
  673. data/lib/stripe/resources/login_link.rb +8 -0
  674. data/lib/stripe/resources/mandate.rb +219 -94
  675. data/lib/stripe/resources/payment_intent.rb +1241 -13361
  676. data/lib/stripe/resources/payment_link.rb +333 -1357
  677. data/lib/stripe/resources/payment_method.rb +796 -966
  678. data/lib/stripe/resources/payment_method_configuration.rb +862 -2528
  679. data/lib/stripe/resources/payment_method_domain.rb +107 -63
  680. data/lib/stripe/resources/payout.rb +12 -150
  681. data/lib/stripe/resources/person.rb +184 -4
  682. data/lib/stripe/resources/plan.rb +20 -235
  683. data/lib/stripe/resources/price.rb +65 -509
  684. data/lib/stripe/resources/product.rb +23 -411
  685. data/lib/stripe/resources/product_feature.rb +8 -0
  686. data/lib/stripe/resources/promotion_code.rb +40 -182
  687. data/lib/stripe/resources/quote.rb +280 -2743
  688. data/lib/stripe/resources/radar/early_fraud_warning.rb +8 -51
  689. data/lib/stripe/resources/radar/value_list.rb +8 -92
  690. data/lib/stripe/resources/radar/value_list_item.rb +8 -68
  691. data/lib/stripe/resources/refund.rb +365 -159
  692. data/lib/stripe/resources/reporting/report_run.rb +12 -93
  693. data/lib/stripe/resources/reporting/report_type.rb +8 -8
  694. data/lib/stripe/resources/reserve_transaction.rb +8 -0
  695. data/lib/stripe/resources/reversal.rb +8 -0
  696. data/lib/stripe/resources/review.rb +20 -43
  697. data/lib/stripe/resources/setup_attempt.rb +284 -87
  698. data/lib/stripe/resources/setup_intent.rb +358 -4143
  699. data/lib/stripe/resources/shipping_rate.rb +44 -187
  700. data/lib/stripe/resources/sigma/scheduled_query_run.rb +13 -15
  701. data/lib/stripe/resources/source.rb +267 -611
  702. data/lib/stripe/resources/source_mandate_notification.rb +32 -0
  703. data/lib/stripe/resources/source_transaction.rb +54 -0
  704. data/lib/stripe/resources/subscription.rb +266 -1931
  705. data/lib/stripe/resources/subscription_item.rb +12 -379
  706. data/lib/stripe/resources/subscription_schedule.rb +230 -2273
  707. data/lib/stripe/resources/tax/calculation.rb +111 -220
  708. data/lib/stripe/resources/tax/calculation_line_item.rb +32 -0
  709. data/lib/stripe/resources/tax/registration.rb +1274 -2096
  710. data/lib/stripe/resources/tax/settings.rb +61 -64
  711. data/lib/stripe/resources/tax/transaction.rb +95 -122
  712. data/lib/stripe/resources/tax/transaction_line_item.rb +16 -0
  713. data/lib/stripe/resources/tax_code.rb +8 -17
  714. data/lib/stripe/resources/tax_deducted_at_source.rb +8 -0
  715. data/lib/stripe/resources/tax_id.rb +20 -75
  716. data/lib/stripe/resources/tax_rate.rb +12 -142
  717. data/lib/stripe/resources/terminal/configuration.rb +301 -1205
  718. data/lib/stripe/resources/terminal/connection_token.rb +8 -11
  719. data/lib/stripe/resources/terminal/location.rb +72 -126
  720. data/lib/stripe/resources/terminal/reader.rb +237 -509
  721. data/lib/stripe/resources/test_helpers/test_clock.rb +20 -43
  722. data/lib/stripe/resources/token.rb +8 -1191
  723. data/lib/stripe/resources/topup.rb +8 -132
  724. data/lib/stripe/resources/transfer.rb +8 -115
  725. data/lib/stripe/resources/treasury/credit_reversal.rb +12 -46
  726. data/lib/stripe/resources/treasury/debit_reversal.rb +20 -50
  727. data/lib/stripe/resources/treasury/financial_account.rb +55 -658
  728. data/lib/stripe/resources/treasury/financial_account_features.rb +192 -2
  729. data/lib/stripe/resources/treasury/inbound_transfer.rb +67 -115
  730. data/lib/stripe/resources/treasury/outbound_payment.rb +104 -334
  731. data/lib/stripe/resources/treasury/outbound_transfer.rb +93 -235
  732. data/lib/stripe/resources/treasury/received_credit.rb +76 -136
  733. data/lib/stripe/resources/treasury/received_debit.rb +68 -126
  734. data/lib/stripe/resources/treasury/transaction.rb +32 -82
  735. data/lib/stripe/resources/treasury/transaction_entry.rb +20 -74
  736. data/lib/stripe/resources/v2/billing/meter_event.rb +8 -0
  737. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +16 -0
  738. data/lib/stripe/resources/v2/billing/meter_event_session.rb +8 -0
  739. data/lib/stripe/resources/v2/core/event.rb +67 -0
  740. data/lib/stripe/resources/v2/core/event_destination.rb +119 -0
  741. data/lib/stripe/resources/v2/core/event_notification.rb +62 -0
  742. data/lib/stripe/resources/v2/deleted_object.rb +21 -0
  743. data/lib/stripe/resources/webhook_endpoint.rb +8 -85
  744. data/lib/stripe/resources.rb +3 -110
  745. data/lib/stripe/services/account_capability_service.rb +0 -32
  746. data/lib/stripe/services/account_external_account_service.rb +0 -249
  747. data/lib/stripe/services/account_link_service.rb +0 -48
  748. data/lib/stripe/services/account_login_link_service.rb +0 -9
  749. data/lib/stripe/services/account_person_service.rb +0 -958
  750. data/lib/stripe/services/account_service.rb +0 -4710
  751. data/lib/stripe/services/account_session_service.rb +0 -862
  752. data/lib/stripe/services/apple_pay_domain_service.rb +0 -50
  753. data/lib/stripe/services/application_fee_refund_service.rb +0 -54
  754. data/lib/stripe/services/application_fee_service.rb +0 -57
  755. data/lib/stripe/services/apps/secret_service.rb +0 -116
  756. data/lib/stripe/services/balance_service.rb +0 -9
  757. data/lib/stripe/services/balance_settings_service.rb +0 -69
  758. data/lib/stripe/services/balance_transaction_service.rb +0 -69
  759. data/lib/stripe/services/billing/alert_service.rb +0 -113
  760. data/lib/stripe/services/billing/credit_balance_summary_service.rb +0 -51
  761. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -44
  762. data/lib/stripe/services/billing/credit_grant_service.rb +0 -174
  763. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +0 -26
  764. data/lib/stripe/services/billing/meter_event_service.rb +0 -21
  765. data/lib/stripe/services/billing/meter_event_summary_service.rb +0 -39
  766. data/lib/stripe/services/billing/meter_service.rb +0 -130
  767. data/lib/stripe/services/billing_portal/configuration_service.rb +0 -486
  768. data/lib/stripe/services/billing_portal/session_service.rb +0 -177
  769. data/lib/stripe/services/billing_service.rb +1 -2
  770. data/lib/stripe/services/charge_service.rb +0 -1820
  771. data/lib/stripe/services/checkout/session_line_item_service.rb +0 -18
  772. data/lib/stripe/services/checkout/session_service.rb +0 -2882
  773. data/lib/stripe/services/climate/order_service.rb +0 -102
  774. data/lib/stripe/services/climate/product_service.rb +0 -27
  775. data/lib/stripe/services/climate/supplier_service.rb +0 -27
  776. data/lib/stripe/services/confirmation_token_service.rb +0 -9
  777. data/lib/stripe/services/country_spec_service.rb +0 -27
  778. data/lib/stripe/services/coupon_service.rb +0 -167
  779. data/lib/stripe/services/credit_note_line_item_service.rb +0 -18
  780. data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -152
  781. data/lib/stripe/services/credit_note_service.rb +0 -369
  782. data/lib/stripe/services/customer_balance_transaction_service.rb +0 -63
  783. data/lib/stripe/services/customer_cash_balance_service.rb +0 -29
  784. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +0 -27
  785. data/lib/stripe/services/customer_funding_instructions_service.rb +0 -42
  786. data/lib/stripe/services/customer_payment_method_service.rb +0 -40
  787. data/lib/stripe/services/customer_payment_source_service.rb +0 -179
  788. data/lib/stripe/services/customer_service.rb +0 -575
  789. data/lib/stripe/services/customer_session_service.rb +0 -99
  790. data/lib/stripe/services/customer_tax_id_service.rb +0 -44
  791. data/lib/stripe/services/dispute_service.rb +0 -374
  792. data/lib/stripe/services/entitlements/active_entitlement_service.rb +0 -36
  793. data/lib/stripe/services/entitlements/feature_service.rb +0 -76
  794. data/lib/stripe/services/ephemeral_key_service.rb +0 -36
  795. data/lib/stripe/services/event_service.rb +0 -65
  796. data/lib/stripe/services/exchange_rate_service.rb +4 -27
  797. data/lib/stripe/services/file_link_service.rb +0 -94
  798. data/lib/stripe/services/file_service.rb +0 -89
  799. data/lib/stripe/services/financial_connections/account_owner_service.rb +0 -27
  800. data/lib/stripe/services/financial_connections/account_service.rb +1 -102
  801. data/lib/stripe/services/financial_connections/session_service.rb +0 -100
  802. data/lib/stripe/services/financial_connections/transaction_service.rb +0 -70
  803. data/lib/stripe/services/financial_connections_service.rb +1 -2
  804. data/lib/stripe/services/forwarding/request_service.rb +0 -106
  805. data/lib/stripe/services/identity/verification_report_service.rb +0 -65
  806. data/lib/stripe/services/identity/verification_session_service.rb +0 -255
  807. data/lib/stripe/services/invoice_item_service.rb +0 -405
  808. data/lib/stripe/services/invoice_line_item_service.rb +0 -253
  809. data/lib/stripe/services/invoice_payment_service.rb +0 -58
  810. data/lib/stripe/services/invoice_rendering_template_service.rb +0 -51
  811. data/lib/stripe/services/invoice_service.rb +0 -3836
  812. data/lib/stripe/services/issuing/authorization_service.rb +0 -104
  813. data/lib/stripe/services/issuing/card_service.rb +0 -463
  814. data/lib/stripe/services/issuing/cardholder_service.rb +0 -526
  815. data/lib/stripe/services/issuing/dispute_service.rb +0 -633
  816. data/lib/stripe/services/issuing/personalization_design_service.rb +0 -193
  817. data/lib/stripe/services/issuing/physical_bundle_service.rb +0 -40
  818. data/lib/stripe/services/issuing/token_service.rb +0 -73
  819. data/lib/stripe/services/issuing/transaction_service.rb +0 -81
  820. data/lib/stripe/services/issuing_service.rb +1 -5
  821. data/lib/stripe/services/mandate_service.rb +0 -49
  822. data/lib/stripe/services/payment_intent_service.rb +0 -12747
  823. data/lib/stripe/services/payment_link_line_item_service.rb +0 -18
  824. data/lib/stripe/services/payment_link_service.rb +0 -1352
  825. data/lib/stripe/services/payment_method_configuration_service.rb +0 -2466
  826. data/lib/stripe/services/payment_method_domain_service.rb +0 -76
  827. data/lib/stripe/services/payment_method_service.rb +0 -881
  828. data/lib/stripe/services/payout_service.rb +0 -163
  829. data/lib/stripe/services/plan_service.rb +0 -248
  830. data/lib/stripe/services/price_service.rb +0 -512
  831. data/lib/stripe/services/product_feature_service.rb +0 -41
  832. data/lib/stripe/services/product_service.rb +0 -424
  833. data/lib/stripe/services/promotion_code_service.rb +1 -187
  834. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +0 -18
  835. data/lib/stripe/services/quote_line_item_service.rb +0 -18
  836. data/lib/stripe/services/quote_service.rb +1 -2344
  837. data/lib/stripe/services/radar/early_fraud_warning_service.rb +0 -61
  838. data/lib/stripe/services/radar/value_list_item_service.rb +0 -78
  839. data/lib/stripe/services/radar/value_list_service.rb +0 -102
  840. data/lib/stripe/services/refund_service.rb +0 -137
  841. data/lib/stripe/services/reporting/report_run_service.rb +0 -106
  842. data/lib/stripe/services/reporting/report_type_service.rb +0 -18
  843. data/lib/stripe/services/review_service.rb +0 -56
  844. data/lib/stripe/services/setup_attempt_service.rb +0 -51
  845. data/lib/stripe/services/setup_intent_service.rb +0 -3957
  846. data/lib/stripe/services/shipping_rate_service.rb +0 -200
  847. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +0 -27
  848. data/lib/stripe/services/source_service.rb +0 -601
  849. data/lib/stripe/services/source_transaction_service.rb +0 -18
  850. data/lib/stripe/services/subscription_item_service.rb +0 -383
  851. data/lib/stripe/services/subscription_schedule_service.rb +0 -2196
  852. data/lib/stripe/services/subscription_service.rb +0 -1894
  853. data/lib/stripe/services/tax/calculation_line_item_service.rb +0 -18
  854. data/lib/stripe/services/tax/calculation_service.rb +0 -209
  855. data/lib/stripe/services/tax/registration_service.rb +0 -2063
  856. data/lib/stripe/services/tax/settings_service.rb +0 -74
  857. data/lib/stripe/services/tax/transaction_line_item_service.rb +0 -18
  858. data/lib/stripe/services/tax/transaction_service.rb +0 -111
  859. data/lib/stripe/services/tax_code_service.rb +0 -27
  860. data/lib/stripe/services/tax_id_service.rb +0 -84
  861. data/lib/stripe/services/tax_rate_service.rb +0 -155
  862. data/lib/stripe/services/tax_service.rb +1 -3
  863. data/lib/stripe/services/terminal/configuration_service.rb +0 -1212
  864. data/lib/stripe/services/terminal/connection_token_service.rb +0 -12
  865. data/lib/stripe/services/terminal/location_service.rb +0 -143
  866. data/lib/stripe/services/terminal/reader_service.rb +0 -427
  867. data/lib/stripe/services/terminal_service.rb +1 -3
  868. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +0 -738
  869. data/lib/stripe/services/test_helpers/customer_service.rb +0 -18
  870. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +0 -745
  871. data/lib/stripe/services/test_helpers/issuing/card_service.rb +0 -45
  872. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +0 -41
  873. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +0 -632
  874. data/lib/stripe/services/test_helpers/refund_service.rb +0 -9
  875. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -87
  876. data/lib/stripe/services/test_helpers/test_clock_service.rb +0 -56
  877. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +0 -38
  878. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +0 -87
  879. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +0 -87
  880. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +0 -84
  881. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +0 -84
  882. data/lib/stripe/services/token_service.rb +0 -1201
  883. data/lib/stripe/services/topup_service.rb +0 -142
  884. data/lib/stripe/services/transfer_reversal_service.rb +0 -66
  885. data/lib/stripe/services/transfer_service.rb +0 -123
  886. data/lib/stripe/services/treasury/credit_reversal_service.rb +0 -59
  887. data/lib/stripe/services/treasury/debit_reversal_service.rb +0 -63
  888. data/lib/stripe/services/treasury/financial_account_features_service.rb +0 -169
  889. data/lib/stripe/services/treasury/financial_account_service.rb +0 -502
  890. data/lib/stripe/services/treasury/inbound_transfer_service.rb +0 -88
  891. data/lib/stripe/services/treasury/outbound_payment_service.rb +0 -258
  892. data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -148
  893. data/lib/stripe/services/treasury/received_credit_service.rb +0 -52
  894. data/lib/stripe/services/treasury/received_debit_service.rb +0 -40
  895. data/lib/stripe/services/treasury/transaction_entry_service.rb +0 -87
  896. data/lib/stripe/services/treasury/transaction_service.rb +0 -95
  897. data/lib/stripe/services/v1_services.rb +1 -10
  898. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +0 -23
  899. data/lib/stripe/services/v2/billing/meter_event_service.rb +0 -25
  900. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +0 -2
  901. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +0 -33
  902. data/lib/stripe/services/v2/core/event_destination_service.rb +0 -137
  903. data/lib/stripe/services/v2/core/event_service.rb +0 -16
  904. data/lib/stripe/services/v2/core_service.rb +1 -4
  905. data/lib/stripe/services/v2_services.rb +1 -4
  906. data/lib/stripe/services/webhook_endpoint_service.rb +0 -95
  907. data/lib/stripe/services.rb +0 -54
  908. data/lib/stripe/stripe_client.rb +8 -5
  909. data/lib/stripe/stripe_configuration.rb +2 -9
  910. data/lib/stripe/stripe_context.rb +68 -0
  911. data/lib/stripe/stripe_object.rb +34 -10
  912. data/lib/stripe/util.rb +25 -20
  913. data/lib/stripe/version.rb +1 -1
  914. data/lib/stripe.rb +3 -54
  915. data/rbi/stripe/resources/v2/core/event_notification.rbi +43 -0
  916. data/rbi/stripe/stripe_client.rbi +17 -0
  917. data/rbi/stripe.rbi +121931 -190301
  918. metadata +599 -189
  919. data/API_VERSION +0 -1
  920. data/CHANGELOG.md +0 -2780
  921. data/CODE_OF_CONDUCT.md +0 -77
  922. data/CONTRIBUTING.md +0 -25
  923. data/CONTRIBUTORS +0 -3
  924. data/Gemfile +0 -41
  925. data/History.txt +0 -1
  926. data/LICENSE +0 -21
  927. data/Makefile +0 -22
  928. data/OPENAPI_VERSION +0 -1
  929. data/README.md +0 -424
  930. data/Rakefile +0 -34
  931. data/VERSION +0 -1
  932. data/examples/README.md +0 -16
  933. data/examples/example_template.rb +0 -36
  934. data/examples/meter_event_stream.rb +0 -57
  935. data/examples/thinevent_webhook_handler.rb +0 -39
  936. data/justfile +0 -43
  937. data/lib/stripe/events/v2_core_account_closed_event.rb +0 -21
  938. data/lib/stripe/events/v2_core_account_created_event.rb +0 -21
  939. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +0 -23
  940. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +0 -21
  941. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +0 -23
  942. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +0 -21
  943. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +0 -23
  944. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +0 -21
  945. data/lib/stripe/events/v2_core_account_including_configuration_storer_capability_status_updated_event.rb +0 -23
  946. data/lib/stripe/events/v2_core_account_including_configuration_storer_updated_event.rb +0 -21
  947. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +0 -21
  948. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +0 -21
  949. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +0 -21
  950. data/lib/stripe/events/v2_core_account_link_returned_event.rb +0 -13
  951. data/lib/stripe/events/v2_core_account_person_created_event.rb +0 -23
  952. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +0 -23
  953. data/lib/stripe/events/v2_core_account_person_updated_event.rb +0 -23
  954. data/lib/stripe/events/v2_core_account_updated_event.rb +0 -21
  955. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +0 -21
  956. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +0 -21
  957. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +0 -21
  958. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +0 -21
  959. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +0 -21
  960. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +0 -23
  961. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +0 -21
  962. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +0 -21
  963. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +0 -21
  964. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +0 -21
  965. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +0 -21
  966. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +0 -21
  967. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +0 -21
  968. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +0 -21
  969. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +0 -21
  970. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +0 -21
  971. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +0 -21
  972. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +0 -21
  973. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +0 -21
  974. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +0 -21
  975. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +0 -21
  976. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +0 -21
  977. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +0 -21
  978. data/lib/stripe/events/v2_money_management_payout_method_updated_event.rb +0 -21
  979. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +0 -23
  980. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +0 -21
  981. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +0 -21
  982. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +0 -21
  983. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +0 -21
  984. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +0 -21
  985. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +0 -21
  986. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +0 -21
  987. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +0 -21
  988. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +0 -21
  989. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +0 -21
  990. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +0 -21
  991. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +0 -22
  992. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +0 -21
  993. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +0 -21
  994. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +0 -21
  995. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +0 -21
  996. data/lib/stripe/resources/account_notice.rb +0 -123
  997. data/lib/stripe/resources/billing/meter_usage.rb +0 -23
  998. data/lib/stripe/resources/billing/meter_usage_row.rb +0 -28
  999. data/lib/stripe/resources/capital/financing_offer.rb +0 -179
  1000. data/lib/stripe/resources/capital/financing_summary.rb +0 -55
  1001. data/lib/stripe/resources/capital/financing_transaction.rb +0 -114
  1002. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
  1003. data/lib/stripe/resources/financial_connections/institution.rb +0 -92
  1004. data/lib/stripe/resources/fx_quote.rb +0 -186
  1005. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -602
  1006. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -82
  1007. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -86
  1008. data/lib/stripe/resources/issuing/settlement.rb +0 -53
  1009. data/lib/stripe/resources/margin.rb +0 -115
  1010. data/lib/stripe/resources/order.rb +0 -2958
  1011. data/lib/stripe/resources/payment_attempt_record.rb +0 -1181
  1012. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +0 -72
  1013. data/lib/stripe/resources/payment_record.rb +0 -1727
  1014. data/lib/stripe/resources/privacy/redaction_job.rb +0 -298
  1015. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +0 -33
  1016. data/lib/stripe/resources/quote_line.rb +0 -274
  1017. data/lib/stripe/resources/quote_preview_invoice.rb +0 -680
  1018. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -395
  1019. data/lib/stripe/resources/tax/association.rb +0 -66
  1020. data/lib/stripe/resources/tax/form.rb +0 -211
  1021. data/lib/stripe/resources/terminal/onboarding_link.rb +0 -84
  1022. data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -31
  1023. data/lib/stripe/resources/v2/core/account.rb +0 -1938
  1024. data/lib/stripe/resources/v2/core/account_link.rb +0 -72
  1025. data/lib/stripe/resources/v2/core/person.rb +0 -276
  1026. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +0 -74
  1027. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +0 -39
  1028. data/lib/stripe/resources/v2/event.rb +0 -41
  1029. data/lib/stripe/resources/v2/event_destination.rb +0 -73
  1030. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +0 -20
  1031. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +0 -22
  1032. data/lib/stripe/resources/v2/money_management/adjustment.rb +0 -51
  1033. data/lib/stripe/resources/v2/money_management/financial_account.rb +0 -79
  1034. data/lib/stripe/resources/v2/money_management/financial_address.rb +0 -68
  1035. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +0 -94
  1036. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +0 -129
  1037. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +0 -82
  1038. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +0 -45
  1039. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +0 -117
  1040. data/lib/stripe/resources/v2/money_management/payout_method.rb +0 -77
  1041. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +0 -49
  1042. data/lib/stripe/resources/v2/money_management/received_credit.rb +0 -122
  1043. data/lib/stripe/resources/v2/money_management/received_debit.rb +0 -84
  1044. data/lib/stripe/resources/v2/money_management/transaction.rb +0 -80
  1045. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +0 -70
  1046. data/lib/stripe/resources/v2/payments/off_session_payment.rb +0 -89
  1047. data/lib/stripe/services/account_notice_service.rb +0 -101
  1048. data/lib/stripe/services/billing/meter_usage_service.rb +0 -76
  1049. data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
  1050. data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
  1051. data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
  1052. data/lib/stripe/services/capital_service.rb +0 -15
  1053. data/lib/stripe/services/external_account_service.rb +0 -317
  1054. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -37
  1055. data/lib/stripe/services/financial_connections/institution_service.rb +0 -57
  1056. data/lib/stripe/services/fx_quote_service.rb +0 -123
  1057. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
  1058. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
  1059. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
  1060. data/lib/stripe/services/margin_service.rb +0 -119
  1061. data/lib/stripe/services/order_service.rb +0 -2388
  1062. data/lib/stripe/services/payment_attempt_record_service.rb +0 -52
  1063. data/lib/stripe/services/payment_record_service.rb +0 -562
  1064. data/lib/stripe/services/privacy/redaction_job_service.rb +0 -240
  1065. data/lib/stripe/services/privacy/redaction_job_validation_error_service.rb +0 -37
  1066. data/lib/stripe/services/privacy_service.rb +0 -13
  1067. data/lib/stripe/services/tax/association_service.rb +0 -31
  1068. data/lib/stripe/services/tax/form_service.rb +0 -100
  1069. data/lib/stripe/services/terminal/onboarding_link_service.rb +0 -56
  1070. data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
  1071. data/lib/stripe/services/v2/core/account_link_service.rb +0 -114
  1072. data/lib/stripe/services/v2/core/account_service.rb +0 -4536
  1073. data/lib/stripe/services/v2/core/accounts/person_service.rb +0 -1045
  1074. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +0 -130
  1075. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +0 -107
  1076. data/lib/stripe/services/v2/core/vault_service.rb +0 -18
  1077. data/lib/stripe/services/v2/money_management/adjustment_service.rb +0 -74
  1078. data/lib/stripe/services/v2/money_management/financial_account_service.rb +0 -119
  1079. data/lib/stripe/services/v2/money_management/financial_address_service.rb +0 -82
  1080. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +0 -125
  1081. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +0 -95
  1082. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +0 -199
  1083. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +0 -235
  1084. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +0 -172
  1085. data/lib/stripe/services/v2/money_management/payout_method_service.rb +0 -90
  1086. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +0 -32
  1087. data/lib/stripe/services/v2/money_management/received_credit_service.rb +0 -70
  1088. data/lib/stripe/services/v2/money_management/received_debit_service.rb +0 -43
  1089. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +0 -69
  1090. data/lib/stripe/services/v2/money_management/transaction_service.rb +0 -73
  1091. data/lib/stripe/services/v2/money_management_service.rb +0 -31
  1092. data/lib/stripe/services/v2/payment_service.rb +0 -15
  1093. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +0 -152
  1094. data/lib/stripe/services/v2/test_helper_service.rb +0 -15
  1095. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +0 -53
  1096. data/lib/stripe/thin_event.rb +0 -37
  1097. data/stripe.gemspec +0 -47
@@ -0,0 +1,2445 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ module Stripe
5
+ module Checkout
6
+ class SessionCreateParams < Stripe::RequestParams
7
+ class AdaptivePricing < Stripe::RequestParams
8
+ # If set to `true`, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions). Defaults to your [dashboard setting](https://dashboard.stripe.com/settings/adaptive-pricing).
9
+ attr_accessor :enabled
10
+
11
+ def initialize(enabled: nil)
12
+ @enabled = enabled
13
+ end
14
+ end
15
+
16
+ class AfterExpiration < Stripe::RequestParams
17
+ class Recovery < Stripe::RequestParams
18
+ # Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
19
+ attr_accessor :allow_promotion_codes
20
+ # If `true`, a recovery URL will be generated to recover this Checkout Session if it
21
+ # expires before a successful transaction is completed. It will be attached to the
22
+ # Checkout Session object upon expiration.
23
+ attr_accessor :enabled
24
+
25
+ def initialize(allow_promotion_codes: nil, enabled: nil)
26
+ @allow_promotion_codes = allow_promotion_codes
27
+ @enabled = enabled
28
+ end
29
+ end
30
+ # Configure a Checkout Session that can be used to recover an expired session.
31
+ attr_accessor :recovery
32
+
33
+ def initialize(recovery: nil)
34
+ @recovery = recovery
35
+ end
36
+ end
37
+
38
+ class AutomaticTax < Stripe::RequestParams
39
+ class Liability < Stripe::RequestParams
40
+ # The connected account being referenced when `type` is `account`.
41
+ attr_accessor :account
42
+ # Type of the account referenced in the request.
43
+ attr_accessor :type
44
+
45
+ def initialize(account: nil, type: nil)
46
+ @account = account
47
+ @type = type
48
+ end
49
+ end
50
+ # Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
51
+ #
52
+ # Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.
53
+ attr_accessor :enabled
54
+ # 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.
55
+ attr_accessor :liability
56
+
57
+ def initialize(enabled: nil, liability: nil)
58
+ @enabled = enabled
59
+ @liability = liability
60
+ end
61
+ end
62
+
63
+ class BrandingSettings < Stripe::RequestParams
64
+ class Icon < Stripe::RequestParams
65
+ # The ID of a [File upload](https://stripe.com/docs/api/files) representing the icon. Purpose must be `business_icon`. Required if `type` is `file` and disallowed otherwise.
66
+ attr_accessor :file
67
+ # The type of image for the icon. Must be one of `file` or `url`.
68
+ attr_accessor :type
69
+ # The URL of the image. Required if `type` is `url` and disallowed otherwise.
70
+ attr_accessor :url
71
+
72
+ def initialize(file: nil, type: nil, url: nil)
73
+ @file = file
74
+ @type = type
75
+ @url = url
76
+ end
77
+ end
78
+
79
+ class Logo < Stripe::RequestParams
80
+ # The ID of a [File upload](https://stripe.com/docs/api/files) representing the logo. Purpose must be `business_logo`. Required if `type` is `file` and disallowed otherwise.
81
+ attr_accessor :file
82
+ # The type of image for the logo. Must be one of `file` or `url`.
83
+ attr_accessor :type
84
+ # The URL of the image. Required if `type` is `url` and disallowed otherwise.
85
+ attr_accessor :url
86
+
87
+ def initialize(file: nil, type: nil, url: nil)
88
+ @file = file
89
+ @type = type
90
+ @url = url
91
+ end
92
+ end
93
+ # A hex color value starting with `#` representing the background color for the Checkout Session.
94
+ attr_accessor :background_color
95
+ # The border style for the Checkout Session.
96
+ attr_accessor :border_style
97
+ # A hex color value starting with `#` representing the button color for the Checkout Session.
98
+ attr_accessor :button_color
99
+ # A string to override the business name shown on the Checkout Session.
100
+ attr_accessor :display_name
101
+ # The font family for the Checkout Session corresponding to one of the [supported font families](https://docs.stripe.com/payments/checkout/customization/appearance?payment-ui=stripe-hosted#font-compatibility).
102
+ attr_accessor :font_family
103
+ # The icon for the Checkout Session. You cannot set both `logo` and `icon`.
104
+ attr_accessor :icon
105
+ # The logo for the Checkout Session. You cannot set both `logo` and `icon`.
106
+ attr_accessor :logo
107
+
108
+ def initialize(
109
+ background_color: nil,
110
+ border_style: nil,
111
+ button_color: nil,
112
+ display_name: nil,
113
+ font_family: nil,
114
+ icon: nil,
115
+ logo: nil
116
+ )
117
+ @background_color = background_color
118
+ @border_style = border_style
119
+ @button_color = button_color
120
+ @display_name = display_name
121
+ @font_family = font_family
122
+ @icon = icon
123
+ @logo = logo
124
+ end
125
+ end
126
+
127
+ class ConsentCollection < Stripe::RequestParams
128
+ class PaymentMethodReuseAgreement < Stripe::RequestParams
129
+ # Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
130
+ # defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
131
+ attr_accessor :position
132
+
133
+ def initialize(position: nil)
134
+ @position = position
135
+ end
136
+ end
137
+ # 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.
138
+ attr_accessor :payment_method_reuse_agreement
139
+ # If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
140
+ # Session will determine whether to display an option to opt into promotional communication
141
+ # from the merchant depending on the customer's locale. Only available to US merchants.
142
+ attr_accessor :promotions
143
+ # If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
144
+ # There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
145
+ attr_accessor :terms_of_service
146
+
147
+ def initialize(payment_method_reuse_agreement: nil, promotions: nil, terms_of_service: nil)
148
+ @payment_method_reuse_agreement = payment_method_reuse_agreement
149
+ @promotions = promotions
150
+ @terms_of_service = terms_of_service
151
+ end
152
+ end
153
+
154
+ class CustomField < Stripe::RequestParams
155
+ class Dropdown < Stripe::RequestParams
156
+ class Option < Stripe::RequestParams
157
+ # The label for the option, displayed to the customer. Up to 100 characters.
158
+ attr_accessor :label
159
+ # 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.
160
+ attr_accessor :value
161
+
162
+ def initialize(label: nil, value: nil)
163
+ @label = label
164
+ @value = value
165
+ end
166
+ end
167
+ # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
168
+ attr_accessor :default_value
169
+ # The options available for the customer to select. Up to 200 options allowed.
170
+ attr_accessor :options
171
+
172
+ def initialize(default_value: nil, options: nil)
173
+ @default_value = default_value
174
+ @options = options
175
+ end
176
+ end
177
+
178
+ class Label < Stripe::RequestParams
179
+ # Custom text for the label, displayed to the customer. Up to 50 characters.
180
+ attr_accessor :custom
181
+ # The type of the label.
182
+ attr_accessor :type
183
+
184
+ def initialize(custom: nil, type: nil)
185
+ @custom = custom
186
+ @type = type
187
+ end
188
+ end
189
+
190
+ class Numeric < Stripe::RequestParams
191
+ # The value that will pre-fill the field on the payment page.
192
+ attr_accessor :default_value
193
+ # The maximum character length constraint for the customer's input.
194
+ attr_accessor :maximum_length
195
+ # The minimum character length requirement for the customer's input.
196
+ attr_accessor :minimum_length
197
+
198
+ def initialize(default_value: nil, maximum_length: nil, minimum_length: nil)
199
+ @default_value = default_value
200
+ @maximum_length = maximum_length
201
+ @minimum_length = minimum_length
202
+ end
203
+ end
204
+
205
+ class Text < Stripe::RequestParams
206
+ # The value that will pre-fill the field on the payment page.
207
+ attr_accessor :default_value
208
+ # The maximum character length constraint for the customer's input.
209
+ attr_accessor :maximum_length
210
+ # The minimum character length requirement for the customer's input.
211
+ attr_accessor :minimum_length
212
+
213
+ def initialize(default_value: nil, maximum_length: nil, minimum_length: nil)
214
+ @default_value = default_value
215
+ @maximum_length = maximum_length
216
+ @minimum_length = minimum_length
217
+ end
218
+ end
219
+ # Configuration for `type=dropdown` fields.
220
+ attr_accessor :dropdown
221
+ # 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.
222
+ attr_accessor :key
223
+ # The label for the field, displayed to the customer.
224
+ attr_accessor :label
225
+ # Configuration for `type=numeric` fields.
226
+ attr_accessor :numeric
227
+ # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
228
+ attr_accessor :optional
229
+ # Configuration for `type=text` fields.
230
+ attr_accessor :text
231
+ # The type of the field.
232
+ attr_accessor :type
233
+
234
+ def initialize(
235
+ dropdown: nil,
236
+ key: nil,
237
+ label: nil,
238
+ numeric: nil,
239
+ optional: nil,
240
+ text: nil,
241
+ type: nil
242
+ )
243
+ @dropdown = dropdown
244
+ @key = key
245
+ @label = label
246
+ @numeric = numeric
247
+ @optional = optional
248
+ @text = text
249
+ @type = type
250
+ end
251
+ end
252
+
253
+ class CustomText < Stripe::RequestParams
254
+ class AfterSubmit < Stripe::RequestParams
255
+ # Text may be up to 1200 characters in length.
256
+ attr_accessor :message
257
+
258
+ def initialize(message: nil)
259
+ @message = message
260
+ end
261
+ end
262
+
263
+ class ShippingAddress < Stripe::RequestParams
264
+ # Text may be up to 1200 characters in length.
265
+ attr_accessor :message
266
+
267
+ def initialize(message: nil)
268
+ @message = message
269
+ end
270
+ end
271
+
272
+ class Submit < Stripe::RequestParams
273
+ # Text may be up to 1200 characters in length.
274
+ attr_accessor :message
275
+
276
+ def initialize(message: nil)
277
+ @message = message
278
+ end
279
+ end
280
+
281
+ class TermsOfServiceAcceptance < Stripe::RequestParams
282
+ # Text may be up to 1200 characters in length.
283
+ attr_accessor :message
284
+
285
+ def initialize(message: nil)
286
+ @message = message
287
+ end
288
+ end
289
+ # Custom text that should be displayed after the payment confirmation button.
290
+ attr_accessor :after_submit
291
+ # Custom text that should be displayed alongside shipping address collection.
292
+ attr_accessor :shipping_address
293
+ # Custom text that should be displayed alongside the payment confirmation button.
294
+ attr_accessor :submit
295
+ # Custom text that should be displayed in place of the default terms of service agreement text.
296
+ attr_accessor :terms_of_service_acceptance
297
+
298
+ def initialize(
299
+ after_submit: nil,
300
+ shipping_address: nil,
301
+ submit: nil,
302
+ terms_of_service_acceptance: nil
303
+ )
304
+ @after_submit = after_submit
305
+ @shipping_address = shipping_address
306
+ @submit = submit
307
+ @terms_of_service_acceptance = terms_of_service_acceptance
308
+ end
309
+ end
310
+
311
+ class CustomerUpdate < Stripe::RequestParams
312
+ # Describes whether Checkout saves the billing address onto `customer.address`.
313
+ # To always collect a full billing address, use `billing_address_collection`. Defaults to `never`.
314
+ attr_accessor :address
315
+ # Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.
316
+ attr_accessor :name
317
+ # Describes whether Checkout saves shipping information onto `customer.shipping`.
318
+ # To collect shipping information, use `shipping_address_collection`. Defaults to `never`.
319
+ attr_accessor :shipping
320
+
321
+ def initialize(address: nil, name: nil, shipping: nil)
322
+ @address = address
323
+ @name = name
324
+ @shipping = shipping
325
+ end
326
+ end
327
+
328
+ class Discount < Stripe::RequestParams
329
+ # The ID of the coupon to apply to this Session.
330
+ attr_accessor :coupon
331
+ # The ID of a promotion code to apply to this Session.
332
+ attr_accessor :promotion_code
333
+
334
+ def initialize(coupon: nil, promotion_code: nil)
335
+ @coupon = coupon
336
+ @promotion_code = promotion_code
337
+ end
338
+ end
339
+
340
+ class InvoiceCreation < Stripe::RequestParams
341
+ class InvoiceData < Stripe::RequestParams
342
+ class CustomField < Stripe::RequestParams
343
+ # The name of the custom field. This may be up to 40 characters.
344
+ attr_accessor :name
345
+ # The value of the custom field. This may be up to 140 characters.
346
+ attr_accessor :value
347
+
348
+ def initialize(name: nil, value: nil)
349
+ @name = name
350
+ @value = value
351
+ end
352
+ end
353
+
354
+ class Issuer < Stripe::RequestParams
355
+ # The connected account being referenced when `type` is `account`.
356
+ attr_accessor :account
357
+ # Type of the account referenced in the request.
358
+ attr_accessor :type
359
+
360
+ def initialize(account: nil, type: nil)
361
+ @account = account
362
+ @type = type
363
+ end
364
+ end
365
+
366
+ class RenderingOptions < Stripe::RequestParams
367
+ # 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.
368
+ attr_accessor :amount_tax_display
369
+ # ID of the invoice rendering template to use for this invoice.
370
+ attr_accessor :template
371
+
372
+ def initialize(amount_tax_display: nil, template: nil)
373
+ @amount_tax_display = amount_tax_display
374
+ @template = template
375
+ end
376
+ end
377
+ # The account tax IDs associated with the invoice.
378
+ attr_accessor :account_tax_ids
379
+ # Default custom fields to be displayed on invoices for this customer.
380
+ attr_accessor :custom_fields
381
+ # An arbitrary string attached to the object. Often useful for displaying to users.
382
+ attr_accessor :description
383
+ # Default footer to be displayed on invoices for this customer.
384
+ attr_accessor :footer
385
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
386
+ attr_accessor :issuer
387
+ # 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`.
388
+ attr_accessor :metadata
389
+ # Default options for invoice PDF rendering for this customer.
390
+ attr_accessor :rendering_options
391
+
392
+ def initialize(
393
+ account_tax_ids: nil,
394
+ custom_fields: nil,
395
+ description: nil,
396
+ footer: nil,
397
+ issuer: nil,
398
+ metadata: nil,
399
+ rendering_options: nil
400
+ )
401
+ @account_tax_ids = account_tax_ids
402
+ @custom_fields = custom_fields
403
+ @description = description
404
+ @footer = footer
405
+ @issuer = issuer
406
+ @metadata = metadata
407
+ @rendering_options = rendering_options
408
+ end
409
+ end
410
+ # Set to `true` to enable invoice creation.
411
+ attr_accessor :enabled
412
+ # Parameters passed when creating invoices for payment-mode Checkout Sessions.
413
+ attr_accessor :invoice_data
414
+
415
+ def initialize(enabled: nil, invoice_data: nil)
416
+ @enabled = enabled
417
+ @invoice_data = invoice_data
418
+ end
419
+ end
420
+
421
+ class LineItem < Stripe::RequestParams
422
+ class AdjustableQuantity < Stripe::RequestParams
423
+ # Set to true if the quantity can be adjusted to any non-negative integer.
424
+ attr_accessor :enabled
425
+ # 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.
426
+ attr_accessor :maximum
427
+ # The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
428
+ attr_accessor :minimum
429
+
430
+ def initialize(enabled: nil, maximum: nil, minimum: nil)
431
+ @enabled = enabled
432
+ @maximum = maximum
433
+ @minimum = minimum
434
+ end
435
+ end
436
+
437
+ class PriceData < Stripe::RequestParams
438
+ class ProductData < Stripe::RequestParams
439
+ # 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.
440
+ attr_accessor :description
441
+ # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
442
+ attr_accessor :images
443
+ # 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`.
444
+ attr_accessor :metadata
445
+ # The product's name, meant to be displayable to the customer.
446
+ attr_accessor :name
447
+ # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
448
+ attr_accessor :tax_code
449
+ # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
450
+ attr_accessor :unit_label
451
+
452
+ def initialize(
453
+ description: nil,
454
+ images: nil,
455
+ metadata: nil,
456
+ name: nil,
457
+ tax_code: nil,
458
+ unit_label: nil
459
+ )
460
+ @description = description
461
+ @images = images
462
+ @metadata = metadata
463
+ @name = name
464
+ @tax_code = tax_code
465
+ @unit_label = unit_label
466
+ end
467
+ end
468
+
469
+ class Recurring < Stripe::RequestParams
470
+ # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
471
+ attr_accessor :interval
472
+ # 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).
473
+ attr_accessor :interval_count
474
+
475
+ def initialize(interval: nil, interval_count: nil)
476
+ @interval = interval
477
+ @interval_count = interval_count
478
+ end
479
+ end
480
+ # 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).
481
+ attr_accessor :currency
482
+ # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
483
+ attr_accessor :product
484
+ # Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
485
+ attr_accessor :product_data
486
+ # The recurring components of a price such as `interval` and `interval_count`.
487
+ attr_accessor :recurring
488
+ # 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.
489
+ attr_accessor :tax_behavior
490
+ # A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
491
+ attr_accessor :unit_amount
492
+ # 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.
493
+ attr_accessor :unit_amount_decimal
494
+
495
+ def initialize(
496
+ currency: nil,
497
+ product: nil,
498
+ product_data: nil,
499
+ recurring: nil,
500
+ tax_behavior: nil,
501
+ unit_amount: nil,
502
+ unit_amount_decimal: nil
503
+ )
504
+ @currency = currency
505
+ @product = product
506
+ @product_data = product_data
507
+ @recurring = recurring
508
+ @tax_behavior = tax_behavior
509
+ @unit_amount = unit_amount
510
+ @unit_amount_decimal = unit_amount_decimal
511
+ end
512
+ end
513
+ # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
514
+ attr_accessor :adjustable_quantity
515
+ # 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.
516
+ attr_accessor :dynamic_tax_rates
517
+ # 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.
518
+ attr_accessor :price
519
+ # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
520
+ attr_accessor :price_data
521
+ # The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
522
+ attr_accessor :quantity
523
+ # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
524
+ attr_accessor :tax_rates
525
+
526
+ def initialize(
527
+ adjustable_quantity: nil,
528
+ dynamic_tax_rates: nil,
529
+ price: nil,
530
+ price_data: nil,
531
+ quantity: nil,
532
+ tax_rates: nil
533
+ )
534
+ @adjustable_quantity = adjustable_quantity
535
+ @dynamic_tax_rates = dynamic_tax_rates
536
+ @price = price
537
+ @price_data = price_data
538
+ @quantity = quantity
539
+ @tax_rates = tax_rates
540
+ end
541
+ end
542
+
543
+ class NameCollection < Stripe::RequestParams
544
+ class Business < Stripe::RequestParams
545
+ # Enable business name collection on the Checkout Session. Defaults to `false`.
546
+ attr_accessor :enabled
547
+ # Whether the customer is required to provide a business name before completing the Checkout Session. Defaults to `false`.
548
+ attr_accessor :optional
549
+
550
+ def initialize(enabled: nil, optional: nil)
551
+ @enabled = enabled
552
+ @optional = optional
553
+ end
554
+ end
555
+
556
+ class Individual < Stripe::RequestParams
557
+ # Enable individual name collection on the Checkout Session. Defaults to `false`.
558
+ attr_accessor :enabled
559
+ # Whether the customer is required to provide their name before completing the Checkout Session. Defaults to `false`.
560
+ attr_accessor :optional
561
+
562
+ def initialize(enabled: nil, optional: nil)
563
+ @enabled = enabled
564
+ @optional = optional
565
+ end
566
+ end
567
+ # Controls settings applied for collecting the customer's business name on the session.
568
+ attr_accessor :business
569
+ # Controls settings applied for collecting the customer's individual name on the session.
570
+ attr_accessor :individual
571
+
572
+ def initialize(business: nil, individual: nil)
573
+ @business = business
574
+ @individual = individual
575
+ end
576
+ end
577
+
578
+ class OptionalItem < Stripe::RequestParams
579
+ class AdjustableQuantity < Stripe::RequestParams
580
+ # Set to true if the quantity can be adjusted to any non-negative integer.
581
+ attr_accessor :enabled
582
+ # The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.
583
+ attr_accessor :maximum
584
+ # The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
585
+ attr_accessor :minimum
586
+
587
+ def initialize(enabled: nil, maximum: nil, minimum: nil)
588
+ @enabled = enabled
589
+ @maximum = maximum
590
+ @minimum = minimum
591
+ end
592
+ end
593
+ # When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.
594
+ attr_accessor :adjustable_quantity
595
+ # The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
596
+ attr_accessor :price
597
+ # The initial quantity of the line item created when a customer chooses to add this optional item to their order.
598
+ attr_accessor :quantity
599
+
600
+ def initialize(adjustable_quantity: nil, price: nil, quantity: nil)
601
+ @adjustable_quantity = adjustable_quantity
602
+ @price = price
603
+ @quantity = quantity
604
+ end
605
+ end
606
+
607
+ class PaymentIntentData < Stripe::RequestParams
608
+ class Shipping < Stripe::RequestParams
609
+ class Address < Stripe::RequestParams
610
+ # City, district, suburb, town, or village.
611
+ attr_accessor :city
612
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
613
+ attr_accessor :country
614
+ # Address line 1, such as the street, PO Box, or company name.
615
+ attr_accessor :line1
616
+ # Address line 2, such as the apartment, suite, unit, or building.
617
+ attr_accessor :line2
618
+ # ZIP or postal code.
619
+ attr_accessor :postal_code
620
+ # State, county, province, or region.
621
+ attr_accessor :state
622
+
623
+ def initialize(
624
+ city: nil,
625
+ country: nil,
626
+ line1: nil,
627
+ line2: nil,
628
+ postal_code: nil,
629
+ state: nil
630
+ )
631
+ @city = city
632
+ @country = country
633
+ @line1 = line1
634
+ @line2 = line2
635
+ @postal_code = postal_code
636
+ @state = state
637
+ end
638
+ end
639
+ # Shipping address.
640
+ attr_accessor :address
641
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
642
+ attr_accessor :carrier
643
+ # Recipient name.
644
+ attr_accessor :name
645
+ # Recipient phone (including extension).
646
+ attr_accessor :phone
647
+ # 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.
648
+ attr_accessor :tracking_number
649
+
650
+ def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil)
651
+ @address = address
652
+ @carrier = carrier
653
+ @name = name
654
+ @phone = phone
655
+ @tracking_number = tracking_number
656
+ end
657
+ end
658
+
659
+ class TransferData < Stripe::RequestParams
660
+ # The amount that will be transferred automatically when a charge succeeds.
661
+ attr_accessor :amount
662
+ # If specified, successful charges will be attributed to the destination
663
+ # account for tax reporting, and the funds from charges will be transferred
664
+ # to the destination account. The ID of the resulting transfer will be
665
+ # returned on the successful charge's `transfer` field.
666
+ attr_accessor :destination
667
+
668
+ def initialize(amount: nil, destination: nil)
669
+ @amount = amount
670
+ @destination = destination
671
+ end
672
+ end
673
+ # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
674
+ attr_accessor :application_fee_amount
675
+ # Controls when the funds will be captured from the customer's account.
676
+ attr_accessor :capture_method
677
+ # An arbitrary string attached to the object. Often useful for displaying to users.
678
+ attr_accessor :description
679
+ # 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`.
680
+ attr_accessor :metadata
681
+ # The Stripe account ID for which these funds are intended. For details,
682
+ # see the PaymentIntents [use case for connected
683
+ # accounts](/docs/payments/connected-accounts).
684
+ attr_accessor :on_behalf_of
685
+ # 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).
686
+ attr_accessor :receipt_email
687
+ # Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment
688
+ # method collected by this Checkout Session.
689
+ #
690
+ # When setting this to `on_session`, Checkout will show a notice to the
691
+ # customer that their payment details will be saved.
692
+ #
693
+ # When setting this to `off_session`, Checkout will show a notice to the
694
+ # customer that their payment details will be saved and used for future
695
+ # payments.
696
+ #
697
+ # If a Customer has been provided or Checkout creates a new Customer,
698
+ # Checkout will attach the payment method to the Customer.
699
+ #
700
+ # If Checkout does not create a Customer, the payment method is not attached
701
+ # to a Customer. To reuse the payment method, you can retrieve it from the
702
+ # Checkout Session's PaymentIntent.
703
+ #
704
+ # When processing card payments, Checkout also uses `setup_future_usage`
705
+ # to dynamically optimize your payment flow and comply with regional
706
+ # legislation and network rules, such as SCA.
707
+ attr_accessor :setup_future_usage
708
+ # Shipping information for this payment.
709
+ attr_accessor :shipping
710
+ # 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).
711
+ #
712
+ # 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.
713
+ attr_accessor :statement_descriptor
714
+ # 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.
715
+ attr_accessor :statement_descriptor_suffix
716
+ # The parameters used to automatically create a Transfer when the payment succeeds.
717
+ # For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
718
+ attr_accessor :transfer_data
719
+ # 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.
720
+ attr_accessor :transfer_group
721
+
722
+ def initialize(
723
+ application_fee_amount: nil,
724
+ capture_method: nil,
725
+ description: nil,
726
+ metadata: nil,
727
+ on_behalf_of: nil,
728
+ receipt_email: nil,
729
+ setup_future_usage: nil,
730
+ shipping: nil,
731
+ statement_descriptor: nil,
732
+ statement_descriptor_suffix: nil,
733
+ transfer_data: nil,
734
+ transfer_group: nil
735
+ )
736
+ @application_fee_amount = application_fee_amount
737
+ @capture_method = capture_method
738
+ @description = description
739
+ @metadata = metadata
740
+ @on_behalf_of = on_behalf_of
741
+ @receipt_email = receipt_email
742
+ @setup_future_usage = setup_future_usage
743
+ @shipping = shipping
744
+ @statement_descriptor = statement_descriptor
745
+ @statement_descriptor_suffix = statement_descriptor_suffix
746
+ @transfer_data = transfer_data
747
+ @transfer_group = transfer_group
748
+ end
749
+ end
750
+
751
+ class PaymentMethodData < Stripe::RequestParams
752
+ # 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.
753
+ attr_accessor :allow_redisplay
754
+
755
+ def initialize(allow_redisplay: nil)
756
+ @allow_redisplay = allow_redisplay
757
+ end
758
+ end
759
+
760
+ class PaymentMethodOptions < Stripe::RequestParams
761
+ class AcssDebit < Stripe::RequestParams
762
+ class MandateOptions < Stripe::RequestParams
763
+ # A URL for custom mandate text to render during confirmation step.
764
+ # The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
765
+ # or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
766
+ attr_accessor :custom_mandate_url
767
+ # List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.
768
+ attr_accessor :default_for
769
+ # Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
770
+ attr_accessor :interval_description
771
+ # Payment schedule for the mandate.
772
+ attr_accessor :payment_schedule
773
+ # Transaction type of the mandate.
774
+ attr_accessor :transaction_type
775
+
776
+ def initialize(
777
+ custom_mandate_url: nil,
778
+ default_for: nil,
779
+ interval_description: nil,
780
+ payment_schedule: nil,
781
+ transaction_type: nil
782
+ )
783
+ @custom_mandate_url = custom_mandate_url
784
+ @default_for = default_for
785
+ @interval_description = interval_description
786
+ @payment_schedule = payment_schedule
787
+ @transaction_type = transaction_type
788
+ end
789
+ end
790
+ # 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.
791
+ attr_accessor :currency
792
+ # Additional fields for Mandate creation
793
+ attr_accessor :mandate_options
794
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
795
+ #
796
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
797
+ #
798
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
799
+ #
800
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
801
+ attr_accessor :setup_future_usage
802
+ # Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
803
+ attr_accessor :target_date
804
+ # Verification method for the intent
805
+ attr_accessor :verification_method
806
+
807
+ def initialize(
808
+ currency: nil,
809
+ mandate_options: nil,
810
+ setup_future_usage: nil,
811
+ target_date: nil,
812
+ verification_method: nil
813
+ )
814
+ @currency = currency
815
+ @mandate_options = mandate_options
816
+ @setup_future_usage = setup_future_usage
817
+ @target_date = target_date
818
+ @verification_method = verification_method
819
+ end
820
+ end
821
+
822
+ class Affirm < Stripe::RequestParams
823
+ # Controls when the funds will be captured from the customer's account.
824
+ attr_accessor :capture_method
825
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
826
+ #
827
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
828
+ #
829
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
830
+ #
831
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
832
+ attr_accessor :setup_future_usage
833
+
834
+ def initialize(capture_method: nil, setup_future_usage: nil)
835
+ @capture_method = capture_method
836
+ @setup_future_usage = setup_future_usage
837
+ end
838
+ end
839
+
840
+ class AfterpayClearpay < Stripe::RequestParams
841
+ # Controls when the funds will be captured from the customer's account.
842
+ attr_accessor :capture_method
843
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
844
+ #
845
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
846
+ #
847
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
848
+ #
849
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
850
+ attr_accessor :setup_future_usage
851
+
852
+ def initialize(capture_method: nil, setup_future_usage: nil)
853
+ @capture_method = capture_method
854
+ @setup_future_usage = setup_future_usage
855
+ end
856
+ end
857
+
858
+ class Alipay < Stripe::RequestParams
859
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
860
+ #
861
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
862
+ #
863
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
864
+ #
865
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
866
+ attr_accessor :setup_future_usage
867
+
868
+ def initialize(setup_future_usage: nil)
869
+ @setup_future_usage = setup_future_usage
870
+ end
871
+ end
872
+
873
+ class Alma < Stripe::RequestParams
874
+ # Controls when the funds will be captured from the customer's account.
875
+ attr_accessor :capture_method
876
+
877
+ def initialize(capture_method: nil)
878
+ @capture_method = capture_method
879
+ end
880
+ end
881
+
882
+ class AmazonPay < Stripe::RequestParams
883
+ # Controls when the funds will be captured from the customer's account.
884
+ attr_accessor :capture_method
885
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
886
+ #
887
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
888
+ #
889
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
890
+ #
891
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
892
+ attr_accessor :setup_future_usage
893
+
894
+ def initialize(capture_method: nil, setup_future_usage: nil)
895
+ @capture_method = capture_method
896
+ @setup_future_usage = setup_future_usage
897
+ end
898
+ end
899
+
900
+ class AuBecsDebit < Stripe::RequestParams
901
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
902
+ #
903
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
904
+ #
905
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
906
+ #
907
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
908
+ attr_accessor :setup_future_usage
909
+ # Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
910
+ attr_accessor :target_date
911
+
912
+ def initialize(setup_future_usage: nil, target_date: nil)
913
+ @setup_future_usage = setup_future_usage
914
+ @target_date = target_date
915
+ end
916
+ end
917
+
918
+ class BacsDebit < Stripe::RequestParams
919
+ class MandateOptions < Stripe::RequestParams
920
+ # 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'.
921
+ attr_accessor :reference_prefix
922
+
923
+ def initialize(reference_prefix: nil)
924
+ @reference_prefix = reference_prefix
925
+ end
926
+ end
927
+ # Additional fields for Mandate creation
928
+ attr_accessor :mandate_options
929
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
930
+ #
931
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
932
+ #
933
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
934
+ #
935
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
936
+ attr_accessor :setup_future_usage
937
+ # Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
938
+ attr_accessor :target_date
939
+
940
+ def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil)
941
+ @mandate_options = mandate_options
942
+ @setup_future_usage = setup_future_usage
943
+ @target_date = target_date
944
+ end
945
+ end
946
+
947
+ class Bancontact < Stripe::RequestParams
948
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
949
+ #
950
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
951
+ #
952
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
953
+ #
954
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
955
+ attr_accessor :setup_future_usage
956
+
957
+ def initialize(setup_future_usage: nil)
958
+ @setup_future_usage = setup_future_usage
959
+ end
960
+ end
961
+
962
+ class Billie < Stripe::RequestParams
963
+ # Controls when the funds will be captured from the customer's account.
964
+ attr_accessor :capture_method
965
+
966
+ def initialize(capture_method: nil)
967
+ @capture_method = capture_method
968
+ end
969
+ end
970
+
971
+ class Boleto < Stripe::RequestParams
972
+ # 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.
973
+ attr_accessor :expires_after_days
974
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
975
+ #
976
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
977
+ #
978
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
979
+ #
980
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
981
+ attr_accessor :setup_future_usage
982
+
983
+ def initialize(expires_after_days: nil, setup_future_usage: nil)
984
+ @expires_after_days = expires_after_days
985
+ @setup_future_usage = setup_future_usage
986
+ end
987
+ end
988
+
989
+ class Card < Stripe::RequestParams
990
+ class Installments < Stripe::RequestParams
991
+ # Setting to true enables installments for this Checkout Session.
992
+ # Setting to false will prevent any installment plan from applying to a payment.
993
+ attr_accessor :enabled
994
+
995
+ def initialize(enabled: nil)
996
+ @enabled = enabled
997
+ end
998
+ end
999
+
1000
+ class Restrictions < Stripe::RequestParams
1001
+ # Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can't complete the Session.
1002
+ attr_accessor :brands_blocked
1003
+
1004
+ def initialize(brands_blocked: nil)
1005
+ @brands_blocked = brands_blocked
1006
+ end
1007
+ end
1008
+ # Controls when the funds will be captured from the customer's account.
1009
+ attr_accessor :capture_method
1010
+ # Installment options for card payments
1011
+ attr_accessor :installments
1012
+ # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
1013
+ attr_accessor :request_extended_authorization
1014
+ # Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
1015
+ attr_accessor :request_incremental_authorization
1016
+ # Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
1017
+ attr_accessor :request_multicapture
1018
+ # Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
1019
+ attr_accessor :request_overcapture
1020
+ # 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.
1021
+ attr_accessor :request_three_d_secure
1022
+ # Restrictions to apply to the card payment method. For example, you can block specific card brands.
1023
+ attr_accessor :restrictions
1024
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1025
+ #
1026
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1027
+ #
1028
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1029
+ #
1030
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1031
+ attr_accessor :setup_future_usage
1032
+ # 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.
1033
+ attr_accessor :statement_descriptor_suffix_kana
1034
+ # 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.
1035
+ attr_accessor :statement_descriptor_suffix_kanji
1036
+
1037
+ def initialize(
1038
+ capture_method: nil,
1039
+ installments: nil,
1040
+ request_extended_authorization: nil,
1041
+ request_incremental_authorization: nil,
1042
+ request_multicapture: nil,
1043
+ request_overcapture: nil,
1044
+ request_three_d_secure: nil,
1045
+ restrictions: nil,
1046
+ setup_future_usage: nil,
1047
+ statement_descriptor_suffix_kana: nil,
1048
+ statement_descriptor_suffix_kanji: nil
1049
+ )
1050
+ @capture_method = capture_method
1051
+ @installments = installments
1052
+ @request_extended_authorization = request_extended_authorization
1053
+ @request_incremental_authorization = request_incremental_authorization
1054
+ @request_multicapture = request_multicapture
1055
+ @request_overcapture = request_overcapture
1056
+ @request_three_d_secure = request_three_d_secure
1057
+ @restrictions = restrictions
1058
+ @setup_future_usage = setup_future_usage
1059
+ @statement_descriptor_suffix_kana = statement_descriptor_suffix_kana
1060
+ @statement_descriptor_suffix_kanji = statement_descriptor_suffix_kanji
1061
+ end
1062
+ end
1063
+
1064
+ class Cashapp < Stripe::RequestParams
1065
+ # Controls when the funds will be captured from the customer's account.
1066
+ attr_accessor :capture_method
1067
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1068
+ #
1069
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1070
+ #
1071
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1072
+ #
1073
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1074
+ attr_accessor :setup_future_usage
1075
+
1076
+ def initialize(capture_method: nil, setup_future_usage: nil)
1077
+ @capture_method = capture_method
1078
+ @setup_future_usage = setup_future_usage
1079
+ end
1080
+ end
1081
+
1082
+ class CustomerBalance < Stripe::RequestParams
1083
+ class BankTransfer < Stripe::RequestParams
1084
+ class EuBankTransfer < Stripe::RequestParams
1085
+ # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
1086
+ attr_accessor :country
1087
+
1088
+ def initialize(country: nil)
1089
+ @country = country
1090
+ end
1091
+ end
1092
+ # Configuration for eu_bank_transfer funding type.
1093
+ attr_accessor :eu_bank_transfer
1094
+ # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
1095
+ #
1096
+ # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
1097
+ attr_accessor :requested_address_types
1098
+ # The list of bank transfer types that this PaymentIntent is allowed to use for funding.
1099
+ attr_accessor :type
1100
+
1101
+ def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil)
1102
+ @eu_bank_transfer = eu_bank_transfer
1103
+ @requested_address_types = requested_address_types
1104
+ @type = type
1105
+ end
1106
+ end
1107
+ # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
1108
+ attr_accessor :bank_transfer
1109
+ # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
1110
+ attr_accessor :funding_type
1111
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1112
+ #
1113
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1114
+ #
1115
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1116
+ #
1117
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1118
+ attr_accessor :setup_future_usage
1119
+
1120
+ def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil)
1121
+ @bank_transfer = bank_transfer
1122
+ @funding_type = funding_type
1123
+ @setup_future_usage = setup_future_usage
1124
+ end
1125
+ end
1126
+
1127
+ class DemoPay < Stripe::RequestParams
1128
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1129
+ #
1130
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1131
+ #
1132
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1133
+ #
1134
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1135
+ attr_accessor :setup_future_usage
1136
+
1137
+ def initialize(setup_future_usage: nil)
1138
+ @setup_future_usage = setup_future_usage
1139
+ end
1140
+ end
1141
+
1142
+ class Eps < Stripe::RequestParams
1143
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1144
+ #
1145
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1146
+ #
1147
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1148
+ #
1149
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1150
+ attr_accessor :setup_future_usage
1151
+
1152
+ def initialize(setup_future_usage: nil)
1153
+ @setup_future_usage = setup_future_usage
1154
+ end
1155
+ end
1156
+
1157
+ class Fpx < Stripe::RequestParams
1158
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1159
+ #
1160
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1161
+ #
1162
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1163
+ #
1164
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1165
+ attr_accessor :setup_future_usage
1166
+
1167
+ def initialize(setup_future_usage: nil)
1168
+ @setup_future_usage = setup_future_usage
1169
+ end
1170
+ end
1171
+
1172
+ class Giropay < Stripe::RequestParams
1173
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1174
+ #
1175
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1176
+ #
1177
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1178
+ #
1179
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1180
+ attr_accessor :setup_future_usage
1181
+
1182
+ def initialize(setup_future_usage: nil)
1183
+ @setup_future_usage = setup_future_usage
1184
+ end
1185
+ end
1186
+
1187
+ class Grabpay < Stripe::RequestParams
1188
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1189
+ #
1190
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1191
+ #
1192
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1193
+ #
1194
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1195
+ attr_accessor :setup_future_usage
1196
+
1197
+ def initialize(setup_future_usage: nil)
1198
+ @setup_future_usage = setup_future_usage
1199
+ end
1200
+ end
1201
+
1202
+ class Ideal < Stripe::RequestParams
1203
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1204
+ #
1205
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1206
+ #
1207
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1208
+ #
1209
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1210
+ attr_accessor :setup_future_usage
1211
+
1212
+ def initialize(setup_future_usage: nil)
1213
+ @setup_future_usage = setup_future_usage
1214
+ end
1215
+ end
1216
+
1217
+ class KakaoPay < Stripe::RequestParams
1218
+ # Controls when the funds will be captured from the customer's account.
1219
+ attr_accessor :capture_method
1220
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1221
+ #
1222
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1223
+ #
1224
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1225
+ #
1226
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1227
+ attr_accessor :setup_future_usage
1228
+
1229
+ def initialize(capture_method: nil, setup_future_usage: nil)
1230
+ @capture_method = capture_method
1231
+ @setup_future_usage = setup_future_usage
1232
+ end
1233
+ end
1234
+
1235
+ class Klarna < Stripe::RequestParams
1236
+ class Subscription < Stripe::RequestParams
1237
+ class NextBilling < Stripe::RequestParams
1238
+ # The amount of the next charge for the subscription.
1239
+ attr_accessor :amount
1240
+ # The date of the next charge for the subscription in YYYY-MM-DD format.
1241
+ attr_accessor :date
1242
+
1243
+ def initialize(amount: nil, date: nil)
1244
+ @amount = amount
1245
+ @date = date
1246
+ end
1247
+ end
1248
+ # Unit of time between subscription charges.
1249
+ attr_accessor :interval
1250
+ # The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
1251
+ attr_accessor :interval_count
1252
+ # Name for subscription.
1253
+ attr_accessor :name
1254
+ # Describes the upcoming charge for this subscription.
1255
+ attr_accessor :next_billing
1256
+ # A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
1257
+ attr_accessor :reference
1258
+
1259
+ def initialize(
1260
+ interval: nil,
1261
+ interval_count: nil,
1262
+ name: nil,
1263
+ next_billing: nil,
1264
+ reference: nil
1265
+ )
1266
+ @interval = interval
1267
+ @interval_count = interval_count
1268
+ @name = name
1269
+ @next_billing = next_billing
1270
+ @reference = reference
1271
+ end
1272
+ end
1273
+ # Controls when the funds will be captured from the customer's account.
1274
+ attr_accessor :capture_method
1275
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1276
+ #
1277
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1278
+ #
1279
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1280
+ #
1281
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1282
+ attr_accessor :setup_future_usage
1283
+ # Subscription details if the Checkout Session sets up a future subscription.
1284
+ attr_accessor :subscriptions
1285
+
1286
+ def initialize(capture_method: nil, setup_future_usage: nil, subscriptions: nil)
1287
+ @capture_method = capture_method
1288
+ @setup_future_usage = setup_future_usage
1289
+ @subscriptions = subscriptions
1290
+ end
1291
+ end
1292
+
1293
+ class Konbini < Stripe::RequestParams
1294
+ # 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.
1295
+ attr_accessor :expires_after_days
1296
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1297
+ #
1298
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1299
+ #
1300
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1301
+ #
1302
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1303
+ attr_accessor :setup_future_usage
1304
+
1305
+ def initialize(expires_after_days: nil, setup_future_usage: nil)
1306
+ @expires_after_days = expires_after_days
1307
+ @setup_future_usage = setup_future_usage
1308
+ end
1309
+ end
1310
+
1311
+ class KrCard < Stripe::RequestParams
1312
+ # Controls when the funds will be captured from the customer's account.
1313
+ attr_accessor :capture_method
1314
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1315
+ #
1316
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1317
+ #
1318
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1319
+ #
1320
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1321
+ attr_accessor :setup_future_usage
1322
+
1323
+ def initialize(capture_method: nil, setup_future_usage: nil)
1324
+ @capture_method = capture_method
1325
+ @setup_future_usage = setup_future_usage
1326
+ end
1327
+ end
1328
+
1329
+ class Link < Stripe::RequestParams
1330
+ # Controls when the funds will be captured from the customer's account.
1331
+ attr_accessor :capture_method
1332
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1333
+ #
1334
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1335
+ #
1336
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1337
+ #
1338
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1339
+ attr_accessor :setup_future_usage
1340
+
1341
+ def initialize(capture_method: nil, setup_future_usage: nil)
1342
+ @capture_method = capture_method
1343
+ @setup_future_usage = setup_future_usage
1344
+ end
1345
+ end
1346
+
1347
+ class Mobilepay < Stripe::RequestParams
1348
+ # Controls when the funds will be captured from the customer's account.
1349
+ attr_accessor :capture_method
1350
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1351
+ #
1352
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1353
+ #
1354
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1355
+ #
1356
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1357
+ attr_accessor :setup_future_usage
1358
+
1359
+ def initialize(capture_method: nil, setup_future_usage: nil)
1360
+ @capture_method = capture_method
1361
+ @setup_future_usage = setup_future_usage
1362
+ end
1363
+ end
1364
+
1365
+ class Multibanco < Stripe::RequestParams
1366
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1367
+ #
1368
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1369
+ #
1370
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1371
+ #
1372
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1373
+ attr_accessor :setup_future_usage
1374
+
1375
+ def initialize(setup_future_usage: nil)
1376
+ @setup_future_usage = setup_future_usage
1377
+ end
1378
+ end
1379
+
1380
+ class NaverPay < Stripe::RequestParams
1381
+ # Controls when the funds will be captured from the customer's account.
1382
+ attr_accessor :capture_method
1383
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1384
+ #
1385
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1386
+ #
1387
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1388
+ #
1389
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1390
+ attr_accessor :setup_future_usage
1391
+
1392
+ def initialize(capture_method: nil, setup_future_usage: nil)
1393
+ @capture_method = capture_method
1394
+ @setup_future_usage = setup_future_usage
1395
+ end
1396
+ end
1397
+
1398
+ class Oxxo < Stripe::RequestParams
1399
+ # 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.
1400
+ attr_accessor :expires_after_days
1401
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1402
+ #
1403
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1404
+ #
1405
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1406
+ #
1407
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1408
+ attr_accessor :setup_future_usage
1409
+
1410
+ def initialize(expires_after_days: nil, setup_future_usage: nil)
1411
+ @expires_after_days = expires_after_days
1412
+ @setup_future_usage = setup_future_usage
1413
+ end
1414
+ end
1415
+
1416
+ class P24 < Stripe::RequestParams
1417
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1418
+ #
1419
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1420
+ #
1421
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1422
+ #
1423
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1424
+ attr_accessor :setup_future_usage
1425
+ # Confirm that the payer has accepted the P24 terms and conditions.
1426
+ attr_accessor :tos_shown_and_accepted
1427
+
1428
+ def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil)
1429
+ @setup_future_usage = setup_future_usage
1430
+ @tos_shown_and_accepted = tos_shown_and_accepted
1431
+ end
1432
+ end
1433
+
1434
+ class PayByBank < Stripe::RequestParams; end
1435
+
1436
+ class Payco < Stripe::RequestParams
1437
+ # Controls when the funds will be captured from the customer's account.
1438
+ attr_accessor :capture_method
1439
+
1440
+ def initialize(capture_method: nil)
1441
+ @capture_method = capture_method
1442
+ end
1443
+ end
1444
+
1445
+ class Paynow < Stripe::RequestParams
1446
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1447
+ #
1448
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1449
+ #
1450
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1451
+ #
1452
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1453
+ attr_accessor :setup_future_usage
1454
+
1455
+ def initialize(setup_future_usage: nil)
1456
+ @setup_future_usage = setup_future_usage
1457
+ end
1458
+ end
1459
+
1460
+ class Paypal < Stripe::RequestParams
1461
+ # Controls when the funds will be captured from the customer's account.
1462
+ attr_accessor :capture_method
1463
+ # [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
1464
+ attr_accessor :preferred_locale
1465
+ # 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.
1466
+ attr_accessor :reference
1467
+ # The risk correlation ID for an on-session payment using a saved PayPal payment method.
1468
+ attr_accessor :risk_correlation_id
1469
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1470
+ #
1471
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1472
+ #
1473
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1474
+ #
1475
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1476
+ #
1477
+ # 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`.
1478
+ attr_accessor :setup_future_usage
1479
+
1480
+ def initialize(
1481
+ capture_method: nil,
1482
+ preferred_locale: nil,
1483
+ reference: nil,
1484
+ risk_correlation_id: nil,
1485
+ setup_future_usage: nil
1486
+ )
1487
+ @capture_method = capture_method
1488
+ @preferred_locale = preferred_locale
1489
+ @reference = reference
1490
+ @risk_correlation_id = risk_correlation_id
1491
+ @setup_future_usage = setup_future_usage
1492
+ end
1493
+ end
1494
+
1495
+ class Pix < Stripe::RequestParams
1496
+ # Determines if the amount includes the IOF tax. Defaults to `never`.
1497
+ attr_accessor :amount_includes_iof
1498
+ # The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
1499
+ attr_accessor :expires_after_seconds
1500
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1501
+ #
1502
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1503
+ #
1504
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1505
+ #
1506
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1507
+ attr_accessor :setup_future_usage
1508
+
1509
+ def initialize(
1510
+ amount_includes_iof: nil,
1511
+ expires_after_seconds: nil,
1512
+ setup_future_usage: nil
1513
+ )
1514
+ @amount_includes_iof = amount_includes_iof
1515
+ @expires_after_seconds = expires_after_seconds
1516
+ @setup_future_usage = setup_future_usage
1517
+ end
1518
+ end
1519
+
1520
+ class RevolutPay < Stripe::RequestParams
1521
+ # Controls when the funds will be captured from the customer's account.
1522
+ attr_accessor :capture_method
1523
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1524
+ #
1525
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1526
+ #
1527
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1528
+ #
1529
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1530
+ attr_accessor :setup_future_usage
1531
+
1532
+ def initialize(capture_method: nil, setup_future_usage: nil)
1533
+ @capture_method = capture_method
1534
+ @setup_future_usage = setup_future_usage
1535
+ end
1536
+ end
1537
+
1538
+ class SamsungPay < Stripe::RequestParams
1539
+ # Controls when the funds will be captured from the customer's account.
1540
+ attr_accessor :capture_method
1541
+
1542
+ def initialize(capture_method: nil)
1543
+ @capture_method = capture_method
1544
+ end
1545
+ end
1546
+
1547
+ class Satispay < Stripe::RequestParams
1548
+ # Controls when the funds will be captured from the customer's account.
1549
+ attr_accessor :capture_method
1550
+
1551
+ def initialize(capture_method: nil)
1552
+ @capture_method = capture_method
1553
+ end
1554
+ end
1555
+
1556
+ class SepaDebit < Stripe::RequestParams
1557
+ class MandateOptions < Stripe::RequestParams
1558
+ # 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'.
1559
+ attr_accessor :reference_prefix
1560
+
1561
+ def initialize(reference_prefix: nil)
1562
+ @reference_prefix = reference_prefix
1563
+ end
1564
+ end
1565
+ # Additional fields for Mandate creation
1566
+ attr_accessor :mandate_options
1567
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1568
+ #
1569
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1570
+ #
1571
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1572
+ #
1573
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1574
+ attr_accessor :setup_future_usage
1575
+ # Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
1576
+ attr_accessor :target_date
1577
+
1578
+ def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil)
1579
+ @mandate_options = mandate_options
1580
+ @setup_future_usage = setup_future_usage
1581
+ @target_date = target_date
1582
+ end
1583
+ end
1584
+
1585
+ class Sofort < Stripe::RequestParams
1586
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1587
+ #
1588
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1589
+ #
1590
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1591
+ #
1592
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1593
+ attr_accessor :setup_future_usage
1594
+
1595
+ def initialize(setup_future_usage: nil)
1596
+ @setup_future_usage = setup_future_usage
1597
+ end
1598
+ end
1599
+
1600
+ class Swish < Stripe::RequestParams
1601
+ # The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
1602
+ attr_accessor :reference
1603
+
1604
+ def initialize(reference: nil)
1605
+ @reference = reference
1606
+ end
1607
+ end
1608
+
1609
+ class UsBankAccount < Stripe::RequestParams
1610
+ class FinancialConnections < Stripe::RequestParams
1611
+ # 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`.
1612
+ attr_accessor :permissions
1613
+ # List of data features that you would like to retrieve upon account creation.
1614
+ attr_accessor :prefetch
1615
+
1616
+ def initialize(permissions: nil, prefetch: nil)
1617
+ @permissions = permissions
1618
+ @prefetch = prefetch
1619
+ end
1620
+ end
1621
+ # Additional fields for Financial Connections Session creation
1622
+ attr_accessor :financial_connections
1623
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1624
+ #
1625
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1626
+ #
1627
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1628
+ #
1629
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1630
+ attr_accessor :setup_future_usage
1631
+ # Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
1632
+ attr_accessor :target_date
1633
+ # Verification method for the intent
1634
+ attr_accessor :verification_method
1635
+
1636
+ def initialize(
1637
+ financial_connections: nil,
1638
+ setup_future_usage: nil,
1639
+ target_date: nil,
1640
+ verification_method: nil
1641
+ )
1642
+ @financial_connections = financial_connections
1643
+ @setup_future_usage = setup_future_usage
1644
+ @target_date = target_date
1645
+ @verification_method = verification_method
1646
+ end
1647
+ end
1648
+
1649
+ class WechatPay < Stripe::RequestParams
1650
+ # The app ID registered with WeChat Pay. Only required when client is ios or android.
1651
+ attr_accessor :app_id
1652
+ # The client type that the end customer will pay from
1653
+ attr_accessor :client
1654
+ # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1655
+ #
1656
+ # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1657
+ #
1658
+ # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1659
+ #
1660
+ # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1661
+ attr_accessor :setup_future_usage
1662
+
1663
+ def initialize(app_id: nil, client: nil, setup_future_usage: nil)
1664
+ @app_id = app_id
1665
+ @client = client
1666
+ @setup_future_usage = setup_future_usage
1667
+ end
1668
+ end
1669
+ # contains details about the ACSS Debit payment method options.
1670
+ attr_accessor :acss_debit
1671
+ # contains details about the Affirm payment method options.
1672
+ attr_accessor :affirm
1673
+ # contains details about the Afterpay Clearpay payment method options.
1674
+ attr_accessor :afterpay_clearpay
1675
+ # contains details about the Alipay payment method options.
1676
+ attr_accessor :alipay
1677
+ # contains details about the Alma payment method options.
1678
+ attr_accessor :alma
1679
+ # contains details about the AmazonPay payment method options.
1680
+ attr_accessor :amazon_pay
1681
+ # contains details about the AU Becs Debit payment method options.
1682
+ attr_accessor :au_becs_debit
1683
+ # contains details about the Bacs Debit payment method options.
1684
+ attr_accessor :bacs_debit
1685
+ # contains details about the Bancontact payment method options.
1686
+ attr_accessor :bancontact
1687
+ # contains details about the Billie payment method options.
1688
+ attr_accessor :billie
1689
+ # contains details about the Boleto payment method options.
1690
+ attr_accessor :boleto
1691
+ # contains details about the Card payment method options.
1692
+ attr_accessor :card
1693
+ # contains details about the Cashapp Pay payment method options.
1694
+ attr_accessor :cashapp
1695
+ # contains details about the Customer Balance payment method options.
1696
+ attr_accessor :customer_balance
1697
+ # contains details about the DemoPay payment method options.
1698
+ attr_accessor :demo_pay
1699
+ # contains details about the EPS payment method options.
1700
+ attr_accessor :eps
1701
+ # contains details about the FPX payment method options.
1702
+ attr_accessor :fpx
1703
+ # contains details about the Giropay payment method options.
1704
+ attr_accessor :giropay
1705
+ # contains details about the Grabpay payment method options.
1706
+ attr_accessor :grabpay
1707
+ # contains details about the Ideal payment method options.
1708
+ attr_accessor :ideal
1709
+ # contains details about the Kakao Pay payment method options.
1710
+ attr_accessor :kakao_pay
1711
+ # contains details about the Klarna payment method options.
1712
+ attr_accessor :klarna
1713
+ # contains details about the Konbini payment method options.
1714
+ attr_accessor :konbini
1715
+ # contains details about the Korean card payment method options.
1716
+ attr_accessor :kr_card
1717
+ # contains details about the Link payment method options.
1718
+ attr_accessor :link
1719
+ # contains details about the Mobilepay payment method options.
1720
+ attr_accessor :mobilepay
1721
+ # contains details about the Multibanco payment method options.
1722
+ attr_accessor :multibanco
1723
+ # contains details about the Naver Pay payment method options.
1724
+ attr_accessor :naver_pay
1725
+ # contains details about the OXXO payment method options.
1726
+ attr_accessor :oxxo
1727
+ # contains details about the P24 payment method options.
1728
+ attr_accessor :p24
1729
+ # contains details about the Pay By Bank payment method options.
1730
+ attr_accessor :pay_by_bank
1731
+ # contains details about the PAYCO payment method options.
1732
+ attr_accessor :payco
1733
+ # contains details about the PayNow payment method options.
1734
+ attr_accessor :paynow
1735
+ # contains details about the PayPal payment method options.
1736
+ attr_accessor :paypal
1737
+ # contains details about the Pix payment method options.
1738
+ attr_accessor :pix
1739
+ # contains details about the RevolutPay payment method options.
1740
+ attr_accessor :revolut_pay
1741
+ # contains details about the Samsung Pay payment method options.
1742
+ attr_accessor :samsung_pay
1743
+ # contains details about the Satispay payment method options.
1744
+ attr_accessor :satispay
1745
+ # contains details about the Sepa Debit payment method options.
1746
+ attr_accessor :sepa_debit
1747
+ # contains details about the Sofort payment method options.
1748
+ attr_accessor :sofort
1749
+ # contains details about the Swish payment method options.
1750
+ attr_accessor :swish
1751
+ # contains details about the Us Bank Account payment method options.
1752
+ attr_accessor :us_bank_account
1753
+ # contains details about the WeChat Pay payment method options.
1754
+ attr_accessor :wechat_pay
1755
+
1756
+ def initialize(
1757
+ acss_debit: nil,
1758
+ affirm: nil,
1759
+ afterpay_clearpay: nil,
1760
+ alipay: nil,
1761
+ alma: nil,
1762
+ amazon_pay: nil,
1763
+ au_becs_debit: nil,
1764
+ bacs_debit: nil,
1765
+ bancontact: nil,
1766
+ billie: nil,
1767
+ boleto: nil,
1768
+ card: nil,
1769
+ cashapp: nil,
1770
+ customer_balance: nil,
1771
+ demo_pay: nil,
1772
+ eps: nil,
1773
+ fpx: nil,
1774
+ giropay: nil,
1775
+ grabpay: nil,
1776
+ ideal: nil,
1777
+ kakao_pay: nil,
1778
+ klarna: nil,
1779
+ konbini: nil,
1780
+ kr_card: nil,
1781
+ link: nil,
1782
+ mobilepay: nil,
1783
+ multibanco: nil,
1784
+ naver_pay: nil,
1785
+ oxxo: nil,
1786
+ p24: nil,
1787
+ pay_by_bank: nil,
1788
+ payco: nil,
1789
+ paynow: nil,
1790
+ paypal: nil,
1791
+ pix: nil,
1792
+ revolut_pay: nil,
1793
+ samsung_pay: nil,
1794
+ satispay: nil,
1795
+ sepa_debit: nil,
1796
+ sofort: nil,
1797
+ swish: nil,
1798
+ us_bank_account: nil,
1799
+ wechat_pay: nil
1800
+ )
1801
+ @acss_debit = acss_debit
1802
+ @affirm = affirm
1803
+ @afterpay_clearpay = afterpay_clearpay
1804
+ @alipay = alipay
1805
+ @alma = alma
1806
+ @amazon_pay = amazon_pay
1807
+ @au_becs_debit = au_becs_debit
1808
+ @bacs_debit = bacs_debit
1809
+ @bancontact = bancontact
1810
+ @billie = billie
1811
+ @boleto = boleto
1812
+ @card = card
1813
+ @cashapp = cashapp
1814
+ @customer_balance = customer_balance
1815
+ @demo_pay = demo_pay
1816
+ @eps = eps
1817
+ @fpx = fpx
1818
+ @giropay = giropay
1819
+ @grabpay = grabpay
1820
+ @ideal = ideal
1821
+ @kakao_pay = kakao_pay
1822
+ @klarna = klarna
1823
+ @konbini = konbini
1824
+ @kr_card = kr_card
1825
+ @link = link
1826
+ @mobilepay = mobilepay
1827
+ @multibanco = multibanco
1828
+ @naver_pay = naver_pay
1829
+ @oxxo = oxxo
1830
+ @p24 = p24
1831
+ @pay_by_bank = pay_by_bank
1832
+ @payco = payco
1833
+ @paynow = paynow
1834
+ @paypal = paypal
1835
+ @pix = pix
1836
+ @revolut_pay = revolut_pay
1837
+ @samsung_pay = samsung_pay
1838
+ @satispay = satispay
1839
+ @sepa_debit = sepa_debit
1840
+ @sofort = sofort
1841
+ @swish = swish
1842
+ @us_bank_account = us_bank_account
1843
+ @wechat_pay = wechat_pay
1844
+ end
1845
+ end
1846
+
1847
+ class Permissions < Stripe::RequestParams
1848
+ # Determines which entity is allowed to update the shipping details.
1849
+ #
1850
+ # 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.
1851
+ #
1852
+ # 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.
1853
+ attr_accessor :update_shipping_details
1854
+
1855
+ def initialize(update_shipping_details: nil)
1856
+ @update_shipping_details = update_shipping_details
1857
+ end
1858
+ end
1859
+
1860
+ class PhoneNumberCollection < Stripe::RequestParams
1861
+ # Set to `true` to enable phone number collection.
1862
+ #
1863
+ # Can only be set in `payment` and `subscription` mode.
1864
+ attr_accessor :enabled
1865
+
1866
+ def initialize(enabled: nil)
1867
+ @enabled = enabled
1868
+ end
1869
+ end
1870
+
1871
+ class SavedPaymentMethodOptions < Stripe::RequestParams
1872
+ # 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.
1873
+ attr_accessor :allow_redisplay_filters
1874
+ # Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
1875
+ attr_accessor :payment_method_remove
1876
+ # Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
1877
+ attr_accessor :payment_method_save
1878
+
1879
+ def initialize(
1880
+ allow_redisplay_filters: nil,
1881
+ payment_method_remove: nil,
1882
+ payment_method_save: nil
1883
+ )
1884
+ @allow_redisplay_filters = allow_redisplay_filters
1885
+ @payment_method_remove = payment_method_remove
1886
+ @payment_method_save = payment_method_save
1887
+ end
1888
+ end
1889
+
1890
+ class SetupIntentData < Stripe::RequestParams
1891
+ # An arbitrary string attached to the object. Often useful for displaying to users.
1892
+ attr_accessor :description
1893
+ # 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`.
1894
+ attr_accessor :metadata
1895
+ # The Stripe account for which the setup is intended.
1896
+ attr_accessor :on_behalf_of
1897
+
1898
+ def initialize(description: nil, metadata: nil, on_behalf_of: nil)
1899
+ @description = description
1900
+ @metadata = metadata
1901
+ @on_behalf_of = on_behalf_of
1902
+ end
1903
+ end
1904
+
1905
+ class ShippingAddressCollection < Stripe::RequestParams
1906
+ # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
1907
+ # shipping locations.
1908
+ attr_accessor :allowed_countries
1909
+
1910
+ def initialize(allowed_countries: nil)
1911
+ @allowed_countries = allowed_countries
1912
+ end
1913
+ end
1914
+
1915
+ class ShippingOption < Stripe::RequestParams
1916
+ class ShippingRateData < Stripe::RequestParams
1917
+ class DeliveryEstimate < Stripe::RequestParams
1918
+ class Maximum < Stripe::RequestParams
1919
+ # A unit of time.
1920
+ attr_accessor :unit
1921
+ # Must be greater than 0.
1922
+ attr_accessor :value
1923
+
1924
+ def initialize(unit: nil, value: nil)
1925
+ @unit = unit
1926
+ @value = value
1927
+ end
1928
+ end
1929
+
1930
+ class Minimum < Stripe::RequestParams
1931
+ # A unit of time.
1932
+ attr_accessor :unit
1933
+ # Must be greater than 0.
1934
+ attr_accessor :value
1935
+
1936
+ def initialize(unit: nil, value: nil)
1937
+ @unit = unit
1938
+ @value = value
1939
+ end
1940
+ end
1941
+ # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
1942
+ attr_accessor :maximum
1943
+ # The lower bound of the estimated range. If empty, represents no lower bound.
1944
+ attr_accessor :minimum
1945
+
1946
+ def initialize(maximum: nil, minimum: nil)
1947
+ @maximum = maximum
1948
+ @minimum = minimum
1949
+ end
1950
+ end
1951
+
1952
+ class FixedAmount < Stripe::RequestParams
1953
+ class CurrencyOptions < Stripe::RequestParams
1954
+ # A non-negative integer in cents representing how much to charge.
1955
+ attr_accessor :amount
1956
+ # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
1957
+ attr_accessor :tax_behavior
1958
+
1959
+ def initialize(amount: nil, tax_behavior: nil)
1960
+ @amount = amount
1961
+ @tax_behavior = tax_behavior
1962
+ end
1963
+ end
1964
+ # A non-negative integer in cents representing how much to charge.
1965
+ attr_accessor :amount
1966
+ # 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).
1967
+ attr_accessor :currency
1968
+ # 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).
1969
+ attr_accessor :currency_options
1970
+
1971
+ def initialize(amount: nil, currency: nil, currency_options: nil)
1972
+ @amount = amount
1973
+ @currency = currency
1974
+ @currency_options = currency_options
1975
+ end
1976
+ end
1977
+ # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
1978
+ attr_accessor :delivery_estimate
1979
+ # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
1980
+ attr_accessor :display_name
1981
+ # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
1982
+ attr_accessor :fixed_amount
1983
+ # 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`.
1984
+ attr_accessor :metadata
1985
+ # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
1986
+ attr_accessor :tax_behavior
1987
+ # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
1988
+ attr_accessor :tax_code
1989
+ # The type of calculation to use on the shipping rate.
1990
+ attr_accessor :type
1991
+
1992
+ def initialize(
1993
+ delivery_estimate: nil,
1994
+ display_name: nil,
1995
+ fixed_amount: nil,
1996
+ metadata: nil,
1997
+ tax_behavior: nil,
1998
+ tax_code: nil,
1999
+ type: nil
2000
+ )
2001
+ @delivery_estimate = delivery_estimate
2002
+ @display_name = display_name
2003
+ @fixed_amount = fixed_amount
2004
+ @metadata = metadata
2005
+ @tax_behavior = tax_behavior
2006
+ @tax_code = tax_code
2007
+ @type = type
2008
+ end
2009
+ end
2010
+ # The ID of the Shipping Rate to use for this shipping option.
2011
+ attr_accessor :shipping_rate
2012
+ # Parameters to be passed to Shipping Rate creation for this shipping option.
2013
+ attr_accessor :shipping_rate_data
2014
+
2015
+ def initialize(shipping_rate: nil, shipping_rate_data: nil)
2016
+ @shipping_rate = shipping_rate
2017
+ @shipping_rate_data = shipping_rate_data
2018
+ end
2019
+ end
2020
+
2021
+ class SubscriptionData < Stripe::RequestParams
2022
+ class BillingMode < Stripe::RequestParams
2023
+ class Flexible < Stripe::RequestParams
2024
+ # Controls how invoices and invoice items display proration amounts and discount amounts.
2025
+ attr_accessor :proration_discounts
2026
+
2027
+ def initialize(proration_discounts: nil)
2028
+ @proration_discounts = proration_discounts
2029
+ end
2030
+ end
2031
+ # Configure behavior for flexible billing mode.
2032
+ attr_accessor :flexible
2033
+ # Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
2034
+ attr_accessor :type
2035
+
2036
+ def initialize(flexible: nil, type: nil)
2037
+ @flexible = flexible
2038
+ @type = type
2039
+ end
2040
+ end
2041
+
2042
+ class InvoiceSettings < Stripe::RequestParams
2043
+ class Issuer < Stripe::RequestParams
2044
+ # The connected account being referenced when `type` is `account`.
2045
+ attr_accessor :account
2046
+ # Type of the account referenced in the request.
2047
+ attr_accessor :type
2048
+
2049
+ def initialize(account: nil, type: nil)
2050
+ @account = account
2051
+ @type = type
2052
+ end
2053
+ end
2054
+ # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
2055
+ attr_accessor :issuer
2056
+
2057
+ def initialize(issuer: nil)
2058
+ @issuer = issuer
2059
+ end
2060
+ end
2061
+
2062
+ class TransferData < Stripe::RequestParams
2063
+ # 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.
2064
+ attr_accessor :amount_percent
2065
+ # ID of an existing, connected Stripe account.
2066
+ attr_accessor :destination
2067
+
2068
+ def initialize(amount_percent: nil, destination: nil)
2069
+ @amount_percent = amount_percent
2070
+ @destination = destination
2071
+ end
2072
+ end
2073
+
2074
+ class TrialSettings < Stripe::RequestParams
2075
+ class EndBehavior < Stripe::RequestParams
2076
+ # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
2077
+ attr_accessor :missing_payment_method
2078
+
2079
+ def initialize(missing_payment_method: nil)
2080
+ @missing_payment_method = missing_payment_method
2081
+ end
2082
+ end
2083
+ # Defines how the subscription should behave when the user's free trial ends.
2084
+ attr_accessor :end_behavior
2085
+
2086
+ def initialize(end_behavior: nil)
2087
+ @end_behavior = end_behavior
2088
+ end
2089
+ end
2090
+ # 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).
2091
+ attr_accessor :application_fee_percent
2092
+ # A future timestamp to anchor the subscription's billing cycle for new subscriptions.
2093
+ attr_accessor :billing_cycle_anchor
2094
+ # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
2095
+ attr_accessor :billing_mode
2096
+ # The tax rates that will apply to any subscription item that does not have
2097
+ # `tax_rates` set. Invoices created will have their `default_tax_rates` populated
2098
+ # from the subscription.
2099
+ attr_accessor :default_tax_rates
2100
+ # The subscription's description, meant to be displayable to the customer.
2101
+ # Use this field to optionally store an explanation of the subscription
2102
+ # for rendering in the [customer portal](https://stripe.com/docs/customer-management).
2103
+ attr_accessor :description
2104
+ # All invoices will be billed using the specified settings.
2105
+ attr_accessor :invoice_settings
2106
+ # 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`.
2107
+ attr_accessor :metadata
2108
+ # The account on behalf of which to charge, for each of the subscription's invoices.
2109
+ attr_accessor :on_behalf_of
2110
+ # Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
2111
+ attr_accessor :proration_behavior
2112
+ # 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.
2113
+ attr_accessor :transfer_data
2114
+ # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.
2115
+ attr_accessor :trial_end
2116
+ # Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
2117
+ attr_accessor :trial_period_days
2118
+ # Settings related to subscription trials.
2119
+ attr_accessor :trial_settings
2120
+
2121
+ def initialize(
2122
+ application_fee_percent: nil,
2123
+ billing_cycle_anchor: nil,
2124
+ billing_mode: nil,
2125
+ default_tax_rates: nil,
2126
+ description: nil,
2127
+ invoice_settings: nil,
2128
+ metadata: nil,
2129
+ on_behalf_of: nil,
2130
+ proration_behavior: nil,
2131
+ transfer_data: nil,
2132
+ trial_end: nil,
2133
+ trial_period_days: nil,
2134
+ trial_settings: nil
2135
+ )
2136
+ @application_fee_percent = application_fee_percent
2137
+ @billing_cycle_anchor = billing_cycle_anchor
2138
+ @billing_mode = billing_mode
2139
+ @default_tax_rates = default_tax_rates
2140
+ @description = description
2141
+ @invoice_settings = invoice_settings
2142
+ @metadata = metadata
2143
+ @on_behalf_of = on_behalf_of
2144
+ @proration_behavior = proration_behavior
2145
+ @transfer_data = transfer_data
2146
+ @trial_end = trial_end
2147
+ @trial_period_days = trial_period_days
2148
+ @trial_settings = trial_settings
2149
+ end
2150
+ end
2151
+
2152
+ class TaxIdCollection < Stripe::RequestParams
2153
+ # Enable tax ID collection during checkout. Defaults to `false`.
2154
+ attr_accessor :enabled
2155
+ # Describes whether a tax ID is required during checkout. Defaults to `never`.
2156
+ attr_accessor :required
2157
+
2158
+ def initialize(enabled: nil, required: nil)
2159
+ @enabled = enabled
2160
+ @required = required
2161
+ end
2162
+ end
2163
+
2164
+ class WalletOptions < Stripe::RequestParams
2165
+ class Link < Stripe::RequestParams
2166
+ # Specifies whether Checkout should display Link as a payment option. By default, Checkout will display all the supported wallets that the Checkout Session was created with. This is the `auto` behavior, and it is the default choice.
2167
+ attr_accessor :display
2168
+
2169
+ def initialize(display: nil)
2170
+ @display = display
2171
+ end
2172
+ end
2173
+ # contains details about the Link wallet options.
2174
+ attr_accessor :link
2175
+
2176
+ def initialize(link: nil)
2177
+ @link = link
2178
+ end
2179
+ end
2180
+ # Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
2181
+ attr_accessor :adaptive_pricing
2182
+ # Configure actions after a Checkout Session has expired.
2183
+ attr_accessor :after_expiration
2184
+ # Enables user redeemable promotion codes.
2185
+ attr_accessor :allow_promotion_codes
2186
+ # Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
2187
+ attr_accessor :automatic_tax
2188
+ # Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
2189
+ attr_accessor :billing_address_collection
2190
+ # The branding settings for the Checkout Session. This parameter is not allowed if ui_mode is `custom`.
2191
+ attr_accessor :branding_settings
2192
+ # 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`.
2193
+ attr_accessor :cancel_url
2194
+ # A unique string to reference the Checkout Session. This can be a
2195
+ # customer ID, a cart ID, or similar, and can be used to reconcile the
2196
+ # session with your internal systems.
2197
+ attr_accessor :client_reference_id
2198
+ # Configure fields for the Checkout Session to gather active consent from customers.
2199
+ attr_accessor :consent_collection
2200
+ # 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.
2201
+ attr_accessor :currency
2202
+ # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
2203
+ attr_accessor :custom_fields
2204
+ # Display additional text for your customers using custom text.
2205
+ attr_accessor :custom_text
2206
+ # ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card
2207
+ # payment method will be used to prefill the email, name, card details, and billing address
2208
+ # 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)
2209
+ # 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.
2210
+ #
2211
+ # 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.
2212
+ # If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
2213
+ #
2214
+ # 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.
2215
+ #
2216
+ # 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.
2217
+ attr_accessor :customer
2218
+ # Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
2219
+ #
2220
+ # When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
2221
+ # with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).
2222
+ #
2223
+ # Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)
2224
+ # in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
2225
+ #
2226
+ # Can only be set in `payment` and `setup` mode.
2227
+ attr_accessor :customer_creation
2228
+ # If provided, this value will be used when the Customer object is created.
2229
+ # If not provided, customers will be asked to enter their email address.
2230
+ # Use this parameter to prefill customer data if you already have an email
2231
+ # on file. To access information about the customer once a session is
2232
+ # complete, use the `customer` field.
2233
+ attr_accessor :customer_email
2234
+ # Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
2235
+ attr_accessor :customer_update
2236
+ # The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
2237
+ attr_accessor :discounts
2238
+ # A list of the types of payment methods (e.g., `card`) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
2239
+ attr_accessor :excluded_payment_method_types
2240
+ # Specifies which fields in the response should be expanded.
2241
+ attr_accessor :expand
2242
+ # 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.
2243
+ attr_accessor :expires_at
2244
+ # Generate a post-purchase Invoice for one-time payments.
2245
+ attr_accessor :invoice_creation
2246
+ # A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). The parameter is required for `payment` and `subscription` mode.
2247
+ #
2248
+ # 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.
2249
+ #
2250
+ # 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.
2251
+ attr_accessor :line_items
2252
+ # The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
2253
+ attr_accessor :locale
2254
+ # 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`.
2255
+ attr_accessor :metadata
2256
+ # The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
2257
+ attr_accessor :mode
2258
+ # Controls name collection settings for the session.
2259
+ #
2260
+ # You can configure Checkout to collect your customers' business names, individual names, or both. Each name field can be either required or optional.
2261
+ #
2262
+ # If a [Customer](https://stripe.com/docs/api/customers) is created or provided, the names can be saved to the Customer object as well.
2263
+ attr_accessor :name_collection
2264
+ # A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
2265
+ #
2266
+ # There is a maximum of 10 optional items allowed on a Checkout Session, and the existing limits on the number of line items allowed on a Checkout Session apply to the combined number of line items and optional items.
2267
+ #
2268
+ # For `payment` mode, there is a maximum of 100 combined line items and optional items, however it is recommended to consolidate items if there are more than a few dozen.
2269
+ #
2270
+ # For `subscription` mode, there is a maximum of 20 line items and optional items with recurring Prices and 20 line items and optional items with one-time Prices.
2271
+ attr_accessor :optional_items
2272
+ # Where the user is coming from. This informs the optimizations that are applied to the session.
2273
+ attr_accessor :origin_context
2274
+ # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
2275
+ attr_accessor :payment_intent_data
2276
+ # 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.
2277
+ # This may occur if the Checkout Session includes a free trial or a discount.
2278
+ #
2279
+ # Can only be set in `subscription` mode. Defaults to `always`.
2280
+ #
2281
+ # 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).
2282
+ attr_accessor :payment_method_collection
2283
+ # The ID of the payment method configuration to use with this Checkout session.
2284
+ attr_accessor :payment_method_configuration
2285
+ # This parameter allows you to set some attributes on the payment method created during a Checkout session.
2286
+ attr_accessor :payment_method_data
2287
+ # Payment-method-specific configuration.
2288
+ attr_accessor :payment_method_options
2289
+ # A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
2290
+ #
2291
+ # You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
2292
+ # See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.
2293
+ #
2294
+ # Read more about the supported payment methods and their requirements in our [payment
2295
+ # method details guide](/docs/payments/checkout/payment-methods).
2296
+ #
2297
+ # If multiple payment methods are passed, Checkout will dynamically reorder them to
2298
+ # prioritize the most relevant payment methods based on the customer's location and
2299
+ # other characteristics.
2300
+ attr_accessor :payment_method_types
2301
+ # This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object. Can only be set when creating `embedded` or `custom` sessions.
2302
+ #
2303
+ # For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.
2304
+ attr_accessor :permissions
2305
+ # Controls phone number collection settings for the session.
2306
+ #
2307
+ # We recommend that you review your privacy policy and check with your legal contacts
2308
+ # before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).
2309
+ attr_accessor :phone_number_collection
2310
+ # 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`.
2311
+ attr_accessor :redirect_on_completion
2312
+ # The URL to redirect your customer back to after they authenticate or cancel their payment on the
2313
+ # payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
2314
+ # and redirect-based payment methods are enabled on the session.
2315
+ attr_accessor :return_url
2316
+ # Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
2317
+ attr_accessor :saved_payment_method_options
2318
+ # A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
2319
+ attr_accessor :setup_intent_data
2320
+ # When set, provides configuration for Checkout to collect a shipping address from a customer.
2321
+ attr_accessor :shipping_address_collection
2322
+ # The shipping rate options to apply to this Session. Up to a maximum of 5.
2323
+ attr_accessor :shipping_options
2324
+ # Describes the type of transaction being performed by Checkout in order
2325
+ # to customize relevant text on the page, such as the submit button.
2326
+ # `submit_type` can only be specified on Checkout Sessions in
2327
+ # `payment` or `subscription` mode. If blank or `auto`, `pay` is used.
2328
+ attr_accessor :submit_type
2329
+ # A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
2330
+ attr_accessor :subscription_data
2331
+ # The URL to which Stripe should send customers when payment or setup
2332
+ # is complete.
2333
+ # This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
2334
+ # information from the successful Checkout Session on your page, read the
2335
+ # guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
2336
+ attr_accessor :success_url
2337
+ # Controls tax ID collection during checkout.
2338
+ attr_accessor :tax_id_collection
2339
+ # The UI mode of the Session. Defaults to `hosted`.
2340
+ attr_accessor :ui_mode
2341
+ # Wallet-specific configuration.
2342
+ attr_accessor :wallet_options
2343
+
2344
+ def initialize(
2345
+ adaptive_pricing: nil,
2346
+ after_expiration: nil,
2347
+ allow_promotion_codes: nil,
2348
+ automatic_tax: nil,
2349
+ billing_address_collection: nil,
2350
+ branding_settings: nil,
2351
+ cancel_url: nil,
2352
+ client_reference_id: nil,
2353
+ consent_collection: nil,
2354
+ currency: nil,
2355
+ custom_fields: nil,
2356
+ custom_text: nil,
2357
+ customer: nil,
2358
+ customer_creation: nil,
2359
+ customer_email: nil,
2360
+ customer_update: nil,
2361
+ discounts: nil,
2362
+ excluded_payment_method_types: nil,
2363
+ expand: nil,
2364
+ expires_at: nil,
2365
+ invoice_creation: nil,
2366
+ line_items: nil,
2367
+ locale: nil,
2368
+ metadata: nil,
2369
+ mode: nil,
2370
+ name_collection: nil,
2371
+ optional_items: nil,
2372
+ origin_context: nil,
2373
+ payment_intent_data: nil,
2374
+ payment_method_collection: nil,
2375
+ payment_method_configuration: nil,
2376
+ payment_method_data: nil,
2377
+ payment_method_options: nil,
2378
+ payment_method_types: nil,
2379
+ permissions: nil,
2380
+ phone_number_collection: nil,
2381
+ redirect_on_completion: nil,
2382
+ return_url: nil,
2383
+ saved_payment_method_options: nil,
2384
+ setup_intent_data: nil,
2385
+ shipping_address_collection: nil,
2386
+ shipping_options: nil,
2387
+ submit_type: nil,
2388
+ subscription_data: nil,
2389
+ success_url: nil,
2390
+ tax_id_collection: nil,
2391
+ ui_mode: nil,
2392
+ wallet_options: nil
2393
+ )
2394
+ @adaptive_pricing = adaptive_pricing
2395
+ @after_expiration = after_expiration
2396
+ @allow_promotion_codes = allow_promotion_codes
2397
+ @automatic_tax = automatic_tax
2398
+ @billing_address_collection = billing_address_collection
2399
+ @branding_settings = branding_settings
2400
+ @cancel_url = cancel_url
2401
+ @client_reference_id = client_reference_id
2402
+ @consent_collection = consent_collection
2403
+ @currency = currency
2404
+ @custom_fields = custom_fields
2405
+ @custom_text = custom_text
2406
+ @customer = customer
2407
+ @customer_creation = customer_creation
2408
+ @customer_email = customer_email
2409
+ @customer_update = customer_update
2410
+ @discounts = discounts
2411
+ @excluded_payment_method_types = excluded_payment_method_types
2412
+ @expand = expand
2413
+ @expires_at = expires_at
2414
+ @invoice_creation = invoice_creation
2415
+ @line_items = line_items
2416
+ @locale = locale
2417
+ @metadata = metadata
2418
+ @mode = mode
2419
+ @name_collection = name_collection
2420
+ @optional_items = optional_items
2421
+ @origin_context = origin_context
2422
+ @payment_intent_data = payment_intent_data
2423
+ @payment_method_collection = payment_method_collection
2424
+ @payment_method_configuration = payment_method_configuration
2425
+ @payment_method_data = payment_method_data
2426
+ @payment_method_options = payment_method_options
2427
+ @payment_method_types = payment_method_types
2428
+ @permissions = permissions
2429
+ @phone_number_collection = phone_number_collection
2430
+ @redirect_on_completion = redirect_on_completion
2431
+ @return_url = return_url
2432
+ @saved_payment_method_options = saved_payment_method_options
2433
+ @setup_intent_data = setup_intent_data
2434
+ @shipping_address_collection = shipping_address_collection
2435
+ @shipping_options = shipping_options
2436
+ @submit_type = submit_type
2437
+ @subscription_data = subscription_data
2438
+ @success_url = success_url
2439
+ @tax_id_collection = tax_id_collection
2440
+ @ui_mode = ui_mode
2441
+ @wallet_options = wallet_options
2442
+ end
2443
+ end
2444
+ end
2445
+ end