stripe 15.6.0.pre.beta.1 → 16.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1097) hide show
  1. checksums.yaml +4 -4
  2. data/lib/stripe/api_requestor.rb +5 -34
  3. data/lib/stripe/api_resource.rb +3 -0
  4. data/lib/stripe/api_version.rb +2 -1
  5. data/lib/stripe/errors.rb +0 -60
  6. data/lib/stripe/event_types.rb +20 -108
  7. data/lib/stripe/events/unknown_event_notification.rb +19 -0
  8. data/lib/stripe/events/v1_billing_meter_error_report_triggered_event.rb +115 -15
  9. data/lib/stripe/events/v1_billing_meter_no_meter_found_event.rb +93 -6
  10. data/lib/stripe/events/v2_core_event_destination_ping_event.rb +35 -12
  11. data/lib/stripe/object_types.rb +2 -54
  12. data/lib/stripe/params/account_capability_list_params.rb +13 -0
  13. data/lib/stripe/params/account_capability_retrieve_params.rb +13 -0
  14. data/lib/stripe/params/account_capability_update_params.rb +18 -0
  15. data/lib/stripe/params/account_create_params.rb +2083 -0
  16. data/lib/stripe/params/account_delete_params.rb +6 -0
  17. data/lib/stripe/params/account_external_account_create_params.rb +134 -0
  18. data/lib/stripe/params/account_external_account_delete_params.rb +6 -0
  19. data/lib/stripe/params/account_external_account_list_params.rb +25 -0
  20. data/lib/stripe/params/account_external_account_retrieve_params.rb +13 -0
  21. data/lib/stripe/params/account_external_account_update_params.rb +91 -0
  22. data/lib/stripe/params/account_link_create_params.rb +52 -0
  23. data/lib/stripe/params/account_list_params.rb +42 -0
  24. data/lib/stripe/params/account_login_link_create_params.rb +13 -0
  25. data/lib/stripe/params/account_person_create_params.rb +435 -0
  26. data/lib/stripe/params/account_person_delete_params.rb +6 -0
  27. data/lib/stripe/params/account_person_list_params.rb +61 -0
  28. data/lib/stripe/params/account_person_retrieve_params.rb +13 -0
  29. data/lib/stripe/params/account_person_update_params.rb +435 -0
  30. data/lib/stripe/params/account_persons_params.rb +61 -0
  31. data/lib/stripe/params/account_reject_params.rb +16 -0
  32. data/lib/stripe/params/account_retrieve_current_params.rb +13 -0
  33. data/lib/stripe/params/account_retrieve_params.rb +13 -0
  34. data/lib/stripe/params/account_session_create_params.rb +598 -0
  35. data/lib/stripe/params/account_update_params.rb +2030 -0
  36. data/lib/stripe/params/apple_pay_domain_create_params.rb +16 -0
  37. data/lib/stripe/params/apple_pay_domain_delete_params.rb +6 -0
  38. data/lib/stripe/params/apple_pay_domain_list_params.rb +31 -0
  39. data/lib/stripe/params/apple_pay_domain_retrieve_params.rb +13 -0
  40. data/lib/stripe/params/application_fee_list_params.rb +52 -0
  41. data/lib/stripe/params/application_fee_refund_create_params.rb +19 -0
  42. data/lib/stripe/params/application_fee_refund_list_params.rb +22 -0
  43. data/lib/stripe/params/application_fee_refund_retrieve_params.rb +13 -0
  44. data/lib/stripe/params/application_fee_refund_update_params.rb +16 -0
  45. data/lib/stripe/params/application_fee_retrieve_params.rb +13 -0
  46. data/lib/stripe/params/apps/secret_create_params.rb +38 -0
  47. data/lib/stripe/params/apps/secret_delete_where_params.rb +32 -0
  48. data/lib/stripe/params/apps/secret_find_params.rb +32 -0
  49. data/lib/stripe/{services/quote_line_service.rb → params/apps/secret_list_params.rb} +17 -14
  50. data/lib/stripe/params/balance_retrieve_params.rb +13 -0
  51. data/lib/stripe/params/balance_settings_retrieve_params.rb +13 -0
  52. data/lib/stripe/params/balance_settings_update_params.rb +67 -0
  53. data/lib/stripe/params/balance_transaction_list_params.rb +64 -0
  54. data/lib/stripe/params/balance_transaction_retrieve_params.rb +13 -0
  55. data/lib/stripe/params/billing/alert_activate_params.rb +15 -0
  56. data/lib/stripe/params/billing/alert_archive_params.rb +15 -0
  57. data/lib/stripe/params/billing/alert_create_params.rb +52 -0
  58. data/lib/stripe/params/billing/alert_deactivate_params.rb +15 -0
  59. data/lib/stripe/params/billing/alert_list_params.rb +37 -0
  60. data/lib/stripe/params/billing/alert_retrieve_params.rb +15 -0
  61. data/lib/stripe/params/billing/credit_balance_summary_retrieve_params.rb +54 -0
  62. data/lib/stripe/params/billing/credit_balance_transaction_list_params.rb +37 -0
  63. data/lib/stripe/params/billing/credit_balance_transaction_retrieve_params.rb +15 -0
  64. data/lib/stripe/params/billing/credit_grant_create_params.rb +103 -0
  65. data/lib/stripe/params/billing/credit_grant_expire_params.rb +15 -0
  66. data/lib/stripe/params/billing/credit_grant_list_params.rb +33 -0
  67. data/lib/stripe/params/billing/credit_grant_retrieve_params.rb +15 -0
  68. data/lib/stripe/params/billing/credit_grant_update_params.rb +21 -0
  69. data/lib/stripe/params/billing/credit_grant_void_grant_params.rb +15 -0
  70. data/lib/stripe/params/billing/meter_create_params.rb +70 -0
  71. data/lib/stripe/params/billing/meter_deactivate_params.rb +15 -0
  72. data/lib/stripe/params/billing/meter_event_adjustment_create_params.rb +32 -0
  73. data/lib/stripe/params/billing/meter_event_create_params.rb +27 -0
  74. data/lib/stripe/params/billing/meter_event_summary_list_params.rb +45 -0
  75. data/lib/stripe/params/billing/meter_list_params.rb +27 -0
  76. data/lib/stripe/params/billing/meter_reactivate_params.rb +15 -0
  77. data/lib/stripe/params/billing/meter_retrieve_params.rb +15 -0
  78. data/lib/stripe/params/billing/meter_update_params.rb +18 -0
  79. data/lib/stripe/params/billing_portal/configuration_create_params.rb +225 -0
  80. data/lib/stripe/params/billing_portal/configuration_list_params.rb +37 -0
  81. data/lib/stripe/params/billing_portal/configuration_retrieve_params.rb +15 -0
  82. data/lib/stripe/params/billing_portal/configuration_update_params.rb +231 -0
  83. data/lib/stripe/params/billing_portal/session_create_params.rb +179 -0
  84. data/lib/stripe/params/charge_capture_params.rb +57 -0
  85. data/lib/stripe/params/charge_create_params.rb +172 -0
  86. data/lib/stripe/params/charge_list_params.rb +60 -0
  87. data/lib/stripe/params/charge_retrieve_params.rb +13 -0
  88. data/lib/stripe/params/charge_search_params.rb +22 -0
  89. data/lib/stripe/params/charge_update_params.rb +102 -0
  90. data/lib/stripe/params/checkout/session_create_params.rb +2445 -0
  91. data/lib/stripe/params/checkout/session_expire_params.rb +15 -0
  92. data/lib/stripe/{services/quote_preview_subscription_schedule_service.rb → params/checkout/session_line_item_list_params.rb} +2 -13
  93. data/lib/stripe/{services/order_line_item_service.rb → params/checkout/session_list_line_items_params.rb} +2 -13
  94. data/lib/stripe/params/checkout/session_list_params.rb +83 -0
  95. data/lib/stripe/params/checkout/session_retrieve_params.rb +15 -0
  96. data/lib/stripe/params/checkout/session_update_params.rb +179 -0
  97. data/lib/stripe/params/climate/order_cancel_params.rb +15 -0
  98. data/lib/stripe/params/climate/order_create_params.rb +49 -0
  99. data/lib/stripe/params/climate/order_list_params.rb +24 -0
  100. data/lib/stripe/params/climate/order_retrieve_params.rb +15 -0
  101. data/lib/stripe/params/climate/order_update_params.rb +29 -0
  102. data/lib/stripe/params/climate/product_list_params.rb +24 -0
  103. data/lib/stripe/params/climate/product_retrieve_params.rb +15 -0
  104. data/lib/stripe/params/climate/supplier_list_params.rb +24 -0
  105. data/lib/stripe/params/climate/supplier_retrieve_params.rb +15 -0
  106. data/lib/stripe/params/confirmation_token_create_params.rb +650 -0
  107. data/lib/stripe/params/confirmation_token_retrieve_params.rb +13 -0
  108. data/lib/stripe/params/country_spec_list_params.rb +22 -0
  109. data/lib/stripe/params/country_spec_retrieve_params.rb +13 -0
  110. data/lib/stripe/params/coupon_create_params.rb +80 -0
  111. data/lib/stripe/params/coupon_delete_params.rb +6 -0
  112. data/lib/stripe/params/coupon_list_params.rb +42 -0
  113. data/lib/stripe/params/coupon_retrieve_params.rb +13 -0
  114. data/lib/stripe/params/coupon_update_params.rb +30 -0
  115. data/lib/stripe/params/credit_note_create_params.rb +144 -0
  116. data/lib/stripe/params/credit_note_line_item_list_params.rb +22 -0
  117. data/lib/stripe/params/credit_note_list_params.rb +56 -0
  118. data/lib/stripe/params/credit_note_list_preview_line_items_params.rb +156 -0
  119. data/lib/stripe/params/credit_note_preview_lines_list_params.rb +156 -0
  120. data/lib/stripe/params/credit_note_preview_params.rb +144 -0
  121. data/lib/stripe/params/credit_note_retrieve_params.rb +13 -0
  122. data/lib/stripe/params/credit_note_update_params.rb +19 -0
  123. data/lib/stripe/params/credit_note_void_credit_note_params.rb +13 -0
  124. data/lib/stripe/params/customer_balance_transaction_create_params.rb +25 -0
  125. data/lib/stripe/params/customer_balance_transaction_list_params.rb +22 -0
  126. data/lib/stripe/params/customer_balance_transaction_retrieve_params.rb +13 -0
  127. data/lib/stripe/params/customer_balance_transaction_update_params.rb +19 -0
  128. data/lib/stripe/params/customer_cash_balance_retrieve_params.rb +13 -0
  129. data/lib/stripe/params/customer_cash_balance_transaction_list_params.rb +22 -0
  130. data/lib/stripe/params/customer_cash_balance_transaction_retrieve_params.rb +13 -0
  131. data/lib/stripe/params/customer_cash_balance_update_params.rb +24 -0
  132. data/lib/stripe/params/customer_create_funding_instructions_params.rb +46 -0
  133. data/lib/stripe/params/customer_create_params.rb +259 -0
  134. data/lib/stripe/params/customer_delete_discount_params.rb +6 -0
  135. data/lib/stripe/params/customer_delete_params.rb +6 -0
  136. data/lib/stripe/params/customer_fund_cash_balance_params.rb +22 -0
  137. data/lib/stripe/params/customer_funding_instructions_create_params.rb +46 -0
  138. data/lib/stripe/params/customer_list_params.rb +56 -0
  139. data/lib/stripe/params/customer_list_payment_methods_params.rb +35 -0
  140. data/lib/stripe/params/customer_payment_method_list_params.rb +35 -0
  141. data/lib/stripe/params/customer_payment_method_retrieve_params.rb +13 -0
  142. data/lib/stripe/params/customer_payment_source_create_params.rb +22 -0
  143. data/lib/stripe/params/customer_payment_source_delete_params.rb +13 -0
  144. data/lib/stripe/params/customer_payment_source_list_params.rb +25 -0
  145. data/lib/stripe/params/customer_payment_source_retrieve_params.rb +13 -0
  146. data/lib/stripe/params/customer_payment_source_update_params.rb +114 -0
  147. data/lib/stripe/params/customer_payment_source_verify_params.rb +16 -0
  148. data/lib/stripe/params/customer_retrieve_params.rb +13 -0
  149. data/lib/stripe/params/customer_retrieve_payment_method_params.rb +13 -0
  150. data/lib/stripe/params/customer_search_params.rb +22 -0
  151. data/lib/stripe/params/customer_session_create_params.rb +100 -0
  152. data/lib/stripe/params/customer_tax_id_create_params.rb +19 -0
  153. data/lib/stripe/params/customer_tax_id_delete_params.rb +6 -0
  154. data/lib/stripe/params/customer_tax_id_list_params.rb +22 -0
  155. data/lib/stripe/params/customer_tax_id_retrieve_params.rb +13 -0
  156. data/lib/stripe/params/customer_update_params.rb +243 -0
  157. data/lib/stripe/params/dispute_close_params.rb +13 -0
  158. data/lib/stripe/params/dispute_list_params.rb +56 -0
  159. data/lib/stripe/params/dispute_retrieve_params.rb +13 -0
  160. data/lib/stripe/params/dispute_update_params.rb +308 -0
  161. data/lib/stripe/params/entitlements/active_entitlement_list_params.rb +33 -0
  162. data/lib/stripe/params/entitlements/active_entitlement_retrieve_params.rb +15 -0
  163. data/lib/stripe/params/entitlements/feature_create_params.rb +24 -0
  164. data/lib/stripe/params/entitlements/feature_list_params.rb +37 -0
  165. data/lib/stripe/params/entitlements/feature_retrieve_params.rb +15 -0
  166. data/lib/stripe/params/entitlements/feature_update_params.rb +24 -0
  167. data/lib/stripe/params/ephemeral_key_create_params.rb +31 -0
  168. data/lib/stripe/params/ephemeral_key_delete_params.rb +13 -0
  169. data/lib/stripe/params/event_list_params.rb +60 -0
  170. data/lib/stripe/params/event_retrieve_params.rb +13 -0
  171. data/lib/stripe/params/exchange_rate_list_params.rb +22 -0
  172. data/lib/stripe/params/exchange_rate_retrieve_params.rb +13 -0
  173. data/lib/stripe/params/file_create_params.rb +36 -0
  174. data/lib/stripe/params/file_link_create_params.rb +22 -0
  175. data/lib/stripe/params/file_link_list_params.rb +56 -0
  176. data/lib/stripe/params/file_link_retrieve_params.rb +13 -0
  177. data/lib/stripe/params/file_link_update_params.rb +19 -0
  178. data/lib/stripe/params/file_list_params.rb +52 -0
  179. data/lib/stripe/params/file_retrieve_params.rb +13 -0
  180. data/lib/stripe/params/financial_connections/account_disconnect_params.rb +15 -0
  181. data/lib/stripe/params/financial_connections/account_list_owners_params.rb +33 -0
  182. data/lib/stripe/params/financial_connections/account_list_params.rb +48 -0
  183. data/lib/stripe/params/financial_connections/account_owner_list_params.rb +33 -0
  184. data/lib/stripe/params/financial_connections/account_refresh_account_params.rb +18 -0
  185. data/lib/stripe/params/financial_connections/account_refresh_params.rb +18 -0
  186. data/lib/stripe/params/financial_connections/account_retrieve_params.rb +15 -0
  187. data/lib/stripe/params/financial_connections/account_subscribe_params.rb +18 -0
  188. data/lib/stripe/params/financial_connections/account_unsubscribe_params.rb +18 -0
  189. data/lib/stripe/params/financial_connections/session_create_params.rb +65 -0
  190. data/lib/stripe/params/financial_connections/session_retrieve_params.rb +15 -0
  191. data/lib/stripe/params/financial_connections/transaction_list_params.rb +67 -0
  192. data/lib/stripe/params/financial_connections/transaction_retrieve_params.rb +15 -0
  193. data/lib/stripe/params/forwarding/request_create_params.rb +59 -0
  194. data/lib/stripe/params/forwarding/request_list_params.rb +44 -0
  195. data/lib/stripe/params/forwarding/request_retrieve_params.rb +15 -0
  196. data/lib/stripe/params/identity/verification_report_list_params.rb +62 -0
  197. data/lib/stripe/params/identity/verification_report_retrieve_params.rb +15 -0
  198. data/lib/stripe/params/identity/verification_session_cancel_params.rb +15 -0
  199. data/lib/stripe/params/identity/verification_session_create_params.rb +107 -0
  200. data/lib/stripe/params/identity/verification_session_list_params.rb +62 -0
  201. data/lib/stripe/params/identity/verification_session_redact_params.rb +15 -0
  202. data/lib/stripe/params/identity/verification_session_retrieve_params.rb +15 -0
  203. data/lib/stripe/params/identity/verification_session_update_params.rb +69 -0
  204. data/lib/stripe/params/invoice_add_lines_params.rb +231 -0
  205. data/lib/stripe/params/invoice_attach_payment_params.rb +16 -0
  206. data/lib/stripe/params/invoice_create_params.rb +589 -0
  207. data/lib/stripe/params/invoice_create_preview_params.rb +993 -0
  208. data/lib/stripe/params/invoice_delete_params.rb +6 -0
  209. data/lib/stripe/params/invoice_finalize_invoice_params.rb +16 -0
  210. data/lib/stripe/params/invoice_item_create_params.rb +145 -0
  211. data/lib/stripe/params/invoice_item_delete_params.rb +6 -0
  212. data/lib/stripe/params/invoice_item_list_params.rb +60 -0
  213. data/lib/stripe/params/invoice_item_retrieve_params.rb +13 -0
  214. data/lib/stripe/params/invoice_item_update_params.rb +129 -0
  215. data/lib/stripe/params/invoice_line_item_list_params.rb +22 -0
  216. data/lib/stripe/params/invoice_line_item_update_params.rb +217 -0
  217. data/lib/stripe/params/invoice_list_params.rb +86 -0
  218. data/lib/stripe/params/invoice_mark_uncollectible_params.rb +13 -0
  219. data/lib/stripe/params/invoice_pay_params.rb +41 -0
  220. data/lib/stripe/params/invoice_payment_list_params.rb +50 -0
  221. data/lib/stripe/params/invoice_payment_retrieve_params.rb +13 -0
  222. data/lib/stripe/params/invoice_remove_lines_params.rb +30 -0
  223. data/lib/stripe/params/invoice_rendering_template_archive_params.rb +13 -0
  224. data/lib/stripe/params/invoice_rendering_template_list_params.rb +25 -0
  225. data/lib/stripe/params/invoice_rendering_template_retrieve_params.rb +16 -0
  226. data/lib/stripe/params/invoice_rendering_template_unarchive_params.rb +13 -0
  227. data/lib/stripe/params/invoice_retrieve_params.rb +13 -0
  228. data/lib/stripe/params/invoice_search_params.rb +22 -0
  229. data/lib/stripe/params/invoice_send_invoice_params.rb +13 -0
  230. data/lib/stripe/params/invoice_update_lines_params.rb +231 -0
  231. data/lib/stripe/params/invoice_update_params.rb +557 -0
  232. data/lib/stripe/params/invoice_void_invoice_params.rb +13 -0
  233. data/lib/stripe/params/issuing/authorization_approve_params.rb +21 -0
  234. data/lib/stripe/params/issuing/authorization_capture_params.rb +265 -0
  235. data/lib/stripe/params/issuing/authorization_create_params.rb +357 -0
  236. data/lib/stripe/params/issuing/authorization_decline_params.rb +18 -0
  237. data/lib/stripe/params/issuing/authorization_expire_params.rb +15 -0
  238. data/lib/stripe/params/issuing/authorization_finalize_amount_params.rb +143 -0
  239. data/lib/stripe/params/issuing/authorization_increment_params.rb +21 -0
  240. data/lib/stripe/params/issuing/authorization_list_params.rb +62 -0
  241. data/lib/stripe/params/issuing/authorization_respond_params.rb +18 -0
  242. data/lib/stripe/params/issuing/authorization_retrieve_params.rb +15 -0
  243. data/lib/stripe/params/issuing/authorization_reverse_params.rb +18 -0
  244. data/lib/stripe/params/issuing/authorization_update_params.rb +18 -0
  245. data/lib/stripe/params/issuing/card_create_params.rb +213 -0
  246. data/lib/stripe/params/issuing/card_deliver_card_params.rb +15 -0
  247. data/lib/stripe/params/issuing/card_fail_card_params.rb +15 -0
  248. data/lib/stripe/params/issuing/card_list_params.rb +78 -0
  249. data/lib/stripe/params/issuing/card_retrieve_params.rb +15 -0
  250. data/lib/stripe/params/issuing/card_return_card_params.rb +15 -0
  251. data/lib/stripe/params/issuing/card_ship_card_params.rb +15 -0
  252. data/lib/stripe/params/issuing/card_submit_card_params.rb +15 -0
  253. data/lib/stripe/params/issuing/card_update_params.rb +181 -0
  254. data/lib/stripe/params/issuing/cardholder_create_params.rb +238 -0
  255. data/lib/stripe/params/issuing/cardholder_list_params.rb +66 -0
  256. data/lib/stripe/params/issuing/cardholder_retrieve_params.rb +15 -0
  257. data/lib/stripe/params/issuing/cardholder_update_params.rb +230 -0
  258. data/lib/stripe/params/issuing/dispute_create_params.rb +297 -0
  259. data/lib/stripe/params/issuing/dispute_list_params.rb +58 -0
  260. data/lib/stripe/params/issuing/dispute_retrieve_params.rb +15 -0
  261. data/lib/stripe/params/issuing/dispute_submit_params.rb +18 -0
  262. data/lib/stripe/params/issuing/dispute_update_params.rb +275 -0
  263. data/lib/stripe/params/issuing/personalization_design_activate_params.rb +15 -0
  264. data/lib/stripe/params/issuing/personalization_design_create_params.rb +75 -0
  265. data/lib/stripe/params/issuing/personalization_design_deactivate_params.rb +15 -0
  266. data/lib/stripe/params/issuing/personalization_design_list_params.rb +52 -0
  267. data/lib/stripe/params/issuing/personalization_design_reject_params.rb +29 -0
  268. data/lib/stripe/params/issuing/personalization_design_retrieve_params.rb +15 -0
  269. data/lib/stripe/params/issuing/personalization_design_update_params.rb +75 -0
  270. data/lib/stripe/params/issuing/physical_bundle_list_params.rb +37 -0
  271. data/lib/stripe/params/issuing/physical_bundle_retrieve_params.rb +15 -0
  272. data/lib/stripe/params/issuing/token_list_params.rb +58 -0
  273. data/lib/stripe/params/issuing/token_retrieve_params.rb +15 -0
  274. data/lib/stripe/params/issuing/token_update_params.rb +18 -0
  275. data/lib/stripe/params/issuing/transaction_create_force_capture_params.rb +316 -0
  276. data/lib/stripe/params/issuing/transaction_create_unlinked_refund_params.rb +316 -0
  277. data/lib/stripe/params/issuing/transaction_list_params.rb +62 -0
  278. data/lib/stripe/params/issuing/transaction_refund_params.rb +18 -0
  279. data/lib/stripe/params/issuing/transaction_retrieve_params.rb +15 -0
  280. data/lib/stripe/params/issuing/transaction_update_params.rb +18 -0
  281. data/lib/stripe/params/mandate_retrieve_params.rb +13 -0
  282. data/lib/stripe/params/payment_intent_apply_customer_balance_params.rb +23 -0
  283. data/lib/stripe/params/payment_intent_cancel_params.rb +16 -0
  284. data/lib/stripe/params/payment_intent_capture_params.rb +54 -0
  285. data/lib/stripe/params/payment_intent_confirm_params.rb +2379 -0
  286. data/lib/stripe/params/payment_intent_create_params.rb +2480 -0
  287. data/lib/stripe/params/payment_intent_increment_authorization_params.rb +48 -0
  288. data/lib/stripe/params/payment_intent_list_params.rb +52 -0
  289. data/lib/stripe/params/payment_intent_retrieve_params.rb +16 -0
  290. data/lib/stripe/params/payment_intent_search_params.rb +22 -0
  291. data/lib/stripe/params/payment_intent_update_params.rb +2353 -0
  292. data/lib/stripe/params/payment_intent_verify_microdeposits_params.rb +19 -0
  293. data/lib/stripe/params/payment_link_create_params.rb +776 -0
  294. data/lib/stripe/params/payment_link_line_item_list_params.rb +22 -0
  295. data/lib/stripe/params/payment_link_list_line_items_params.rb +22 -0
  296. data/lib/stripe/params/payment_link_list_params.rb +25 -0
  297. data/lib/stripe/params/payment_link_retrieve_params.rb +13 -0
  298. data/lib/stripe/params/payment_link_update_params.rb +564 -0
  299. data/lib/stripe/params/payment_method_attach_params.rb +16 -0
  300. data/lib/stripe/params/payment_method_configuration_create_params.rb +1135 -0
  301. data/lib/stripe/params/payment_method_configuration_list_params.rb +31 -0
  302. data/lib/stripe/params/payment_method_configuration_retrieve_params.rb +13 -0
  303. data/lib/stripe/params/payment_method_configuration_update_params.rb +1135 -0
  304. data/lib/stripe/params/payment_method_create_params.rb +583 -0
  305. data/lib/stripe/params/payment_method_detach_params.rb +13 -0
  306. data/lib/stripe/params/payment_method_domain_create_params.rb +19 -0
  307. data/lib/stripe/params/payment_method_domain_list_params.rb +35 -0
  308. data/lib/stripe/params/payment_method_domain_retrieve_params.rb +13 -0
  309. data/lib/stripe/params/payment_method_domain_update_params.rb +16 -0
  310. data/lib/stripe/params/payment_method_domain_validate_params.rb +13 -0
  311. data/lib/stripe/params/payment_method_list_params.rb +35 -0
  312. data/lib/stripe/params/payment_method_retrieve_params.rb +13 -0
  313. data/lib/stripe/params/payment_method_update_params.rb +120 -0
  314. data/lib/stripe/params/payout_cancel_params.rb +13 -0
  315. data/lib/stripe/params/payout_create_params.rb +51 -0
  316. data/lib/stripe/params/payout_list_params.rb +78 -0
  317. data/lib/stripe/params/payout_retrieve_params.rb +13 -0
  318. data/lib/stripe/params/payout_reverse_params.rb +16 -0
  319. data/lib/stripe/params/payout_update_params.rb +16 -0
  320. data/lib/stripe/params/plan_create_params.rb +158 -0
  321. data/lib/stripe/params/plan_delete_params.rb +6 -0
  322. data/lib/stripe/params/plan_list_params.rb +56 -0
  323. data/lib/stripe/params/plan_retrieve_params.rb +13 -0
  324. data/lib/stripe/params/plan_update_params.rb +35 -0
  325. data/lib/stripe/params/price_create_params.rb +278 -0
  326. data/lib/stripe/params/price_list_params.rb +87 -0
  327. data/lib/stripe/params/price_retrieve_params.rb +13 -0
  328. data/lib/stripe/params/price_search_params.rb +22 -0
  329. data/lib/stripe/params/price_update_params.rb +113 -0
  330. data/lib/stripe/params/product_create_params.rb +243 -0
  331. data/lib/stripe/params/product_delete_params.rb +6 -0
  332. data/lib/stripe/params/product_feature_create_params.rb +16 -0
  333. data/lib/stripe/params/product_feature_delete_params.rb +6 -0
  334. data/lib/stripe/params/product_feature_list_params.rb +22 -0
  335. data/lib/stripe/params/product_feature_retrieve_params.rb +13 -0
  336. data/lib/stripe/params/product_list_params.rb +68 -0
  337. data/lib/stripe/params/product_retrieve_params.rb +13 -0
  338. data/lib/stripe/params/product_search_params.rb +22 -0
  339. data/lib/stripe/params/product_update_params.rb +96 -0
  340. data/lib/stripe/params/promotion_code_create_params.rb +91 -0
  341. data/lib/stripe/params/promotion_code_list_params.rb +64 -0
  342. data/lib/stripe/params/promotion_code_retrieve_params.rb +13 -0
  343. data/lib/stripe/params/promotion_code_update_params.rb +38 -0
  344. data/lib/stripe/params/quote_accept_params.rb +13 -0
  345. data/lib/stripe/params/quote_cancel_params.rb +13 -0
  346. data/lib/stripe/params/quote_computed_upfront_line_items_list_params.rb +22 -0
  347. data/lib/stripe/params/quote_create_params.rb +301 -0
  348. data/lib/stripe/params/quote_finalize_quote_params.rb +16 -0
  349. data/lib/stripe/params/quote_line_item_list_params.rb +22 -0
  350. data/lib/stripe/params/quote_list_computed_upfront_line_items_params.rb +22 -0
  351. data/lib/stripe/params/quote_list_line_items_params.rb +22 -0
  352. data/lib/stripe/params/quote_list_params.rb +39 -0
  353. data/lib/stripe/params/quote_pdf_params.rb +13 -0
  354. data/lib/stripe/params/quote_retrieve_params.rb +13 -0
  355. data/lib/stripe/params/quote_update_params.rb +263 -0
  356. data/lib/stripe/params/radar/early_fraud_warning_list_params.rb +58 -0
  357. data/lib/stripe/params/radar/early_fraud_warning_retrieve_params.rb +15 -0
  358. data/lib/stripe/params/radar/value_list_create_params.rb +27 -0
  359. data/lib/stripe/params/radar/value_list_delete_params.rb +8 -0
  360. data/lib/stripe/params/radar/value_list_item_create_params.rb +21 -0
  361. data/lib/stripe/params/radar/value_list_item_delete_params.rb +8 -0
  362. data/lib/stripe/params/radar/value_list_item_list_params.rb +58 -0
  363. data/lib/stripe/params/radar/value_list_item_retrieve_params.rb +15 -0
  364. data/lib/stripe/params/radar/value_list_list_params.rb +58 -0
  365. data/lib/stripe/params/radar/value_list_retrieve_params.rb +15 -0
  366. data/lib/stripe/params/radar/value_list_update_params.rb +24 -0
  367. data/lib/stripe/params/refund_cancel_params.rb +13 -0
  368. data/lib/stripe/params/refund_create_params.rb +59 -0
  369. data/lib/stripe/params/refund_expire_params.rb +13 -0
  370. data/lib/stripe/params/refund_list_params.rb +56 -0
  371. data/lib/stripe/params/refund_retrieve_params.rb +13 -0
  372. data/lib/stripe/params/refund_update_params.rb +16 -0
  373. data/lib/stripe/params/reporting/report_run_create_params.rb +59 -0
  374. data/lib/stripe/params/reporting/report_run_list_params.rb +44 -0
  375. data/lib/stripe/params/reporting/report_run_retrieve_params.rb +15 -0
  376. data/lib/stripe/params/reporting/report_type_list_params.rb +15 -0
  377. data/lib/stripe/params/reporting/report_type_retrieve_params.rb +15 -0
  378. data/lib/stripe/params/review_approve_params.rb +13 -0
  379. data/lib/stripe/params/review_list_params.rb +42 -0
  380. data/lib/stripe/params/review_retrieve_params.rb +13 -0
  381. data/lib/stripe/params/setup_attempt_list_params.rb +55 -0
  382. data/lib/stripe/params/setup_intent_cancel_params.rb +16 -0
  383. data/lib/stripe/params/setup_intent_confirm_params.rb +1050 -0
  384. data/lib/stripe/params/setup_intent_create_params.rb +1130 -0
  385. data/lib/stripe/params/setup_intent_list_params.rb +62 -0
  386. data/lib/stripe/params/setup_intent_retrieve_params.rb +16 -0
  387. data/lib/stripe/params/setup_intent_update_params.rb +1025 -0
  388. data/lib/stripe/params/setup_intent_verify_microdeposits_params.rb +19 -0
  389. data/lib/stripe/params/shipping_rate_create_params.rb +103 -0
  390. data/lib/stripe/params/shipping_rate_list_params.rb +56 -0
  391. data/lib/stripe/params/shipping_rate_retrieve_params.rb +13 -0
  392. data/lib/stripe/params/shipping_rate_update_params.rb +44 -0
  393. data/lib/stripe/params/sigma/scheduled_query_run_list_params.rb +24 -0
  394. data/lib/stripe/params/sigma/scheduled_query_run_retrieve_params.rb +15 -0
  395. data/lib/stripe/params/source_create_params.rb +317 -0
  396. data/lib/stripe/params/source_detach_params.rb +13 -0
  397. data/lib/stripe/params/source_retrieve_params.rb +16 -0
  398. data/lib/stripe/params/source_transaction_list_params.rb +22 -0
  399. data/lib/stripe/params/source_update_params.rb +259 -0
  400. data/lib/stripe/params/source_verify_params.rb +16 -0
  401. data/lib/stripe/params/subscription_cancel_params.rb +33 -0
  402. data/lib/stripe/params/subscription_create_params.rb +704 -0
  403. data/lib/stripe/params/subscription_delete_discount_params.rb +6 -0
  404. data/lib/stripe/params/subscription_item_create_params.rb +134 -0
  405. data/lib/stripe/params/subscription_item_delete_params.rb +19 -0
  406. data/lib/stripe/params/subscription_item_list_params.rb +31 -0
  407. data/lib/stripe/params/subscription_item_retrieve_params.rb +13 -0
  408. data/lib/stripe/params/subscription_item_update_params.rb +134 -0
  409. data/lib/stripe/params/subscription_list_params.rb +129 -0
  410. data/lib/stripe/params/subscription_migrate_params.rb +35 -0
  411. data/lib/stripe/params/subscription_resume_params.rb +27 -0
  412. data/lib/stripe/params/subscription_retrieve_params.rb +13 -0
  413. data/lib/stripe/params/subscription_schedule_cancel_params.rb +19 -0
  414. data/lib/stripe/params/subscription_schedule_create_params.rb +590 -0
  415. data/lib/stripe/params/subscription_schedule_list_params.rb +122 -0
  416. data/lib/stripe/params/subscription_schedule_release_params.rb +16 -0
  417. data/lib/stripe/params/subscription_schedule_retrieve_params.rb +13 -0
  418. data/lib/stripe/params/subscription_schedule_update_params.rb +562 -0
  419. data/lib/stripe/params/subscription_search_params.rb +22 -0
  420. data/lib/stripe/params/subscription_update_params.rb +683 -0
  421. data/lib/stripe/params/tax/calculation_create_params.rb +206 -0
  422. data/lib/stripe/params/tax/calculation_line_item_list_params.rb +24 -0
  423. data/lib/stripe/{services/quote_preview_invoice_service.rb → params/tax/calculation_list_line_items_params.rb} +2 -13
  424. data/lib/stripe/params/tax/calculation_retrieve_params.rb +15 -0
  425. data/lib/stripe/params/tax/registration_create_params.rb +2018 -0
  426. data/lib/stripe/params/tax/registration_list_params.rb +27 -0
  427. data/lib/stripe/params/tax/registration_retrieve_params.rb +15 -0
  428. data/lib/stripe/params/tax/registration_update_params.rb +21 -0
  429. data/lib/stripe/params/tax/settings_retrieve_params.rb +15 -0
  430. data/lib/stripe/params/tax/settings_update_params.rb +71 -0
  431. data/lib/stripe/params/tax/transaction_create_from_calculation_params.rb +27 -0
  432. data/lib/stripe/params/tax/transaction_create_reversal_params.rb +87 -0
  433. data/lib/stripe/params/tax/transaction_line_item_list_params.rb +24 -0
  434. data/lib/stripe/{services/payment_intent_amount_details_line_item_service.rb → params/tax/transaction_list_line_items_params.rb} +2 -13
  435. data/lib/stripe/params/tax/transaction_retrieve_params.rb +15 -0
  436. data/lib/stripe/params/tax_code_list_params.rb +22 -0
  437. data/lib/stripe/params/tax_code_retrieve_params.rb +13 -0
  438. data/lib/stripe/params/tax_id_create_params.rb +36 -0
  439. data/lib/stripe/params/tax_id_delete_params.rb +6 -0
  440. data/lib/stripe/params/tax_id_list_params.rb +39 -0
  441. data/lib/stripe/params/tax_id_retrieve_params.rb +13 -0
  442. data/lib/stripe/params/tax_rate_create_params.rb +55 -0
  443. data/lib/stripe/params/tax_rate_list_params.rb +56 -0
  444. data/lib/stripe/params/tax_rate_retrieve_params.rb +13 -0
  445. data/lib/stripe/params/tax_rate_update_params.rb +47 -0
  446. data/lib/stripe/params/terminal/configuration_create_params.rb +593 -0
  447. data/lib/stripe/params/terminal/configuration_delete_params.rb +8 -0
  448. data/lib/stripe/params/terminal/configuration_list_params.rb +33 -0
  449. data/lib/stripe/params/terminal/configuration_retrieve_params.rb +15 -0
  450. data/lib/stripe/params/terminal/configuration_update_params.rb +593 -0
  451. data/lib/stripe/params/terminal/connection_token_create_params.rb +18 -0
  452. data/lib/stripe/params/terminal/location_create_params.rb +153 -0
  453. data/lib/stripe/params/terminal/location_delete_params.rb +8 -0
  454. data/lib/stripe/params/terminal/location_list_params.rb +24 -0
  455. data/lib/stripe/params/terminal/location_retrieve_params.rb +15 -0
  456. data/lib/stripe/params/terminal/location_update_params.rb +153 -0
  457. data/lib/stripe/params/terminal/reader_cancel_action_params.rb +15 -0
  458. data/lib/stripe/params/terminal/reader_collect_inputs_params.rb +96 -0
  459. data/lib/stripe/params/terminal/reader_collect_payment_method_params.rb +51 -0
  460. data/lib/stripe/params/terminal/reader_confirm_payment_intent_params.rb +29 -0
  461. data/lib/stripe/params/terminal/reader_create_params.rb +27 -0
  462. data/lib/stripe/params/terminal/reader_delete_params.rb +8 -0
  463. data/lib/stripe/params/terminal/reader_list_params.rb +45 -0
  464. data/lib/stripe/params/terminal/reader_present_payment_method_params.rb +72 -0
  465. data/lib/stripe/params/terminal/reader_process_payment_intent_params.rb +55 -0
  466. data/lib/stripe/params/terminal/reader_process_setup_intent_params.rb +32 -0
  467. data/lib/stripe/params/terminal/reader_refund_payment_params.rb +53 -0
  468. data/lib/stripe/params/terminal/reader_retrieve_params.rb +15 -0
  469. data/lib/stripe/params/terminal/reader_set_reader_display_params.rb +52 -0
  470. data/lib/stripe/params/terminal/reader_succeed_input_collection_params.rb +18 -0
  471. data/lib/stripe/params/terminal/reader_timeout_input_collection_params.rb +15 -0
  472. data/lib/stripe/params/terminal/reader_update_params.rb +21 -0
  473. data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +652 -0
  474. data/lib/stripe/params/test_helpers/customer_fund_cash_balance_params.rb +24 -0
  475. data/lib/stripe/params/test_helpers/issuing/authorization_capture_params.rb +267 -0
  476. data/lib/stripe/params/test_helpers/issuing/authorization_create_params.rb +359 -0
  477. data/lib/stripe/params/test_helpers/issuing/authorization_expire_params.rb +17 -0
  478. data/lib/stripe/params/test_helpers/issuing/authorization_finalize_amount_params.rb +145 -0
  479. data/lib/stripe/params/test_helpers/issuing/authorization_increment_params.rb +23 -0
  480. data/lib/stripe/params/test_helpers/issuing/authorization_respond_params.rb +20 -0
  481. data/lib/stripe/params/test_helpers/issuing/authorization_reverse_params.rb +20 -0
  482. data/lib/stripe/params/test_helpers/issuing/card_deliver_card_params.rb +17 -0
  483. data/lib/stripe/params/test_helpers/issuing/card_fail_card_params.rb +17 -0
  484. data/lib/stripe/params/test_helpers/issuing/card_return_card_params.rb +17 -0
  485. data/lib/stripe/params/test_helpers/issuing/card_ship_card_params.rb +17 -0
  486. data/lib/stripe/params/test_helpers/issuing/card_submit_card_params.rb +17 -0
  487. data/lib/stripe/params/test_helpers/issuing/personalization_design_activate_params.rb +17 -0
  488. data/lib/stripe/params/test_helpers/issuing/personalization_design_deactivate_params.rb +17 -0
  489. data/lib/stripe/params/test_helpers/issuing/personalization_design_reject_params.rb +31 -0
  490. data/lib/stripe/params/test_helpers/issuing/transaction_create_force_capture_params.rb +318 -0
  491. data/lib/stripe/params/test_helpers/issuing/transaction_create_unlinked_refund_params.rb +318 -0
  492. data/lib/stripe/params/test_helpers/issuing/transaction_refund_params.rb +20 -0
  493. data/lib/stripe/params/test_helpers/refund_expire_params.rb +15 -0
  494. data/lib/stripe/params/test_helpers/terminal/reader_present_payment_method_params.rb +74 -0
  495. data/lib/stripe/params/test_helpers/terminal/reader_succeed_input_collection_params.rb +20 -0
  496. data/lib/stripe/params/test_helpers/terminal/reader_timeout_input_collection_params.rb +17 -0
  497. data/lib/stripe/params/test_helpers/test_clock_advance_params.rb +18 -0
  498. data/lib/stripe/params/test_helpers/test_clock_create_params.rb +21 -0
  499. data/lib/stripe/params/test_helpers/test_clock_delete_params.rb +8 -0
  500. data/lib/stripe/params/test_helpers/test_clock_list_params.rb +24 -0
  501. data/lib/stripe/params/test_helpers/test_clock_retrieve_params.rb +15 -0
  502. data/lib/stripe/params/test_helpers/treasury/inbound_transfer_fail_params.rb +28 -0
  503. data/lib/stripe/params/test_helpers/treasury/inbound_transfer_return_inbound_transfer_params.rb +17 -0
  504. data/lib/stripe/params/test_helpers/treasury/inbound_transfer_succeed_params.rb +17 -0
  505. data/lib/stripe/params/test_helpers/treasury/outbound_payment_fail_params.rb +17 -0
  506. data/lib/stripe/params/test_helpers/treasury/outbound_payment_post_params.rb +17 -0
  507. data/lib/stripe/params/test_helpers/treasury/outbound_payment_return_outbound_payment_params.rb +28 -0
  508. data/lib/stripe/params/test_helpers/treasury/outbound_payment_update_params.rb +57 -0
  509. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_fail_params.rb +17 -0
  510. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_post_params.rb +17 -0
  511. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_return_outbound_transfer_params.rb +28 -0
  512. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_update_params.rb +57 -0
  513. data/lib/stripe/params/test_helpers/treasury/received_credit_create_params.rb +68 -0
  514. data/lib/stripe/params/test_helpers/treasury/received_debit_create_params.rb +68 -0
  515. data/lib/stripe/params/token_create_params.rb +1191 -0
  516. data/lib/stripe/params/token_retrieve_params.rb +13 -0
  517. data/lib/stripe/params/topup_cancel_params.rb +13 -0
  518. data/lib/stripe/params/topup_create_params.rb +43 -0
  519. data/lib/stripe/params/topup_list_params.rb +74 -0
  520. data/lib/stripe/params/topup_retrieve_params.rb +13 -0
  521. data/lib/stripe/params/topup_update_params.rb +19 -0
  522. data/lib/stripe/params/transfer_create_params.rb +47 -0
  523. data/lib/stripe/params/transfer_list_params.rb +56 -0
  524. data/lib/stripe/params/transfer_retrieve_params.rb +13 -0
  525. data/lib/stripe/params/transfer_reversal_create_params.rb +31 -0
  526. data/lib/stripe/params/transfer_reversal_list_params.rb +22 -0
  527. data/lib/stripe/params/transfer_reversal_retrieve_params.rb +13 -0
  528. data/lib/stripe/params/transfer_reversal_update_params.rb +16 -0
  529. data/lib/stripe/params/transfer_update_params.rb +19 -0
  530. data/lib/stripe/params/treasury/credit_reversal_create_params.rb +21 -0
  531. data/lib/stripe/params/treasury/credit_reversal_list_params.rb +41 -0
  532. data/lib/stripe/params/treasury/credit_reversal_retrieve_params.rb +15 -0
  533. data/lib/stripe/params/treasury/debit_reversal_create_params.rb +21 -0
  534. data/lib/stripe/params/treasury/debit_reversal_list_params.rb +45 -0
  535. data/lib/stripe/params/treasury/debit_reversal_retrieve_params.rb +15 -0
  536. data/lib/stripe/params/treasury/financial_account_close_params.rb +32 -0
  537. data/lib/stripe/params/treasury/financial_account_create_params.rb +201 -0
  538. data/lib/stripe/params/treasury/financial_account_features_retrieve_params.rb +15 -0
  539. data/lib/stripe/params/treasury/financial_account_features_update_params.rb +163 -0
  540. data/lib/stripe/params/treasury/financial_account_list_params.rb +54 -0
  541. data/lib/stripe/params/treasury/financial_account_retrieve_features_params.rb +15 -0
  542. data/lib/stripe/params/treasury/financial_account_retrieve_params.rb +15 -0
  543. data/lib/stripe/params/treasury/financial_account_update_features_params.rb +163 -0
  544. data/lib/stripe/params/treasury/financial_account_update_params.rb +216 -0
  545. data/lib/stripe/params/treasury/inbound_transfer_cancel_params.rb +15 -0
  546. data/lib/stripe/params/treasury/inbound_transfer_create_params.rb +45 -0
  547. data/lib/stripe/params/treasury/inbound_transfer_fail_params.rb +26 -0
  548. data/lib/stripe/params/treasury/inbound_transfer_list_params.rb +37 -0
  549. data/lib/stripe/params/treasury/inbound_transfer_retrieve_params.rb +15 -0
  550. data/lib/stripe/params/treasury/inbound_transfer_return_inbound_transfer_params.rb +15 -0
  551. data/lib/stripe/params/treasury/inbound_transfer_succeed_params.rb +15 -0
  552. data/lib/stripe/params/treasury/outbound_payment_cancel_params.rb +15 -0
  553. data/lib/stripe/params/treasury/outbound_payment_create_params.rb +190 -0
  554. data/lib/stripe/params/treasury/outbound_payment_fail_params.rb +15 -0
  555. data/lib/stripe/params/treasury/outbound_payment_list_params.rb +62 -0
  556. data/lib/stripe/params/treasury/outbound_payment_post_params.rb +15 -0
  557. data/lib/stripe/params/treasury/outbound_payment_retrieve_params.rb +15 -0
  558. data/lib/stripe/params/treasury/outbound_payment_return_outbound_payment_params.rb +26 -0
  559. data/lib/stripe/params/treasury/outbound_payment_update_params.rb +55 -0
  560. data/lib/stripe/params/treasury/outbound_transfer_cancel_params.rb +15 -0
  561. data/lib/stripe/params/treasury/outbound_transfer_create_params.rb +81 -0
  562. data/lib/stripe/params/treasury/outbound_transfer_fail_params.rb +15 -0
  563. data/lib/stripe/params/treasury/outbound_transfer_list_params.rb +37 -0
  564. data/lib/stripe/params/treasury/outbound_transfer_post_params.rb +15 -0
  565. data/lib/stripe/params/treasury/outbound_transfer_retrieve_params.rb +15 -0
  566. data/lib/stripe/params/treasury/outbound_transfer_return_outbound_transfer_params.rb +26 -0
  567. data/lib/stripe/params/treasury/outbound_transfer_update_params.rb +55 -0
  568. data/lib/stripe/params/treasury/received_credit_create_params.rb +66 -0
  569. data/lib/stripe/params/treasury/received_credit_list_params.rb +49 -0
  570. data/lib/stripe/params/treasury/received_credit_retrieve_params.rb +15 -0
  571. data/lib/stripe/params/treasury/received_debit_create_params.rb +66 -0
  572. data/lib/stripe/params/treasury/received_debit_list_params.rb +37 -0
  573. data/lib/stripe/params/treasury/received_debit_retrieve_params.rb +15 -0
  574. data/lib/stripe/params/treasury/transaction_entry_list_params.rb +84 -0
  575. data/lib/stripe/params/treasury/transaction_entry_retrieve_params.rb +15 -0
  576. data/lib/stripe/params/treasury/transaction_list_params.rb +92 -0
  577. data/lib/stripe/params/treasury/transaction_retrieve_params.rb +15 -0
  578. data/lib/stripe/params/v2/billing/meter_event_adjustment_create_params.rb +31 -0
  579. data/lib/stripe/params/v2/billing/meter_event_create_params.rb +33 -0
  580. data/lib/stripe/params/v2/billing/meter_event_session_create_params.rb +10 -0
  581. data/lib/stripe/params/v2/billing/meter_event_stream_create_params.rb +41 -0
  582. data/lib/stripe/params/v2/core/event_destination_create_params.rb +79 -0
  583. data/lib/stripe/params/v2/core/event_destination_delete_params.rb +10 -0
  584. data/lib/stripe/params/v2/core/event_destination_disable_params.rb +10 -0
  585. data/lib/stripe/params/v2/core/event_destination_enable_params.rb +10 -0
  586. data/lib/stripe/params/v2/core/event_destination_list_params.rb +20 -0
  587. data/lib/stripe/params/v2/core/event_destination_ping_params.rb +10 -0
  588. data/lib/stripe/params/v2/core/event_destination_retrieve_params.rb +17 -0
  589. data/lib/stripe/params/v2/core/event_destination_update_params.rb +47 -0
  590. data/lib/stripe/params/v2/core/event_list_params.rb +22 -0
  591. data/lib/stripe/params/v2/core/event_retrieve_params.rb +10 -0
  592. data/lib/stripe/params/webhook_endpoint_create_params.rb +39 -0
  593. data/lib/stripe/params/webhook_endpoint_delete_params.rb +6 -0
  594. data/lib/stripe/params/webhook_endpoint_list_params.rb +22 -0
  595. data/lib/stripe/params/webhook_endpoint_retrieve_params.rb +13 -0
  596. data/lib/stripe/params/webhook_endpoint_update_params.rb +35 -0
  597. data/lib/stripe/params.rb +588 -0
  598. data/lib/stripe/request_options.rb +14 -5
  599. data/lib/stripe/resources/account.rb +437 -4906
  600. data/lib/stripe/resources/account_link.rb +8 -47
  601. data/lib/stripe/resources/account_session.rb +338 -910
  602. data/lib/stripe/resources/apple_pay_domain.rb +8 -40
  603. data/lib/stripe/resources/application.rb +8 -0
  604. data/lib/stripe/resources/application_fee.rb +12 -44
  605. data/lib/stripe/resources/application_fee_refund.rb +8 -0
  606. data/lib/stripe/resources/apps/secret.rb +12 -112
  607. data/lib/stripe/resources/balance.rb +159 -0
  608. data/lib/stripe/resources/balance_settings.rb +40 -60
  609. data/lib/stripe/resources/balance_transaction.rb +12 -56
  610. data/lib/stripe/resources/bank_account.rb +40 -0
  611. data/lib/stripe/resources/billing/alert.rb +20 -100
  612. data/lib/stripe/resources/billing/alert_triggered.rb +8 -0
  613. data/lib/stripe/resources/billing/credit_balance_summary.rb +48 -2
  614. data/lib/stripe/resources/billing/credit_balance_transaction.rb +73 -33
  615. data/lib/stripe/resources/billing/credit_grant.rb +42 -161
  616. data/lib/stripe/resources/billing/meter.rb +40 -116
  617. data/lib/stripe/resources/billing/meter_event.rb +8 -20
  618. data/lib/stripe/resources/billing/meter_event_adjustment.rb +12 -22
  619. data/lib/stripe/resources/billing/meter_event_summary.rb +8 -0
  620. data/lib/stripe/resources/billing_portal/configuration.rb +120 -473
  621. data/lib/stripe/resources/billing_portal/session.rb +98 -176
  622. data/lib/stripe/resources/capability.rb +56 -0
  623. data/lib/stripe/resources/card.rb +17 -3
  624. data/lib/stripe/resources/cash_balance.rb +16 -2
  625. data/lib/stripe/resources/charge.rb +949 -1945
  626. data/lib/stripe/resources/checkout/session.rb +1038 -2991
  627. data/lib/stripe/resources/climate/order.rb +28 -89
  628. data/lib/stripe/resources/climate/product.rb +13 -15
  629. data/lib/stripe/resources/climate/supplier.rb +13 -15
  630. data/lib/stripe/resources/confirmation_token.rb +883 -841
  631. data/lib/stripe/resources/connect_collection_transfer.rb +8 -0
  632. data/lib/stripe/resources/country_spec.rb +29 -15
  633. data/lib/stripe/resources/coupon.rb +19 -166
  634. data/lib/stripe/resources/credit_note.rb +66 -510
  635. data/lib/stripe/resources/credit_note_line_item.rb +43 -8
  636. data/lib/stripe/resources/customer.rb +81 -677
  637. data/lib/stripe/resources/customer_balance_transaction.rb +8 -2
  638. data/lib/stripe/resources/customer_cash_balance_transaction.rb +108 -2
  639. data/lib/stripe/resources/customer_session.rb +49 -98
  640. data/lib/stripe/resources/discount.rb +24 -6
  641. data/lib/stripe/resources/dispute.rb +159 -376
  642. data/lib/stripe/resources/entitlements/active_entitlement.rb +8 -26
  643. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +8 -0
  644. data/lib/stripe/resources/entitlements/feature.rb +8 -66
  645. data/lib/stripe/resources/ephemeral_key.rb +8 -8
  646. data/lib/stripe/resources/event.rb +16 -79
  647. data/lib/stripe/resources/exchange_rate.rb +18 -17
  648. data/lib/stripe/resources/file.rb +8 -79
  649. data/lib/stripe/resources/file_link.rb +8 -84
  650. data/lib/stripe/resources/financial_connections/account.rb +65 -130
  651. data/lib/stripe/resources/financial_connections/account_owner.rb +8 -0
  652. data/lib/stripe/resources/financial_connections/account_ownership.rb +8 -0
  653. data/lib/stripe/resources/financial_connections/session.rb +20 -115
  654. data/lib/stripe/resources/financial_connections/transaction.rb +12 -57
  655. data/lib/stripe/resources/forwarding/request.rb +48 -93
  656. data/lib/stripe/resources/funding_instructions.rb +217 -24
  657. data/lib/stripe/resources/identity/verification_report.rb +165 -56
  658. data/lib/stripe/resources/identity/verification_session.rb +124 -247
  659. data/lib/stripe/resources/invoice.rb +500 -4017
  660. data/lib/stripe/resources/invoice_item.rb +69 -385
  661. data/lib/stripe/resources/invoice_line_item.rb +124 -251
  662. data/lib/stripe/resources/invoice_payment.rb +20 -47
  663. data/lib/stripe/resources/invoice_rendering_template.rb +8 -38
  664. data/lib/stripe/resources/issuing/authorization.rb +173 -836
  665. data/lib/stripe/resources/issuing/card.rb +98 -499
  666. data/lib/stripe/resources/issuing/cardholder.rb +108 -515
  667. data/lib/stripe/resources/issuing/dispute.rb +93 -620
  668. data/lib/stripe/resources/issuing/personalization_design.rb +32 -221
  669. data/lib/stripe/resources/issuing/physical_bundle.rb +13 -28
  670. data/lib/stripe/resources/issuing/token.rb +57 -60
  671. data/lib/stripe/resources/issuing/transaction.rb +147 -702
  672. data/lib/stripe/resources/line_item.rb +22 -35
  673. data/lib/stripe/resources/login_link.rb +8 -0
  674. data/lib/stripe/resources/mandate.rb +219 -94
  675. data/lib/stripe/resources/payment_intent.rb +1241 -13361
  676. data/lib/stripe/resources/payment_link.rb +333 -1357
  677. data/lib/stripe/resources/payment_method.rb +796 -966
  678. data/lib/stripe/resources/payment_method_configuration.rb +862 -2528
  679. data/lib/stripe/resources/payment_method_domain.rb +107 -63
  680. data/lib/stripe/resources/payout.rb +12 -150
  681. data/lib/stripe/resources/person.rb +184 -4
  682. data/lib/stripe/resources/plan.rb +20 -235
  683. data/lib/stripe/resources/price.rb +65 -509
  684. data/lib/stripe/resources/product.rb +23 -411
  685. data/lib/stripe/resources/product_feature.rb +8 -0
  686. data/lib/stripe/resources/promotion_code.rb +40 -182
  687. data/lib/stripe/resources/quote.rb +280 -2743
  688. data/lib/stripe/resources/radar/early_fraud_warning.rb +8 -51
  689. data/lib/stripe/resources/radar/value_list.rb +8 -92
  690. data/lib/stripe/resources/radar/value_list_item.rb +8 -68
  691. data/lib/stripe/resources/refund.rb +365 -159
  692. data/lib/stripe/resources/reporting/report_run.rb +12 -93
  693. data/lib/stripe/resources/reporting/report_type.rb +8 -8
  694. data/lib/stripe/resources/reserve_transaction.rb +8 -0
  695. data/lib/stripe/resources/reversal.rb +8 -0
  696. data/lib/stripe/resources/review.rb +20 -43
  697. data/lib/stripe/resources/setup_attempt.rb +284 -87
  698. data/lib/stripe/resources/setup_intent.rb +358 -4143
  699. data/lib/stripe/resources/shipping_rate.rb +44 -187
  700. data/lib/stripe/resources/sigma/scheduled_query_run.rb +13 -15
  701. data/lib/stripe/resources/source.rb +267 -611
  702. data/lib/stripe/resources/source_mandate_notification.rb +32 -0
  703. data/lib/stripe/resources/source_transaction.rb +54 -0
  704. data/lib/stripe/resources/subscription.rb +266 -1931
  705. data/lib/stripe/resources/subscription_item.rb +12 -379
  706. data/lib/stripe/resources/subscription_schedule.rb +230 -2273
  707. data/lib/stripe/resources/tax/calculation.rb +111 -220
  708. data/lib/stripe/resources/tax/calculation_line_item.rb +32 -0
  709. data/lib/stripe/resources/tax/registration.rb +1274 -2096
  710. data/lib/stripe/resources/tax/settings.rb +61 -64
  711. data/lib/stripe/resources/tax/transaction.rb +95 -122
  712. data/lib/stripe/resources/tax/transaction_line_item.rb +16 -0
  713. data/lib/stripe/resources/tax_code.rb +8 -17
  714. data/lib/stripe/resources/tax_deducted_at_source.rb +8 -0
  715. data/lib/stripe/resources/tax_id.rb +20 -75
  716. data/lib/stripe/resources/tax_rate.rb +12 -142
  717. data/lib/stripe/resources/terminal/configuration.rb +301 -1205
  718. data/lib/stripe/resources/terminal/connection_token.rb +8 -11
  719. data/lib/stripe/resources/terminal/location.rb +72 -126
  720. data/lib/stripe/resources/terminal/reader.rb +237 -509
  721. data/lib/stripe/resources/test_helpers/test_clock.rb +20 -43
  722. data/lib/stripe/resources/token.rb +8 -1191
  723. data/lib/stripe/resources/topup.rb +8 -132
  724. data/lib/stripe/resources/transfer.rb +8 -115
  725. data/lib/stripe/resources/treasury/credit_reversal.rb +12 -46
  726. data/lib/stripe/resources/treasury/debit_reversal.rb +20 -50
  727. data/lib/stripe/resources/treasury/financial_account.rb +55 -658
  728. data/lib/stripe/resources/treasury/financial_account_features.rb +192 -2
  729. data/lib/stripe/resources/treasury/inbound_transfer.rb +67 -115
  730. data/lib/stripe/resources/treasury/outbound_payment.rb +104 -334
  731. data/lib/stripe/resources/treasury/outbound_transfer.rb +93 -235
  732. data/lib/stripe/resources/treasury/received_credit.rb +76 -136
  733. data/lib/stripe/resources/treasury/received_debit.rb +68 -126
  734. data/lib/stripe/resources/treasury/transaction.rb +32 -82
  735. data/lib/stripe/resources/treasury/transaction_entry.rb +20 -74
  736. data/lib/stripe/resources/v2/billing/meter_event.rb +8 -0
  737. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +16 -0
  738. data/lib/stripe/resources/v2/billing/meter_event_session.rb +8 -0
  739. data/lib/stripe/resources/v2/core/event.rb +67 -0
  740. data/lib/stripe/resources/v2/core/event_destination.rb +119 -0
  741. data/lib/stripe/resources/v2/core/event_notification.rb +62 -0
  742. data/lib/stripe/resources/v2/deleted_object.rb +21 -0
  743. data/lib/stripe/resources/webhook_endpoint.rb +8 -85
  744. data/lib/stripe/resources.rb +3 -110
  745. data/lib/stripe/services/account_capability_service.rb +0 -32
  746. data/lib/stripe/services/account_external_account_service.rb +0 -249
  747. data/lib/stripe/services/account_link_service.rb +0 -48
  748. data/lib/stripe/services/account_login_link_service.rb +0 -9
  749. data/lib/stripe/services/account_person_service.rb +0 -958
  750. data/lib/stripe/services/account_service.rb +0 -4710
  751. data/lib/stripe/services/account_session_service.rb +0 -862
  752. data/lib/stripe/services/apple_pay_domain_service.rb +0 -50
  753. data/lib/stripe/services/application_fee_refund_service.rb +0 -54
  754. data/lib/stripe/services/application_fee_service.rb +0 -57
  755. data/lib/stripe/services/apps/secret_service.rb +0 -116
  756. data/lib/stripe/services/balance_service.rb +0 -9
  757. data/lib/stripe/services/balance_settings_service.rb +0 -69
  758. data/lib/stripe/services/balance_transaction_service.rb +0 -69
  759. data/lib/stripe/services/billing/alert_service.rb +0 -113
  760. data/lib/stripe/services/billing/credit_balance_summary_service.rb +0 -51
  761. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -44
  762. data/lib/stripe/services/billing/credit_grant_service.rb +0 -174
  763. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +0 -26
  764. data/lib/stripe/services/billing/meter_event_service.rb +0 -21
  765. data/lib/stripe/services/billing/meter_event_summary_service.rb +0 -39
  766. data/lib/stripe/services/billing/meter_service.rb +0 -130
  767. data/lib/stripe/services/billing_portal/configuration_service.rb +0 -486
  768. data/lib/stripe/services/billing_portal/session_service.rb +0 -177
  769. data/lib/stripe/services/billing_service.rb +1 -2
  770. data/lib/stripe/services/charge_service.rb +0 -1820
  771. data/lib/stripe/services/checkout/session_line_item_service.rb +0 -18
  772. data/lib/stripe/services/checkout/session_service.rb +0 -2882
  773. data/lib/stripe/services/climate/order_service.rb +0 -102
  774. data/lib/stripe/services/climate/product_service.rb +0 -27
  775. data/lib/stripe/services/climate/supplier_service.rb +0 -27
  776. data/lib/stripe/services/confirmation_token_service.rb +0 -9
  777. data/lib/stripe/services/country_spec_service.rb +0 -27
  778. data/lib/stripe/services/coupon_service.rb +0 -167
  779. data/lib/stripe/services/credit_note_line_item_service.rb +0 -18
  780. data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -152
  781. data/lib/stripe/services/credit_note_service.rb +0 -369
  782. data/lib/stripe/services/customer_balance_transaction_service.rb +0 -63
  783. data/lib/stripe/services/customer_cash_balance_service.rb +0 -29
  784. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +0 -27
  785. data/lib/stripe/services/customer_funding_instructions_service.rb +0 -42
  786. data/lib/stripe/services/customer_payment_method_service.rb +0 -40
  787. data/lib/stripe/services/customer_payment_source_service.rb +0 -179
  788. data/lib/stripe/services/customer_service.rb +0 -575
  789. data/lib/stripe/services/customer_session_service.rb +0 -99
  790. data/lib/stripe/services/customer_tax_id_service.rb +0 -44
  791. data/lib/stripe/services/dispute_service.rb +0 -374
  792. data/lib/stripe/services/entitlements/active_entitlement_service.rb +0 -36
  793. data/lib/stripe/services/entitlements/feature_service.rb +0 -76
  794. data/lib/stripe/services/ephemeral_key_service.rb +0 -36
  795. data/lib/stripe/services/event_service.rb +0 -65
  796. data/lib/stripe/services/exchange_rate_service.rb +4 -27
  797. data/lib/stripe/services/file_link_service.rb +0 -94
  798. data/lib/stripe/services/file_service.rb +0 -89
  799. data/lib/stripe/services/financial_connections/account_owner_service.rb +0 -27
  800. data/lib/stripe/services/financial_connections/account_service.rb +1 -102
  801. data/lib/stripe/services/financial_connections/session_service.rb +0 -100
  802. data/lib/stripe/services/financial_connections/transaction_service.rb +0 -70
  803. data/lib/stripe/services/financial_connections_service.rb +1 -2
  804. data/lib/stripe/services/forwarding/request_service.rb +0 -106
  805. data/lib/stripe/services/identity/verification_report_service.rb +0 -65
  806. data/lib/stripe/services/identity/verification_session_service.rb +0 -255
  807. data/lib/stripe/services/invoice_item_service.rb +0 -405
  808. data/lib/stripe/services/invoice_line_item_service.rb +0 -253
  809. data/lib/stripe/services/invoice_payment_service.rb +0 -58
  810. data/lib/stripe/services/invoice_rendering_template_service.rb +0 -51
  811. data/lib/stripe/services/invoice_service.rb +0 -3836
  812. data/lib/stripe/services/issuing/authorization_service.rb +0 -104
  813. data/lib/stripe/services/issuing/card_service.rb +0 -463
  814. data/lib/stripe/services/issuing/cardholder_service.rb +0 -526
  815. data/lib/stripe/services/issuing/dispute_service.rb +0 -633
  816. data/lib/stripe/services/issuing/personalization_design_service.rb +0 -193
  817. data/lib/stripe/services/issuing/physical_bundle_service.rb +0 -40
  818. data/lib/stripe/services/issuing/token_service.rb +0 -73
  819. data/lib/stripe/services/issuing/transaction_service.rb +0 -81
  820. data/lib/stripe/services/issuing_service.rb +1 -5
  821. data/lib/stripe/services/mandate_service.rb +0 -49
  822. data/lib/stripe/services/payment_intent_service.rb +0 -12747
  823. data/lib/stripe/services/payment_link_line_item_service.rb +0 -18
  824. data/lib/stripe/services/payment_link_service.rb +0 -1352
  825. data/lib/stripe/services/payment_method_configuration_service.rb +0 -2466
  826. data/lib/stripe/services/payment_method_domain_service.rb +0 -76
  827. data/lib/stripe/services/payment_method_service.rb +0 -881
  828. data/lib/stripe/services/payout_service.rb +0 -163
  829. data/lib/stripe/services/plan_service.rb +0 -248
  830. data/lib/stripe/services/price_service.rb +0 -512
  831. data/lib/stripe/services/product_feature_service.rb +0 -41
  832. data/lib/stripe/services/product_service.rb +0 -424
  833. data/lib/stripe/services/promotion_code_service.rb +1 -187
  834. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +0 -18
  835. data/lib/stripe/services/quote_line_item_service.rb +0 -18
  836. data/lib/stripe/services/quote_service.rb +1 -2344
  837. data/lib/stripe/services/radar/early_fraud_warning_service.rb +0 -61
  838. data/lib/stripe/services/radar/value_list_item_service.rb +0 -78
  839. data/lib/stripe/services/radar/value_list_service.rb +0 -102
  840. data/lib/stripe/services/refund_service.rb +0 -137
  841. data/lib/stripe/services/reporting/report_run_service.rb +0 -106
  842. data/lib/stripe/services/reporting/report_type_service.rb +0 -18
  843. data/lib/stripe/services/review_service.rb +0 -56
  844. data/lib/stripe/services/setup_attempt_service.rb +0 -51
  845. data/lib/stripe/services/setup_intent_service.rb +0 -3957
  846. data/lib/stripe/services/shipping_rate_service.rb +0 -200
  847. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +0 -27
  848. data/lib/stripe/services/source_service.rb +0 -601
  849. data/lib/stripe/services/source_transaction_service.rb +0 -18
  850. data/lib/stripe/services/subscription_item_service.rb +0 -383
  851. data/lib/stripe/services/subscription_schedule_service.rb +0 -2196
  852. data/lib/stripe/services/subscription_service.rb +0 -1894
  853. data/lib/stripe/services/tax/calculation_line_item_service.rb +0 -18
  854. data/lib/stripe/services/tax/calculation_service.rb +0 -209
  855. data/lib/stripe/services/tax/registration_service.rb +0 -2063
  856. data/lib/stripe/services/tax/settings_service.rb +0 -74
  857. data/lib/stripe/services/tax/transaction_line_item_service.rb +0 -18
  858. data/lib/stripe/services/tax/transaction_service.rb +0 -111
  859. data/lib/stripe/services/tax_code_service.rb +0 -27
  860. data/lib/stripe/services/tax_id_service.rb +0 -84
  861. data/lib/stripe/services/tax_rate_service.rb +0 -155
  862. data/lib/stripe/services/tax_service.rb +1 -3
  863. data/lib/stripe/services/terminal/configuration_service.rb +0 -1212
  864. data/lib/stripe/services/terminal/connection_token_service.rb +0 -12
  865. data/lib/stripe/services/terminal/location_service.rb +0 -143
  866. data/lib/stripe/services/terminal/reader_service.rb +0 -427
  867. data/lib/stripe/services/terminal_service.rb +1 -3
  868. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +0 -738
  869. data/lib/stripe/services/test_helpers/customer_service.rb +0 -18
  870. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +0 -745
  871. data/lib/stripe/services/test_helpers/issuing/card_service.rb +0 -45
  872. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +0 -41
  873. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +0 -632
  874. data/lib/stripe/services/test_helpers/refund_service.rb +0 -9
  875. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -87
  876. data/lib/stripe/services/test_helpers/test_clock_service.rb +0 -56
  877. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +0 -38
  878. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +0 -87
  879. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +0 -87
  880. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +0 -84
  881. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +0 -84
  882. data/lib/stripe/services/token_service.rb +0 -1201
  883. data/lib/stripe/services/topup_service.rb +0 -142
  884. data/lib/stripe/services/transfer_reversal_service.rb +0 -66
  885. data/lib/stripe/services/transfer_service.rb +0 -123
  886. data/lib/stripe/services/treasury/credit_reversal_service.rb +0 -59
  887. data/lib/stripe/services/treasury/debit_reversal_service.rb +0 -63
  888. data/lib/stripe/services/treasury/financial_account_features_service.rb +0 -169
  889. data/lib/stripe/services/treasury/financial_account_service.rb +0 -502
  890. data/lib/stripe/services/treasury/inbound_transfer_service.rb +0 -88
  891. data/lib/stripe/services/treasury/outbound_payment_service.rb +0 -258
  892. data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -148
  893. data/lib/stripe/services/treasury/received_credit_service.rb +0 -52
  894. data/lib/stripe/services/treasury/received_debit_service.rb +0 -40
  895. data/lib/stripe/services/treasury/transaction_entry_service.rb +0 -87
  896. data/lib/stripe/services/treasury/transaction_service.rb +0 -95
  897. data/lib/stripe/services/v1_services.rb +1 -10
  898. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +0 -23
  899. data/lib/stripe/services/v2/billing/meter_event_service.rb +0 -25
  900. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +0 -2
  901. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +0 -33
  902. data/lib/stripe/services/v2/core/event_destination_service.rb +0 -137
  903. data/lib/stripe/services/v2/core/event_service.rb +0 -16
  904. data/lib/stripe/services/v2/core_service.rb +1 -4
  905. data/lib/stripe/services/v2_services.rb +1 -4
  906. data/lib/stripe/services/webhook_endpoint_service.rb +0 -95
  907. data/lib/stripe/services.rb +0 -54
  908. data/lib/stripe/stripe_client.rb +8 -5
  909. data/lib/stripe/stripe_configuration.rb +2 -9
  910. data/lib/stripe/stripe_context.rb +68 -0
  911. data/lib/stripe/stripe_object.rb +34 -10
  912. data/lib/stripe/util.rb +25 -20
  913. data/lib/stripe/version.rb +1 -1
  914. data/lib/stripe.rb +3 -54
  915. data/rbi/stripe/resources/v2/core/event_notification.rbi +43 -0
  916. data/rbi/stripe/stripe_client.rbi +17 -0
  917. data/rbi/stripe.rbi +121931 -190301
  918. metadata +599 -189
  919. data/API_VERSION +0 -1
  920. data/CHANGELOG.md +0 -2780
  921. data/CODE_OF_CONDUCT.md +0 -77
  922. data/CONTRIBUTING.md +0 -25
  923. data/CONTRIBUTORS +0 -3
  924. data/Gemfile +0 -41
  925. data/History.txt +0 -1
  926. data/LICENSE +0 -21
  927. data/Makefile +0 -22
  928. data/OPENAPI_VERSION +0 -1
  929. data/README.md +0 -424
  930. data/Rakefile +0 -34
  931. data/VERSION +0 -1
  932. data/examples/README.md +0 -16
  933. data/examples/example_template.rb +0 -36
  934. data/examples/meter_event_stream.rb +0 -57
  935. data/examples/thinevent_webhook_handler.rb +0 -39
  936. data/justfile +0 -43
  937. data/lib/stripe/events/v2_core_account_closed_event.rb +0 -21
  938. data/lib/stripe/events/v2_core_account_created_event.rb +0 -21
  939. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +0 -23
  940. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +0 -21
  941. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +0 -23
  942. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +0 -21
  943. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +0 -23
  944. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +0 -21
  945. data/lib/stripe/events/v2_core_account_including_configuration_storer_capability_status_updated_event.rb +0 -23
  946. data/lib/stripe/events/v2_core_account_including_configuration_storer_updated_event.rb +0 -21
  947. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +0 -21
  948. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +0 -21
  949. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +0 -21
  950. data/lib/stripe/events/v2_core_account_link_returned_event.rb +0 -13
  951. data/lib/stripe/events/v2_core_account_person_created_event.rb +0 -23
  952. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +0 -23
  953. data/lib/stripe/events/v2_core_account_person_updated_event.rb +0 -23
  954. data/lib/stripe/events/v2_core_account_updated_event.rb +0 -21
  955. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +0 -21
  956. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +0 -21
  957. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +0 -21
  958. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +0 -21
  959. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +0 -21
  960. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +0 -23
  961. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +0 -21
  962. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +0 -21
  963. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +0 -21
  964. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +0 -21
  965. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +0 -21
  966. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +0 -21
  967. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +0 -21
  968. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +0 -21
  969. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +0 -21
  970. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +0 -21
  971. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +0 -21
  972. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +0 -21
  973. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +0 -21
  974. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +0 -21
  975. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +0 -21
  976. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +0 -21
  977. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +0 -21
  978. data/lib/stripe/events/v2_money_management_payout_method_updated_event.rb +0 -21
  979. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +0 -23
  980. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +0 -21
  981. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +0 -21
  982. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +0 -21
  983. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +0 -21
  984. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +0 -21
  985. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +0 -21
  986. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +0 -21
  987. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +0 -21
  988. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +0 -21
  989. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +0 -21
  990. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +0 -21
  991. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +0 -22
  992. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +0 -21
  993. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +0 -21
  994. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +0 -21
  995. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +0 -21
  996. data/lib/stripe/resources/account_notice.rb +0 -123
  997. data/lib/stripe/resources/billing/meter_usage.rb +0 -23
  998. data/lib/stripe/resources/billing/meter_usage_row.rb +0 -28
  999. data/lib/stripe/resources/capital/financing_offer.rb +0 -179
  1000. data/lib/stripe/resources/capital/financing_summary.rb +0 -55
  1001. data/lib/stripe/resources/capital/financing_transaction.rb +0 -114
  1002. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
  1003. data/lib/stripe/resources/financial_connections/institution.rb +0 -92
  1004. data/lib/stripe/resources/fx_quote.rb +0 -186
  1005. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -602
  1006. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -82
  1007. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -86
  1008. data/lib/stripe/resources/issuing/settlement.rb +0 -53
  1009. data/lib/stripe/resources/margin.rb +0 -115
  1010. data/lib/stripe/resources/order.rb +0 -2958
  1011. data/lib/stripe/resources/payment_attempt_record.rb +0 -1181
  1012. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +0 -72
  1013. data/lib/stripe/resources/payment_record.rb +0 -1727
  1014. data/lib/stripe/resources/privacy/redaction_job.rb +0 -298
  1015. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +0 -33
  1016. data/lib/stripe/resources/quote_line.rb +0 -274
  1017. data/lib/stripe/resources/quote_preview_invoice.rb +0 -680
  1018. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -395
  1019. data/lib/stripe/resources/tax/association.rb +0 -66
  1020. data/lib/stripe/resources/tax/form.rb +0 -211
  1021. data/lib/stripe/resources/terminal/onboarding_link.rb +0 -84
  1022. data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -31
  1023. data/lib/stripe/resources/v2/core/account.rb +0 -1938
  1024. data/lib/stripe/resources/v2/core/account_link.rb +0 -72
  1025. data/lib/stripe/resources/v2/core/person.rb +0 -276
  1026. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +0 -74
  1027. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +0 -39
  1028. data/lib/stripe/resources/v2/event.rb +0 -41
  1029. data/lib/stripe/resources/v2/event_destination.rb +0 -73
  1030. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +0 -20
  1031. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +0 -22
  1032. data/lib/stripe/resources/v2/money_management/adjustment.rb +0 -51
  1033. data/lib/stripe/resources/v2/money_management/financial_account.rb +0 -79
  1034. data/lib/stripe/resources/v2/money_management/financial_address.rb +0 -68
  1035. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +0 -94
  1036. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +0 -129
  1037. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +0 -82
  1038. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +0 -45
  1039. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +0 -117
  1040. data/lib/stripe/resources/v2/money_management/payout_method.rb +0 -77
  1041. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +0 -49
  1042. data/lib/stripe/resources/v2/money_management/received_credit.rb +0 -122
  1043. data/lib/stripe/resources/v2/money_management/received_debit.rb +0 -84
  1044. data/lib/stripe/resources/v2/money_management/transaction.rb +0 -80
  1045. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +0 -70
  1046. data/lib/stripe/resources/v2/payments/off_session_payment.rb +0 -89
  1047. data/lib/stripe/services/account_notice_service.rb +0 -101
  1048. data/lib/stripe/services/billing/meter_usage_service.rb +0 -76
  1049. data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
  1050. data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
  1051. data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
  1052. data/lib/stripe/services/capital_service.rb +0 -15
  1053. data/lib/stripe/services/external_account_service.rb +0 -317
  1054. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -37
  1055. data/lib/stripe/services/financial_connections/institution_service.rb +0 -57
  1056. data/lib/stripe/services/fx_quote_service.rb +0 -123
  1057. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
  1058. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
  1059. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
  1060. data/lib/stripe/services/margin_service.rb +0 -119
  1061. data/lib/stripe/services/order_service.rb +0 -2388
  1062. data/lib/stripe/services/payment_attempt_record_service.rb +0 -52
  1063. data/lib/stripe/services/payment_record_service.rb +0 -562
  1064. data/lib/stripe/services/privacy/redaction_job_service.rb +0 -240
  1065. data/lib/stripe/services/privacy/redaction_job_validation_error_service.rb +0 -37
  1066. data/lib/stripe/services/privacy_service.rb +0 -13
  1067. data/lib/stripe/services/tax/association_service.rb +0 -31
  1068. data/lib/stripe/services/tax/form_service.rb +0 -100
  1069. data/lib/stripe/services/terminal/onboarding_link_service.rb +0 -56
  1070. data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
  1071. data/lib/stripe/services/v2/core/account_link_service.rb +0 -114
  1072. data/lib/stripe/services/v2/core/account_service.rb +0 -4536
  1073. data/lib/stripe/services/v2/core/accounts/person_service.rb +0 -1045
  1074. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +0 -130
  1075. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +0 -107
  1076. data/lib/stripe/services/v2/core/vault_service.rb +0 -18
  1077. data/lib/stripe/services/v2/money_management/adjustment_service.rb +0 -74
  1078. data/lib/stripe/services/v2/money_management/financial_account_service.rb +0 -119
  1079. data/lib/stripe/services/v2/money_management/financial_address_service.rb +0 -82
  1080. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +0 -125
  1081. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +0 -95
  1082. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +0 -199
  1083. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +0 -235
  1084. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +0 -172
  1085. data/lib/stripe/services/v2/money_management/payout_method_service.rb +0 -90
  1086. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +0 -32
  1087. data/lib/stripe/services/v2/money_management/received_credit_service.rb +0 -70
  1088. data/lib/stripe/services/v2/money_management/received_debit_service.rb +0 -43
  1089. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +0 -69
  1090. data/lib/stripe/services/v2/money_management/transaction_service.rb +0 -73
  1091. data/lib/stripe/services/v2/money_management_service.rb +0 -31
  1092. data/lib/stripe/services/v2/payment_service.rb +0 -15
  1093. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +0 -152
  1094. data/lib/stripe/services/v2/test_helper_service.rb +0 -15
  1095. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +0 -53
  1096. data/lib/stripe/thin_event.rb +0 -37
  1097. data/stripe.gemspec +0 -47
