stripe 15.6.0.pre.beta.1 → 16.0.0

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