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