@@ -30,6 +30,14 @@ module Stripe
30
30
  class AdaptivePricing < Stripe::StripeObject
31
31
  # If enabled, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions).
32
32
  attr_reader :enabled
33
+
34
+ def self.inner_class_types
35
+ @inner_class_types = {}
36
+ end
37
+
38
+ def self.field_remappings
39
+ @field_remappings = {}
40
+ end
33
41
  end
34
42
 
35
43
  class AfterExpiration < Stripe::StripeObject
@@ -44,9 +52,25 @@ module Stripe
44
52
  attr_reader :expires_at
45
53
  # URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session
46
54
  attr_reader :url
55
+
56
+ def self.inner_class_types
57
+ @inner_class_types = {}
58
+ end
59
+
60
+ def self.field_remappings
61
+ @field_remappings = {}
62
+ end
47
63
  end
48
64
  # When set, configuration used to recover the Checkout Session on expiry.
49
65
  attr_reader :recovery
66
+
67
+ def self.inner_class_types
68
+ @inner_class_types = { recovery: Recovery }
69
+ end
70
+
71
+ def self.field_remappings
72
+ @field_remappings = {}
73
+ end
50
74
  end
51
75
 
52
76
  class AutomaticTax < Stripe::StripeObject
@@ -55,6 +79,14 @@ module Stripe
55
79
  attr_reader :account
