stripe 5.55.0 → 18.2.0.pre.beta.1

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