56
80
  # Type of the account referenced.
57
81
  attr_reader :type
82
+
83
+ def self.inner_class_types
84
+ @inner_class_types = {}
85
+ end
86
+
87
+ def self.field_remappings
88
+ @field_remappings = {}
89
+ end
58
90
  end
59
91
  # Indicates whether automatic tax is enabled for the session
60
92
  attr_reader :enabled
@@ -64,6 +96,72 @@ module Stripe
64
96
  attr_reader :provider
65
97
  # The status of the most recent automated tax calculation for this session.
66
98
  attr_reader :status
99
+
100
+ def self.inner_class_types
101
+ @inner_class_types = { liability: Liability }
102
+ end
103
+
104
+ def self.field_remappings
105
+ @field_remappings = {}
106
+ end
107
+ end
108
+
109
+ class BrandingSettings < Stripe::StripeObject
110
+ class Icon < Stripe::StripeObject
111
+ # 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.
112
+ attr_reader :file
113
+ # The type of image for the icon. Must be one of `file` or `url`.
114
+ attr_reader :type
115
+ # The URL of the image. Present when `type` is `url`.
116
+ attr_reader :url
117
+
118
+ def self.inner_class_types
119
+ @inner_class_types = {}
120
+ end
121
+
122
+ def self.field_remappings
123
+ @field_remappings = {}
124
+ end
125
+ end
126
+
127
+ class Logo < Stripe::StripeObject
128
+ # 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.
129
+ attr_reader :file
130
+ # The type of image for the logo. Must be one of `file` or `url`.
131
+ attr_reader :type
132
+ # The URL of the image. Present when `type` is `url`.
133
+ attr_reader :url
134
+
135
+ def self.inner_class_types
136
+ @inner_class_types = {}
137
+ end
138
+
139
+ def self.field_remappings
140
+ @field_remappings = {}
141
+ end
142
+ end
143
+ # A hex color value starting with `#` representing the background color for the Checkout Session.
144
+ attr_reader :background_color
145
+ # The border style for the Checkout Session. Must be one of `rounded`, `rectangular`, or `pill`.
146
+ attr_reader :border_style
147
+ # A hex color value starting with `#` representing the button color for the Checkout Session.
148
+ attr_reader :button_color
149
+ # The display name shown on the Checkout Session.
150
+ attr_reader :display_name
151
+ # The font family for the Checkout Session. Must be one of the [supported font families](https://docs.stripe.com/payments/checkout/customization/appearance?payment-ui=stripe-hosted#font-compatibility).
152
+ attr_reader :font_family
153
+ # The icon for the Checkout Session. You cannot set both `logo` and `icon`.
154
+ attr_reader :icon
155
+ # The logo for the Checkout Session. You cannot set both `logo` and `icon`.
156
+ attr_reader :logo
157
+
158
+ def self.inner_class_types
159
+ @inner_class_types = { icon: Icon, logo: Logo }
160
+ end
161
+
162
+ def self.field_remappings
163
+ @field_remappings = {}
164
+ end
67
165
  end
68
166
 
69
167
  class CollectedInformation < Stripe::StripeObject
@@ -73,37 +171,50 @@ module Stripe
73
171
  attr_reader :city
74
172
  # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
75
173
  attr_reader :country
76
- # Address line 1 (e.g., street, PO Box, or company name).
174
+ # Address line 1, such as the street, PO Box, or company name.
77
175
  attr_reader :line1
78
- # Address line 2 (e.g., apartment, suite, unit, or building).
176
+ # Address line 2, such as the apartment, suite, unit, or building.
79
177
  attr_reader :line2
80
178
  # ZIP or postal code.
81
179
  attr_reader :postal_code
82
180
  # State, county, province, or region.
83
181
  attr_reader :state
182
+
183
+ def self.inner_class_types
184
+ @inner_class_types = {}
185
+ end
186
+
187
+ def self.field_remappings
188
+ @field_remappings = {}
189
+ end
84
190
  end
85
191
  # Attribute for field address
86
192
  attr_reader :address
87
193
  # Customer name.
88
194
  attr_reader :name
89
- end
90
195
 
91
- class TaxId < Stripe::StripeObject
92
- # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
93
- attr_reader :type
94
- # The value of the tax ID.
95
- attr_reader :value
196
+ def self.inner_class_types
197
+ @inner_class_types = { address: Address }
198
+ end
199
+
200
+ def self.field_remappings
201
+ @field_remappings = {}
202
+ end
96
203
  end
97
204
  # Customer’s business name for this Checkout Session
98
205
  attr_reader :business_name
99
- # Customer’s email for this Checkout Session
100
- attr_reader :email
101
- # Customer’s phone number for this Checkout Session
102
- attr_reader :phone
206
+ # Customer’s individual name for this Checkout Session
207
+ attr_reader :individual_name
103
208
  # Shipping information for this Checkout Session.
104
209
  attr_reader :shipping_details
105
- # Customer’s tax ids for this Checkout Session.
106
- attr_reader :tax_ids
210
+
211
+ def self.inner_class_types
212
+ @inner_class_types = { shipping_details: ShippingDetails }
213
+ end
214
+
215
+ def self.field_remappings
216
+ @field_remappings = {}
217
+ end
107
218
  end
108
219
 
109
220
  class Consent < Stripe::StripeObject
@@ -112,6 +223,14 @@ module Stripe
112
223
  attr_reader :promotions
113
224
  # If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.
114
225
  attr_reader :terms_of_service
226
+
227
+ def self.inner_class_types
228
+ @inner_class_types = {}
229
+ end
230
+
231
+ def self.field_remappings
232
+ @field_remappings = {}
233
+ end
115
234
  end
116
235
 
117
236
  class ConsentCollection < Stripe::StripeObject
@@ -120,6 +239,14 @@ module Stripe
120
239
  #
121
240
  # When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
122
241
  attr_reader :position
242
+
243
+ def self.inner_class_types
244
+ @inner_class_types = {}
245
+ end
246
+
247
+ def self.field_remappings
248
+ @field_remappings = {}
249
+ end
123
250
  end
124
251
  # If set to `hidden`, it will hide legal text related to the reuse of a payment method.
125
252
  attr_reader :payment_method_reuse_agreement
@@ -129,6 +256,14 @@ module Stripe
129
256
  attr_reader :promotions
130
257
  # If set to `required`, it requires customers to accept the terms of service before being able to pay.
131
258
  attr_reader :terms_of_service
259
+
260
+ def self.inner_class_types
261
+ @inner_class_types = { payment_method_reuse_agreement: PaymentMethodReuseAgreement }
262
+ end
263
+
264
+ def self.field_remappings
265
+ @field_remappings = {}
266
+ end
132
267
  end
133
268
 
134
269
  class CurrencyConversion < Stripe::StripeObject
@@ -140,6 +275,14 @@ module Stripe
140
275
  attr_reader :fx_rate
141
276
  # Creation currency of the CheckoutSession before localization
142
277
  attr_reader :source_currency
278
+
279
+ def self.inner_class_types
280
+ @inner_class_types = {}
281
+ end
282
+
283
+ def self.field_remappings
284
+ @field_remappings = {}
285
+ end
143
286
  end
144
287
 
145
288
  class CustomField < Stripe::StripeObject
@@ -149,6 +292,14 @@ module Stripe
149
292
  attr_reader :label
150
293
  # 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.
151
294
  attr_reader :value
295
+
296
+ def self.inner_class_types
297
+ @inner_class_types = {}
298
+ end
299
+
300
+ def self.field_remappings
301
+ @field_remappings = {}
302
+ end
152
303
  end
153
304
  # The value that will pre-fill on the payment page.
154
305
  attr_reader :default_value
@@ -156,6 +307,14 @@ module Stripe
156
307
  attr_reader :options
157
308
  # The option selected by the customer. This will be the `value` for the option.
158
309
  attr_reader :value
310
+
311
+ def self.inner_class_types
312
+ @inner_class_types = { options: Option }
313
+ end
314
+
315
+ def self.field_remappings
316
+ @field_remappings = {}
317
+ end
159
318
  end
160
319
 
161
320
  class Label < Stripe::StripeObject
@@ -163,6 +322,14 @@ module Stripe
163
322
  attr_reader :custom
164
323
  # The type of the label.
165
324
  attr_reader :type
325
+
326
+ def self.inner_class_types
327
+ @inner_class_types = {}
328
+ end
329
+
330
+ def self.field_remappings
331
+ @field_remappings = {}
332
+ end
166
333
  end
167
334
 
168
335
  class Numeric < Stripe::StripeObject
@@ -174,6 +341,14 @@ module Stripe
174
341
  attr_reader :minimum_length
175
342
  # The value entered by the customer, containing only digits.
176
343
  attr_reader :value
344
+
345
+ def self.inner_class_types
346
+ @inner_class_types = {}
347
+ end
348
+
349
+ def self.field_remappings
350
+ @field_remappings = {}
351
+ end
177
352
  end
178
353
 
179
354
  class Text < Stripe::StripeObject
@@ -185,6 +360,14 @@ module Stripe
185
360
  attr_reader :minimum_length
186
361
  # The value entered by the customer.
187
362
  attr_reader :value
363
+
364
+ def self.inner_class_types
365
+ @inner_class_types = {}
366
+ end
367
+
368
+ def self.field_remappings
369
+ @field_remappings = {}
370
+ end
188
371
  end
189
372
  # Attribute for field dropdown
190
373
  attr_reader :dropdown
@@ -200,27 +383,67 @@ module Stripe
200
383
  attr_reader :text
201
384
  # The type of the field.
202
385
  attr_reader :type
386
+
387
+ def self.inner_class_types
388
+ @inner_class_types = { dropdown: Dropdown, label: Label, numeric: Numeric, text: Text }
389
+ end
390
+
391
+ def self.field_remappings
392
+ @field_remappings = {}
393
+ end
203
394
  end
204
395
 
205
396
  class CustomText < Stripe::StripeObject
206
397
  class AfterSubmit < Stripe::StripeObject
207
398
  # Text may be up to 1200 characters in length.
208
399
  attr_reader :message
400
+
401
+ def self.inner_class_types
402
+ @inner_class_types = {}
403
+ end
404
+
405
+ def self.field_remappings
406
+ @field_remappings = {}
407
+ end
209
408
  end
210
409
 
211
410
  class ShippingAddress < Stripe::StripeObject
212
411
  # Text may be up to 1200 characters in length.
213
412
  attr_reader :message
413
+
414
+ def self.inner_class_types
415
+ @inner_class_types = {}
416
+ end
417
+
418
+ def self.field_remappings
419
+ @field_remappings = {}
420
+ end
214
421
  end
215
422
 
216
423
  class Submit < Stripe::StripeObject
217
424
  # Text may be up to 1200 characters in length.
218
425
  attr_reader :message
426
+
427
+ def self.inner_class_types
428
+ @inner_class_types = {}
429
+ end
430
+
431
+ def self.field_remappings
432
+ @field_remappings = {}
433
+ end
219
434
  end
220
435
 
221
436
  class TermsOfServiceAcceptance < Stripe::StripeObject
222
437
  # Text may be up to 1200 characters in length.
223
438
  attr_reader :message
439
+
440
+ def self.inner_class_types
441
+ @inner_class_types = {}
442
+ end
443
+
444
+ def self.field_remappings
445
+ @field_remappings = {}
446
+ end
224
447
  end
225
448
  # Custom text that should be displayed after the payment confirmation button.
226
449
  attr_reader :after_submit
@@ -230,6 +453,19 @@ module Stripe
230
453
  attr_reader :submit
231
454
  # Custom text that should be displayed in place of the default terms of service agreement text.
232
455
  attr_reader :terms_of_service_acceptance
456
+
457
+ def self.inner_class_types
458
+ @inner_class_types = {
459
+ after_submit: AfterSubmit,
460
+ shipping_address: ShippingAddress,
461
+ submit: Submit,
462
+ terms_of_service_acceptance: TermsOfServiceAcceptance,
463
+ }
464
+ end
465
+
466
+ def self.field_remappings
467
+ @field_remappings = {}
468
+ end
233
469
  end
234
470
 
235
471
  class CustomerDetails < Stripe::StripeObject
@@ -238,14 +474,22 @@ module Stripe
238
474
  attr_reader :city
239
475
  # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
240
476
  attr_reader :country
241
- # Address line 1 (e.g., street, PO Box, or company name).
477
+ # Address line 1, such as the street, PO Box, or company name.
242
478
  attr_reader :line1
243
- # Address line 2 (e.g., apartment, suite, unit, or building).
479
+ # Address line 2, such as the apartment, suite, unit, or building.
244
480
  attr_reader :line2
245
481
  # ZIP or postal code.
246
482
  attr_reader :postal_code
247
483
  # State, county, province, or region.
248
484
  attr_reader :state
485
+
486
+ def self.inner_class_types
487
+ @inner_class_types = {}
488
+ end
489
+
490
+ def self.field_remappings
491
+ @field_remappings = {}
492
+ end
249
493
  end
250
494
 
251
495
  class TaxId < Stripe::StripeObject
@@ -253,12 +497,24 @@ module Stripe
253
497
  attr_reader :type
254
498
  # The value of the tax ID.
255
499
  attr_reader :value
500
+
501
+ def self.inner_class_types
502
+ @inner_class_types = {}
503
+ end
504
+
505
+ def self.field_remappings
506
+ @field_remappings = {}
507
+ end
256
508
  end
257
509
  # The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
258
510
  attr_reader :address
511
+ # The customer's business name after a completed Checkout Session.
512
+ attr_reader :business_name
259
513
  # The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.
260
514
  # Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.
261
515
  attr_reader :email
516
+ # The customer's individual name after a completed Checkout Session.
517
+ attr_reader :individual_name
262
518
  # The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
263
519
  attr_reader :name
264
520
  # The customer's phone number after a completed Checkout Session.
@@ -267,6 +523,14 @@ module Stripe
267
523
  attr_reader :tax_exempt
268
524
  # The customer’s tax IDs after a completed Checkout Session.
269
525
  attr_reader :tax_ids
526
+
527
+ def self.inner_class_types
528
+ @inner_class_types = { address: Address, tax_ids: TaxId }
529
+ end
530
+
531
+ def self.field_remappings
532
+ @field_remappings = {}
533
+ end
270
534
  end
271
535
 
272
536
  class Discount < Stripe::StripeObject
@@ -274,6 +538,14 @@ module Stripe
274
538
  attr_reader :coupon
275
539
  # Promotion code attached to the Checkout Session.
276
540
  attr_reader :promotion_code
541
+
542
+ def self.inner_class_types
543
+ @inner_class_types = {}
544
+ end
545
+
546
+ def self.field_remappings
547
+ @field_remappings = {}
548
+ end
277
549
  end
278
550
 
279
551
  class InvoiceCreation < Stripe::StripeObject
@@ -283,6 +555,14 @@ module Stripe
283
555
  attr_reader :name
284
556
  # The value of the custom field.
285
557
  attr_reader :value
558
+
559
+ def self.inner_class_types
560
+ @inner_class_types = {}
561
+ end
562
+
563
+ def self.field_remappings
564
+ @field_remappings = {}
565
+ end
286
566
  end
287
567
 
288
568
  class Issuer < Stripe::StripeObject
@@ -290,6 +570,14 @@ module Stripe
290
570
  attr_reader :account
291
571
  # Type of the account referenced.
292
572
  attr_reader :type
573
+
574
+ def self.inner_class_types
575
+ @inner_class_types = {}
576
+ end
577
+
578
+ def self.field_remappings
579
+ @field_remappings = {}
580
+ end
293
581
  end
294
582
 
295
583
  class RenderingOptions < Stripe::StripeObject
@@ -297,6 +585,14 @@ module Stripe
297
585
  attr_reader :amount_tax_display
298
586
  # ID of the invoice rendering template to be used for the generated invoice.
299
587
  attr_reader :template
588
+
589
+ def self.inner_class_types
590
+ @inner_class_types = {}
591
+ end
592
+
593
+ def self.field_remappings
594
+ @field_remappings = {}
595
+ end
300
596
  end
301
597
  # The account tax IDs associated with the invoice.
302
598
  attr_reader :account_tax_ids
@@ -312,11 +608,75 @@ module Stripe
312
608
  attr_reader :metadata
313
609
  # Options for invoice PDF rendering.
314
610
  attr_reader :rendering_options
611
+
612
+ def self.inner_class_types
613
+ @inner_class_types = {
614
+ custom_fields: CustomField,
615
+ issuer: Issuer,
616
+ rendering_options: RenderingOptions,
617
+ }
618
+ end
619
+
620
+ def self.field_remappings
621
+ @field_remappings = {}
622
+ end
315
623
  end
316
624
  # Indicates whether invoice creation is enabled for the Checkout Session.
317
625
  attr_reader :enabled
318
626
  # Attribute for field invoice_data
319
627
  attr_reader :invoice_data
628
+
629
+ def self.inner_class_types
630
+ @inner_class_types = { invoice_data: InvoiceData }
631
+ end
632
+
633
+ def self.field_remappings
634
+ @field_remappings = {}
635
+ end
636
+ end
637
+
638
+ class NameCollection < Stripe::StripeObject
639
+ class Business < Stripe::StripeObject
640
+ # Indicates whether business name collection is enabled for the session
641
+ attr_reader :enabled
642
+ # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
643
+ attr_reader :optional
644
+
645
+ def self.inner_class_types
646
+ @inner_class_types = {}
647
+ end
648
+
649
+ def self.field_remappings
650
+ @field_remappings = {}
651
+ end
652
+ end
653
+
654
+ class Individual < Stripe::StripeObject
655
+ # Indicates whether individual name collection is enabled for the session
656
+ attr_reader :enabled
657
+ # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
658
+ attr_reader :optional
659
+
660
+ def self.inner_class_types
661
+ @inner_class_types = {}
662
+ end
663
+
664
+ def self.field_remappings
665
+ @field_remappings = {}
666
+ end
667
+ end
668
+ # Attribute for field business
669
+ attr_reader :business
670
+ # Attribute for field individual
671
+ attr_reader :individual
672
+
673
+ def self.inner_class_types
674
+ @inner_class_types = { business: Business, individual: Individual }
675
+ end
676
+
677
+ def self.field_remappings
678
+ @field_remappings = {}
679
+ end
320
680
  end
321
681
 
322
682
  class OptionalItem < Stripe::StripeObject
@@ -327,6 +687,14 @@ module Stripe
327
687
  attr_reader :maximum
328
688
  # 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.
329
689
  attr_reader :minimum
690
+
691
+ def self.inner_class_types
692
+ @inner_class_types = {}
693
+ end
694
+
695
+ def self.field_remappings
696
+ @field_remappings = {}
697
+ end
330
698
  end
331
699
  # Attribute for field adjustable_quantity
332
700
  attr_reader :adjustable_quantity
@@ -334,6 +702,14 @@ module Stripe
334
702
  attr_reader :price
335
703
  # Attribute for field quantity
336
704
  attr_reader :quantity
705
+
706
+ def self.inner_class_types
707
+ @inner_class_types = { adjustable_quantity: AdjustableQuantity }
708
+ end
709
+
710
+ def self.field_remappings
711
+ @field_remappings = {}
712
+ end
337
713
  end
338
714
 
339
715
  class PaymentMethodConfigurationDetails < Stripe::StripeObject
@@ -341,6 +717,14 @@ module Stripe
341
717
  attr_reader :id
342
718
  # ID of the parent payment method configuration used.
343
719
  attr_reader :parent
720
+
721
+ def self.inner_class_types
722
+ @inner_class_types = {}
723
+ end
724
+
725
+ def self.field_remappings
726
+ @field_remappings = {}
727
+ end
344
728
  end
345
729
 
346
730
  class PaymentMethodOptions < Stripe::StripeObject
@@ -356,6 +740,14 @@ module Stripe
356
740
  attr_reader :payment_schedule
357
741
  # Transaction type of the mandate.
358
742
  attr_reader :transaction_type
743
+
744
+ def self.inner_class_types
745
+ @inner_class_types = {}
746
+ end
747
+
748
+ def self.field_remappings
749
+ @field_remappings = {}
750
+ end
359
751
  end
360
752
  # Currency supported by the bank account. Returned when the Session is in `setup` mode.
361
753
  attr_reader :currency
@@ -373,9 +765,19 @@ module Stripe
373
765
  attr_reader :target_date
374
766
  # Bank account verification method.
375
767
  attr_reader :verification_method
768
+
769
+ def self.inner_class_types
770
+ @inner_class_types = { mandate_options: MandateOptions }
771
+ end
772
+
773
+ def self.field_remappings
774
+ @field_remappings = {}
775
+ end
376
776
  end
377
777
 
378
778
  class Affirm < Stripe::StripeObject
779
+ # Controls when the funds will be captured from the customer's account.
780
+ attr_reader :capture_method
379
781
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
380
782
  #
381
783
  # 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.
@@ -384,9 +786,19 @@ module Stripe
384
786
  #
385
787
  # 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).
386
788
  attr_reader :setup_future_usage
789
+
790
+ def self.inner_class_types
791
+ @inner_class_types = {}
792
+ end
793
+
794
+ def self.field_remappings
795
+ @field_remappings = {}
796
+ end
387
797
  end
388
798
 
389
799
  class AfterpayClearpay < Stripe::StripeObject
800
+ # Controls when the funds will be captured from the customer's account.
801
+ attr_reader :capture_method
390
802
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
391
803
  #
392
804
  # 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.
@@ -395,6 +807,14 @@ module Stripe
395
807
  #
396
808
  # 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).
397
809
  attr_reader :setup_future_usage
810
+
811
+ def self.inner_class_types
812
+ @inner_class_types = {}
813
+ end
814
+
815
+ def self.field_remappings
816
+ @field_remappings = {}
817
+ end
398
818
  end
399
819
 
400
820
  class Alipay < Stripe::StripeObject
@@ -406,9 +826,32 @@ module Stripe
406
826
  #
407
827
  # 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).
408
828
  attr_reader :setup_future_usage
829
+
830
+ def self.inner_class_types
831
+ @inner_class_types = {}
832
+ end
833
+
834
+ def self.field_remappings
835
+ @field_remappings = {}
836
+ end
837
+ end
838
+
839
+ class Alma < Stripe::StripeObject
840
+ # Controls when the funds will be captured from the customer's account.
841
+ attr_reader :capture_method
842
+
843
+ def self.inner_class_types
844
+ @inner_class_types = {}
845
+ end
846
+
847
+ def self.field_remappings
848
+ @field_remappings = {}
849
+ end
409
850
  end
410
851
 
411
852
  class AmazonPay < Stripe::StripeObject
853
+ # Controls when the funds will be captured from the customer's account.
854
+ attr_reader :capture_method
412
855
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
413
856
  #
414
857
  # 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.
@@ -417,6 +860,14 @@ module Stripe
417
860
  #
418
861
  # 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).
419
862
  attr_reader :setup_future_usage
863
+
864
+ def self.inner_class_types
865
+ @inner_class_types = {}
866
+ end
867
+
868
+ def self.field_remappings
869
+ @field_remappings = {}
870
+ end
420
871
  end
421
872
 
422
873
  class AuBecsDebit < Stripe::StripeObject
@@ -430,12 +881,28 @@ module Stripe
430
881
  attr_reader :setup_future_usage
431
882
  # 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.
432
883
  attr_reader :target_date
884
+
885
+ def self.inner_class_types
886
+ @inner_class_types = {}
887
+ end
888
+
889
+ def self.field_remappings
890
+ @field_remappings = {}
891
+ end
433
892
  end
434
893
 
435
894
  class BacsDebit < Stripe::StripeObject
436
895
  class MandateOptions < Stripe::StripeObject
437
896
  # 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'.
438
897
  attr_reader :reference_prefix
898
+
899
+ def self.inner_class_types
900
+ @inner_class_types = {}
901
+ end
902
+
903
+ def self.field_remappings
904
+ @field_remappings = {}
905
+ end
439
906
  end
440
907
  # Attribute for field mandate_options
441
908
  attr_reader :mandate_options
@@ -449,6 +916,14 @@ module Stripe
449
916
  attr_reader :setup_future_usage
450
917
  # 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.
451
918
  attr_reader :target_date
919
+
920
+ def self.inner_class_types
921
+ @inner_class_types = { mandate_options: MandateOptions }
922
+ end
923
+
924
+ def self.field_remappings
925
+ @field_remappings = {}
926
+ end
452
927
  end
453
928
 
454
929
  class Bancontact < Stripe::StripeObject
@@ -460,6 +935,27 @@ module Stripe
460
935
  #
461
936
  # 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).
462
937
  attr_reader :setup_future_usage
938
+
939
+ def self.inner_class_types
940
+ @inner_class_types = {}
941
+ end
942
+
943
+ def self.field_remappings
944
+ @field_remappings = {}
945
+ end
946
+ end
947
+
948
+ class Billie < Stripe::StripeObject
949
+ # Controls when the funds will be captured from the customer's account.
950
+ attr_reader :capture_method
951
+
952
+ def self.inner_class_types
953
+ @inner_class_types = {}
954
+ end
955
+
956
+ def self.field_remappings
957
+ @field_remappings = {}
958
+ end
463
959
  end
464
960
 
465
961
  class Boleto < Stripe::StripeObject
@@ -473,23 +969,47 @@ module Stripe
473
969
  #
474
970
  # 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).
475
971
  attr_reader :setup_future_usage
476
- end
477
972
 
478
- class Card < Stripe::StripeObject
479
- class Installments < Stripe::StripeObject
973
+ def self.inner_class_types
974
+ @inner_class_types = {}
975
+ end
976
+
977
+ def self.field_remappings
978
+ @field_remappings = {}
979
+ end
980
+ end
981
+
982
+ class Card < Stripe::StripeObject
983
+ class Installments < Stripe::StripeObject
480
984
  # Indicates if installments are enabled
481
985
  attr_reader :enabled
986
+
987
+ def self.inner_class_types
988
+ @inner_class_types = {}
989
+ end
990
+
991
+ def self.field_remappings
992
+ @field_remappings = {}
993
+ end
482
994
  end
483
995
 
484
996
  class Restrictions < Stripe::StripeObject
485
997
  # 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.
486
998
  attr_reader :brands_blocked
999
+
1000
+ def self.inner_class_types
1001
+ @inner_class_types = {}
1002
+ end
1003
+
1004
+ def self.field_remappings
1005
+ @field_remappings = {}
1006
+ end
487
1007
  end
1008
+ # Controls when the funds will be captured from the customer's account.
1009
+ attr_reader :capture_method
488
1010
  # Attribute for field installments
489
1011
  attr_reader :installments
490
1012
  # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
491
- attr_reader :request_decremental_authorization
492
- # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
493
1013
  attr_reader :request_extended_authorization
494
1014
  # Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
495
1015
  attr_reader :request_incremental_authorization
@@ -513,9 +1033,19 @@ module Stripe
513
1033
  attr_reader :statement_descriptor_suffix_kana
514
1034
  # Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
515
1035
  attr_reader :statement_descriptor_suffix_kanji
1036
+
1037
+ def self.inner_class_types
1038
+ @inner_class_types = { installments: Installments, restrictions: Restrictions }
1039
+ end
1040
+
1041
+ def self.field_remappings
1042
+ @field_remappings = {}
1043
+ end
516
1044
  end
517
1045
 
518
1046
  class Cashapp < Stripe::StripeObject
1047
+ # Controls when the funds will be captured from the customer's account.
1048
+ attr_reader :capture_method
519
1049
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
520
1050
  #
521
1051
  # 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.
@@ -524,6 +1054,14 @@ module Stripe
524
1054
  #
525
1055
  # 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).
526
1056
  attr_reader :setup_future_usage
1057
+
1058
+ def self.inner_class_types
1059
+ @inner_class_types = {}
1060
+ end
1061
+
1062
+ def self.field_remappings
1063
+ @field_remappings = {}
1064
+ end
527
1065
  end
528
1066
 
529
1067
  class CustomerBalance < Stripe::StripeObject
@@ -531,6 +1069,14 @@ module Stripe
531
1069
  class EuBankTransfer < Stripe::StripeObject
532
1070
  # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
533
1071
  attr_reader :country
1072
+
1073
+ def self.inner_class_types
1074
+ @inner_class_types = {}
1075
+ end
1076
+
1077
+ def self.field_remappings
1078
+ @field_remappings = {}
1079
+ end
534
1080
  end
535
1081
  # Attribute for field eu_bank_transfer
536
1082
  attr_reader :eu_bank_transfer
@@ -540,6 +1086,14 @@ module Stripe
540
1086
  attr_reader :requested_address_types
541
1087
  # The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
542
1088
  attr_reader :type
1089
+
1090
+ def self.inner_class_types
1091
+ @inner_class_types = { eu_bank_transfer: EuBankTransfer }
1092
+ end
1093
+
1094
+ def self.field_remappings
1095
+ @field_remappings = {}
1096
+ end
543
1097
  end
544
1098
  # Attribute for field bank_transfer
545
1099
  attr_reader :bank_transfer
@@ -553,6 +1107,14 @@ module Stripe
553
1107
  #
554
1108
  # 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).
555
1109
  attr_reader :setup_future_usage
1110
+
1111
+ def self.inner_class_types
1112
+ @inner_class_types = { bank_transfer: BankTransfer }
1113
+ end
1114
+
1115
+ def self.field_remappings
1116
+ @field_remappings = {}
1117
+ end
556
1118
  end
557
1119
 
558
1120
  class Eps < Stripe::StripeObject
@@ -564,6 +1126,14 @@ module Stripe
564
1126
  #
565
1127
  # 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).
566
1128
  attr_reader :setup_future_usage
1129
+
1130
+ def self.inner_class_types
1131
+ @inner_class_types = {}
1132
+ end
1133
+
1134
+ def self.field_remappings
1135
+ @field_remappings = {}
1136
+ end
567
1137
  end
568
1138
 
569
1139
  class Fpx < Stripe::StripeObject
@@ -575,6 +1145,14 @@ module Stripe
575
1145
  #
576
1146
  # 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).
577
1147
  attr_reader :setup_future_usage
1148
+
1149
+ def self.inner_class_types
1150
+ @inner_class_types = {}
1151
+ end
1152
+
1153
+ def self.field_remappings
1154
+ @field_remappings = {}
1155
+ end
578
1156
  end
579
1157
 
580
1158
  class Giropay < Stripe::StripeObject
@@ -586,6 +1164,14 @@ module Stripe
586
1164
  #
587
1165
  # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
588
1166
  attr_reader :setup_future_usage
1167
+
1168
+ def self.inner_class_types
1169
+ @inner_class_types = {}
1170
+ end
1171
+
1172
+ def self.field_remappings
1173
+ @field_remappings = {}
1174
+ end
589
1175
  end
590
1176
 
591
1177
  class Grabpay < Stripe::StripeObject
@@ -597,6 +1183,14 @@ module Stripe
597
1183
  #
598
1184
  # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
599
1185
  attr_reader :setup_future_usage
1186
+
1187
+ def self.inner_class_types
1188
+ @inner_class_types = {}
1189
+ end
1190
+
1191
+ def self.field_remappings
1192
+ @field_remappings = {}
1193
+ end
600
1194
  end
601
1195
 
602
1196
  class Ideal < Stripe::StripeObject
@@ -608,6 +1202,14 @@ module Stripe
608
1202
  #
609
1203
  # 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).
610
1204
  attr_reader :setup_future_usage
1205
+
1206
+ def self.inner_class_types
1207
+ @inner_class_types = {}
1208
+ end
1209
+
1210
+ def self.field_remappings
1211
+ @field_remappings = {}
1212
+ end
611
1213
  end
612
1214
 
613
1215
  class KakaoPay < Stripe::StripeObject
@@ -621,9 +1223,19 @@ module Stripe
621
1223
  #
622
1224
  # 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).
623
1225
  attr_reader :setup_future_usage
1226
+
1227
+ def self.inner_class_types
1228
+ @inner_class_types = {}
1229
+ end
1230
+
1231
+ def self.field_remappings
1232
+ @field_remappings = {}
1233
+ end
624
1234
  end
625
1235
 
626
1236
  class Klarna < Stripe::StripeObject
1237
+ # Controls when the funds will be captured from the customer's account.
1238
+ attr_reader :capture_method
627
1239
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
628
1240
  #
629
1241
  # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
@@ -632,6 +1244,14 @@ module Stripe
632
1244
  #
633
1245
  # 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).
634
1246
  attr_reader :setup_future_usage
1247
+
1248
+ def self.inner_class_types
1249
+ @inner_class_types = {}
1250
+ end
1251
+
1252
+ def self.field_remappings
1253
+ @field_remappings = {}
1254
+ end
635
1255
  end
636
1256
 
637
1257
  class Konbini < Stripe::StripeObject
@@ -645,6 +1265,14 @@ module Stripe
645
1265
  #
646
1266
  # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
647
1267
  attr_reader :setup_future_usage
1268
+
1269
+ def self.inner_class_types
1270
+ @inner_class_types = {}
1271
+ end
1272
+
1273
+ def self.field_remappings
1274
+ @field_remappings = {}
1275
+ end
648
1276
  end
649
1277
 
650
1278
  class KrCard < Stripe::StripeObject
@@ -658,9 +1286,19 @@ module Stripe
658
1286
  #
659
1287
  # 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).
660
1288
  attr_reader :setup_future_usage
1289
+
1290
+ def self.inner_class_types
1291
+ @inner_class_types = {}
1292
+ end
1293
+
1294
+ def self.field_remappings
1295
+ @field_remappings = {}
1296
+ end
661
1297
  end
662
1298
 
663
1299
  class Link < Stripe::StripeObject
1300
+ # Controls when the funds will be captured from the customer's account.
1301
+ attr_reader :capture_method
664
1302
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
665
1303
  #
666
1304
  # 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.
@@ -669,9 +1307,19 @@ module Stripe
669
1307
  #
670
1308
  # 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).
671
1309
  attr_reader :setup_future_usage
1310
+
1311
+ def self.inner_class_types
1312
+ @inner_class_types = {}
1313
+ end
1314
+
1315
+ def self.field_remappings
1316
+ @field_remappings = {}
1317
+ end
672
1318
  end
673
1319
 
674
1320
  class Mobilepay < Stripe::StripeObject
1321
+ # Controls when the funds will be captured from the customer's account.
1322
+ attr_reader :capture_method
675
1323
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
676
1324
  #
677
1325
  # 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.
@@ -680,6 +1328,14 @@ module Stripe
680
1328
  #
681
1329
  # 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).
682
1330
  attr_reader :setup_future_usage
1331
+
1332
+ def self.inner_class_types
1333
+ @inner_class_types = {}
1334
+ end
1335
+
1336
+ def self.field_remappings
1337
+ @field_remappings = {}
1338
+ end
683
1339
  end
684
1340
 
685
1341
  class Multibanco < Stripe::StripeObject
@@ -691,6 +1347,14 @@ module Stripe
691
1347
  #
692
1348
  # 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).
693
1349
  attr_reader :setup_future_usage
1350
+
1351
+ def self.inner_class_types
1352
+ @inner_class_types = {}
1353
+ end
1354
+
1355
+ def self.field_remappings
1356
+ @field_remappings = {}
1357
+ end
694
1358
  end
695
1359
 
696
1360
  class NaverPay < Stripe::StripeObject
@@ -704,6 +1368,14 @@ module Stripe
704
1368
  #
705
1369
  # 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).
706
1370
  attr_reader :setup_future_usage
1371
+
1372
+ def self.inner_class_types
1373
+ @inner_class_types = {}
1374
+ end
1375
+
1376
+ def self.field_remappings
1377
+ @field_remappings = {}
1378
+ end
707
1379
  end
708
1380
 
709
1381
  class Oxxo < Stripe::StripeObject
@@ -717,6 +1389,14 @@ module Stripe
717
1389
  #
718
1390
  # 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).
719
1391
  attr_reader :setup_future_usage
1392
+
1393
+ def self.inner_class_types
1394
+ @inner_class_types = {}
1395
+ end
1396
+
1397
+ def self.field_remappings
1398
+ @field_remappings = {}
1399
+ end
720
1400
  end
721
1401
 
722
1402
  class P24 < Stripe::StripeObject
@@ -728,11 +1408,27 @@ module Stripe
728
1408
  #
729
1409
  # 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).
730
1410
  attr_reader :setup_future_usage
1411
+
1412
+ def self.inner_class_types
1413
+ @inner_class_types = {}
1414
+ end
1415
+
1416
+ def self.field_remappings
1417
+ @field_remappings = {}
1418
+ end
731
1419
  end
732
1420
 
733
1421
  class Payco < Stripe::StripeObject
734
1422
  # Controls when the funds will be captured from the customer's account.
735
1423
  attr_reader :capture_method
1424
+
1425
+ def self.inner_class_types
1426
+ @inner_class_types = {}
1427
+ end
1428
+
1429
+ def self.field_remappings
1430
+ @field_remappings = {}
1431
+ end
736
1432
  end
737
1433
 
738
1434
  class Paynow < Stripe::StripeObject
@@ -744,6 +1440,14 @@ module Stripe
744
1440
  #
745
1441
  # 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).
746
1442
  attr_reader :setup_future_usage
1443
+
1444
+ def self.inner_class_types
1445
+ @inner_class_types = {}
1446
+ end
1447
+
1448
+ def self.field_remappings
1449
+ @field_remappings = {}
1450
+ end
747
1451
  end
748
1452
 
749
1453
  class Paypal < Stripe::StripeObject
@@ -761,64 +1465,21 @@ module Stripe
761
1465
  #
762
1466
  # 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).
763
1467
  attr_reader :setup_future_usage
764
- # 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.
765
- attr_reader :subsellers
766
- end
767
1468
 
768
- class Payto < Stripe::StripeObject
769
- class MandateOptions < Stripe::StripeObject
770
- # Amount that will be collected. It is required when `amount_type` is `fixed`.
771
- attr_reader :amount
772
- # 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.
773
- attr_reader :amount_type
774
- # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
775
- attr_reader :end_date
776
- # The periodicity at which payments will be collected.
777
- attr_reader :payment_schedule
778
- # 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.
779
- attr_reader :payments_per_period
780
- # The purpose for which payments are made. Defaults to retail.
781
- attr_reader :purpose
782
- # Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
783
- attr_reader :start_date
1469
+ def self.inner_class_types
1470
+ @inner_class_types = {}
1471
+ end
1472
+
1473
+ def self.field_remappings
1474
+ @field_remappings = {}
784
1475
  end
785
- # Attribute for field mandate_options
786
- attr_reader :mandate_options
787
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
788
- #
789
- # 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.
790
- #
791
- # 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.
792
- #
793
- # 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).
794
- attr_reader :setup_future_usage
795
1476
  end
796
1477
 
797
1478
  class Pix < Stripe::StripeObject
798
- class MandateOptions < Stripe::StripeObject
799
- # Amount to be charged for future payments.
800
- attr_reader :amount
801
- # Determines if the amount includes the IOF tax.
802
- attr_reader :amount_includes_iof
803
- # Type of amount.
804
- attr_reader :amount_type
805
- # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
806
- attr_reader :currency
807
- # Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
808
- attr_reader :end_date
809
- # Schedule at which the future payments will be charged.
810
- attr_reader :payment_schedule
811
- # Subscription name displayed to buyers in their bank app.
812
- attr_reader :reference
813
- # Start date of the mandate, in `YYYY-MM-DD`.
814
- attr_reader :start_date
815
- end
816
1479
  # Determines if the amount includes the IOF tax.
817
1480
  attr_reader :amount_includes_iof
818
1481
  # The number of seconds after which Pix payment will expire.
819
1482
  attr_reader :expires_after_seconds
820
- # Attribute for field mandate_options
821
- attr_reader :mandate_options
822
1483
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
823
1484
  #
824
1485
  # 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.
@@ -827,9 +1488,19 @@ module Stripe
827
1488
  #
828
1489
  # 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).
829
1490
  attr_reader :setup_future_usage
1491
+
1492
+ def self.inner_class_types
1493
+ @inner_class_types = {}
1494
+ end
1495
+
1496
+ def self.field_remappings
1497
+ @field_remappings = {}
1498
+ end
830
1499
  end
831
1500
 
832
1501
  class RevolutPay < Stripe::StripeObject
1502
+ # Controls when the funds will be captured from the customer's account.
1503
+ attr_reader :capture_method
833
1504
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
834
1505
  #
835
1506
  # 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.
@@ -838,17 +1509,54 @@ module Stripe
838
1509
  #
839
1510
  # 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).
840
1511
  attr_reader :setup_future_usage
1512
+
1513
+ def self.inner_class_types
1514
+ @inner_class_types = {}
1515
+ end
1516
+
1517
+ def self.field_remappings
1518
+ @field_remappings = {}
1519
+ end
841
1520
  end
842
1521
 
843
1522
  class SamsungPay < Stripe::StripeObject
844
1523
  # Controls when the funds will be captured from the customer's account.
845
1524
  attr_reader :capture_method
1525
+
1526
+ def self.inner_class_types
1527
+ @inner_class_types = {}
1528
+ end
1529
+
1530
+ def self.field_remappings
1531
+ @field_remappings = {}
1532
+ end
1533
+ end
1534
+
1535
+ class Satispay < Stripe::StripeObject
1536
+ # Controls when the funds will be captured from the customer's account.
1537
+ attr_reader :capture_method
1538
+
1539
+ def self.inner_class_types
1540
+ @inner_class_types = {}
1541
+ end
1542
+
1543
+ def self.field_remappings
1544
+ @field_remappings = {}
1545
+ end
846
1546
  end
847
1547
 
848
1548
  class SepaDebit < Stripe::StripeObject
849
1549
  class MandateOptions < Stripe::StripeObject
850
1550
  # 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'.
851
1551
  attr_reader :reference_prefix
1552
+
1553
+ def self.inner_class_types
1554
+ @inner_class_types = {}
1555
+ end
1556
+
1557
+ def self.field_remappings
1558
+ @field_remappings = {}
1559
+ end
852
1560
  end
853
1561
  # Attribute for field mandate_options
854
1562
  attr_reader :mandate_options
@@ -862,6 +1570,14 @@ module Stripe
862
1570
  attr_reader :setup_future_usage
863
1571
  # 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.
864
1572
  attr_reader :target_date
1573
+
1574
+ def self.inner_class_types
1575
+ @inner_class_types = { mandate_options: MandateOptions }
1576
+ end
1577
+
1578
+ def self.field_remappings
1579
+ @field_remappings = {}
1580
+ end
865
1581
  end
866
1582
 
867
1583
  class Sofort < Stripe::StripeObject
@@ -873,11 +1589,27 @@ module Stripe
873
1589
  #
874
1590
  # 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).
875
1591
  attr_reader :setup_future_usage
1592
+
1593
+ def self.inner_class_types
1594
+ @inner_class_types = {}
1595
+ end
1596
+
1597
+ def self.field_remappings
1598
+ @field_remappings = {}
1599
+ end
876
1600
  end
877
1601
 
878
1602
  class Swish < Stripe::StripeObject
879
1603
  # The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
880
1604
  attr_reader :reference
1605
+
1606
+ def self.inner_class_types
1607
+ @inner_class_types = {}
1608
+ end
1609
+
1610
+ def self.field_remappings
1611
+ @field_remappings = {}
1612
+ end
881
1613
  end
882
1614
 
883
1615
  class UsBankAccount < Stripe::StripeObject
@@ -885,24 +1617,31 @@ module Stripe
885
1617
  class Filters < Stripe::StripeObject
886
1618
  # The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
887
1619
  attr_reader :account_subcategories
888
- # The institution to use to filter for possible accounts to link.
889
- attr_reader :institution
890
- end
891
1620
 
892
- class ManualEntry < Stripe::StripeObject
893
- # Settings for configuring manual entry of account details.
894
- attr_reader :mode
1621
+ def self.inner_class_types
1622
+ @inner_class_types = {}
1623
+ end
1624
+
1625
+ def self.field_remappings
1626
+ @field_remappings = {}
1627
+ end
895
1628
  end
896
1629
  # Attribute for field filters
897
1630
  attr_reader :filters
898
- # Attribute for field manual_entry
899
- attr_reader :manual_entry
900
1631
  # The list of permissions to request. The `payment_method` permission must be included.
901
1632
  attr_reader :permissions
902
1633
  # Data features requested to be retrieved upon account creation.
903
1634
  attr_reader :prefetch
904
1635
  # For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
905
1636
  attr_reader :return_url
1637
+
1638
+ def self.inner_class_types
1639
+ @inner_class_types = { filters: Filters }
1640
+ end
1641
+
1642
+ def self.field_remappings
1643
+ @field_remappings = {}
1644
+ end
906
1645
  end
907
1646
  # Attribute for field financial_connections
908
1647
  attr_reader :financial_connections
@@ -918,6 +1657,14 @@ module Stripe
918
1657
  attr_reader :target_date
919
1658
  # Bank account verification method.
920
1659
  attr_reader :verification_method
1660
+
1661
+ def self.inner_class_types
1662
+ @inner_class_types = { financial_connections: FinancialConnections }
1663
+ end
1664
+
1665
+ def self.field_remappings
1666
+ @field_remappings = {}
1667
+ end
921
1668
  end
922
1669
  # Attribute for field acss_debit
923
1670
  attr_reader :acss_debit
@@ -927,6 +1674,8 @@ module Stripe
927
1674
  attr_reader :afterpay_clearpay
928
1675
  # Attribute for field alipay
929
1676
  attr_reader :alipay
1677
+ # Attribute for field alma
1678
+ attr_reader :alma
930
1679
  # Attribute for field amazon_pay
931
1680
  attr_reader :amazon_pay
932
1681
  # Attribute for field au_becs_debit
@@ -935,6 +1684,8 @@ module Stripe
935
1684
  attr_reader :bacs_debit
936
1685
  # Attribute for field bancontact
937
1686
  attr_reader :bancontact
1687
+ # Attribute for field billie
1688
+ attr_reader :billie
938
1689
  # Attribute for field boleto
939
1690
  attr_reader :boleto
940
1691
  # Attribute for field card
@@ -979,14 +1730,14 @@ module Stripe
979
1730
  attr_reader :paynow
980
1731
  # Attribute for field paypal
981
1732
  attr_reader :paypal
982
- # Attribute for field payto
983
- attr_reader :payto
984
1733
  # Attribute for field pix
985
1734
  attr_reader :pix
986
1735
  # Attribute for field revolut_pay
987
1736
  attr_reader :revolut_pay
988
1737
  # Attribute for field samsung_pay
989
1738
  attr_reader :samsung_pay
1739
+ # Attribute for field satispay
1740
+ attr_reader :satispay
990
1741
  # Attribute for field sepa_debit
991
1742
  attr_reader :sepa_debit
992
1743
  # Attribute for field sofort
@@ -995,42 +1746,85 @@ module Stripe
995
1746
  attr_reader :swish
996
1747
  # Attribute for field us_bank_account
997
1748
  attr_reader :us_bank_account
1749
+
1750
+ def self.inner_class_types
1751
+ @inner_class_types = {
1752
+ acss_debit: AcssDebit,
1753
+ affirm: Affirm,
1754
+ afterpay_clearpay: AfterpayClearpay,
1755
+ alipay: Alipay,
1756
+ alma: Alma,
1757
+ amazon_pay: AmazonPay,
1758
+ au_becs_debit: AuBecsDebit,
1759
+ bacs_debit: BacsDebit,
1760
+ bancontact: Bancontact,
1761
+ billie: Billie,
1762
+ boleto: Boleto,
1763
+ card: Card,
1764
+ cashapp: Cashapp,
1765
+ customer_balance: CustomerBalance,
1766
+ eps: Eps,
1767
+ fpx: Fpx,
1768
+ giropay: Giropay,
1769
+ grabpay: Grabpay,
1770
+ ideal: Ideal,
1771
+ kakao_pay: KakaoPay,
1772
+ klarna: Klarna,
1773
+ konbini: Konbini,
1774
+ kr_card: KrCard,
1775
+ link: Link,
1776
+ mobilepay: Mobilepay,
1777
+ multibanco: Multibanco,
1778
+ naver_pay: NaverPay,
1779
+ oxxo: Oxxo,
1780
+ p24: P24,
1781
+ payco: Payco,
1782
+ paynow: Paynow,
1783
+ paypal: Paypal,
1784
+ pix: Pix,
1785
+ revolut_pay: RevolutPay,
1786
+ samsung_pay: SamsungPay,
1787
+ satispay: Satispay,
1788
+ sepa_debit: SepaDebit,
1789
+ sofort: Sofort,
1790
+ swish: Swish,
1791
+ us_bank_account: UsBankAccount,
1792
+ }
1793
+ end
1794
+
1795
+ def self.field_remappings
1796
+ @field_remappings = {}
1797
+ end
998
1798
  end
999
1799
 
1000
1800
  class Permissions < Stripe::StripeObject
1001
- class Update < Stripe::StripeObject
1002
- # Determines which entity is allowed to update the line items.
1003
- #
1004
- # 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.
1005
- #
1006
- # 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.
1007
- attr_reader :line_items
1008
- # Determines which entity is allowed to update the shipping details.
1009
- #
1010
- # 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.
1011
- #
1012
- # 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.
1013
- attr_reader :shipping_details
1014
- end
1015
- # Permissions for updating the Checkout Session.
1016
- attr_reader :update
1017
- # Determines which entity is allowed to update the line items.
1018
- #
1019
- # 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.
1020
- #
1021
- # 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.
1022
- attr_reader :update_line_items
1023
1801
  # Determines which entity is allowed to update the shipping details.
1024
1802
  #
1025
1803
  # 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.
1026
1804
  #
1027
1805
  # 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.
1028
1806
  attr_reader :update_shipping_details
1807
+
1808
+ def self.inner_class_types
1809
+ @inner_class_types = {}
1810
+ end
1811
+
1812
+ def self.field_remappings
1813
+ @field_remappings = {}
1814
+ end
1029
1815
  end
1030
1816
 
1031
1817
  class PhoneNumberCollection < Stripe::StripeObject
1032
1818
  # Indicates whether phone number collection is enabled for the session
1033
1819
  attr_reader :enabled
1820
+
1821
+ def self.inner_class_types
1822
+ @inner_class_types = {}
1823
+ end
1824
+
1825
+ def self.field_remappings
1826
+ @field_remappings = {}
1827
+ end
1034
1828
  end
1035
1829
 
1036
1830
  class PresentmentDetails < Stripe::StripeObject
@@ -1038,6 +1832,14 @@ module Stripe
1038
1832
  attr_reader :presentment_amount
1039
1833
  # Currency presented to the customer during payment.
1040
1834
  attr_reader :presentment_currency
1835
+
1836
+ def self.inner_class_types
1837
+ @inner_class_types = {}
1838
+ end
1839
+
1840
+ def self.field_remappings
1841
+ @field_remappings = {}
1842
+ end
1041
1843
  end
1042
1844
 
1043
1845
  class SavedPaymentMethodOptions < Stripe::StripeObject
@@ -1047,12 +1849,28 @@ module Stripe
1047
1849
  attr_reader :payment_method_remove
1048
1850
  # Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
1049
1851
  attr_reader :payment_method_save
1852
+
1853
+ def self.inner_class_types
1854
+ @inner_class_types = {}
1855
+ end
1856
+
1857
+ def self.field_remappings
1858
+ @field_remappings = {}
1859
+ end
1050
1860
  end
1051
1861
 
1052
1862
  class ShippingAddressCollection < Stripe::StripeObject
1053
1863
  # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
1054
1864
  # shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`.
1055
1865
  attr_reader :allowed_countries
1866
+
1867
+ def self.inner_class_types
1868
+ @inner_class_types = {}
1869
+ end
1870
+
1871
+ def self.field_remappings
1872
+ @field_remappings = {}
1873
+ end
1056
1874
  end
1057
1875
 
1058
1876
  class ShippingCost < Stripe::StripeObject
@@ -1067,6 +1885,14 @@ module Stripe
1067
1885
  attr_reader :taxability_reason
1068
1886
  # The amount on which tax is calculated, in cents (or local equivalent).
1069
1887
  attr_reader :taxable_amount
1888
+
1889
+ def self.inner_class_types
1890
+ @inner_class_types = {}
1891
+ end
1892
+
1893
+ def self.field_remappings
1894
+ @field_remappings = {}
1895
+ end
1070
1896
  end
1071
1897
  # Total shipping cost before any discounts or taxes are applied.
1072
1898
  attr_reader :amount_subtotal
@@ -1078,6 +1904,14 @@ module Stripe
1078
1904
  attr_reader :shipping_rate
1079
1905
  # The taxes applied to the shipping rate.
1080
1906
  attr_reader :taxes
1907
+
1908
+ def self.inner_class_types
1909
+ @inner_class_types = { taxes: Tax }
1910
+ end
1911
+
1912
+ def self.field_remappings
1913
+ @field_remappings = {}
1914
+ end
1081
1915
  end
1082
1916
 
1083
1917
  class ShippingOption < Stripe::StripeObject
@@ -1085,6 +1919,14 @@ module Stripe
1085
1919
  attr_reader :shipping_amount
1086
1920
  # The shipping rate.
1087
1921
  attr_reader :shipping_rate
1922
+
1923
+ def self.inner_class_types
1924
+ @inner_class_types = {}
1925
+ end
1926
+
1927
+ def self.field_remappings
1928
+ @field_remappings = {}
1929
+ end
1088
1930
  end
1089
1931
 
1090
1932
  class TaxIdCollection < Stripe::StripeObject
@@ -1092,6 +1934,14 @@ module Stripe
1092
1934
  attr_reader :enabled
1093
1935
  # Indicates whether a tax ID is required on the payment page
1094
1936
  attr_reader :required
1937
+
1938
+ def self.inner_class_types
1939
+ @inner_class_types = {}
1940
+ end
1941
+
1942
+ def self.field_remappings
1943
+ @field_remappings = {}
1944
+ end
1095
1945
  end
1096
1946
 
1097
1947
  class TotalDetails < Stripe::StripeObject
@@ -1104,6 +1954,14 @@ module Stripe
1104
1954
  #
1105
1955
  # Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)
1106
1956
  attr_reader :discount
1957
+
1958
+ def self.inner_class_types
1959
+ @inner_class_types = {}
1960
+ end
1961
+
1962
+ def self.field_remappings
1963
+ @field_remappings = {}
1964
+ end
1107
1965
  end
1108
1966
 
1109
1967
  class Tax < Stripe::StripeObject
@@ -1117,11 +1975,27 @@ module Stripe
1117
1975
  attr_reader :taxability_reason
1118
1976
  # The amount on which tax is calculated, in cents (or local equivalent).
1119
1977
  attr_reader :taxable_amount
1978
+
1979
+ def self.inner_class_types
1980
+ @inner_class_types = {}
1981
+ end
1982
+
1983
+ def self.field_remappings
1984
+ @field_remappings = {}
1985
+ end
1120
1986
  end
1121
1987
  # The aggregated discounts.
1122
1988
  attr_reader :discounts
1123
1989
  # The aggregated tax amounts by rate.
1124
1990
  attr_reader :taxes
1991
+
1992
+ def self.inner_class_types
1993
+ @inner_class_types = { discounts: Discount, taxes: Tax }
1994
+ end
1995
+
1996
+ def self.field_remappings
1997
+ @field_remappings = {}
1998
+ end
1125
1999
  end
1126
2000
  # This is the sum of all the discounts.
1127
2001
  attr_reader :amount_discount
@@ -1131,2905 +2005,38 @@ module Stripe
1131
2005
  attr_reader :amount_tax
1132
2006
  # Attribute for field breakdown
1133
2007
  attr_reader :breakdown
2008
+
2009
+ def self.inner_class_types
2010
+ @inner_class_types = { breakdown: Breakdown }
2011
+ end
2012
+
2013
+ def self.field_remappings
2014
+ @field_remappings = {}
2015
+ end
1134
2016
  end
1135
2017
 
1136
2018
  class WalletOptions < Stripe::StripeObject
1137
2019
  class Link < Stripe::StripeObject
1138
2020
  # Describes whether Checkout should display Link. Defaults to `auto`.
1139
2021
  attr_reader :display
2022
+
2023
+ def self.inner_class_types
2024
+ @inner_class_types = {}
2025
+ end
2026
+
2027
+ def self.field_remappings
2028
+ @field_remappings = {}
2029
+ end
1140
2030
  end
1141
2031
  # Attribute for field link
1142
2032
  attr_reader :link
1143
- end
1144
2033
 
1145
- class ListParams < Stripe::RequestParams
1146
- class Created < Stripe::RequestParams
1147
- # Minimum value to filter by (exclusive)
1148
- attr_accessor :gt
1149
- # Minimum value to filter by (inclusive)
1150
- attr_accessor :gte
1151
- # Maximum value to filter by (exclusive)
1152
- attr_accessor :lt
1153
- # Maximum value to filter by (inclusive)
1154
- attr_accessor :lte
1155
-
1156
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
1157
- @gt = gt
1158
- @gte = gte
1159
- @lt = lt
1160
- @lte = lte
1161
- end
2034
+ def self.inner_class_types
2035
+ @inner_class_types = { link: Link }
1162
2036
  end
1163
2037
 
1164
- class CustomerDetails < Stripe::RequestParams
1165
- # Customer's email address.
1166
- attr_accessor :email
1167
-
1168
- def initialize(email: nil)
1169
- @email = email
1170
- end
1171
- end
1172
- # Only return Checkout Sessions that were created during the given date interval.
1173
- attr_accessor :created
1174
- # Only return the Checkout Sessions for the Customer specified.
1175
- attr_accessor :customer
1176
- # Only return the Checkout Sessions for the Account specified.
1177
- attr_accessor :customer_account
1178
- # Only return the Checkout Sessions for the Customer details specified.
1179
- attr_accessor :customer_details
1180
- # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
1181
- attr_accessor :ending_before
1182
- # Specifies which fields in the response should be expanded.
1183
- attr_accessor :expand
1184
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1185
- attr_accessor :limit
1186
- # Only return the Checkout Session for the PaymentIntent specified.
1187
- attr_accessor :payment_intent
1188
- # Only return the Checkout Sessions for the Payment Link specified.
1189
- attr_accessor :payment_link
1190
- # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
1191
- attr_accessor :starting_after
1192
- # Only return the Checkout Sessions matching the given status.
1193
- attr_accessor :status
1194
- # Only return the Checkout Session for the subscription specified.
1195
- attr_accessor :subscription
1196
-
1197
- def initialize(
1198
- created: nil,
1199
- customer: nil,
1200
- customer_account: nil,
1201
- customer_details: nil,
1202
- ending_before: nil,
1203
- expand: nil,
1204
- limit: nil,
1205
- payment_intent: nil,
1206
- payment_link: nil,
1207
- starting_after: nil,
1208
- status: nil,
1209
- subscription: nil
1210
- )
1211
- @created = created
1212
- @customer = customer
1213
- @customer_account = customer_account
1214
- @customer_details = customer_details
1215
- @ending_before = ending_before
1216
- @expand = expand
1217
- @limit = limit
1218
- @payment_intent = payment_intent
1219
- @payment_link = payment_link
1220
- @starting_after = starting_after
1221
- @status = status
1222
- @subscription = subscription
1223
- end
1224
- end
1225
-
1226
- class CreateParams < Stripe::RequestParams
1227
- class AdaptivePricing < Stripe::RequestParams
1228
- # 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).
1229
- attr_accessor :enabled
1230
-
1231
- def initialize(enabled: nil)
1232
- @enabled = enabled
1233
- end
1234
- end
1235
-
1236
- class AfterExpiration < Stripe::RequestParams
1237
- class Recovery < Stripe::RequestParams
1238
- # Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
1239
- attr_accessor :allow_promotion_codes
1240
- # If `true`, a recovery URL will be generated to recover this Checkout Session if it
1241
- # expires before a successful transaction is completed. It will be attached to the
1242
- # Checkout Session object upon expiration.
1243
- attr_accessor :enabled
1244
-
1245
- def initialize(allow_promotion_codes: nil, enabled: nil)
1246
- @allow_promotion_codes = allow_promotion_codes
1247
- @enabled = enabled
1248
- end
1249
- end
1250
- # Configure a Checkout Session that can be used to recover an expired session.
1251
- attr_accessor :recovery
1252
-
1253
- def initialize(recovery: nil)
1254
- @recovery = recovery
1255
- end
1256
- end
1257
-
1258
- class AutomaticTax < Stripe::RequestParams
1259
- class Liability < Stripe::RequestParams
1260
- # The connected account being referenced when `type` is `account`.
1261
- attr_accessor :account
1262
- # Type of the account referenced in the request.
1263
- attr_accessor :type
1264
-
1265
- def initialize(account: nil, type: nil)
1266
- @account = account
1267
- @type = type
1268
- end
1269
- end
1270
- # Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
1271
- #
1272
- # Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.
1273
- attr_accessor :enabled
1274
- # 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.
1275
- attr_accessor :liability
1276
-
1277
- def initialize(enabled: nil, liability: nil)
1278
- @enabled = enabled
1279
- @liability = liability
1280
- end
1281
- end
1282
-
1283
- class ConsentCollection < Stripe::RequestParams
1284
- class PaymentMethodReuseAgreement < Stripe::RequestParams
1285
- # Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
1286
- # defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
1287
- attr_accessor :position
1288
-
1289
- def initialize(position: nil)
1290
- @position = position
1291
- end
1292
- end
1293
- # 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.
1294
- attr_accessor :payment_method_reuse_agreement
1295
- # If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
1296
- # Session will determine whether to display an option to opt into promotional communication
1297
- # from the merchant depending on the customer's locale. Only available to US merchants.
1298
- attr_accessor :promotions
1299
- # If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
1300
- # There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
1301
- attr_accessor :terms_of_service
1302
-
1303
- def initialize(
1304
- payment_method_reuse_agreement: nil,
1305
- promotions: nil,
1306
- terms_of_service: nil
1307
- )
1308
- @payment_method_reuse_agreement = payment_method_reuse_agreement
1309
- @promotions = promotions
1310
- @terms_of_service = terms_of_service
1311
- end
1312
- end
1313
-
1314
- class CustomField < Stripe::RequestParams
1315
- class Dropdown < Stripe::RequestParams
1316
- class Option < Stripe::RequestParams
1317
- # The label for the option, displayed to the customer. Up to 100 characters.
1318
- attr_accessor :label
1319
- # 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.
1320
- attr_accessor :value
1321
-
1322
- def initialize(label: nil, value: nil)
1323
- @label = label
1324
- @value = value
1325
- end
1326
- end
1327
- # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
1328
- attr_accessor :default_value
1329
- # The options available for the customer to select. Up to 200 options allowed.
1330
- attr_accessor :options
1331
-
1332
- def initialize(default_value: nil, options: nil)
1333
- @default_value = default_value
1334
- @options = options
1335
- end
1336
- end
1337
-
1338
- class Label < Stripe::RequestParams
1339
- # Custom text for the label, displayed to the customer. Up to 50 characters.
1340
- attr_accessor :custom
1341
- # The type of the label.
1342
- attr_accessor :type
1343
-
1344
- def initialize(custom: nil, type: nil)
1345
- @custom = custom
1346
- @type = type
1347
- end
1348
- end
1349
-
1350
- class Numeric < Stripe::RequestParams
1351
- # The value that will pre-fill the field on the payment page.
1352
- attr_accessor :default_value
1353
- # The maximum character length constraint for the customer's input.
1354
- attr_accessor :maximum_length
1355
- # The minimum character length requirement for the customer's input.
1356
- attr_accessor :minimum_length
1357
-
1358
- def initialize(default_value: nil, maximum_length: nil, minimum_length: nil)
1359
- @default_value = default_value
1360
- @maximum_length = maximum_length
1361
- @minimum_length = minimum_length
1362
- end
1363
- end
1364
-
1365
- class Text < Stripe::RequestParams
1366
- # The value that will pre-fill the field on the payment page.
1367
- attr_accessor :default_value
1368
- # The maximum character length constraint for the customer's input.
1369
- attr_accessor :maximum_length
1370
- # The minimum character length requirement for the customer's input.
1371
- attr_accessor :minimum_length
1372
-
1373
- def initialize(default_value: nil, maximum_length: nil, minimum_length: nil)
1374
- @default_value = default_value
1375
- @maximum_length = maximum_length
1376
- @minimum_length = minimum_length
1377
- end
1378
- end
1379
- # Configuration for `type=dropdown` fields.
1380
- attr_accessor :dropdown
1381
- # 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.
1382
- attr_accessor :key
1383
- # The label for the field, displayed to the customer.
1384
- attr_accessor :label
1385
- # Configuration for `type=numeric` fields.
1386
- attr_accessor :numeric
1387
- # Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
1388
- attr_accessor :optional
1389
- # Configuration for `type=text` fields.
1390
- attr_accessor :text
1391
- # The type of the field.
1392
- attr_accessor :type
1393
-
1394
- def initialize(
1395
- dropdown: nil,
1396
- key: nil,
1397
- label: nil,
1398
- numeric: nil,
1399
- optional: nil,
1400
- text: nil,
1401
- type: nil
1402
- )
1403
- @dropdown = dropdown
1404
- @key = key
1405
- @label = label
1406
- @numeric = numeric
1407
- @optional = optional
1408
- @text = text
1409
- @type = type
1410
- end
1411
- end
1412
-
1413
- class CustomText < Stripe::RequestParams
1414
- class AfterSubmit < Stripe::RequestParams
1415
- # Text may be up to 1200 characters in length.
1416
- attr_accessor :message
1417
-
1418
- def initialize(message: nil)
1419
- @message = message
1420
- end
1421
- end
1422
-
1423
- class ShippingAddress < Stripe::RequestParams
1424
- # Text may be up to 1200 characters in length.
1425
- attr_accessor :message
1426
-
1427
- def initialize(message: nil)
1428
- @message = message
1429
- end
1430
- end
1431
-
1432
- class Submit < Stripe::RequestParams
1433
- # Text may be up to 1200 characters in length.
1434
- attr_accessor :message
1435
-
1436
- def initialize(message: nil)
1437
- @message = message
1438
- end
1439
- end
1440
-
1441
- class TermsOfServiceAcceptance < Stripe::RequestParams
1442
- # Text may be up to 1200 characters in length.
1443
- attr_accessor :message
1444
-
1445
- def initialize(message: nil)
1446
- @message = message
1447
- end
1448
- end
1449
- # Custom text that should be displayed after the payment confirmation button.
1450
- attr_accessor :after_submit
1451
- # Custom text that should be displayed alongside shipping address collection.
1452
- attr_accessor :shipping_address
1453
- # Custom text that should be displayed alongside the payment confirmation button.
1454
- attr_accessor :submit
1455
- # Custom text that should be displayed in place of the default terms of service agreement text.
1456
- attr_accessor :terms_of_service_acceptance
1457
-
1458
- def initialize(
1459
- after_submit: nil,
1460
- shipping_address: nil,
1461
- submit: nil,
1462
- terms_of_service_acceptance: nil
1463
- )
1464
- @after_submit = after_submit
1465
- @shipping_address = shipping_address
1466
- @submit = submit
1467
- @terms_of_service_acceptance = terms_of_service_acceptance
1468
- end
1469
- end
1470
-
1471
- class CustomerUpdate < Stripe::RequestParams
1472
- # Describes whether Checkout saves the billing address onto `customer.address`.
1473
- # To always collect a full billing address, use `billing_address_collection`. Defaults to `never`.
1474
- attr_accessor :address
1475
- # Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.
1476
- attr_accessor :name
1477
- # Describes whether Checkout saves shipping information onto `customer.shipping`.
1478
- # To collect shipping information, use `shipping_address_collection`. Defaults to `never`.
1479
- attr_accessor :shipping
1480
-
1481
- def initialize(address: nil, name: nil, shipping: nil)
1482
- @address = address
1483
- @name = name
1484
- @shipping = shipping
1485
- end
1486
- end
1487
-
1488
- class Discount < Stripe::RequestParams
1489
- class CouponData < Stripe::RequestParams
1490
- # A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
1491
- attr_accessor :amount_off
1492
- # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
1493
- attr_accessor :currency
1494
- # Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
1495
- attr_accessor :duration
1496
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1497
- attr_accessor :metadata
1498
- # Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
1499
- attr_accessor :name
1500
- # 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).
1501
- attr_accessor :percent_off
1502
-
1503
- def initialize(
1504
- amount_off: nil,
1505
- currency: nil,
1506
- duration: nil,
1507
- metadata: nil,
1508
- name: nil,
1509
- percent_off: nil
1510
- )
1511
- @amount_off = amount_off
1512
- @currency = currency
1513
- @duration = duration
1514
- @metadata = metadata
1515
- @name = name
1516
- @percent_off = percent_off
1517
- end
1518
- end
1519
- # The ID of the coupon to apply to this Session.
1520
- attr_accessor :coupon
1521
- # Data used to generate a new [Coupon](https://stripe.com/docs/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
1522
- attr_accessor :coupon_data
1523
- # The ID of a promotion code to apply to this Session.
1524
- attr_accessor :promotion_code
1525
-
1526
- def initialize(coupon: nil, coupon_data: nil, promotion_code: nil)
1527
- @coupon = coupon
1528
- @coupon_data = coupon_data
1529
- @promotion_code = promotion_code
1530
- end
1531
- end
1532
-
1533
- class InvoiceCreation < Stripe::RequestParams
1534
- class InvoiceData < Stripe::RequestParams
1535
- class CustomField < Stripe::RequestParams
1536
- # The name of the custom field. This may be up to 40 characters.
1537
- attr_accessor :name
1538
- # The value of the custom field. This may be up to 140 characters.
1539
- attr_accessor :value
1540
-
1541
- def initialize(name: nil, value: nil)
1542
- @name = name
1543
- @value = value
1544
- end
1545
- end
1546
-
1547
- class Issuer < Stripe::RequestParams
1548
- # The connected account being referenced when `type` is `account`.
1549
- attr_accessor :account
1550
- # Type of the account referenced in the request.
1551
- attr_accessor :type
1552
-
1553
- def initialize(account: nil, type: nil)
1554
- @account = account
1555
- @type = type
1556
- end
1557
- end
1558
-
1559
- class RenderingOptions < Stripe::RequestParams
1560
- # 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.
1561
- attr_accessor :amount_tax_display
1562
- # ID of the invoice rendering template to use for this invoice.
1563
- attr_accessor :template
1564
-
1565
- def initialize(amount_tax_display: nil, template: nil)
1566
- @amount_tax_display = amount_tax_display
1567
- @template = template
1568
- end
1569
- end
1570
- # The account tax IDs associated with the invoice.
1571
- attr_accessor :account_tax_ids
1572
- # Default custom fields to be displayed on invoices for this customer.
1573
- attr_accessor :custom_fields
1574
- # An arbitrary string attached to the object. Often useful for displaying to users.
1575
- attr_accessor :description
1576
- # Default footer to be displayed on invoices for this customer.
1577
- attr_accessor :footer
1578
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1579
- attr_accessor :issuer
1580
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1581
- attr_accessor :metadata
1582
- # Default options for invoice PDF rendering for this customer.
1583
- attr_accessor :rendering_options
1584
-
1585
- def initialize(
1586
- account_tax_ids: nil,
1587
- custom_fields: nil,
1588
- description: nil,
1589
- footer: nil,
1590
- issuer: nil,
1591
- metadata: nil,
1592
- rendering_options: nil
1593
- )
1594
- @account_tax_ids = account_tax_ids
1595
- @custom_fields = custom_fields
1596
- @description = description
1597
- @footer = footer
1598
- @issuer = issuer
1599
- @metadata = metadata
1600
- @rendering_options = rendering_options
1601
- end
1602
- end
1603
- # Set to `true` to enable invoice creation.
1604
- attr_accessor :enabled
1605
- # Parameters passed when creating invoices for payment-mode Checkout Sessions.
1606
- attr_accessor :invoice_data
1607
-
1608
- def initialize(enabled: nil, invoice_data: nil)
1609
- @enabled = enabled
1610
- @invoice_data = invoice_data
1611
- end
1612
- end
1613
-
1614
- class LineItem < Stripe::RequestParams
1615
- class AdjustableQuantity < Stripe::RequestParams
1616
- # Set to true if the quantity can be adjusted to any non-negative integer.
1617
- attr_accessor :enabled
1618
- # 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.
1619
- attr_accessor :maximum
1620
- # The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
1621
- attr_accessor :minimum
1622
-
1623
- def initialize(enabled: nil, maximum: nil, minimum: nil)
1624
- @enabled = enabled
1625
- @maximum = maximum
1626
- @minimum = minimum
1627
- end
1628
- end
1629
-
1630
- class PriceData < Stripe::RequestParams
1631
- class ProductData < Stripe::RequestParams
1632
- # 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.
1633
- attr_accessor :description
1634
- # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
1635
- attr_accessor :images
1636
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1637
- attr_accessor :metadata
1638
- # The product's name, meant to be displayable to the customer.
1639
- attr_accessor :name
1640
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
1641
- attr_accessor :tax_code
1642
-
1643
- def initialize(description: nil, images: nil, metadata: nil, name: nil, tax_code: nil)
1644
- @description = description
1645
- @images = images
1646
- @metadata = metadata
1647
- @name = name
1648
- @tax_code = tax_code
1649
- end
1650
- end
1651
-
1652
- class Recurring < Stripe::RequestParams
1653
- # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
1654
- attr_accessor :interval
1655
- # 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).
1656
- attr_accessor :interval_count
1657
-
1658
- def initialize(interval: nil, interval_count: nil)
1659
- @interval = interval
1660
- @interval_count = interval_count
1661
- end
1662
- end
1663
- # 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).
1664
- attr_accessor :currency
1665
- # 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.
1666
- attr_accessor :product
1667
- # Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
1668
- attr_accessor :product_data
1669
- # The recurring components of a price such as `interval` and `interval_count`.
1670
- attr_accessor :recurring
1671
- # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
1672
- attr_accessor :tax_behavior
1673
- # A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
1674
- attr_accessor :unit_amount
1675
- # 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.
1676
- attr_accessor :unit_amount_decimal
1677
-
1678
- def initialize(
1679
- currency: nil,
1680
- product: nil,
1681
- product_data: nil,
1682
- recurring: nil,
1683
- tax_behavior: nil,
1684
- unit_amount: nil,
1685
- unit_amount_decimal: nil
1686
- )
1687
- @currency = currency
1688
- @product = product
1689
- @product_data = product_data
1690
- @recurring = recurring
1691
- @tax_behavior = tax_behavior
1692
- @unit_amount = unit_amount
1693
- @unit_amount_decimal = unit_amount_decimal
1694
- end
1695
- end
1696
- # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
1697
- attr_accessor :adjustable_quantity
1698
- # The [tax rates](https://stripe.com/docs/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.
1699
- attr_accessor :dynamic_tax_rates
1700
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1701
- attr_accessor :metadata
1702
- # The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.
1703
- attr_accessor :price
1704
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
1705
- attr_accessor :price_data
1706
- # The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
1707
- attr_accessor :quantity
1708
- # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
1709
- attr_accessor :tax_rates
1710
-
1711
- def initialize(
1712
- adjustable_quantity: nil,
1713
- dynamic_tax_rates: nil,
1714
- metadata: nil,
1715
- price: nil,
1716
- price_data: nil,
1717
- quantity: nil,
1718
- tax_rates: nil
1719
- )
1720
- @adjustable_quantity = adjustable_quantity
1721
- @dynamic_tax_rates = dynamic_tax_rates
1722
- @metadata = metadata
1723
- @price = price
1724
- @price_data = price_data
1725
- @quantity = quantity
1726
- @tax_rates = tax_rates
1727
- end
1728
- end
1729
-
1730
- class OptionalItem < Stripe::RequestParams
1731
- class AdjustableQuantity < Stripe::RequestParams
1732
- # Set to true if the quantity can be adjusted to any non-negative integer.
1733
- attr_accessor :enabled
1734
- # The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.
1735
- attr_accessor :maximum
1736
- # 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.
1737
- attr_accessor :minimum
1738
-
1739
- def initialize(enabled: nil, maximum: nil, minimum: nil)
1740
- @enabled = enabled
1741
- @maximum = maximum
1742
- @minimum = minimum
1743
- end
1744
- end
1745
- # 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.
1746
- attr_accessor :adjustable_quantity
1747
- # The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
1748
- attr_accessor :price
1749
- # The initial quantity of the line item created when a customer chooses to add this optional item to their order.
1750
- attr_accessor :quantity
1751
-
1752
- def initialize(adjustable_quantity: nil, price: nil, quantity: nil)
1753
- @adjustable_quantity = adjustable_quantity
1754
- @price = price
1755
- @quantity = quantity
1756
- end
1757
- end
1758
-
1759
- class PaymentIntentData < Stripe::RequestParams
1760
- class Shipping < Stripe::RequestParams
1761
- class Address < Stripe::RequestParams
1762
- # City, district, suburb, town, or village.
1763
- attr_accessor :city
1764
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1765
- attr_accessor :country
1766
- # Address line 1 (e.g., street, PO Box, or company name).
1767
- attr_accessor :line1
1768
- # Address line 2 (e.g., apartment, suite, unit, or building).
1769
- attr_accessor :line2
1770
- # ZIP or postal code.
1771
- attr_accessor :postal_code
1772
- # State, county, province, or region.
1773
- attr_accessor :state
1774
-
1775
- def initialize(
1776
- city: nil,
1777
- country: nil,
1778
- line1: nil,
1779
- line2: nil,
1780
- postal_code: nil,
1781
- state: nil
1782
- )
1783
- @city = city
1784
- @country = country
1785
- @line1 = line1
1786
- @line2 = line2
1787
- @postal_code = postal_code
1788
- @state = state
1789
- end
1790
- end
1791
- # Shipping address.
1792
- attr_accessor :address
1793
- # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1794
- attr_accessor :carrier
1795
- # Recipient name.
1796
- attr_accessor :name
1797
- # Recipient phone (including extension).
1798
- attr_accessor :phone
1799
- # 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.
1800
- attr_accessor :tracking_number
1801
-
1802
- def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil)
1803
- @address = address
1804
- @carrier = carrier
1805
- @name = name
1806
- @phone = phone
1807
- @tracking_number = tracking_number
1808
- end
1809
- end
1810
-
1811
- class TransferData < Stripe::RequestParams
1812
- # The amount that will be transferred automatically when a charge succeeds.
1813
- attr_accessor :amount
1814
- # If specified, successful charges will be attributed to the destination
1815
- # account for tax reporting, and the funds from charges will be transferred
1816
- # to the destination account. The ID of the resulting transfer will be
1817
- # returned on the successful charge's `transfer` field.
1818
- attr_accessor :destination
1819
-
1820
- def initialize(amount: nil, destination: nil)
1821
- @amount = amount
1822
- @destination = destination
1823
- end
1824
- end
1825
- # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
1826
- attr_accessor :application_fee_amount
1827
- # Controls when the funds will be captured from the customer's account.
1828
- attr_accessor :capture_method
1829
- # An arbitrary string attached to the object. Often useful for displaying to users.
1830
- attr_accessor :description
1831
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1832
- attr_accessor :metadata
1833
- # The Stripe account ID for which these funds are intended. For details,
1834
- # see the PaymentIntents [use case for connected
1835
- # accounts](/docs/payments/connected-accounts).
1836
- attr_accessor :on_behalf_of
1837
- # 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).
1838
- attr_accessor :receipt_email
1839
- # Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment
1840
- # method collected by this Checkout Session.
1841
- #
1842
- # When setting this to `on_session`, Checkout will show a notice to the
1843
- # customer that their payment details will be saved.
1844
- #
1845
- # When setting this to `off_session`, Checkout will show a notice to the
1846
- # customer that their payment details will be saved and used for future
1847
- # payments.
1848
- #
1849
- # If a Customer has been provided or Checkout creates a new Customer,
1850
- # Checkout will attach the payment method to the Customer.
1851
- #
1852
- # If Checkout does not create a Customer, the payment method is not attached
1853
- # to a Customer. To reuse the payment method, you can retrieve it from the
1854
- # Checkout Session's PaymentIntent.
1855
- #
1856
- # When processing card payments, Checkout also uses `setup_future_usage`
1857
- # to dynamically optimize your payment flow and comply with regional
1858
- # legislation and network rules, such as SCA.
1859
- attr_accessor :setup_future_usage
1860
- # Shipping information for this payment.
1861
- attr_accessor :shipping
1862
- # 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).
1863
- #
1864
- # 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.
1865
- attr_accessor :statement_descriptor
1866
- # 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.
1867
- attr_accessor :statement_descriptor_suffix
1868
- # The parameters used to automatically create a Transfer when the payment succeeds.
1869
- # For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
1870
- attr_accessor :transfer_data
1871
- # A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
1872
- attr_accessor :transfer_group
1873
-
1874
- def initialize(
1875
- application_fee_amount: nil,
1876
- capture_method: nil,
1877
- description: nil,
1878
- metadata: nil,
1879
- on_behalf_of: nil,
1880
- receipt_email: nil,
1881
- setup_future_usage: nil,
1882
- shipping: nil,
1883
- statement_descriptor: nil,
1884
- statement_descriptor_suffix: nil,
1885
- transfer_data: nil,
1886
- transfer_group: nil
1887
- )
1888
- @application_fee_amount = application_fee_amount
1889
- @capture_method = capture_method
1890
- @description = description
1891
- @metadata = metadata
1892
- @on_behalf_of = on_behalf_of
1893
- @receipt_email = receipt_email
1894
- @setup_future_usage = setup_future_usage
1895
- @shipping = shipping
1896
- @statement_descriptor = statement_descriptor
1897
- @statement_descriptor_suffix = statement_descriptor_suffix
1898
- @transfer_data = transfer_data
1899
- @transfer_group = transfer_group
1900
- end
1901
- end
1902
-
1903
- class PaymentMethodData < Stripe::RequestParams
1904
- # 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.
1905
- attr_accessor :allow_redisplay
1906
-
1907
- def initialize(allow_redisplay: nil)
1908
- @allow_redisplay = allow_redisplay
1909
- end
1910
- end
1911
-
1912
- class PaymentMethodOptions < Stripe::RequestParams
1913
- class AcssDebit < Stripe::RequestParams
1914
- class MandateOptions < Stripe::RequestParams
1915
- # A URL for custom mandate text to render during confirmation step.
1916
- # The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
1917
- # or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
1918
- attr_accessor :custom_mandate_url
1919
- # List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.
1920
- attr_accessor :default_for
1921
- # Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
1922
- attr_accessor :interval_description
1923
- # Payment schedule for the mandate.
1924
- attr_accessor :payment_schedule
1925
- # Transaction type of the mandate.
1926
- attr_accessor :transaction_type
1927
-
1928
- def initialize(
1929
- custom_mandate_url: nil,
1930
- default_for: nil,
1931
- interval_description: nil,
1932
- payment_schedule: nil,
1933
- transaction_type: nil
1934
- )
1935
- @custom_mandate_url = custom_mandate_url
1936
- @default_for = default_for
1937
- @interval_description = interval_description
1938
- @payment_schedule = payment_schedule
1939
- @transaction_type = transaction_type
1940
- end
1941
- end
1942
- # 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.
1943
- attr_accessor :currency
1944
- # Additional fields for Mandate creation
1945
- attr_accessor :mandate_options
1946
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1947
- #
1948
- # 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.
1949
- #
1950
- # 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.
1951
- #
1952
- # 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).
1953
- attr_accessor :setup_future_usage
1954
- # 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.
1955
- attr_accessor :target_date
1956
- # Verification method for the intent
1957
- attr_accessor :verification_method
1958
-
1959
- def initialize(
1960
- currency: nil,
1961
- mandate_options: nil,
1962
- setup_future_usage: nil,
1963
- target_date: nil,
1964
- verification_method: nil
1965
- )
1966
- @currency = currency
1967
- @mandate_options = mandate_options
1968
- @setup_future_usage = setup_future_usage
1969
- @target_date = target_date
1970
- @verification_method = verification_method
1971
- end
1972
- end
1973
-
1974
- class Affirm < Stripe::RequestParams
1975
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1976
- #
1977
- # 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.
1978
- #
1979
- # 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.
1980
- #
1981
- # 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).
1982
- attr_accessor :setup_future_usage
1983
-
1984
- def initialize(setup_future_usage: nil)
1985
- @setup_future_usage = setup_future_usage
1986
- end
1987
- end
1988
-
1989
- class AfterpayClearpay < Stripe::RequestParams
1990
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
1991
- #
1992
- # 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.
1993
- #
1994
- # 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.
1995
- #
1996
- # 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).
1997
- attr_accessor :setup_future_usage
1998
-
1999
- def initialize(setup_future_usage: nil)
2000
- @setup_future_usage = setup_future_usage
2001
- end
2002
- end
2003
-
2004
- class Alipay < Stripe::RequestParams
2005
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2006
- #
2007
- # 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.
2008
- #
2009
- # 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.
2010
- #
2011
- # 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).
2012
- attr_accessor :setup_future_usage
2013
-
2014
- def initialize(setup_future_usage: nil)
2015
- @setup_future_usage = setup_future_usage
2016
- end
2017
- end
2018
-
2019
- class AmazonPay < Stripe::RequestParams
2020
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2021
- #
2022
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
2023
- #
2024
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
2025
- #
2026
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
2027
- attr_accessor :setup_future_usage
2028
-
2029
- def initialize(setup_future_usage: nil)
2030
- @setup_future_usage = setup_future_usage
2031
- end
2032
- end
2033
-
2034
- class AuBecsDebit < Stripe::RequestParams
2035
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2036
- #
2037
- # 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.
2038
- #
2039
- # 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.
2040
- #
2041
- # 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).
2042
- attr_accessor :setup_future_usage
2043
- # 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.
2044
- attr_accessor :target_date
2045
-
2046
- def initialize(setup_future_usage: nil, target_date: nil)
2047
- @setup_future_usage = setup_future_usage
2048
- @target_date = target_date
2049
- end
2050
- end
2051
-
2052
- class BacsDebit < Stripe::RequestParams
2053
- class MandateOptions < Stripe::RequestParams
2054
- # 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'.
2055
- attr_accessor :reference_prefix
2056
-
2057
- def initialize(reference_prefix: nil)
2058
- @reference_prefix = reference_prefix
2059
- end
2060
- end
2061
- # Additional fields for Mandate creation
2062
- attr_accessor :mandate_options
2063
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2064
- #
2065
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
2066
- #
2067
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
2068
- #
2069
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
2070
- attr_accessor :setup_future_usage
2071
- # 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.
2072
- attr_accessor :target_date
2073
-
2074
- def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil)
2075
- @mandate_options = mandate_options
2076
- @setup_future_usage = setup_future_usage
2077
- @target_date = target_date
2078
- end
2079
- end
2080
-
2081
- class Bancontact < Stripe::RequestParams
2082
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2083
- #
2084
- # 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.
2085
- #
2086
- # 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.
2087
- #
2088
- # 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).
2089
- attr_accessor :setup_future_usage
2090
-
2091
- def initialize(setup_future_usage: nil)
2092
- @setup_future_usage = setup_future_usage
2093
- end
2094
- end
2095
-
2096
- class Boleto < Stripe::RequestParams
2097
- # 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.
2098
- attr_accessor :expires_after_days
2099
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2100
- #
2101
- # 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.
2102
- #
2103
- # 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.
2104
- #
2105
- # 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).
2106
- attr_accessor :setup_future_usage
2107
-
2108
- def initialize(expires_after_days: nil, setup_future_usage: nil)
2109
- @expires_after_days = expires_after_days
2110
- @setup_future_usage = setup_future_usage
2111
- end
2112
- end
2113
-
2114
- class Card < Stripe::RequestParams
2115
- class Installments < Stripe::RequestParams
2116
- # Setting to true enables installments for this Checkout Session.
2117
- # Setting to false will prevent any installment plan from applying to a payment.
2118
- attr_accessor :enabled
2119
-
2120
- def initialize(enabled: nil)
2121
- @enabled = enabled
2122
- end
2123
- end
2124
-
2125
- class Restrictions < Stripe::RequestParams
2126
- # 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.
2127
- attr_accessor :brands_blocked
2128
-
2129
- def initialize(brands_blocked: nil)
2130
- @brands_blocked = brands_blocked
2131
- end
2132
- end
2133
- # Installment options for card payments
2134
- attr_accessor :installments
2135
- # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
2136
- attr_accessor :request_decremental_authorization
2137
- # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
2138
- attr_accessor :request_extended_authorization
2139
- # Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
2140
- attr_accessor :request_incremental_authorization
2141
- # Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
2142
- attr_accessor :request_multicapture
2143
- # Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
2144
- attr_accessor :request_overcapture
2145
- # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
2146
- attr_accessor :request_three_d_secure
2147
- # Restrictions to apply to the card payment method. For example, you can block specific card brands.
2148
- attr_accessor :restrictions
2149
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2150
- #
2151
- # 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.
2152
- #
2153
- # 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.
2154
- #
2155
- # 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).
2156
- attr_accessor :setup_future_usage
2157
- # 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.
2158
- attr_accessor :statement_descriptor_suffix_kana
2159
- # 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.
2160
- attr_accessor :statement_descriptor_suffix_kanji
2161
-
2162
- def initialize(
2163
- installments: nil,
2164
- request_decremental_authorization: nil,
2165
- request_extended_authorization: nil,
2166
- request_incremental_authorization: nil,
2167
- request_multicapture: nil,
2168
- request_overcapture: nil,
2169
- request_three_d_secure: nil,
2170
- restrictions: nil,
2171
- setup_future_usage: nil,
2172
- statement_descriptor_suffix_kana: nil,
2173
- statement_descriptor_suffix_kanji: nil
2174
- )
2175
- @installments = installments
2176
- @request_decremental_authorization = request_decremental_authorization
2177
- @request_extended_authorization = request_extended_authorization
2178
- @request_incremental_authorization = request_incremental_authorization
2179
- @request_multicapture = request_multicapture
2180
- @request_overcapture = request_overcapture
2181
- @request_three_d_secure = request_three_d_secure
2182
- @restrictions = restrictions
2183
- @setup_future_usage = setup_future_usage
2184
- @statement_descriptor_suffix_kana = statement_descriptor_suffix_kana
2185
- @statement_descriptor_suffix_kanji = statement_descriptor_suffix_kanji
2186
- end
2187
- end
2188
-
2189
- class Cashapp < Stripe::RequestParams
2190
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2191
- #
2192
- # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
2193
- #
2194
- # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
2195
- #
2196
- # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
2197
- attr_accessor :setup_future_usage
2198
-
2199
- def initialize(setup_future_usage: nil)
2200
- @setup_future_usage = setup_future_usage
2201
- end
2202
- end
2203
-
2204
- class CustomerBalance < Stripe::RequestParams
2205
- class BankTransfer < Stripe::RequestParams
2206
- class EuBankTransfer < Stripe::RequestParams
2207
- # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
2208
- attr_accessor :country
2209
-
2210
- def initialize(country: nil)
2211
- @country = country
2212
- end
2213
- end
2214
- # Configuration for eu_bank_transfer funding type.
2215
- attr_accessor :eu_bank_transfer
2216
- # List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
2217
- #
2218
- # Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
2219
- attr_accessor :requested_address_types
2220
- # The list of bank transfer types that this PaymentIntent is allowed to use for funding.
2221
- attr_accessor :type
2222
-
2223
- def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil)
2224
- @eu_bank_transfer = eu_bank_transfer
2225
- @requested_address_types = requested_address_types
2226
- @type = type
2227
- end
2228
- end
2229
- # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
2230
- attr_accessor :bank_transfer
2231
- # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
2232
- attr_accessor :funding_type
2233
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2234
- #
2235
- # 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.
2236
- #
2237
- # 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.
2238
- #
2239
- # 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).
2240
- attr_accessor :setup_future_usage
2241
-
2242
- def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil)
2243
- @bank_transfer = bank_transfer
2244
- @funding_type = funding_type
2245
- @setup_future_usage = setup_future_usage
2246
- end
2247
- end
2248
-
2249
- class Eps < Stripe::RequestParams
2250
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2251
- #
2252
- # 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.
2253
- #
2254
- # 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.
2255
- #
2256
- # 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).
2257
- attr_accessor :setup_future_usage
2258
-
2259
- def initialize(setup_future_usage: nil)
2260
- @setup_future_usage = setup_future_usage
2261
- end
2262
- end
2263
-
2264
- class Fpx < Stripe::RequestParams
2265
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2266
- #
2267
- # 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.
2268
- #
2269
- # 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.
2270
- #
2271
- # 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).
2272
- attr_accessor :setup_future_usage
2273
-
2274
- def initialize(setup_future_usage: nil)
2275
- @setup_future_usage = setup_future_usage
2276
- end
2277
- end
2278
-
2279
- class Giropay < Stripe::RequestParams
2280
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2281
- #
2282
- # 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.
2283
- #
2284
- # 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.
2285
- #
2286
- # 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).
2287
- attr_accessor :setup_future_usage
2288
-
2289
- def initialize(setup_future_usage: nil)
2290
- @setup_future_usage = setup_future_usage
2291
- end
2292
- end
2293
-
2294
- class Grabpay < Stripe::RequestParams
2295
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2296
- #
2297
- # 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.
2298
- #
2299
- # 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.
2300
- #
2301
- # 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).
2302
- attr_accessor :setup_future_usage
2303
-
2304
- def initialize(setup_future_usage: nil)
2305
- @setup_future_usage = setup_future_usage
2306
- end
2307
- end
2308
-
2309
- class Ideal < Stripe::RequestParams
2310
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2311
- #
2312
- # 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.
2313
- #
2314
- # 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.
2315
- #
2316
- # 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).
2317
- attr_accessor :setup_future_usage
2318
-
2319
- def initialize(setup_future_usage: nil)
2320
- @setup_future_usage = setup_future_usage
2321
- end
2322
- end
2323
-
2324
- class KakaoPay < Stripe::RequestParams
2325
- # Controls when the funds will be captured from the customer's account.
2326
- attr_accessor :capture_method
2327
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2328
- #
2329
- # 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.
2330
- #
2331
- # 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.
2332
- #
2333
- # 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).
2334
- attr_accessor :setup_future_usage
2335
-
2336
- def initialize(capture_method: nil, setup_future_usage: nil)
2337
- @capture_method = capture_method
2338
- @setup_future_usage = setup_future_usage
2339
- end
2340
- end
2341
-
2342
- class Klarna < Stripe::RequestParams
2343
- class Subscription < Stripe::RequestParams
2344
- class NextBilling < Stripe::RequestParams
2345
- # The amount of the next charge for the subscription.
2346
- attr_accessor :amount
2347
- # The date of the next charge for the subscription in YYYY-MM-DD format.
2348
- attr_accessor :date
2349
-
2350
- def initialize(amount: nil, date: nil)
2351
- @amount = amount
2352
- @date = date
2353
- end
2354
- end
2355
- # Unit of time between subscription charges.
2356
- attr_accessor :interval
2357
- # The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
2358
- attr_accessor :interval_count
2359
- # Name for subscription.
2360
- attr_accessor :name
2361
- # Describes the upcoming charge for this subscription.
2362
- attr_accessor :next_billing
2363
- # A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
2364
- attr_accessor :reference
2365
-
2366
- def initialize(
2367
- interval: nil,
2368
- interval_count: nil,
2369
- name: nil,
2370
- next_billing: nil,
2371
- reference: nil
2372
- )
2373
- @interval = interval
2374
- @interval_count = interval_count
2375
- @name = name
2376
- @next_billing = next_billing
2377
- @reference = reference
2378
- end
2379
- end
2380
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2381
- #
2382
- # 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.
2383
- #
2384
- # 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.
2385
- #
2386
- # 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).
2387
- attr_accessor :setup_future_usage
2388
- # Subscription details if the Checkout Session sets up a future subscription.
2389
- attr_accessor :subscriptions
2390
-
2391
- def initialize(setup_future_usage: nil, subscriptions: nil)
2392
- @setup_future_usage = setup_future_usage
2393
- @subscriptions = subscriptions
2394
- end
2395
- end
2396
-
2397
- class Konbini < Stripe::RequestParams
2398
- # 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.
2399
- attr_accessor :expires_after_days
2400
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2401
- #
2402
- # 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.
2403
- #
2404
- # 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.
2405
- #
2406
- # 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).
2407
- attr_accessor :setup_future_usage
2408
-
2409
- def initialize(expires_after_days: nil, setup_future_usage: nil)
2410
- @expires_after_days = expires_after_days
2411
- @setup_future_usage = setup_future_usage
2412
- end
2413
- end
2414
-
2415
- class KrCard < Stripe::RequestParams
2416
- # Controls when the funds will be captured from the customer's account.
2417
- attr_accessor :capture_method
2418
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2419
- #
2420
- # 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.
2421
- #
2422
- # 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.
2423
- #
2424
- # 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).
2425
- attr_accessor :setup_future_usage
2426
-
2427
- def initialize(capture_method: nil, setup_future_usage: nil)
2428
- @capture_method = capture_method
2429
- @setup_future_usage = setup_future_usage
2430
- end
2431
- end
2432
-
2433
- class Link < Stripe::RequestParams
2434
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2435
- #
2436
- # 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.
2437
- #
2438
- # 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.
2439
- #
2440
- # 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).
2441
- attr_accessor :setup_future_usage
2442
-
2443
- def initialize(setup_future_usage: nil)
2444
- @setup_future_usage = setup_future_usage
2445
- end
2446
- end
2447
-
2448
- class Mobilepay < Stripe::RequestParams
2449
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2450
- #
2451
- # 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.
2452
- #
2453
- # 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.
2454
- #
2455
- # 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).
2456
- attr_accessor :setup_future_usage
2457
-
2458
- def initialize(setup_future_usage: nil)
2459
- @setup_future_usage = setup_future_usage
2460
- end
2461
- end
2462
-
2463
- class Multibanco < Stripe::RequestParams
2464
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2465
- #
2466
- # 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.
2467
- #
2468
- # 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.
2469
- #
2470
- # 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).
2471
- attr_accessor :setup_future_usage
2472
-
2473
- def initialize(setup_future_usage: nil)
2474
- @setup_future_usage = setup_future_usage
2475
- end
2476
- end
2477
-
2478
- class NaverPay < Stripe::RequestParams
2479
- # Controls when the funds will be captured from the customer's account.
2480
- attr_accessor :capture_method
2481
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2482
- #
2483
- # 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.
2484
- #
2485
- # 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.
2486
- #
2487
- # 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).
2488
- attr_accessor :setup_future_usage
2489
-
2490
- def initialize(capture_method: nil, setup_future_usage: nil)
2491
- @capture_method = capture_method
2492
- @setup_future_usage = setup_future_usage
2493
- end
2494
- end
2495
-
2496
- class Oxxo < Stripe::RequestParams
2497
- # 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.
2498
- attr_accessor :expires_after_days
2499
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2500
- #
2501
- # 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.
2502
- #
2503
- # 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.
2504
- #
2505
- # 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).
2506
- attr_accessor :setup_future_usage
2507
-
2508
- def initialize(expires_after_days: nil, setup_future_usage: nil)
2509
- @expires_after_days = expires_after_days
2510
- @setup_future_usage = setup_future_usage
2511
- end
2512
- end
2513
-
2514
- class P24 < Stripe::RequestParams
2515
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2516
- #
2517
- # 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.
2518
- #
2519
- # 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.
2520
- #
2521
- # 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).
2522
- attr_accessor :setup_future_usage
2523
- # Confirm that the payer has accepted the P24 terms and conditions.
2524
- attr_accessor :tos_shown_and_accepted
2525
-
2526
- def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil)
2527
- @setup_future_usage = setup_future_usage
2528
- @tos_shown_and_accepted = tos_shown_and_accepted
2529
- end
2530
- end
2531
-
2532
- class PayByBank < Stripe::RequestParams; end
2533
-
2534
- class Payco < Stripe::RequestParams
2535
- # Controls when the funds will be captured from the customer's account.
2536
- attr_accessor :capture_method
2537
-
2538
- def initialize(capture_method: nil)
2539
- @capture_method = capture_method
2540
- end
2541
- end
2542
-
2543
- class Paynow < Stripe::RequestParams
2544
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2545
- #
2546
- # 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.
2547
- #
2548
- # 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.
2549
- #
2550
- # 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).
2551
- attr_accessor :setup_future_usage
2552
-
2553
- def initialize(setup_future_usage: nil)
2554
- @setup_future_usage = setup_future_usage
2555
- end
2556
- end
2557
-
2558
- class Paypal < Stripe::RequestParams
2559
- # Controls when the funds will be captured from the customer's account.
2560
- attr_accessor :capture_method
2561
- # [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
2562
- attr_accessor :preferred_locale
2563
- # 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.
2564
- attr_accessor :reference
2565
- # 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.
2566
- attr_accessor :reference_id
2567
- # The risk correlation ID for an on-session payment using a saved PayPal payment method.
2568
- attr_accessor :risk_correlation_id
2569
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2570
- #
2571
- # 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.
2572
- #
2573
- # 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.
2574
- #
2575
- # 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).
2576
- #
2577
- # 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`.
2578
- attr_accessor :setup_future_usage
2579
- # 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.
2580
- attr_accessor :subsellers
2581
-
2582
- def initialize(
2583
- capture_method: nil,
2584
- preferred_locale: nil,
2585
- reference: nil,
2586
- reference_id: nil,
2587
- risk_correlation_id: nil,
2588
- setup_future_usage: nil,
2589
- subsellers: nil
2590
- )
2591
- @capture_method = capture_method
2592
- @preferred_locale = preferred_locale
2593
- @reference = reference
2594
- @reference_id = reference_id
2595
- @risk_correlation_id = risk_correlation_id
2596
- @setup_future_usage = setup_future_usage
2597
- @subsellers = subsellers
2598
- end
2599
- end
2600
-
2601
- class Payto < Stripe::RequestParams
2602
- class MandateOptions < Stripe::RequestParams
2603
- # Amount that will be collected. It is required when `amount_type` is `fixed`.
2604
- attr_accessor :amount
2605
- # 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.
2606
- attr_accessor :amount_type
2607
- # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
2608
- attr_accessor :end_date
2609
- # The periodicity at which payments will be collected.
2610
- attr_accessor :payment_schedule
2611
- # 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.
2612
- attr_accessor :payments_per_period
2613
- # The purpose for which payments are made. Defaults to retail.
2614
- attr_accessor :purpose
2615
- # Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
2616
- attr_accessor :start_date
2617
-
2618
- def initialize(
2619
- amount: nil,
2620
- amount_type: nil,
2621
- end_date: nil,
2622
- payment_schedule: nil,
2623
- payments_per_period: nil,
2624
- purpose: nil,
2625
- start_date: nil
2626
- )
2627
- @amount = amount
2628
- @amount_type = amount_type
2629
- @end_date = end_date
2630
- @payment_schedule = payment_schedule
2631
- @payments_per_period = payments_per_period
2632
- @purpose = purpose
2633
- @start_date = start_date
2634
- end
2635
- end
2636
- # Additional fields for Mandate creation
2637
- attr_accessor :mandate_options
2638
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2639
- #
2640
- # 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.
2641
- #
2642
- # 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.
2643
- #
2644
- # 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).
2645
- attr_accessor :setup_future_usage
2646
-
2647
- def initialize(mandate_options: nil, setup_future_usage: nil)
2648
- @mandate_options = mandate_options
2649
- @setup_future_usage = setup_future_usage
2650
- end
2651
- end
2652
-
2653
- class Pix < Stripe::RequestParams
2654
- class MandateOptions < Stripe::RequestParams
2655
- # Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
2656
- attr_accessor :amount
2657
- # Determines if the amount includes the IOF tax. Defaults to `never`.
2658
- attr_accessor :amount_includes_iof
2659
- # Type of amount. Defaults to `maximum`.
2660
- attr_accessor :amount_type
2661
- # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
2662
- attr_accessor :currency
2663
- # 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.
2664
- attr_accessor :end_date
2665
- # Schedule at which the future payments will be charged. Defaults to `weekly`.
2666
- attr_accessor :payment_schedule
2667
- # Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
2668
- attr_accessor :reference
2669
- # 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.
2670
- attr_accessor :start_date
2671
-
2672
- def initialize(
2673
- amount: nil,
2674
- amount_includes_iof: nil,
2675
- amount_type: nil,
2676
- currency: nil,
2677
- end_date: nil,
2678
- payment_schedule: nil,
2679
- reference: nil,
2680
- start_date: nil
2681
- )
2682
- @amount = amount
2683
- @amount_includes_iof = amount_includes_iof
2684
- @amount_type = amount_type
2685
- @currency = currency
2686
- @end_date = end_date
2687
- @payment_schedule = payment_schedule
2688
- @reference = reference
2689
- @start_date = start_date
2690
- end
2691
- end
2692
- # Determines if the amount includes the IOF tax. Defaults to `never`.
2693
- attr_accessor :amount_includes_iof
2694
- # The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
2695
- attr_accessor :expires_after_seconds
2696
- # Additional fields for mandate creation.
2697
- attr_accessor :mandate_options
2698
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2699
- #
2700
- # 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.
2701
- #
2702
- # 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.
2703
- #
2704
- # 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).
2705
- attr_accessor :setup_future_usage
2706
-
2707
- def initialize(
2708
- amount_includes_iof: nil,
2709
- expires_after_seconds: nil,
2710
- mandate_options: nil,
2711
- setup_future_usage: nil
2712
- )
2713
- @amount_includes_iof = amount_includes_iof
2714
- @expires_after_seconds = expires_after_seconds
2715
- @mandate_options = mandate_options
2716
- @setup_future_usage = setup_future_usage
2717
- end
2718
- end
2719
-
2720
- class RevolutPay < Stripe::RequestParams
2721
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2722
- #
2723
- # 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.
2724
- #
2725
- # 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.
2726
- #
2727
- # 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).
2728
- attr_accessor :setup_future_usage
2729
-
2730
- def initialize(setup_future_usage: nil)
2731
- @setup_future_usage = setup_future_usage
2732
- end
2733
- end
2734
-
2735
- class SamsungPay < Stripe::RequestParams
2736
- # Controls when the funds will be captured from the customer's account.
2737
- attr_accessor :capture_method
2738
-
2739
- def initialize(capture_method: nil)
2740
- @capture_method = capture_method
2741
- end
2742
- end
2743
-
2744
- class SepaDebit < Stripe::RequestParams
2745
- class MandateOptions < Stripe::RequestParams
2746
- # 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'.
2747
- attr_accessor :reference_prefix
2748
-
2749
- def initialize(reference_prefix: nil)
2750
- @reference_prefix = reference_prefix
2751
- end
2752
- end
2753
- # Additional fields for Mandate creation
2754
- attr_accessor :mandate_options
2755
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2756
- #
2757
- # 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.
2758
- #
2759
- # 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.
2760
- #
2761
- # 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).
2762
- attr_accessor :setup_future_usage
2763
- # 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.
2764
- attr_accessor :target_date
2765
-
2766
- def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil)
2767
- @mandate_options = mandate_options
2768
- @setup_future_usage = setup_future_usage
2769
- @target_date = target_date
2770
- end
2771
- end
2772
-
2773
- class Sofort < Stripe::RequestParams
2774
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2775
- #
2776
- # 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.
2777
- #
2778
- # 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.
2779
- #
2780
- # 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).
2781
- attr_accessor :setup_future_usage
2782
-
2783
- def initialize(setup_future_usage: nil)
2784
- @setup_future_usage = setup_future_usage
2785
- end
2786
- end
2787
-
2788
- class Swish < Stripe::RequestParams
2789
- # The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
2790
- attr_accessor :reference
2791
-
2792
- def initialize(reference: nil)
2793
- @reference = reference
2794
- end
2795
- end
2796
-
2797
- class UsBankAccount < Stripe::RequestParams
2798
- class FinancialConnections < Stripe::RequestParams
2799
- # 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`.
2800
- attr_accessor :permissions
2801
- # List of data features that you would like to retrieve upon account creation.
2802
- attr_accessor :prefetch
2803
-
2804
- def initialize(permissions: nil, prefetch: nil)
2805
- @permissions = permissions
2806
- @prefetch = prefetch
2807
- end
2808
- end
2809
- # Additional fields for Financial Connections Session creation
2810
- attr_accessor :financial_connections
2811
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2812
- #
2813
- # 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.
2814
- #
2815
- # 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.
2816
- #
2817
- # 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).
2818
- attr_accessor :setup_future_usage
2819
- # 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.
2820
- attr_accessor :target_date
2821
- # Verification method for the intent
2822
- attr_accessor :verification_method
2823
-
2824
- def initialize(
2825
- financial_connections: nil,
2826
- setup_future_usage: nil,
2827
- target_date: nil,
2828
- verification_method: nil
2829
- )
2830
- @financial_connections = financial_connections
2831
- @setup_future_usage = setup_future_usage
2832
- @target_date = target_date
2833
- @verification_method = verification_method
2834
- end
2835
- end
2836
-
2837
- class WechatPay < Stripe::RequestParams
2838
- # The app ID registered with WeChat Pay. Only required when client is ios or android.
2839
- attr_accessor :app_id
2840
- # The client type that the end customer will pay from
2841
- attr_accessor :client
2842
- # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2843
- #
2844
- # 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.
2845
- #
2846
- # 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.
2847
- #
2848
- # 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).
2849
- attr_accessor :setup_future_usage
2850
-
2851
- def initialize(app_id: nil, client: nil, setup_future_usage: nil)
2852
- @app_id = app_id
2853
- @client = client
2854
- @setup_future_usage = setup_future_usage
2855
- end
2856
- end
2857
- # contains details about the ACSS Debit payment method options.
2858
- attr_accessor :acss_debit
2859
- # contains details about the Affirm payment method options.
2860
- attr_accessor :affirm
2861
- # contains details about the Afterpay Clearpay payment method options.
2862
- attr_accessor :afterpay_clearpay
2863
- # contains details about the Alipay payment method options.
2864
- attr_accessor :alipay
2865
- # contains details about the AmazonPay payment method options.
2866
- attr_accessor :amazon_pay
2867
- # contains details about the AU Becs Debit payment method options.
2868
- attr_accessor :au_becs_debit
2869
- # contains details about the Bacs Debit payment method options.
2870
- attr_accessor :bacs_debit
2871
- # contains details about the Bancontact payment method options.
2872
- attr_accessor :bancontact
2873
- # contains details about the Boleto payment method options.
2874
- attr_accessor :boleto
2875
- # contains details about the Card payment method options.
2876
- attr_accessor :card
2877
- # contains details about the Cashapp Pay payment method options.
2878
- attr_accessor :cashapp
2879
- # contains details about the Customer Balance payment method options.
2880
- attr_accessor :customer_balance
2881
- # contains details about the EPS payment method options.
2882
- attr_accessor :eps
2883
- # contains details about the FPX payment method options.
2884
- attr_accessor :fpx
2885
- # contains details about the Giropay payment method options.
2886
- attr_accessor :giropay
2887
- # contains details about the Grabpay payment method options.
2888
- attr_accessor :grabpay
2889
- # contains details about the Ideal payment method options.
2890
- attr_accessor :ideal
2891
- # contains details about the Kakao Pay payment method options.
2892
- attr_accessor :kakao_pay
2893
- # contains details about the Klarna payment method options.
2894
- attr_accessor :klarna
2895
- # contains details about the Konbini payment method options.
2896
- attr_accessor :konbini
2897
- # contains details about the Korean card payment method options.
2898
- attr_accessor :kr_card
2899
- # contains details about the Link payment method options.
2900
- attr_accessor :link
2901
- # contains details about the Mobilepay payment method options.
2902
- attr_accessor :mobilepay
2903
- # contains details about the Multibanco payment method options.
2904
- attr_accessor :multibanco
2905
- # contains details about the Naver Pay payment method options.
2906
- attr_accessor :naver_pay
2907
- # contains details about the OXXO payment method options.
2908
- attr_accessor :oxxo
2909
- # contains details about the P24 payment method options.
2910
- attr_accessor :p24
2911
- # contains details about the Pay By Bank payment method options.
2912
- attr_accessor :pay_by_bank
2913
- # contains details about the PAYCO payment method options.
2914
- attr_accessor :payco
2915
- # contains details about the PayNow payment method options.
2916
- attr_accessor :paynow
2917
- # contains details about the PayPal payment method options.
2918
- attr_accessor :paypal
2919
- # contains details about the PayTo payment method options.
2920
- attr_accessor :payto
2921
- # contains details about the Pix payment method options.
2922
- attr_accessor :pix
2923
- # contains details about the RevolutPay payment method options.
2924
- attr_accessor :revolut_pay
2925
- # contains details about the Samsung Pay payment method options.
2926
- attr_accessor :samsung_pay
2927
- # contains details about the Sepa Debit payment method options.
2928
- attr_accessor :sepa_debit
2929
- # contains details about the Sofort payment method options.
2930
- attr_accessor :sofort
2931
- # contains details about the Swish payment method options.
2932
- attr_accessor :swish
2933
- # contains details about the Us Bank Account payment method options.
2934
- attr_accessor :us_bank_account
2935
- # contains details about the WeChat Pay payment method options.
2936
- attr_accessor :wechat_pay
2937
-
2938
- def initialize(
2939
- acss_debit: nil,
2940
- affirm: nil,
2941
- afterpay_clearpay: nil,
2942
- alipay: nil,
2943
- amazon_pay: nil,
2944
- au_becs_debit: nil,
2945
- bacs_debit: nil,
2946
- bancontact: nil,
2947
- boleto: nil,
2948
- card: nil,
2949
- cashapp: nil,
2950
- customer_balance: nil,
2951
- eps: nil,
2952
- fpx: nil,
2953
- giropay: nil,
2954
- grabpay: nil,
2955
- ideal: nil,
2956
- kakao_pay: nil,
2957
- klarna: nil,
2958
- konbini: nil,
2959
- kr_card: nil,
2960
- link: nil,
2961
- mobilepay: nil,
2962
- multibanco: nil,
2963
- naver_pay: nil,
2964
- oxxo: nil,
2965
- p24: nil,
2966
- pay_by_bank: nil,
2967
- payco: nil,
2968
- paynow: nil,
2969
- paypal: nil,
2970
- payto: nil,
2971
- pix: nil,
2972
- revolut_pay: nil,
2973
- samsung_pay: nil,
2974
- sepa_debit: nil,
2975
- sofort: nil,
2976
- swish: nil,
2977
- us_bank_account: nil,
2978
- wechat_pay: nil
2979
- )
2980
- @acss_debit = acss_debit
2981
- @affirm = affirm
2982
- @afterpay_clearpay = afterpay_clearpay
2983
- @alipay = alipay
2984
- @amazon_pay = amazon_pay
2985
- @au_becs_debit = au_becs_debit
2986
- @bacs_debit = bacs_debit
2987
- @bancontact = bancontact
2988
- @boleto = boleto
2989
- @card = card
2990
- @cashapp = cashapp
2991
- @customer_balance = customer_balance
2992
- @eps = eps
2993
- @fpx = fpx
2994
- @giropay = giropay
2995
- @grabpay = grabpay
2996
- @ideal = ideal
2997
- @kakao_pay = kakao_pay
2998
- @klarna = klarna
2999
- @konbini = konbini
3000
- @kr_card = kr_card
3001
- @link = link
3002
- @mobilepay = mobilepay
3003
- @multibanco = multibanco
3004
- @naver_pay = naver_pay
3005
- @oxxo = oxxo
3006
- @p24 = p24
3007
- @pay_by_bank = pay_by_bank
3008
- @payco = payco
3009
- @paynow = paynow
3010
- @paypal = paypal
3011
- @payto = payto
3012
- @pix = pix
3013
- @revolut_pay = revolut_pay
3014
- @samsung_pay = samsung_pay
3015
- @sepa_debit = sepa_debit
3016
- @sofort = sofort
3017
- @swish = swish
3018
- @us_bank_account = us_bank_account
3019
- @wechat_pay = wechat_pay
3020
- end
3021
- end
3022
-
3023
- class Permissions < Stripe::RequestParams
3024
- class Update < Stripe::RequestParams
3025
- # Determines which entity is allowed to update the line items.
3026
- #
3027
- # 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.
3028
- #
3029
- # 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.
3030
- attr_accessor :line_items
3031
- # Determines which entity is allowed to update the shipping details.
3032
- #
3033
- # 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.
3034
- #
3035
- # 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.
3036
- attr_accessor :shipping_details
3037
-
3038
- def initialize(line_items: nil, shipping_details: nil)
3039
- @line_items = line_items
3040
- @shipping_details = shipping_details
3041
- end
3042
- end
3043
- # Permissions for updating the Checkout Session.
3044
- attr_accessor :update
3045
- # Determines which entity is allowed to update the discounts (coupons or promotion codes) that apply to this session.
3046
- #
3047
- # 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.
3048
- attr_accessor :update_discounts
3049
- # Determines which entity is allowed to update the line items.
3050
- #
3051
- # 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.
3052
- #
3053
- # 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.
3054
- attr_accessor :update_line_items
3055
- # Determines which entity is allowed to update the shipping details.
3056
- #
3057
- # 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.
3058
- #
3059
- # 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.
3060
- attr_accessor :update_shipping_details
3061
-
3062
- def initialize(
3063
- update: nil,
3064
- update_discounts: nil,
3065
- update_line_items: nil,
3066
- update_shipping_details: nil
3067
- )
3068
- @update = update
3069
- @update_discounts = update_discounts
3070
- @update_line_items = update_line_items
3071
- @update_shipping_details = update_shipping_details
3072
- end
3073
- end
3074
-
3075
- class PhoneNumberCollection < Stripe::RequestParams
3076
- # Set to `true` to enable phone number collection.
3077
- #
3078
- # Can only be set in `payment` and `subscription` mode.
3079
- attr_accessor :enabled
3080
-
3081
- def initialize(enabled: nil)
3082
- @enabled = enabled
3083
- end
3084
- end
3085
-
3086
- class SavedPaymentMethodOptions < Stripe::RequestParams
3087
- # 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.
3088
- attr_accessor :allow_redisplay_filters
3089
- # Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
3090
- attr_accessor :payment_method_remove
3091
- # Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
3092
- attr_accessor :payment_method_save
3093
-
3094
- def initialize(
3095
- allow_redisplay_filters: nil,
3096
- payment_method_remove: nil,
3097
- payment_method_save: nil
3098
- )
3099
- @allow_redisplay_filters = allow_redisplay_filters
3100
- @payment_method_remove = payment_method_remove
3101
- @payment_method_save = payment_method_save
3102
- end
3103
- end
3104
-
3105
- class SetupIntentData < Stripe::RequestParams
3106
- # An arbitrary string attached to the object. Often useful for displaying to users.
3107
- attr_accessor :description
3108
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
3109
- attr_accessor :metadata
3110
- # The Stripe account for which the setup is intended.
3111
- attr_accessor :on_behalf_of
3112
-
3113
- def initialize(description: nil, metadata: nil, on_behalf_of: nil)
3114
- @description = description
3115
- @metadata = metadata
3116
- @on_behalf_of = on_behalf_of
3117
- end
3118
- end
3119
-
3120
- class ShippingAddressCollection < Stripe::RequestParams
3121
- # An array of two-letter ISO country codes representing which countries Checkout should provide as options for
3122
- # shipping locations.
3123
- attr_accessor :allowed_countries
3124
-
3125
- def initialize(allowed_countries: nil)
3126
- @allowed_countries = allowed_countries
3127
- end
3128
- end
3129
-
3130
- class ShippingOption < Stripe::RequestParams
3131
- class ShippingRateData < Stripe::RequestParams
3132
- class DeliveryEstimate < Stripe::RequestParams
3133
- class Maximum < Stripe::RequestParams
3134
- # A unit of time.
3135
- attr_accessor :unit
3136
- # Must be greater than 0.
3137
- attr_accessor :value
3138
-
3139
- def initialize(unit: nil, value: nil)
3140
- @unit = unit
3141
- @value = value
3142
- end
3143
- end
3144
-
3145
- class Minimum < Stripe::RequestParams
3146
- # A unit of time.
3147
- attr_accessor :unit
3148
- # Must be greater than 0.
3149
- attr_accessor :value
3150
-
3151
- def initialize(unit: nil, value: nil)
3152
- @unit = unit
3153
- @value = value
3154
- end
3155
- end
3156
- # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
3157
- attr_accessor :maximum
3158
- # The lower bound of the estimated range. If empty, represents no lower bound.
3159
- attr_accessor :minimum
3160
-
3161
- def initialize(maximum: nil, minimum: nil)
3162
- @maximum = maximum
3163
- @minimum = minimum
3164
- end
3165
- end
3166
-
3167
- class FixedAmount < Stripe::RequestParams
3168
- class CurrencyOptions < Stripe::RequestParams
3169
- # A non-negative integer in cents representing how much to charge.
3170
- attr_accessor :amount
3171
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
3172
- attr_accessor :tax_behavior
3173
-
3174
- def initialize(amount: nil, tax_behavior: nil)
3175
- @amount = amount
3176
- @tax_behavior = tax_behavior
3177
- end
3178
- end
3179
- # A non-negative integer in cents representing how much to charge.
3180
- attr_accessor :amount
3181
- # 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).
3182
- attr_accessor :currency
3183
- # 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).
3184
- attr_accessor :currency_options
3185
-
3186
- def initialize(amount: nil, currency: nil, currency_options: nil)
3187
- @amount = amount
3188
- @currency = currency
3189
- @currency_options = currency_options
3190
- end
3191
- end
3192
- # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
3193
- attr_accessor :delivery_estimate
3194
- # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
3195
- attr_accessor :display_name
3196
- # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
3197
- attr_accessor :fixed_amount
3198
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
3199
- attr_accessor :metadata
3200
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
3201
- attr_accessor :tax_behavior
3202
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
3203
- attr_accessor :tax_code
3204
- # The type of calculation to use on the shipping rate.
3205
- attr_accessor :type
3206
-
3207
- def initialize(
3208
- delivery_estimate: nil,
3209
- display_name: nil,
3210
- fixed_amount: nil,
3211
- metadata: nil,
3212
- tax_behavior: nil,
3213
- tax_code: nil,
3214
- type: nil
3215
- )
3216
- @delivery_estimate = delivery_estimate
3217
- @display_name = display_name
3218
- @fixed_amount = fixed_amount
3219
- @metadata = metadata
3220
- @tax_behavior = tax_behavior
3221
- @tax_code = tax_code
3222
- @type = type
3223
- end
3224
- end
3225
- # The ID of the Shipping Rate to use for this shipping option.
3226
- attr_accessor :shipping_rate
3227
- # Parameters to be passed to Shipping Rate creation for this shipping option.
3228
- attr_accessor :shipping_rate_data
3229
-
3230
- def initialize(shipping_rate: nil, shipping_rate_data: nil)
3231
- @shipping_rate = shipping_rate
3232
- @shipping_rate_data = shipping_rate_data
3233
- end
3234
- end
3235
-
3236
- class SubscriptionData < Stripe::RequestParams
3237
- class BillingMode < Stripe::RequestParams
3238
- # Controls the calculation and orchestration of prorations and invoices for subscriptions.
3239
- attr_accessor :type
3240
-
3241
- def initialize(type: nil)
3242
- @type = type
3243
- end
3244
- end
3245
-
3246
- class InvoiceSettings < Stripe::RequestParams
3247
- class Issuer < Stripe::RequestParams
3248
- # The connected account being referenced when `type` is `account`.
3249
- attr_accessor :account
3250
- # Type of the account referenced in the request.
3251
- attr_accessor :type
3252
-
3253
- def initialize(account: nil, type: nil)
3254
- @account = account
3255
- @type = type
3256
- end
3257
- end
3258
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
3259
- attr_accessor :issuer
3260
-
3261
- def initialize(issuer: nil)
3262
- @issuer = issuer
3263
- end
3264
- end
3265
-
3266
- class TransferData < Stripe::RequestParams
3267
- # 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.
3268
- attr_accessor :amount_percent
3269
- # ID of an existing, connected Stripe account.
3270
- attr_accessor :destination
3271
-
3272
- def initialize(amount_percent: nil, destination: nil)
3273
- @amount_percent = amount_percent
3274
- @destination = destination
3275
- end
3276
- end
3277
-
3278
- class TrialSettings < Stripe::RequestParams
3279
- class EndBehavior < Stripe::RequestParams
3280
- # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
3281
- attr_accessor :missing_payment_method
3282
-
3283
- def initialize(missing_payment_method: nil)
3284
- @missing_payment_method = missing_payment_method
3285
- end
3286
- end
3287
- # Defines how the subscription should behave when the user's free trial ends.
3288
- attr_accessor :end_behavior
3289
-
3290
- def initialize(end_behavior: nil)
3291
- @end_behavior = end_behavior
3292
- end
3293
- end
3294
- # 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).
3295
- attr_accessor :application_fee_percent
3296
- # A future timestamp to anchor the subscription's billing cycle for new subscriptions.
3297
- attr_accessor :billing_cycle_anchor
3298
- # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
3299
- attr_accessor :billing_mode
3300
- # The tax rates that will apply to any subscription item that does not have
3301
- # `tax_rates` set. Invoices created will have their `default_tax_rates` populated
3302
- # from the subscription.
3303
- attr_accessor :default_tax_rates
3304
- # The subscription's description, meant to be displayable to the customer.
3305
- # Use this field to optionally store an explanation of the subscription
3306
- # for rendering in the [customer portal](https://stripe.com/docs/customer-management).
3307
- attr_accessor :description
3308
- # All invoices will be billed using the specified settings.
3309
- attr_accessor :invoice_settings
3310
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
3311
- attr_accessor :metadata
3312
- # The account on behalf of which to charge, for each of the subscription's invoices.
3313
- attr_accessor :on_behalf_of
3314
- # Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
3315
- attr_accessor :proration_behavior
3316
- # 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.
3317
- attr_accessor :transfer_data
3318
- # 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.
3319
- attr_accessor :trial_end
3320
- # Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
3321
- attr_accessor :trial_period_days
3322
- # Settings related to subscription trials.
3323
- attr_accessor :trial_settings
3324
-
3325
- def initialize(
3326
- application_fee_percent: nil,
3327
- billing_cycle_anchor: nil,
3328
- billing_mode: nil,
3329
- default_tax_rates: nil,
3330
- description: nil,
3331
- invoice_settings: nil,
3332
- metadata: nil,
3333
- on_behalf_of: nil,
3334
- proration_behavior: nil,
3335
- transfer_data: nil,
3336
- trial_end: nil,
3337
- trial_period_days: nil,
3338
- trial_settings: nil
3339
- )
3340
- @application_fee_percent = application_fee_percent
3341
- @billing_cycle_anchor = billing_cycle_anchor
3342
- @billing_mode = billing_mode
3343
- @default_tax_rates = default_tax_rates
3344
- @description = description
3345
- @invoice_settings = invoice_settings
3346
- @metadata = metadata
3347
- @on_behalf_of = on_behalf_of
3348
- @proration_behavior = proration_behavior
3349
- @transfer_data = transfer_data
3350
- @trial_end = trial_end
3351
- @trial_period_days = trial_period_days
3352
- @trial_settings = trial_settings
3353
- end
3354
- end
3355
-
3356
- class TaxIdCollection < Stripe::RequestParams
3357
- # Enable tax ID collection during checkout. Defaults to `false`.
3358
- attr_accessor :enabled
3359
- # Describes whether a tax ID is required during checkout. Defaults to `never`.
3360
- attr_accessor :required
3361
-
3362
- def initialize(enabled: nil, required: nil)
3363
- @enabled = enabled
3364
- @required = required
3365
- end
3366
- end
3367
-
3368
- class WalletOptions < Stripe::RequestParams
3369
- class Link < Stripe::RequestParams
3370
- # 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.
3371
- attr_accessor :display
3372
-
3373
- def initialize(display: nil)
3374
- @display = display
3375
- end
3376
- end
3377
- # contains details about the Link wallet options.
3378
- attr_accessor :link
3379
-
3380
- def initialize(link: nil)
3381
- @link = link
3382
- end
3383
- end
3384
- # Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
3385
- attr_accessor :adaptive_pricing
3386
- # Configure actions after a Checkout Session has expired.
3387
- attr_accessor :after_expiration
3388
- # Enables user redeemable promotion codes.
3389
- attr_accessor :allow_promotion_codes
3390
- # Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
3391
- attr_accessor :automatic_tax
3392
- # Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
3393
- attr_accessor :billing_address_collection
3394
- # 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`.
3395
- attr_accessor :cancel_url
3396
- # A unique string to reference the Checkout Session. This can be a
3397
- # customer ID, a cart ID, or similar, and can be used to reconcile the
3398
- # session with your internal systems.
3399
- attr_accessor :client_reference_id
3400
- # Configure fields for the Checkout Session to gather active consent from customers.
3401
- attr_accessor :consent_collection
3402
- # 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.
3403
- attr_accessor :currency
3404
- # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
3405
- attr_accessor :custom_fields
3406
- # Display additional text for your customers using custom text.
3407
- attr_accessor :custom_text
3408
- # ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card
3409
- # payment method will be used to prefill the email, name, card details, and billing address
3410
- # on the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)
3411
- # 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.
3412
- #
3413
- # If the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.
3414
- # If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
3415
- #
3416
- # 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.
3417
- #
3418
- # You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.
3419
- attr_accessor :customer
3420
- # ID of an existing Account, if one exists. Has the same behavior as `customer`.
3421
- attr_accessor :customer_account
3422
- # Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
3423
- #
3424
- # When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
3425
- # with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).
3426
- #
3427
- # Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)
3428
- # in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
3429
- #
3430
- # Can only be set in `payment` and `setup` mode.
3431
- attr_accessor :customer_creation
3432
- # If provided, this value will be used when the Customer object is created.
3433
- # If not provided, customers will be asked to enter their email address.
3434
- # Use this parameter to prefill customer data if you already have an email
3435
- # on file. To access information about the customer once a session is
3436
- # complete, use the `customer` field.
3437
- attr_accessor :customer_email
3438
- # Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
3439
- attr_accessor :customer_update
3440
- # The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
3441
- attr_accessor :discounts
3442
- # Specifies which fields in the response should be expanded.
3443
- attr_accessor :expand
3444
- # 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.
3445
- attr_accessor :expires_at
3446
- # Generate a post-purchase Invoice for one-time payments.
3447
- attr_accessor :invoice_creation
3448
- # A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). The parameter is required for `payment` and `subscription` mode.
3449
- #
3450
- # 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.
3451
- #
3452
- # 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.
3453
- attr_accessor :line_items
3454
- # The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
3455
- attr_accessor :locale
3456
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
3457
- attr_accessor :metadata
3458
- # The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
3459
- attr_accessor :mode
3460
- # A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
3461
- #
3462
- # 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.
3463
- #
3464
- # 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.
3465
- #
3466
- # 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.
3467
- attr_accessor :optional_items
3468
- # Where the user is coming from. This informs the optimizations that are applied to the session.
3469
- attr_accessor :origin_context
3470
- # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
3471
- attr_accessor :payment_intent_data
3472
- # 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.
3473
- # This may occur if the Checkout Session includes a free trial or a discount.
3474
- #
3475
- # Can only be set in `subscription` mode. Defaults to `always`.
3476
- #
3477
- # If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
3478
- attr_accessor :payment_method_collection
3479
- # The ID of the payment method configuration to use with this Checkout session.
3480
- attr_accessor :payment_method_configuration
3481
- # This parameter allows you to set some attributes on the payment method created during a Checkout session.
3482
- attr_accessor :payment_method_data
3483
- # Payment-method-specific configuration.
3484
- attr_accessor :payment_method_options
3485
- # A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
3486
- #
3487
- # You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
3488
- # See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.
3489
- #
3490
- # Read more about the supported payment methods and their requirements in our [payment
3491
- # method details guide](/docs/payments/checkout/payment-methods).
3492
- #
3493
- # If multiple payment methods are passed, Checkout will dynamically reorder them to
3494
- # prioritize the most relevant payment methods based on the customer's location and
3495
- # other characteristics.
3496
- attr_accessor :payment_method_types
3497
- # 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.
3498
- #
3499
- # For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.
3500
- attr_accessor :permissions
3501
- # Controls phone number collection settings for the session.
3502
- #
3503
- # We recommend that you review your privacy policy and check with your legal contacts
3504
- # before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).
3505
- attr_accessor :phone_number_collection
3506
- # This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
3507
- attr_accessor :redirect_on_completion
3508
- # The URL to redirect your customer back to after they authenticate or cancel their payment on the
3509
- # payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
3510
- # and redirect-based payment methods are enabled on the session.
3511
- attr_accessor :return_url
3512
- # Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
3513
- attr_accessor :saved_payment_method_options
3514
- # A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
3515
- attr_accessor :setup_intent_data
3516
- # When set, provides configuration for Checkout to collect a shipping address from a customer.
3517
- attr_accessor :shipping_address_collection
3518
- # The shipping rate options to apply to this Session. Up to a maximum of 5.
3519
- attr_accessor :shipping_options
3520
- # Describes the type of transaction being performed by Checkout in order
3521
- # to customize relevant text on the page, such as the submit button.
3522
- # `submit_type` can only be specified on Checkout Sessions in
3523
- # `payment` or `subscription` mode. If blank or `auto`, `pay` is used.
3524
- attr_accessor :submit_type
3525
- # A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
3526
- attr_accessor :subscription_data
3527
- # The URL to which Stripe should send customers when payment or setup
3528
- # is complete.
3529
- # This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
3530
- # information from the successful Checkout Session on your page, read the
3531
- # guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
3532
- attr_accessor :success_url
3533
- # Controls tax ID collection during checkout.
3534
- attr_accessor :tax_id_collection
3535
- # The UI mode of the Session. Defaults to `hosted`.
3536
- attr_accessor :ui_mode
3537
- # Wallet-specific configuration.
3538
- attr_accessor :wallet_options
3539
-
3540
- def initialize(
3541
- adaptive_pricing: nil,
3542
- after_expiration: nil,
3543
- allow_promotion_codes: nil,
3544
- automatic_tax: nil,
3545
- billing_address_collection: nil,
3546
- cancel_url: nil,
3547
- client_reference_id: nil,
3548
- consent_collection: nil,
3549
- currency: nil,
3550
- custom_fields: nil,
3551
- custom_text: nil,
3552
- customer: nil,
3553
- customer_account: nil,
3554
- customer_creation: nil,
3555
- customer_email: nil,
3556
- customer_update: nil,
3557
- discounts: nil,
3558
- expand: nil,
3559
- expires_at: nil,
3560
- invoice_creation: nil,
3561
- line_items: nil,
3562
- locale: nil,
3563
- metadata: nil,
3564
- mode: nil,
3565
- optional_items: nil,
3566
- origin_context: nil,
3567
- payment_intent_data: nil,
3568
- payment_method_collection: nil,
3569
- payment_method_configuration: nil,
3570
- payment_method_data: nil,
3571
- payment_method_options: nil,
3572
- payment_method_types: nil,
3573
- permissions: nil,
3574
- phone_number_collection: nil,
3575
- redirect_on_completion: nil,
3576
- return_url: nil,
3577
- saved_payment_method_options: nil,
3578
- setup_intent_data: nil,
3579
- shipping_address_collection: nil,
3580
- shipping_options: nil,
3581
- submit_type: nil,
3582
- subscription_data: nil,
3583
- success_url: nil,
3584
- tax_id_collection: nil,
3585
- ui_mode: nil,
3586
- wallet_options: nil
3587
- )
3588
- @adaptive_pricing = adaptive_pricing
3589
- @after_expiration = after_expiration
3590
- @allow_promotion_codes = allow_promotion_codes
3591
- @automatic_tax = automatic_tax
3592
- @billing_address_collection = billing_address_collection
3593
- @cancel_url = cancel_url
3594
- @client_reference_id = client_reference_id
3595
- @consent_collection = consent_collection
3596
- @currency = currency
3597
- @custom_fields = custom_fields
3598
- @custom_text = custom_text
3599
- @customer = customer
3600
- @customer_account = customer_account
3601
- @customer_creation = customer_creation
3602
- @customer_email = customer_email
3603
- @customer_update = customer_update
3604
- @discounts = discounts
3605
- @expand = expand
3606
- @expires_at = expires_at
3607
- @invoice_creation = invoice_creation
3608
- @line_items = line_items
3609
- @locale = locale
3610
- @metadata = metadata
3611
- @mode = mode
3612
- @optional_items = optional_items
3613
- @origin_context = origin_context
3614
- @payment_intent_data = payment_intent_data
3615
- @payment_method_collection = payment_method_collection
3616
- @payment_method_configuration = payment_method_configuration
3617
- @payment_method_data = payment_method_data
3618
- @payment_method_options = payment_method_options
3619
- @payment_method_types = payment_method_types
3620
- @permissions = permissions
3621
- @phone_number_collection = phone_number_collection
3622
- @redirect_on_completion = redirect_on_completion
3623
- @return_url = return_url
3624
- @saved_payment_method_options = saved_payment_method_options
3625
- @setup_intent_data = setup_intent_data
3626
- @shipping_address_collection = shipping_address_collection
3627
- @shipping_options = shipping_options
3628
- @submit_type = submit_type
3629
- @subscription_data = subscription_data
3630
- @success_url = success_url
3631
- @tax_id_collection = tax_id_collection
3632
- @ui_mode = ui_mode
3633
- @wallet_options = wallet_options
3634
- end
3635
- end
3636
-
3637
- class UpdateParams < Stripe::RequestParams
3638
- class CollectedInformation < Stripe::RequestParams
3639
- class ShippingDetails < Stripe::RequestParams
3640
- class Address < Stripe::RequestParams
3641
- # City, district, suburb, town, or village.
3642
- attr_accessor :city
3643
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
3644
- attr_accessor :country
3645
- # Address line 1 (e.g., street, PO Box, or company name).
3646
- attr_accessor :line1
3647
- # Address line 2 (e.g., apartment, suite, unit, or building).
3648
- attr_accessor :line2
3649
- # ZIP or postal code.
3650
- attr_accessor :postal_code
3651
- # State, county, province, or region.
3652
- attr_accessor :state
3653
-
3654
- def initialize(
3655
- city: nil,
3656
- country: nil,
3657
- line1: nil,
3658
- line2: nil,
3659
- postal_code: nil,
3660
- state: nil
3661
- )
3662
- @city = city
3663
- @country = country
3664
- @line1 = line1
3665
- @line2 = line2
3666
- @postal_code = postal_code
3667
- @state = state
3668
- end
3669
- end
3670
- # The address of the customer
3671
- attr_accessor :address
3672
- # The name of customer
3673
- attr_accessor :name
3674
-
3675
- def initialize(address: nil, name: nil)
3676
- @address = address
3677
- @name = name
3678
- end
3679
- end
3680
- # The shipping details to apply to this Session.
3681
- attr_accessor :shipping_details
3682
-
3683
- def initialize(shipping_details: nil)
3684
- @shipping_details = shipping_details
3685
- end
3686
- end
3687
-
3688
- class Discount < Stripe::RequestParams
3689
- class CouponData < Stripe::RequestParams
3690
- # A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
3691
- attr_accessor :amount_off
3692
- # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
3693
- attr_accessor :currency
3694
- # Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
3695
- attr_accessor :duration
3696
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
3697
- attr_accessor :metadata
3698
- # Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
3699
- attr_accessor :name
3700
- # 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).
3701
- attr_accessor :percent_off
3702
-
3703
- def initialize(
3704
- amount_off: nil,
3705
- currency: nil,
3706
- duration: nil,
3707
- metadata: nil,
3708
- name: nil,
3709
- percent_off: nil
3710
- )
3711
- @amount_off = amount_off
3712
- @currency = currency
3713
- @duration = duration
3714
- @metadata = metadata
3715
- @name = name
3716
- @percent_off = percent_off
3717
- end
3718
- end
3719
- # The ID of the [Coupon](https://stripe.com/docs/api/coupons) to apply to this Session. One of `coupon` or `coupon_data` is required when updating discounts.
3720
- attr_accessor :coupon
3721
- # Data used to generate a new [Coupon](https://stripe.com/docs/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
3722
- attr_accessor :coupon_data
3723
-
3724
- def initialize(coupon: nil, coupon_data: nil)
3725
- @coupon = coupon
3726
- @coupon_data = coupon_data
3727
- end
3728
- end
3729
-
3730
- class LineItem < Stripe::RequestParams
3731
- class AdjustableQuantity < Stripe::RequestParams
3732
- # Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.
3733
- attr_accessor :enabled
3734
- # 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.
3735
- attr_accessor :maximum
3736
- # The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
3737
- attr_accessor :minimum
3738
-
3739
- def initialize(enabled: nil, maximum: nil, minimum: nil)
3740
- @enabled = enabled
3741
- @maximum = maximum
3742
- @minimum = minimum
3743
- end
3744
- end
3745
-
3746
- class PriceData < Stripe::RequestParams
3747
- class ProductData < Stripe::RequestParams
3748
- # 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.
3749
- attr_accessor :description
3750
- # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
3751
- attr_accessor :images
3752
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
3753
- attr_accessor :metadata
3754
- # The product's name, meant to be displayable to the customer.
3755
- attr_accessor :name
3756
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
3757
- attr_accessor :tax_code
3758
-
3759
- def initialize(description: nil, images: nil, metadata: nil, name: nil, tax_code: nil)
3760
- @description = description
3761
- @images = images
3762
- @metadata = metadata
3763
- @name = name
3764
- @tax_code = tax_code
3765
- end
3766
- end
3767
-
3768
- class Recurring < Stripe::RequestParams
3769
- # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
3770
- attr_accessor :interval
3771
- # 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).
3772
- attr_accessor :interval_count
3773
-
3774
- def initialize(interval: nil, interval_count: nil)
3775
- @interval = interval
3776
- @interval_count = interval_count
3777
- end
3778
- end
3779
- # 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).
3780
- attr_accessor :currency
3781
- # 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.
3782
- attr_accessor :product
3783
- # Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
3784
- attr_accessor :product_data
3785
- # The recurring components of a price such as `interval` and `interval_count`.
3786
- attr_accessor :recurring
3787
- # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
3788
- attr_accessor :tax_behavior
3789
- # A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
3790
- attr_accessor :unit_amount
3791
- # 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.
3792
- attr_accessor :unit_amount_decimal
3793
-
3794
- def initialize(
3795
- currency: nil,
3796
- product: nil,
3797
- product_data: nil,
3798
- recurring: nil,
3799
- tax_behavior: nil,
3800
- unit_amount: nil,
3801
- unit_amount_decimal: nil
3802
- )
3803
- @currency = currency
3804
- @product = product
3805
- @product_data = product_data
3806
- @recurring = recurring
3807
- @tax_behavior = tax_behavior
3808
- @unit_amount = unit_amount
3809
- @unit_amount_decimal = unit_amount_decimal
3810
- end
3811
- end
3812
- # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
3813
- attr_accessor :adjustable_quantity
3814
- # ID of an existing line item.
3815
- attr_accessor :id
3816
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
3817
- attr_accessor :metadata
3818
- # The ID of the [Price](https://stripe.com/docs/api/prices). One of `price` or `price_data` is required when creating a new line item.
3819
- attr_accessor :price
3820
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required when creating a new line item.
3821
- attr_accessor :price_data
3822
- # The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
3823
- attr_accessor :quantity
3824
- # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
3825
- attr_accessor :tax_rates
3826
-
3827
- def initialize(
3828
- adjustable_quantity: nil,
3829
- id: nil,
3830
- metadata: nil,
3831
- price: nil,
3832
- price_data: nil,
3833
- quantity: nil,
3834
- tax_rates: nil
3835
- )
3836
- @adjustable_quantity = adjustable_quantity
3837
- @id = id
3838
- @metadata = metadata
3839
- @price = price
3840
- @price_data = price_data
3841
- @quantity = quantity
3842
- @tax_rates = tax_rates
3843
- end
3844
- end
3845
-
3846
- class ShippingOption < Stripe::RequestParams
3847
- class ShippingRateData < Stripe::RequestParams
3848
- class DeliveryEstimate < Stripe::RequestParams
3849
- class Maximum < Stripe::RequestParams
3850
- # A unit of time.
3851
- attr_accessor :unit
3852
- # Must be greater than 0.
3853
- attr_accessor :value
3854
-
3855
- def initialize(unit: nil, value: nil)
3856
- @unit = unit
3857
- @value = value
3858
- end
3859
- end
3860
-
3861
- class Minimum < Stripe::RequestParams
3862
- # A unit of time.
3863
- attr_accessor :unit
3864
- # Must be greater than 0.
3865
- attr_accessor :value
3866
-
3867
- def initialize(unit: nil, value: nil)
3868
- @unit = unit
3869
- @value = value
3870
- end
3871
- end
3872
- # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
3873
- attr_accessor :maximum
3874
- # The lower bound of the estimated range. If empty, represents no lower bound.
3875
- attr_accessor :minimum
3876
-
3877
- def initialize(maximum: nil, minimum: nil)
3878
- @maximum = maximum
3879
- @minimum = minimum
3880
- end
3881
- end
3882
-
3883
- class FixedAmount < Stripe::RequestParams
3884
- class CurrencyOptions < Stripe::RequestParams
3885
- # A non-negative integer in cents representing how much to charge.
3886
- attr_accessor :amount
3887
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
3888
- attr_accessor :tax_behavior
3889
-
3890
- def initialize(amount: nil, tax_behavior: nil)
3891
- @amount = amount
3892
- @tax_behavior = tax_behavior
3893
- end
3894
- end
3895
- # A non-negative integer in cents representing how much to charge.
3896
- attr_accessor :amount
3897
- # 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).
3898
- attr_accessor :currency
3899
- # 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).
3900
- attr_accessor :currency_options
3901
-
3902
- def initialize(amount: nil, currency: nil, currency_options: nil)
3903
- @amount = amount
3904
- @currency = currency
3905
- @currency_options = currency_options
3906
- end
3907
- end
3908
- # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
3909
- attr_accessor :delivery_estimate
3910
- # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
3911
- attr_accessor :display_name
3912
- # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
3913
- attr_accessor :fixed_amount
3914
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
3915
- attr_accessor :metadata
3916
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
3917
- attr_accessor :tax_behavior
3918
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
3919
- attr_accessor :tax_code
3920
- # The type of calculation to use on the shipping rate.
3921
- attr_accessor :type
3922
-
3923
- def initialize(
3924
- delivery_estimate: nil,
3925
- display_name: nil,
3926
- fixed_amount: nil,
3927
- metadata: nil,
3928
- tax_behavior: nil,
3929
- tax_code: nil,
3930
- type: nil
3931
- )
3932
- @delivery_estimate = delivery_estimate
3933
- @display_name = display_name
3934
- @fixed_amount = fixed_amount
3935
- @metadata = metadata
3936
- @tax_behavior = tax_behavior
3937
- @tax_code = tax_code
3938
- @type = type
3939
- end
3940
- end
3941
- # The ID of the Shipping Rate to use for this shipping option.
3942
- attr_accessor :shipping_rate
3943
- # Parameters to be passed to Shipping Rate creation for this shipping option.
3944
- attr_accessor :shipping_rate_data
3945
-
3946
- def initialize(shipping_rate: nil, shipping_rate_data: nil)
3947
- @shipping_rate = shipping_rate
3948
- @shipping_rate_data = shipping_rate_data
3949
- end
3950
- end
3951
-
3952
- class SubscriptionData < Stripe::RequestParams
3953
- # 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.
3954
- attr_accessor :trial_end
3955
- # Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
3956
- attr_accessor :trial_period_days
3957
-
3958
- def initialize(trial_end: nil, trial_period_days: nil)
3959
- @trial_end = trial_end
3960
- @trial_period_days = trial_period_days
3961
- end
3962
- end
3963
- # Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions.
3964
- attr_accessor :collected_information
3965
- # List of coupons and promotion codes attached to the Checkout Session.
3966
- attr_accessor :discounts
3967
- # Specifies which fields in the response should be expanded.
3968
- attr_accessor :expand
3969
- # A list of items the customer is purchasing.
3970
- #
3971
- # When updating line items, you must retransmit the entire array of line items.
3972
- #
3973
- # To retain an existing line item, specify its `id`.
3974
- #
3975
- # To update an existing line item, specify its `id` along with the new values of the fields to update.
3976
- #
3977
- # To add a new line item, specify one of `price` or `price_data` and `quantity`.
3978
- #
3979
- # To remove an existing line item, omit the line item's ID from the retransmitted array.
3980
- #
3981
- # To reorder a line item, specify it at the desired position in the retransmitted array.
3982
- attr_accessor :line_items
3983
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
3984
- attr_accessor :metadata
3985
- # The shipping rate options to apply to this Session. Up to a maximum of 5.
3986
- attr_accessor :shipping_options
3987
- # A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
3988
- attr_accessor :subscription_data
3989
-
3990
- def initialize(
3991
- collected_information: nil,
3992
- discounts: nil,
3993
- expand: nil,
3994
- line_items: nil,
3995
- metadata: nil,
3996
- shipping_options: nil,
3997
- subscription_data: nil
3998
- )
3999
- @collected_information = collected_information
4000
- @discounts = discounts
4001
- @expand = expand
4002
- @line_items = line_items
4003
- @metadata = metadata
4004
- @shipping_options = shipping_options
4005
- @subscription_data = subscription_data
4006
- end
4007
- end
4008
-
4009
- class ListLineItemsParams < Stripe::RequestParams
4010
- # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
4011
- attr_accessor :ending_before
4012
- # Specifies which fields in the response should be expanded.
4013
- attr_accessor :expand
4014
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
4015
- attr_accessor :limit
4016
- # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
4017
- attr_accessor :starting_after
4018
-
4019
- def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
4020
- @ending_before = ending_before
4021
- @expand = expand
4022
- @limit = limit
4023
- @starting_after = starting_after
4024
- end
4025
- end
4026
-
4027
- class ExpireParams < Stripe::RequestParams
4028
- # Specifies which fields in the response should be expanded.
4029
- attr_accessor :expand
4030
-
4031
- def initialize(expand: nil)
4032
- @expand = expand
2038
+ def self.field_remappings
2039
+ @field_remappings = {}
4033
2040
  end
4034
2041
  end
4035
2042
  # Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
@@ -4046,6 +2053,8 @@ module Stripe
4046
2053
  attr_reader :automatic_tax
4047
2054
  # Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.
4048
2055
  attr_reader :billing_address_collection
2056
+ # Attribute for field branding_settings
2057
+ attr_reader :branding_settings
4049
2058
  # 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.
4050
2059
  attr_reader :cancel_url
4051
2060
  # A unique string to reference the Checkout Session. This can be a
@@ -4077,8 +2086,6 @@ module Stripe
4077
2086
  # during the payment flow unless an existing customer was provided when
4078
2087
  # the Session was created.
4079
2088
  attr_reader :customer
4080
- # The ID of the account for this Session.
4081
- attr_reader :customer_account
4082
2089
  # Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
4083
2090
  attr_reader :customer_creation
4084
2091
  # The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.
@@ -4091,6 +2098,8 @@ module Stripe
4091
2098
  attr_reader :customer_email
4092
2099
  # List of coupons and promotion codes attached to the Checkout Session.
4093
2100
  attr_reader :discounts
2101
+ # 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).
2102
+ attr_reader :excluded_payment_method_types
4094
2103
  # The timestamp at which the Checkout Session will expire.
4095
2104
  attr_reader :expires_at
4096
2105
  # Unique identifier for the object.
@@ -4109,6 +2118,8 @@ module Stripe
4109
2118
  attr_reader :metadata
4110
2119
  # The mode of the Checkout Session.
4111
2120
  attr_reader :mode
2121
+ # Attribute for field name_collection
2122
+ attr_reader :name_collection
4112
2123
  # String representing the object's type. Objects of the same type share the same value.
4113
2124
  attr_reader :object
4114
2125
  # The optional items presented to the customer at checkout.
@@ -4253,6 +2264,42 @@ module Stripe
4253
2264
  opts: opts
4254
2265
  )
4255
2266
  end
2267
+
2268
+ def self.inner_class_types
2269
+ @inner_class_types = {
2270
+ adaptive_pricing: AdaptivePricing,
2271
+ after_expiration: AfterExpiration,
2272
+ automatic_tax: AutomaticTax,
2273
+ branding_settings: BrandingSettings,
2274
+ collected_information: CollectedInformation,
2275
+ consent: Consent,
2276
+ consent_collection: ConsentCollection,
2277
+ currency_conversion: CurrencyConversion,
2278
+ custom_fields: CustomField,
2279
+ custom_text: CustomText,
2280
+ customer_details: CustomerDetails,
2281
+ discounts: Discount,
2282
+ invoice_creation: InvoiceCreation,
2283
+ name_collection: NameCollection,
2284
+ optional_items: OptionalItem,
2285
+ payment_method_configuration_details: PaymentMethodConfigurationDetails,
2286
+ payment_method_options: PaymentMethodOptions,
2287
+ permissions: Permissions,
2288
+ phone_number_collection: PhoneNumberCollection,
2289
+ presentment_details: PresentmentDetails,
2290
+ saved_payment_method_options: SavedPaymentMethodOptions,
2291
+ shipping_address_collection: ShippingAddressCollection,
2292
+ shipping_cost: ShippingCost,
2293
+ shipping_options: ShippingOption,
2294
+ tax_id_collection: TaxIdCollection,
2295
+ total_details: TotalDetails,
2296
+ wallet_options: WalletOptions,
2297
+ }
2298
+ end
2299
+
2300
+ def self.field_remappings
2301
+ @field_remappings = {}
2302
+ end
4256
2303
  end
4257
2304
  end
4258
2305
  end