stripe 13.4.1 → 17.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (861) hide show
  1. checksums.yaml +4 -4
  2. data/lib/stripe/api_operations/nested_resource.rb +35 -35
  3. data/lib/stripe/api_operations/request.rb +1 -0
  4. data/lib/stripe/api_operations/save.rb +2 -1
  5. data/lib/stripe/api_operations/singleton_save.rb +2 -1
  6. data/lib/stripe/api_requestor.rb +12 -4
  7. data/lib/stripe/api_resource.rb +13 -3
  8. data/lib/stripe/api_version.rb +2 -1
  9. data/lib/stripe/connection_manager.rb +1 -3
  10. data/lib/stripe/errors.rb +0 -7
  11. data/lib/stripe/event_types.rb +20 -5
  12. data/lib/stripe/events/unknown_event_notification.rb +19 -0
  13. data/lib/stripe/events/v1_billing_meter_error_report_triggered_event.rb +115 -15
  14. data/lib/stripe/events/v1_billing_meter_no_meter_found_event.rb +93 -6
  15. data/lib/stripe/events/v2_core_event_destination_ping_event.rb +44 -0
  16. data/lib/stripe/oauth.rb +1 -1
  17. data/lib/stripe/object_types.rb +11 -4
  18. data/lib/stripe/params/account_capability_list_params.rb +13 -0
  19. data/lib/stripe/params/account_capability_retrieve_params.rb +13 -0
  20. data/lib/stripe/params/account_capability_update_params.rb +18 -0
  21. data/lib/stripe/params/account_create_params.rb +2083 -0
  22. data/lib/stripe/params/account_delete_params.rb +6 -0
  23. data/lib/stripe/params/account_external_account_create_params.rb +134 -0
  24. data/lib/stripe/params/account_external_account_delete_params.rb +6 -0
  25. data/lib/stripe/params/account_external_account_list_params.rb +25 -0
  26. data/lib/stripe/params/account_external_account_retrieve_params.rb +13 -0
  27. data/lib/stripe/params/account_external_account_update_params.rb +91 -0
  28. data/lib/stripe/params/account_link_create_params.rb +52 -0
  29. data/lib/stripe/params/account_list_params.rb +42 -0
  30. data/lib/stripe/params/account_login_link_create_params.rb +13 -0
  31. data/lib/stripe/params/account_person_create_params.rb +435 -0
  32. data/lib/stripe/params/account_person_delete_params.rb +6 -0
  33. data/lib/stripe/params/account_person_list_params.rb +61 -0
  34. data/lib/stripe/params/account_person_retrieve_params.rb +13 -0
  35. data/lib/stripe/params/account_person_update_params.rb +435 -0
  36. data/lib/stripe/params/account_persons_params.rb +61 -0
  37. data/lib/stripe/params/account_reject_params.rb +16 -0
  38. data/lib/stripe/params/account_retrieve_current_params.rb +13 -0
  39. data/lib/stripe/params/account_retrieve_params.rb +13 -0
  40. data/lib/stripe/params/account_session_create_params.rb +598 -0
  41. data/lib/stripe/params/account_update_params.rb +2030 -0
  42. data/lib/stripe/params/apple_pay_domain_create_params.rb +16 -0
  43. data/lib/stripe/params/apple_pay_domain_delete_params.rb +6 -0
  44. data/lib/stripe/params/apple_pay_domain_list_params.rb +31 -0
  45. data/lib/stripe/params/apple_pay_domain_retrieve_params.rb +13 -0
  46. data/lib/stripe/params/application_fee_list_params.rb +52 -0
  47. data/lib/stripe/params/application_fee_refund_create_params.rb +19 -0
  48. data/lib/stripe/params/application_fee_refund_list_params.rb +22 -0
  49. data/lib/stripe/params/application_fee_refund_retrieve_params.rb +13 -0
  50. data/lib/stripe/params/application_fee_refund_update_params.rb +16 -0
  51. data/lib/stripe/params/application_fee_retrieve_params.rb +13 -0
  52. data/lib/stripe/params/apps/secret_create_params.rb +38 -0
  53. data/lib/stripe/params/apps/secret_delete_where_params.rb +32 -0
  54. data/lib/stripe/params/apps/secret_find_params.rb +32 -0
  55. data/lib/stripe/params/apps/secret_list_params.rb +38 -0
  56. data/lib/stripe/params/balance_retrieve_params.rb +13 -0
  57. data/lib/stripe/params/balance_settings_retrieve_params.rb +13 -0
  58. data/lib/stripe/params/balance_settings_update_params.rb +67 -0
  59. data/lib/stripe/params/balance_transaction_list_params.rb +64 -0
  60. data/lib/stripe/params/balance_transaction_retrieve_params.rb +13 -0
  61. data/lib/stripe/params/billing/alert_activate_params.rb +15 -0
  62. data/lib/stripe/params/billing/alert_archive_params.rb +15 -0
  63. data/lib/stripe/params/billing/alert_create_params.rb +52 -0
  64. data/lib/stripe/params/billing/alert_deactivate_params.rb +15 -0
  65. data/lib/stripe/params/billing/alert_list_params.rb +37 -0
  66. data/lib/stripe/params/billing/alert_retrieve_params.rb +15 -0
  67. data/lib/stripe/params/billing/credit_balance_summary_retrieve_params.rb +54 -0
  68. data/lib/stripe/params/billing/credit_balance_transaction_list_params.rb +37 -0
  69. data/lib/stripe/params/billing/credit_balance_transaction_retrieve_params.rb +15 -0
  70. data/lib/stripe/params/billing/credit_grant_create_params.rb +103 -0
  71. data/lib/stripe/params/billing/credit_grant_expire_params.rb +15 -0
  72. data/lib/stripe/params/billing/credit_grant_list_params.rb +33 -0
  73. data/lib/stripe/params/billing/credit_grant_retrieve_params.rb +15 -0
  74. data/lib/stripe/params/billing/credit_grant_update_params.rb +21 -0
  75. data/lib/stripe/params/billing/credit_grant_void_grant_params.rb +15 -0
  76. data/lib/stripe/params/billing/meter_create_params.rb +70 -0
  77. data/lib/stripe/params/billing/meter_deactivate_params.rb +15 -0
  78. data/lib/stripe/params/billing/meter_event_adjustment_create_params.rb +32 -0
  79. data/lib/stripe/params/billing/meter_event_create_params.rb +27 -0
  80. data/lib/stripe/params/billing/meter_event_summary_list_params.rb +45 -0
  81. data/lib/stripe/params/billing/meter_list_params.rb +27 -0
  82. data/lib/stripe/params/billing/meter_reactivate_params.rb +15 -0
  83. data/lib/stripe/params/billing/meter_retrieve_params.rb +15 -0
  84. data/lib/stripe/params/billing/meter_update_params.rb +18 -0
  85. data/lib/stripe/params/billing_portal/configuration_create_params.rb +225 -0
  86. data/lib/stripe/params/billing_portal/configuration_list_params.rb +37 -0
  87. data/lib/stripe/params/billing_portal/configuration_retrieve_params.rb +15 -0
  88. data/lib/stripe/params/billing_portal/configuration_update_params.rb +231 -0
  89. data/lib/stripe/params/billing_portal/session_create_params.rb +179 -0
  90. data/lib/stripe/params/charge_capture_params.rb +57 -0
  91. data/lib/stripe/params/charge_create_params.rb +172 -0
  92. data/lib/stripe/params/charge_list_params.rb +60 -0
  93. data/lib/stripe/params/charge_retrieve_params.rb +13 -0
  94. data/lib/stripe/params/charge_search_params.rb +22 -0
  95. data/lib/stripe/params/charge_update_params.rb +102 -0
  96. data/lib/stripe/params/checkout/session_create_params.rb +2445 -0
  97. data/lib/stripe/params/checkout/session_expire_params.rb +15 -0
  98. data/lib/stripe/params/checkout/session_line_item_list_params.rb +24 -0
  99. data/lib/stripe/params/checkout/session_list_line_items_params.rb +24 -0
  100. data/lib/stripe/params/checkout/session_list_params.rb +83 -0
  101. data/lib/stripe/params/checkout/session_retrieve_params.rb +15 -0
  102. data/lib/stripe/params/checkout/session_update_params.rb +179 -0
  103. data/lib/stripe/params/climate/order_cancel_params.rb +15 -0
  104. data/lib/stripe/params/climate/order_create_params.rb +49 -0
  105. data/lib/stripe/params/climate/order_list_params.rb +24 -0
  106. data/lib/stripe/params/climate/order_retrieve_params.rb +15 -0
  107. data/lib/stripe/params/climate/order_update_params.rb +29 -0
  108. data/lib/stripe/params/climate/product_list_params.rb +24 -0
  109. data/lib/stripe/params/climate/product_retrieve_params.rb +15 -0
  110. data/lib/stripe/params/climate/supplier_list_params.rb +24 -0
  111. data/lib/stripe/params/climate/supplier_retrieve_params.rb +15 -0
  112. data/lib/stripe/params/confirmation_token_create_params.rb +650 -0
  113. data/lib/stripe/params/confirmation_token_retrieve_params.rb +13 -0
  114. data/lib/stripe/params/country_spec_list_params.rb +22 -0
  115. data/lib/stripe/params/country_spec_retrieve_params.rb +13 -0
  116. data/lib/stripe/params/coupon_create_params.rb +80 -0
  117. data/lib/stripe/params/coupon_delete_params.rb +6 -0
  118. data/lib/stripe/params/coupon_list_params.rb +42 -0
  119. data/lib/stripe/params/coupon_retrieve_params.rb +13 -0
  120. data/lib/stripe/params/coupon_update_params.rb +30 -0
  121. data/lib/stripe/params/credit_note_create_params.rb +144 -0
  122. data/lib/stripe/params/credit_note_line_item_list_params.rb +22 -0
  123. data/lib/stripe/params/credit_note_list_params.rb +56 -0
  124. data/lib/stripe/params/credit_note_list_preview_line_items_params.rb +156 -0
  125. data/lib/stripe/params/credit_note_preview_lines_list_params.rb +156 -0
  126. data/lib/stripe/params/credit_note_preview_params.rb +144 -0
  127. data/lib/stripe/params/credit_note_retrieve_params.rb +13 -0
  128. data/lib/stripe/params/credit_note_update_params.rb +19 -0
  129. data/lib/stripe/params/credit_note_void_credit_note_params.rb +13 -0
  130. data/lib/stripe/params/customer_balance_transaction_create_params.rb +25 -0
  131. data/lib/stripe/params/customer_balance_transaction_list_params.rb +22 -0
  132. data/lib/stripe/params/customer_balance_transaction_retrieve_params.rb +13 -0
  133. data/lib/stripe/params/customer_balance_transaction_update_params.rb +19 -0
  134. data/lib/stripe/params/customer_cash_balance_retrieve_params.rb +13 -0
  135. data/lib/stripe/params/customer_cash_balance_transaction_list_params.rb +22 -0
  136. data/lib/stripe/params/customer_cash_balance_transaction_retrieve_params.rb +13 -0
  137. data/lib/stripe/params/customer_cash_balance_update_params.rb +24 -0
  138. data/lib/stripe/params/customer_create_funding_instructions_params.rb +46 -0
  139. data/lib/stripe/params/customer_create_params.rb +259 -0
  140. data/lib/stripe/params/customer_delete_discount_params.rb +6 -0
  141. data/lib/stripe/params/customer_delete_params.rb +6 -0
  142. data/lib/stripe/params/customer_fund_cash_balance_params.rb +22 -0
  143. data/lib/stripe/params/customer_funding_instructions_create_params.rb +46 -0
  144. data/lib/stripe/params/customer_list_params.rb +56 -0
  145. data/lib/stripe/params/customer_list_payment_methods_params.rb +35 -0
  146. data/lib/stripe/params/customer_payment_method_list_params.rb +35 -0
  147. data/lib/stripe/params/customer_payment_method_retrieve_params.rb +13 -0
  148. data/lib/stripe/params/customer_payment_source_create_params.rb +22 -0
  149. data/lib/stripe/params/customer_payment_source_delete_params.rb +13 -0
  150. data/lib/stripe/params/customer_payment_source_list_params.rb +25 -0
  151. data/lib/stripe/params/customer_payment_source_retrieve_params.rb +13 -0
  152. data/lib/stripe/params/customer_payment_source_update_params.rb +114 -0
  153. data/lib/stripe/params/customer_payment_source_verify_params.rb +16 -0
  154. data/lib/stripe/params/customer_retrieve_params.rb +13 -0
  155. data/lib/stripe/params/customer_retrieve_payment_method_params.rb +13 -0
  156. data/lib/stripe/params/customer_search_params.rb +22 -0
  157. data/lib/stripe/params/customer_session_create_params.rb +100 -0
  158. data/lib/stripe/params/customer_tax_id_create_params.rb +19 -0
  159. data/lib/stripe/params/customer_tax_id_delete_params.rb +6 -0
  160. data/lib/stripe/params/customer_tax_id_list_params.rb +22 -0
  161. data/lib/stripe/params/customer_tax_id_retrieve_params.rb +13 -0
  162. data/lib/stripe/params/customer_update_params.rb +243 -0
  163. data/lib/stripe/params/dispute_close_params.rb +13 -0
  164. data/lib/stripe/params/dispute_list_params.rb +56 -0
  165. data/lib/stripe/params/dispute_retrieve_params.rb +13 -0
  166. data/lib/stripe/params/dispute_update_params.rb +308 -0
  167. data/lib/stripe/params/entitlements/active_entitlement_list_params.rb +33 -0
  168. data/lib/stripe/params/entitlements/active_entitlement_retrieve_params.rb +15 -0
  169. data/lib/stripe/params/entitlements/feature_create_params.rb +24 -0
  170. data/lib/stripe/params/entitlements/feature_list_params.rb +37 -0
  171. data/lib/stripe/params/entitlements/feature_retrieve_params.rb +15 -0
  172. data/lib/stripe/params/entitlements/feature_update_params.rb +24 -0
  173. data/lib/stripe/params/ephemeral_key_create_params.rb +31 -0
  174. data/lib/stripe/params/ephemeral_key_delete_params.rb +13 -0
  175. data/lib/stripe/params/event_list_params.rb +60 -0
  176. data/lib/stripe/params/event_retrieve_params.rb +13 -0
  177. data/lib/stripe/params/exchange_rate_list_params.rb +22 -0
  178. data/lib/stripe/params/exchange_rate_retrieve_params.rb +13 -0
  179. data/lib/stripe/params/file_create_params.rb +36 -0
  180. data/lib/stripe/params/file_link_create_params.rb +22 -0
  181. data/lib/stripe/params/file_link_list_params.rb +56 -0
  182. data/lib/stripe/params/file_link_retrieve_params.rb +13 -0
  183. data/lib/stripe/params/file_link_update_params.rb +19 -0
  184. data/lib/stripe/params/file_list_params.rb +52 -0
  185. data/lib/stripe/params/file_retrieve_params.rb +13 -0
  186. data/lib/stripe/params/financial_connections/account_disconnect_params.rb +15 -0
  187. data/lib/stripe/params/financial_connections/account_list_owners_params.rb +33 -0
  188. data/lib/stripe/params/financial_connections/account_list_params.rb +48 -0
  189. data/lib/stripe/params/financial_connections/account_owner_list_params.rb +33 -0
  190. data/lib/stripe/params/financial_connections/account_refresh_account_params.rb +18 -0
  191. data/lib/stripe/params/financial_connections/account_refresh_params.rb +18 -0
  192. data/lib/stripe/params/financial_connections/account_retrieve_params.rb +15 -0
  193. data/lib/stripe/params/financial_connections/account_subscribe_params.rb +18 -0
  194. data/lib/stripe/params/financial_connections/account_unsubscribe_params.rb +18 -0
  195. data/lib/stripe/params/financial_connections/session_create_params.rb +65 -0
  196. data/lib/stripe/params/financial_connections/session_retrieve_params.rb +15 -0
  197. data/lib/stripe/params/financial_connections/transaction_list_params.rb +67 -0
  198. data/lib/stripe/params/financial_connections/transaction_retrieve_params.rb +15 -0
  199. data/lib/stripe/params/forwarding/request_create_params.rb +59 -0
  200. data/lib/stripe/params/forwarding/request_list_params.rb +44 -0
  201. data/lib/stripe/params/forwarding/request_retrieve_params.rb +15 -0
  202. data/lib/stripe/params/identity/verification_report_list_params.rb +62 -0
  203. data/lib/stripe/params/identity/verification_report_retrieve_params.rb +15 -0
  204. data/lib/stripe/params/identity/verification_session_cancel_params.rb +15 -0
  205. data/lib/stripe/params/identity/verification_session_create_params.rb +107 -0
  206. data/lib/stripe/params/identity/verification_session_list_params.rb +62 -0
  207. data/lib/stripe/params/identity/verification_session_redact_params.rb +15 -0
  208. data/lib/stripe/params/identity/verification_session_retrieve_params.rb +15 -0
  209. data/lib/stripe/params/identity/verification_session_update_params.rb +69 -0
  210. data/lib/stripe/params/invoice_add_lines_params.rb +231 -0
  211. data/lib/stripe/params/invoice_attach_payment_params.rb +16 -0
  212. data/lib/stripe/params/invoice_create_params.rb +589 -0
  213. data/lib/stripe/params/invoice_create_preview_params.rb +993 -0
  214. data/lib/stripe/params/invoice_delete_params.rb +6 -0
  215. data/lib/stripe/params/invoice_finalize_invoice_params.rb +16 -0
  216. data/lib/stripe/params/invoice_item_create_params.rb +145 -0
  217. data/lib/stripe/params/invoice_item_delete_params.rb +6 -0
  218. data/lib/stripe/params/invoice_item_list_params.rb +60 -0
  219. data/lib/stripe/params/invoice_item_retrieve_params.rb +13 -0
  220. data/lib/stripe/params/invoice_item_update_params.rb +129 -0
  221. data/lib/stripe/params/invoice_line_item_list_params.rb +22 -0
  222. data/lib/stripe/params/invoice_line_item_update_params.rb +217 -0
  223. data/lib/stripe/params/invoice_list_params.rb +86 -0
  224. data/lib/stripe/params/invoice_mark_uncollectible_params.rb +13 -0
  225. data/lib/stripe/params/invoice_pay_params.rb +41 -0
  226. data/lib/stripe/params/invoice_payment_list_params.rb +50 -0
  227. data/lib/stripe/params/invoice_payment_retrieve_params.rb +13 -0
  228. data/lib/stripe/params/invoice_remove_lines_params.rb +30 -0
  229. data/lib/stripe/params/invoice_rendering_template_archive_params.rb +13 -0
  230. data/lib/stripe/params/invoice_rendering_template_list_params.rb +25 -0
  231. data/lib/stripe/params/invoice_rendering_template_retrieve_params.rb +16 -0
  232. data/lib/stripe/params/invoice_rendering_template_unarchive_params.rb +13 -0
  233. data/lib/stripe/params/invoice_retrieve_params.rb +13 -0
  234. data/lib/stripe/params/invoice_search_params.rb +22 -0
  235. data/lib/stripe/params/invoice_send_invoice_params.rb +13 -0
  236. data/lib/stripe/params/invoice_update_lines_params.rb +231 -0
  237. data/lib/stripe/params/invoice_update_params.rb +557 -0
  238. data/lib/stripe/params/invoice_void_invoice_params.rb +13 -0
  239. data/lib/stripe/params/issuing/authorization_approve_params.rb +21 -0
  240. data/lib/stripe/params/issuing/authorization_capture_params.rb +265 -0
  241. data/lib/stripe/params/issuing/authorization_create_params.rb +357 -0
  242. data/lib/stripe/params/issuing/authorization_decline_params.rb +18 -0
  243. data/lib/stripe/params/issuing/authorization_expire_params.rb +15 -0
  244. data/lib/stripe/params/issuing/authorization_finalize_amount_params.rb +143 -0
  245. data/lib/stripe/params/issuing/authorization_increment_params.rb +21 -0
  246. data/lib/stripe/params/issuing/authorization_list_params.rb +62 -0
  247. data/lib/stripe/params/issuing/authorization_respond_params.rb +18 -0
  248. data/lib/stripe/params/issuing/authorization_retrieve_params.rb +15 -0
  249. data/lib/stripe/params/issuing/authorization_reverse_params.rb +18 -0
  250. data/lib/stripe/params/issuing/authorization_update_params.rb +18 -0
  251. data/lib/stripe/params/issuing/card_create_params.rb +213 -0
  252. data/lib/stripe/params/issuing/card_deliver_card_params.rb +15 -0
  253. data/lib/stripe/params/issuing/card_fail_card_params.rb +15 -0
  254. data/lib/stripe/params/issuing/card_list_params.rb +78 -0
  255. data/lib/stripe/params/issuing/card_retrieve_params.rb +15 -0
  256. data/lib/stripe/params/issuing/card_return_card_params.rb +15 -0
  257. data/lib/stripe/params/issuing/card_ship_card_params.rb +15 -0
  258. data/lib/stripe/params/issuing/card_submit_card_params.rb +15 -0
  259. data/lib/stripe/params/issuing/card_update_params.rb +181 -0
  260. data/lib/stripe/params/issuing/cardholder_create_params.rb +238 -0
  261. data/lib/stripe/params/issuing/cardholder_list_params.rb +66 -0
  262. data/lib/stripe/params/issuing/cardholder_retrieve_params.rb +15 -0
  263. data/lib/stripe/params/issuing/cardholder_update_params.rb +230 -0
  264. data/lib/stripe/params/issuing/dispute_create_params.rb +297 -0
  265. data/lib/stripe/params/issuing/dispute_list_params.rb +58 -0
  266. data/lib/stripe/params/issuing/dispute_retrieve_params.rb +15 -0
  267. data/lib/stripe/params/issuing/dispute_submit_params.rb +18 -0
  268. data/lib/stripe/params/issuing/dispute_update_params.rb +275 -0
  269. data/lib/stripe/params/issuing/personalization_design_activate_params.rb +15 -0
  270. data/lib/stripe/params/issuing/personalization_design_create_params.rb +75 -0
  271. data/lib/stripe/params/issuing/personalization_design_deactivate_params.rb +15 -0
  272. data/lib/stripe/params/issuing/personalization_design_list_params.rb +52 -0
  273. data/lib/stripe/params/issuing/personalization_design_reject_params.rb +29 -0
  274. data/lib/stripe/params/issuing/personalization_design_retrieve_params.rb +15 -0
  275. data/lib/stripe/params/issuing/personalization_design_update_params.rb +75 -0
  276. data/lib/stripe/params/issuing/physical_bundle_list_params.rb +37 -0
  277. data/lib/stripe/params/issuing/physical_bundle_retrieve_params.rb +15 -0
  278. data/lib/stripe/params/issuing/token_list_params.rb +58 -0
  279. data/lib/stripe/params/issuing/token_retrieve_params.rb +15 -0
  280. data/lib/stripe/params/issuing/token_update_params.rb +18 -0
  281. data/lib/stripe/params/issuing/transaction_create_force_capture_params.rb +316 -0
  282. data/lib/stripe/params/issuing/transaction_create_unlinked_refund_params.rb +316 -0
  283. data/lib/stripe/params/issuing/transaction_list_params.rb +62 -0
  284. data/lib/stripe/params/issuing/transaction_refund_params.rb +18 -0
  285. data/lib/stripe/params/issuing/transaction_retrieve_params.rb +15 -0
  286. data/lib/stripe/params/issuing/transaction_update_params.rb +18 -0
  287. data/lib/stripe/params/mandate_retrieve_params.rb +13 -0
  288. data/lib/stripe/params/payment_intent_apply_customer_balance_params.rb +23 -0
  289. data/lib/stripe/params/payment_intent_cancel_params.rb +16 -0
  290. data/lib/stripe/params/payment_intent_capture_params.rb +54 -0
  291. data/lib/stripe/params/payment_intent_confirm_params.rb +2379 -0
  292. data/lib/stripe/params/payment_intent_create_params.rb +2480 -0
  293. data/lib/stripe/params/payment_intent_increment_authorization_params.rb +48 -0
  294. data/lib/stripe/params/payment_intent_list_params.rb +52 -0
  295. data/lib/stripe/params/payment_intent_retrieve_params.rb +16 -0
  296. data/lib/stripe/params/payment_intent_search_params.rb +22 -0
  297. data/lib/stripe/params/payment_intent_update_params.rb +2353 -0
  298. data/lib/stripe/params/payment_intent_verify_microdeposits_params.rb +19 -0
  299. data/lib/stripe/params/payment_link_create_params.rb +776 -0
  300. data/lib/stripe/params/payment_link_line_item_list_params.rb +22 -0
  301. data/lib/stripe/params/payment_link_list_line_items_params.rb +22 -0
  302. data/lib/stripe/params/payment_link_list_params.rb +25 -0
  303. data/lib/stripe/params/payment_link_retrieve_params.rb +13 -0
  304. data/lib/stripe/params/payment_link_update_params.rb +564 -0
  305. data/lib/stripe/params/payment_method_attach_params.rb +16 -0
  306. data/lib/stripe/params/payment_method_configuration_create_params.rb +1135 -0
  307. data/lib/stripe/params/payment_method_configuration_list_params.rb +31 -0
  308. data/lib/stripe/params/payment_method_configuration_retrieve_params.rb +13 -0
  309. data/lib/stripe/params/payment_method_configuration_update_params.rb +1135 -0
  310. data/lib/stripe/params/payment_method_create_params.rb +583 -0
  311. data/lib/stripe/params/payment_method_detach_params.rb +13 -0
  312. data/lib/stripe/params/payment_method_domain_create_params.rb +19 -0
  313. data/lib/stripe/params/payment_method_domain_list_params.rb +35 -0
  314. data/lib/stripe/params/payment_method_domain_retrieve_params.rb +13 -0
  315. data/lib/stripe/params/payment_method_domain_update_params.rb +16 -0
  316. data/lib/stripe/params/payment_method_domain_validate_params.rb +13 -0
  317. data/lib/stripe/params/payment_method_list_params.rb +35 -0
  318. data/lib/stripe/params/payment_method_retrieve_params.rb +13 -0
  319. data/lib/stripe/params/payment_method_update_params.rb +120 -0
  320. data/lib/stripe/params/payout_cancel_params.rb +13 -0
  321. data/lib/stripe/params/payout_create_params.rb +51 -0
  322. data/lib/stripe/params/payout_list_params.rb +78 -0
  323. data/lib/stripe/params/payout_retrieve_params.rb +13 -0
  324. data/lib/stripe/params/payout_reverse_params.rb +16 -0
  325. data/lib/stripe/params/payout_update_params.rb +16 -0
  326. data/lib/stripe/params/plan_create_params.rb +158 -0
  327. data/lib/stripe/params/plan_delete_params.rb +6 -0
  328. data/lib/stripe/params/plan_list_params.rb +56 -0
  329. data/lib/stripe/params/plan_retrieve_params.rb +13 -0
  330. data/lib/stripe/params/plan_update_params.rb +35 -0
  331. data/lib/stripe/params/price_create_params.rb +278 -0
  332. data/lib/stripe/params/price_list_params.rb +87 -0
  333. data/lib/stripe/params/price_retrieve_params.rb +13 -0
  334. data/lib/stripe/params/price_search_params.rb +22 -0
  335. data/lib/stripe/params/price_update_params.rb +113 -0
  336. data/lib/stripe/params/product_create_params.rb +243 -0
  337. data/lib/stripe/params/product_delete_params.rb +6 -0
  338. data/lib/stripe/params/product_feature_create_params.rb +16 -0
  339. data/lib/stripe/params/product_feature_delete_params.rb +6 -0
  340. data/lib/stripe/params/product_feature_list_params.rb +22 -0
  341. data/lib/stripe/params/product_feature_retrieve_params.rb +13 -0
  342. data/lib/stripe/params/product_list_params.rb +68 -0
  343. data/lib/stripe/params/product_retrieve_params.rb +13 -0
  344. data/lib/stripe/params/product_search_params.rb +22 -0
  345. data/lib/stripe/params/product_update_params.rb +96 -0
  346. data/lib/stripe/params/promotion_code_create_params.rb +91 -0
  347. data/lib/stripe/params/promotion_code_list_params.rb +64 -0
  348. data/lib/stripe/params/promotion_code_retrieve_params.rb +13 -0
  349. data/lib/stripe/params/promotion_code_update_params.rb +38 -0
  350. data/lib/stripe/params/quote_accept_params.rb +13 -0
  351. data/lib/stripe/params/quote_cancel_params.rb +13 -0
  352. data/lib/stripe/params/quote_computed_upfront_line_items_list_params.rb +22 -0
  353. data/lib/stripe/params/quote_create_params.rb +301 -0
  354. data/lib/stripe/params/quote_finalize_quote_params.rb +16 -0
  355. data/lib/stripe/params/quote_line_item_list_params.rb +22 -0
  356. data/lib/stripe/params/quote_list_computed_upfront_line_items_params.rb +22 -0
  357. data/lib/stripe/params/quote_list_line_items_params.rb +22 -0
  358. data/lib/stripe/params/quote_list_params.rb +39 -0
  359. data/lib/stripe/params/quote_pdf_params.rb +13 -0
  360. data/lib/stripe/params/quote_retrieve_params.rb +13 -0
  361. data/lib/stripe/params/quote_update_params.rb +263 -0
  362. data/lib/stripe/params/radar/early_fraud_warning_list_params.rb +58 -0
  363. data/lib/stripe/params/radar/early_fraud_warning_retrieve_params.rb +15 -0
  364. data/lib/stripe/params/radar/value_list_create_params.rb +27 -0
  365. data/lib/stripe/params/radar/value_list_delete_params.rb +8 -0
  366. data/lib/stripe/params/radar/value_list_item_create_params.rb +21 -0
  367. data/lib/stripe/params/radar/value_list_item_delete_params.rb +8 -0
  368. data/lib/stripe/params/radar/value_list_item_list_params.rb +58 -0
  369. data/lib/stripe/params/radar/value_list_item_retrieve_params.rb +15 -0
  370. data/lib/stripe/params/radar/value_list_list_params.rb +58 -0
  371. data/lib/stripe/params/radar/value_list_retrieve_params.rb +15 -0
  372. data/lib/stripe/params/radar/value_list_update_params.rb +24 -0
  373. data/lib/stripe/params/refund_cancel_params.rb +13 -0
  374. data/lib/stripe/params/refund_create_params.rb +59 -0
  375. data/lib/stripe/params/refund_expire_params.rb +13 -0
  376. data/lib/stripe/params/refund_list_params.rb +56 -0
  377. data/lib/stripe/params/refund_retrieve_params.rb +13 -0
  378. data/lib/stripe/params/refund_update_params.rb +16 -0
  379. data/lib/stripe/params/reporting/report_run_create_params.rb +59 -0
  380. data/lib/stripe/params/reporting/report_run_list_params.rb +44 -0
  381. data/lib/stripe/params/reporting/report_run_retrieve_params.rb +15 -0
  382. data/lib/stripe/params/reporting/report_type_list_params.rb +15 -0
  383. data/lib/stripe/params/reporting/report_type_retrieve_params.rb +15 -0
  384. data/lib/stripe/params/review_approve_params.rb +13 -0
  385. data/lib/stripe/params/review_list_params.rb +42 -0
  386. data/lib/stripe/params/review_retrieve_params.rb +13 -0
  387. data/lib/stripe/params/setup_attempt_list_params.rb +55 -0
  388. data/lib/stripe/params/setup_intent_cancel_params.rb +16 -0
  389. data/lib/stripe/params/setup_intent_confirm_params.rb +1050 -0
  390. data/lib/stripe/params/setup_intent_create_params.rb +1130 -0
  391. data/lib/stripe/params/setup_intent_list_params.rb +62 -0
  392. data/lib/stripe/params/setup_intent_retrieve_params.rb +16 -0
  393. data/lib/stripe/params/setup_intent_update_params.rb +1025 -0
  394. data/lib/stripe/params/setup_intent_verify_microdeposits_params.rb +19 -0
  395. data/lib/stripe/params/shipping_rate_create_params.rb +103 -0
  396. data/lib/stripe/params/shipping_rate_list_params.rb +56 -0
  397. data/lib/stripe/params/shipping_rate_retrieve_params.rb +13 -0
  398. data/lib/stripe/params/shipping_rate_update_params.rb +44 -0
  399. data/lib/stripe/params/sigma/scheduled_query_run_list_params.rb +24 -0
  400. data/lib/stripe/params/sigma/scheduled_query_run_retrieve_params.rb +15 -0
  401. data/lib/stripe/params/source_create_params.rb +317 -0
  402. data/lib/stripe/params/source_detach_params.rb +13 -0
  403. data/lib/stripe/params/source_retrieve_params.rb +16 -0
  404. data/lib/stripe/params/source_transaction_list_params.rb +22 -0
  405. data/lib/stripe/params/source_update_params.rb +259 -0
  406. data/lib/stripe/params/source_verify_params.rb +16 -0
  407. data/lib/stripe/params/subscription_cancel_params.rb +33 -0
  408. data/lib/stripe/params/subscription_create_params.rb +704 -0
  409. data/lib/stripe/params/subscription_delete_discount_params.rb +6 -0
  410. data/lib/stripe/params/subscription_item_create_params.rb +134 -0
  411. data/lib/stripe/params/subscription_item_delete_params.rb +19 -0
  412. data/lib/stripe/params/subscription_item_list_params.rb +31 -0
  413. data/lib/stripe/params/subscription_item_retrieve_params.rb +13 -0
  414. data/lib/stripe/params/subscription_item_update_params.rb +134 -0
  415. data/lib/stripe/params/subscription_list_params.rb +129 -0
  416. data/lib/stripe/params/subscription_migrate_params.rb +35 -0
  417. data/lib/stripe/params/subscription_resume_params.rb +27 -0
  418. data/lib/stripe/params/subscription_retrieve_params.rb +13 -0
  419. data/lib/stripe/params/subscription_schedule_cancel_params.rb +19 -0
  420. data/lib/stripe/params/subscription_schedule_create_params.rb +590 -0
  421. data/lib/stripe/params/subscription_schedule_list_params.rb +122 -0
  422. data/lib/stripe/params/subscription_schedule_release_params.rb +16 -0
  423. data/lib/stripe/params/subscription_schedule_retrieve_params.rb +13 -0
  424. data/lib/stripe/params/subscription_schedule_update_params.rb +562 -0
  425. data/lib/stripe/params/subscription_search_params.rb +22 -0
  426. data/lib/stripe/params/subscription_update_params.rb +683 -0
  427. data/lib/stripe/params/tax/calculation_create_params.rb +206 -0
  428. data/lib/stripe/params/tax/calculation_line_item_list_params.rb +24 -0
  429. data/lib/stripe/params/tax/calculation_list_line_items_params.rb +24 -0
  430. data/lib/stripe/params/tax/calculation_retrieve_params.rb +15 -0
  431. data/lib/stripe/params/tax/registration_create_params.rb +2018 -0
  432. data/lib/stripe/params/tax/registration_list_params.rb +27 -0
  433. data/lib/stripe/params/tax/registration_retrieve_params.rb +15 -0
  434. data/lib/stripe/params/tax/registration_update_params.rb +21 -0
  435. data/lib/stripe/params/tax/settings_retrieve_params.rb +15 -0
  436. data/lib/stripe/params/tax/settings_update_params.rb +71 -0
  437. data/lib/stripe/params/tax/transaction_create_from_calculation_params.rb +27 -0
  438. data/lib/stripe/params/tax/transaction_create_reversal_params.rb +87 -0
  439. data/lib/stripe/params/tax/transaction_line_item_list_params.rb +24 -0
  440. data/lib/stripe/params/tax/transaction_list_line_items_params.rb +24 -0
  441. data/lib/stripe/params/tax/transaction_retrieve_params.rb +15 -0
  442. data/lib/stripe/params/tax_code_list_params.rb +22 -0
  443. data/lib/stripe/params/tax_code_retrieve_params.rb +13 -0
  444. data/lib/stripe/params/tax_id_create_params.rb +36 -0
  445. data/lib/stripe/params/tax_id_delete_params.rb +6 -0
  446. data/lib/stripe/params/tax_id_list_params.rb +39 -0
  447. data/lib/stripe/params/tax_id_retrieve_params.rb +13 -0
  448. data/lib/stripe/params/tax_rate_create_params.rb +55 -0
  449. data/lib/stripe/params/tax_rate_list_params.rb +56 -0
  450. data/lib/stripe/params/tax_rate_retrieve_params.rb +13 -0
  451. data/lib/stripe/params/tax_rate_update_params.rb +47 -0
  452. data/lib/stripe/params/terminal/configuration_create_params.rb +593 -0
  453. data/lib/stripe/params/terminal/configuration_delete_params.rb +8 -0
  454. data/lib/stripe/params/terminal/configuration_list_params.rb +33 -0
  455. data/lib/stripe/params/terminal/configuration_retrieve_params.rb +15 -0
  456. data/lib/stripe/params/terminal/configuration_update_params.rb +593 -0
  457. data/lib/stripe/params/terminal/connection_token_create_params.rb +18 -0
  458. data/lib/stripe/params/terminal/location_create_params.rb +153 -0
  459. data/lib/stripe/params/terminal/location_delete_params.rb +8 -0
  460. data/lib/stripe/params/terminal/location_list_params.rb +24 -0
  461. data/lib/stripe/params/terminal/location_retrieve_params.rb +15 -0
  462. data/lib/stripe/params/terminal/location_update_params.rb +153 -0
  463. data/lib/stripe/params/terminal/reader_cancel_action_params.rb +15 -0
  464. data/lib/stripe/params/terminal/reader_collect_inputs_params.rb +96 -0
  465. data/lib/stripe/params/terminal/reader_collect_payment_method_params.rb +51 -0
  466. data/lib/stripe/params/terminal/reader_confirm_payment_intent_params.rb +29 -0
  467. data/lib/stripe/params/terminal/reader_create_params.rb +27 -0
  468. data/lib/stripe/params/terminal/reader_delete_params.rb +8 -0
  469. data/lib/stripe/params/terminal/reader_list_params.rb +45 -0
  470. data/lib/stripe/params/terminal/reader_present_payment_method_params.rb +72 -0
  471. data/lib/stripe/params/terminal/reader_process_payment_intent_params.rb +55 -0
  472. data/lib/stripe/params/terminal/reader_process_setup_intent_params.rb +32 -0
  473. data/lib/stripe/params/terminal/reader_refund_payment_params.rb +53 -0
  474. data/lib/stripe/params/terminal/reader_retrieve_params.rb +15 -0
  475. data/lib/stripe/params/terminal/reader_set_reader_display_params.rb +52 -0
  476. data/lib/stripe/params/terminal/reader_succeed_input_collection_params.rb +18 -0
  477. data/lib/stripe/params/terminal/reader_timeout_input_collection_params.rb +15 -0
  478. data/lib/stripe/params/terminal/reader_update_params.rb +21 -0
  479. data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +652 -0
  480. data/lib/stripe/params/test_helpers/customer_fund_cash_balance_params.rb +24 -0
  481. data/lib/stripe/params/test_helpers/issuing/authorization_capture_params.rb +267 -0
  482. data/lib/stripe/params/test_helpers/issuing/authorization_create_params.rb +359 -0
  483. data/lib/stripe/params/test_helpers/issuing/authorization_expire_params.rb +17 -0
  484. data/lib/stripe/params/test_helpers/issuing/authorization_finalize_amount_params.rb +145 -0
  485. data/lib/stripe/params/test_helpers/issuing/authorization_increment_params.rb +23 -0
  486. data/lib/stripe/params/test_helpers/issuing/authorization_respond_params.rb +20 -0
  487. data/lib/stripe/params/test_helpers/issuing/authorization_reverse_params.rb +20 -0
  488. data/lib/stripe/params/test_helpers/issuing/card_deliver_card_params.rb +17 -0
  489. data/lib/stripe/params/test_helpers/issuing/card_fail_card_params.rb +17 -0
  490. data/lib/stripe/params/test_helpers/issuing/card_return_card_params.rb +17 -0
  491. data/lib/stripe/params/test_helpers/issuing/card_ship_card_params.rb +17 -0
  492. data/lib/stripe/params/test_helpers/issuing/card_submit_card_params.rb +17 -0
  493. data/lib/stripe/params/test_helpers/issuing/personalization_design_activate_params.rb +17 -0
  494. data/lib/stripe/params/test_helpers/issuing/personalization_design_deactivate_params.rb +17 -0
  495. data/lib/stripe/params/test_helpers/issuing/personalization_design_reject_params.rb +31 -0
  496. data/lib/stripe/params/test_helpers/issuing/transaction_create_force_capture_params.rb +318 -0
  497. data/lib/stripe/params/test_helpers/issuing/transaction_create_unlinked_refund_params.rb +318 -0
  498. data/lib/stripe/params/test_helpers/issuing/transaction_refund_params.rb +20 -0
  499. data/lib/stripe/params/test_helpers/refund_expire_params.rb +15 -0
  500. data/lib/stripe/params/test_helpers/terminal/reader_present_payment_method_params.rb +74 -0
  501. data/lib/stripe/params/test_helpers/terminal/reader_succeed_input_collection_params.rb +20 -0
  502. data/lib/stripe/params/test_helpers/terminal/reader_timeout_input_collection_params.rb +17 -0
  503. data/lib/stripe/params/test_helpers/test_clock_advance_params.rb +18 -0
  504. data/lib/stripe/params/test_helpers/test_clock_create_params.rb +21 -0
  505. data/lib/stripe/params/test_helpers/test_clock_delete_params.rb +8 -0
  506. data/lib/stripe/params/test_helpers/test_clock_list_params.rb +24 -0
  507. data/lib/stripe/params/test_helpers/test_clock_retrieve_params.rb +15 -0
  508. data/lib/stripe/params/test_helpers/treasury/inbound_transfer_fail_params.rb +28 -0
  509. data/lib/stripe/params/test_helpers/treasury/inbound_transfer_return_inbound_transfer_params.rb +17 -0
  510. data/lib/stripe/params/test_helpers/treasury/inbound_transfer_succeed_params.rb +17 -0
  511. data/lib/stripe/params/test_helpers/treasury/outbound_payment_fail_params.rb +17 -0
  512. data/lib/stripe/params/test_helpers/treasury/outbound_payment_post_params.rb +17 -0
  513. data/lib/stripe/params/test_helpers/treasury/outbound_payment_return_outbound_payment_params.rb +28 -0
  514. data/lib/stripe/params/test_helpers/treasury/outbound_payment_update_params.rb +57 -0
  515. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_fail_params.rb +17 -0
  516. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_post_params.rb +17 -0
  517. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_return_outbound_transfer_params.rb +28 -0
  518. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_update_params.rb +57 -0
  519. data/lib/stripe/params/test_helpers/treasury/received_credit_create_params.rb +68 -0
  520. data/lib/stripe/params/test_helpers/treasury/received_debit_create_params.rb +68 -0
  521. data/lib/stripe/params/token_create_params.rb +1191 -0
  522. data/lib/stripe/params/token_retrieve_params.rb +13 -0
  523. data/lib/stripe/params/topup_cancel_params.rb +13 -0
  524. data/lib/stripe/params/topup_create_params.rb +43 -0
  525. data/lib/stripe/params/topup_list_params.rb +74 -0
  526. data/lib/stripe/params/topup_retrieve_params.rb +13 -0
  527. data/lib/stripe/params/topup_update_params.rb +19 -0
  528. data/lib/stripe/params/transfer_create_params.rb +47 -0
  529. data/lib/stripe/params/transfer_list_params.rb +56 -0
  530. data/lib/stripe/params/transfer_retrieve_params.rb +13 -0
  531. data/lib/stripe/params/transfer_reversal_create_params.rb +31 -0
  532. data/lib/stripe/params/transfer_reversal_list_params.rb +22 -0
  533. data/lib/stripe/params/transfer_reversal_retrieve_params.rb +13 -0
  534. data/lib/stripe/params/transfer_reversal_update_params.rb +16 -0
  535. data/lib/stripe/params/transfer_update_params.rb +19 -0
  536. data/lib/stripe/params/treasury/credit_reversal_create_params.rb +21 -0
  537. data/lib/stripe/params/treasury/credit_reversal_list_params.rb +41 -0
  538. data/lib/stripe/params/treasury/credit_reversal_retrieve_params.rb +15 -0
  539. data/lib/stripe/params/treasury/debit_reversal_create_params.rb +21 -0
  540. data/lib/stripe/params/treasury/debit_reversal_list_params.rb +45 -0
  541. data/lib/stripe/params/treasury/debit_reversal_retrieve_params.rb +15 -0
  542. data/lib/stripe/params/treasury/financial_account_close_params.rb +32 -0
  543. data/lib/stripe/params/treasury/financial_account_create_params.rb +201 -0
  544. data/lib/stripe/params/treasury/financial_account_features_retrieve_params.rb +15 -0
  545. data/lib/stripe/params/treasury/financial_account_features_update_params.rb +163 -0
  546. data/lib/stripe/params/treasury/financial_account_list_params.rb +54 -0
  547. data/lib/stripe/params/treasury/financial_account_retrieve_features_params.rb +15 -0
  548. data/lib/stripe/params/treasury/financial_account_retrieve_params.rb +15 -0
  549. data/lib/stripe/params/treasury/financial_account_update_features_params.rb +163 -0
  550. data/lib/stripe/params/treasury/financial_account_update_params.rb +216 -0
  551. data/lib/stripe/params/treasury/inbound_transfer_cancel_params.rb +15 -0
  552. data/lib/stripe/params/treasury/inbound_transfer_create_params.rb +45 -0
  553. data/lib/stripe/params/treasury/inbound_transfer_fail_params.rb +26 -0
  554. data/lib/stripe/params/treasury/inbound_transfer_list_params.rb +37 -0
  555. data/lib/stripe/params/treasury/inbound_transfer_retrieve_params.rb +15 -0
  556. data/lib/stripe/params/treasury/inbound_transfer_return_inbound_transfer_params.rb +15 -0
  557. data/lib/stripe/params/treasury/inbound_transfer_succeed_params.rb +15 -0
  558. data/lib/stripe/params/treasury/outbound_payment_cancel_params.rb +15 -0
  559. data/lib/stripe/params/treasury/outbound_payment_create_params.rb +190 -0
  560. data/lib/stripe/params/treasury/outbound_payment_fail_params.rb +15 -0
  561. data/lib/stripe/params/treasury/outbound_payment_list_params.rb +62 -0
  562. data/lib/stripe/params/treasury/outbound_payment_post_params.rb +15 -0
  563. data/lib/stripe/params/treasury/outbound_payment_retrieve_params.rb +15 -0
  564. data/lib/stripe/params/treasury/outbound_payment_return_outbound_payment_params.rb +26 -0
  565. data/lib/stripe/params/treasury/outbound_payment_update_params.rb +55 -0
  566. data/lib/stripe/params/treasury/outbound_transfer_cancel_params.rb +15 -0
  567. data/lib/stripe/params/treasury/outbound_transfer_create_params.rb +81 -0
  568. data/lib/stripe/params/treasury/outbound_transfer_fail_params.rb +15 -0
  569. data/lib/stripe/params/treasury/outbound_transfer_list_params.rb +37 -0
  570. data/lib/stripe/params/treasury/outbound_transfer_post_params.rb +15 -0
  571. data/lib/stripe/params/treasury/outbound_transfer_retrieve_params.rb +15 -0
  572. data/lib/stripe/params/treasury/outbound_transfer_return_outbound_transfer_params.rb +26 -0
  573. data/lib/stripe/params/treasury/outbound_transfer_update_params.rb +55 -0
  574. data/lib/stripe/params/treasury/received_credit_create_params.rb +66 -0
  575. data/lib/stripe/params/treasury/received_credit_list_params.rb +49 -0
  576. data/lib/stripe/params/treasury/received_credit_retrieve_params.rb +15 -0
  577. data/lib/stripe/params/treasury/received_debit_create_params.rb +66 -0
  578. data/lib/stripe/params/treasury/received_debit_list_params.rb +37 -0
  579. data/lib/stripe/params/treasury/received_debit_retrieve_params.rb +15 -0
  580. data/lib/stripe/params/treasury/transaction_entry_list_params.rb +84 -0
  581. data/lib/stripe/params/treasury/transaction_entry_retrieve_params.rb +15 -0
  582. data/lib/stripe/params/treasury/transaction_list_params.rb +92 -0
  583. data/lib/stripe/params/treasury/transaction_retrieve_params.rb +15 -0
  584. data/lib/stripe/params/v2/billing/meter_event_adjustment_create_params.rb +31 -0
  585. data/lib/stripe/params/v2/billing/meter_event_create_params.rb +33 -0
  586. data/lib/stripe/params/v2/billing/meter_event_session_create_params.rb +10 -0
  587. data/lib/stripe/params/v2/billing/meter_event_stream_create_params.rb +41 -0
  588. data/lib/stripe/params/v2/core/event_destination_create_params.rb +79 -0
  589. data/lib/stripe/params/v2/core/event_destination_delete_params.rb +10 -0
  590. data/lib/stripe/params/v2/core/event_destination_disable_params.rb +10 -0
  591. data/lib/stripe/params/v2/core/event_destination_enable_params.rb +10 -0
  592. data/lib/stripe/params/v2/core/event_destination_list_params.rb +20 -0
  593. data/lib/stripe/params/v2/core/event_destination_ping_params.rb +10 -0
  594. data/lib/stripe/params/v2/core/event_destination_retrieve_params.rb +17 -0
  595. data/lib/stripe/params/v2/core/event_destination_update_params.rb +47 -0
  596. data/lib/stripe/params/v2/core/event_list_params.rb +22 -0
  597. data/lib/stripe/params/v2/core/event_retrieve_params.rb +10 -0
  598. data/lib/stripe/params/webhook_endpoint_create_params.rb +39 -0
  599. data/lib/stripe/params/webhook_endpoint_delete_params.rb +6 -0
  600. data/lib/stripe/params/webhook_endpoint_list_params.rb +22 -0
  601. data/lib/stripe/params/webhook_endpoint_retrieve_params.rb +13 -0
  602. data/lib/stripe/params/webhook_endpoint_update_params.rb +35 -0
  603. data/lib/stripe/params.rb +588 -0
  604. data/lib/stripe/request_options.rb +16 -6
  605. data/lib/stripe/request_params.rb +24 -0
  606. data/lib/stripe/resources/account.rb +1007 -20
  607. data/lib/stripe/resources/account_link.rb +17 -0
  608. data/lib/stripe/resources/account_session.rb +658 -0
  609. data/lib/stripe/resources/apple_pay_domain.rb +21 -0
  610. data/lib/stripe/resources/application.rb +28 -0
  611. data/lib/stripe/resources/application_fee.rb +55 -0
  612. data/lib/stripe/resources/application_fee_refund.rb +25 -0
  613. data/lib/stripe/resources/apps/secret.rb +41 -0
  614. data/lib/stripe/resources/balance.rb +325 -7
  615. data/lib/stripe/resources/balance_settings.rb +92 -0
  616. data/lib/stripe/resources/balance_transaction.rb +61 -0
  617. data/lib/stripe/resources/bank_account.rb +126 -4
  618. data/lib/stripe/resources/billing/alert.rb +55 -0
  619. data/lib/stripe/resources/billing/alert_triggered.rb +34 -0
  620. data/lib/stripe/resources/billing/credit_balance_summary.rb +88 -0
  621. data/lib/stripe/resources/billing/credit_balance_transaction.rb +151 -0
  622. data/lib/stripe/resources/billing/credit_grant.rb +108 -0
  623. data/lib/stripe/resources/billing/meter.rb +93 -0
  624. data/lib/stripe/resources/billing/meter_event.rb +23 -0
  625. data/lib/stripe/resources/billing/meter_event_adjustment.rb +33 -0
  626. data/lib/stripe/resources/billing/meter_event_summary.rb +25 -0
  627. data/lib/stripe/resources/billing_portal/configuration.rb +254 -0
  628. data/lib/stripe/resources/billing_portal/session.rb +200 -1
  629. data/lib/stripe/resources/capability.rb +140 -0
  630. data/lib/stripe/resources/card.rb +93 -0
  631. data/lib/stripe/resources/cash_balance.rb +33 -0
  632. data/lib/stripe/resources/charge.rb +2221 -7
  633. data/lib/stripe/resources/checkout/session.rb +2206 -6
  634. data/lib/stripe/resources/climate/order.rb +106 -0
  635. data/lib/stripe/resources/climate/product.rb +45 -0
  636. data/lib/stripe/resources/climate/supplier.rb +43 -0
  637. data/lib/stripe/resources/confirmation_token.rb +1679 -0
  638. data/lib/stripe/resources/connect_collection_transfer.rb +32 -0
  639. data/lib/stripe/resources/country_spec.rb +69 -1
  640. data/lib/stripe/resources/coupon.rb +70 -0
  641. data/lib/stripe/resources/credit_note.rb +213 -9
  642. data/lib/stripe/resources/credit_note_line_item.rb +111 -0
  643. data/lib/stripe/resources/customer.rb +228 -0
  644. data/lib/stripe/resources/customer_balance_transaction.rb +37 -0
  645. data/lib/stripe/resources/customer_cash_balance_transaction.rb +217 -0
  646. data/lib/stripe/resources/customer_session.rb +118 -3
  647. data/lib/stripe/resources/discount.rb +49 -0
  648. data/lib/stripe/resources/dispute.rb +405 -1
  649. data/lib/stripe/resources/entitlements/active_entitlement.rb +19 -0
  650. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +31 -0
  651. data/lib/stripe/resources/entitlements/feature.rb +23 -0
  652. data/lib/stripe/resources/ephemeral_key.rb +21 -0
  653. data/lib/stripe/resources/event.rb +74 -26
  654. data/lib/stripe/resources/exchange_rate.rb +25 -0
  655. data/lib/stripe/resources/file.rb +32 -1
  656. data/lib/stripe/resources/file_link.rb +27 -0
  657. data/lib/stripe/resources/financial_connections/account.rb +193 -0
  658. data/lib/stripe/resources/financial_connections/account_owner.rb +25 -0
  659. data/lib/stripe/resources/financial_connections/account_ownership.rb +17 -0
  660. data/lib/stripe/resources/financial_connections/session.rb +60 -0
  661. data/lib/stripe/resources/financial_connections/transaction.rb +47 -0
  662. data/lib/stripe/resources/forwarding/request.rb +111 -0
  663. data/lib/stripe/resources/funding_instructions.rb +502 -1
  664. data/lib/stripe/resources/identity/verification_report.rb +372 -0
  665. data/lib/stripe/resources/identity/verification_session.rb +290 -11
  666. data/lib/stripe/resources/invoice.rb +997 -34
  667. data/lib/stripe/resources/invoice_item.rb +160 -4
  668. data/lib/stripe/resources/invoice_line_item.rb +278 -1
  669. data/lib/stripe/resources/invoice_payment.rb +90 -0
  670. data/lib/stripe/resources/invoice_rendering_template.rb +25 -0
  671. data/lib/stripe/resources/issuing/authorization.rb +449 -8
  672. data/lib/stripe/resources/issuing/card.rb +264 -0
  673. data/lib/stripe/resources/issuing/cardholder.rb +242 -0
  674. data/lib/stripe/resources/issuing/dispute.rb +257 -3
  675. data/lib/stripe/resources/issuing/personalization_design.rb +87 -0
  676. data/lib/stripe/resources/issuing/physical_bundle.rb +39 -0
  677. data/lib/stripe/resources/issuing/token.rb +163 -0
  678. data/lib/stripe/resources/issuing/transaction.rb +363 -0
  679. data/lib/stripe/resources/line_item.rb +71 -0
  680. data/lib/stripe/resources/login_link.rb +17 -1
  681. data/lib/stripe/resources/mandate.rb +358 -0
  682. data/lib/stripe/resources/payment_intent.rb +2775 -23
  683. data/lib/stripe/resources/payment_link.rb +686 -0
  684. data/lib/stripe/resources/payment_method.rb +1536 -12
  685. data/lib/stripe/resources/payment_method_configuration.rb +1759 -0
  686. data/lib/stripe/resources/payment_method_domain.rb +209 -8
  687. data/lib/stripe/resources/payout.rb +81 -4
  688. data/lib/stripe/resources/person.rb +469 -2
  689. data/lib/stripe/resources/plan.rb +87 -1
  690. data/lib/stripe/resources/price.rb +192 -2
  691. data/lib/stripe/resources/product.rb +83 -0
  692. data/lib/stripe/resources/product_feature.rb +20 -0
  693. data/lib/stripe/resources/promotion_code.rb +86 -3
  694. data/lib/stripe/resources/quote.rb +510 -0
  695. data/lib/stripe/resources/radar/early_fraud_warning.rb +25 -0
  696. data/lib/stripe/resources/radar/value_list.rb +31 -0
  697. data/lib/stripe/resources/radar/value_list_item.rb +25 -0
  698. data/lib/stripe/resources/refund.rb +614 -0
  699. data/lib/stripe/resources/reporting/report_run.rb +60 -0
  700. data/lib/stripe/resources/reporting/report_type.rb +27 -0
  701. data/lib/stripe/resources/reserve_transaction.rb +30 -0
  702. data/lib/stripe/resources/reversal.rb +30 -1
  703. data/lib/stripe/resources/review.rb +77 -1
  704. data/lib/stripe/resources/setup_attempt.rb +589 -0
  705. data/lib/stripe/resources/setup_intent.rb +574 -3
  706. data/lib/stripe/resources/shipping_rate.rb +107 -0
  707. data/lib/stripe/resources/sigma/scheduled_query_run.rb +43 -0
  708. data/lib/stripe/resources/source.rb +885 -2
  709. data/lib/stripe/resources/source_mandate_notification.rb +98 -0
  710. data/lib/stripe/resources/source_transaction.rb +139 -0
  711. data/lib/stripe/resources/subscription.rb +606 -9
  712. data/lib/stripe/resources/subscription_item.rb +60 -5
  713. data/lib/stripe/resources/subscription_schedule.rb +526 -0
  714. data/lib/stripe/resources/tax/calculation.rb +273 -0
  715. data/lib/stripe/resources/tax/calculation_line_item.rb +90 -0
  716. data/lib/stripe/resources/tax/registration.rb +2189 -0
  717. data/lib/stripe/resources/tax/settings.rb +114 -0
  718. data/lib/stripe/resources/tax/transaction.rb +231 -0
  719. data/lib/stripe/resources/tax/transaction_line_item.rb +47 -0
  720. data/lib/stripe/resources/tax_code.rb +17 -0
  721. data/lib/stripe/resources/tax_deducted_at_source.rb +30 -0
  722. data/lib/stripe/resources/tax_id.rb +66 -0
  723. data/lib/stripe/resources/tax_rate.rb +63 -2
  724. data/lib/stripe/resources/terminal/configuration.rb +634 -0
  725. data/lib/stripe/resources/terminal/connection_token.rb +15 -0
  726. data/lib/stripe/resources/terminal/location.rb +112 -1
  727. data/lib/stripe/resources/terminal/reader.rb +605 -0
  728. data/lib/stripe/resources/test_helpers/test_clock.rb +53 -0
  729. data/lib/stripe/resources/token.rb +39 -2
  730. data/lib/stripe/resources/topup.rb +41 -0
  731. data/lib/stripe/resources/transfer.rb +44 -1
  732. data/lib/stripe/resources/treasury/credit_reversal.rb +49 -0
  733. data/lib/stripe/resources/treasury/debit_reversal.rb +64 -0
  734. data/lib/stripe/resources/treasury/financial_account.rb +145 -1
  735. data/lib/stripe/resources/treasury/financial_account_features.rb +381 -0
  736. data/lib/stripe/resources/treasury/inbound_transfer.rb +178 -0
  737. data/lib/stripe/resources/treasury/outbound_payment.rb +256 -0
  738. data/lib/stripe/resources/treasury/outbound_transfer.rb +236 -0
  739. data/lib/stripe/resources/treasury/received_credit.rb +214 -0
  740. data/lib/stripe/resources/treasury/received_debit.rb +177 -0
  741. data/lib/stripe/resources/treasury/transaction.rb +117 -0
  742. data/lib/stripe/resources/treasury/transaction_entry.rb +94 -0
  743. data/lib/stripe/resources/v2/amount.rb +9 -0
  744. data/lib/stripe/resources/v2/billing/meter_event.rb +26 -0
  745. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +37 -0
  746. data/lib/stripe/resources/v2/billing/meter_event_session.rb +22 -0
  747. data/lib/stripe/resources/v2/core/event.rb +67 -0
  748. data/lib/stripe/resources/v2/core/event_destination.rb +119 -0
  749. data/lib/stripe/resources/v2/core/event_notification.rb +62 -0
  750. data/lib/stripe/resources/v2/deleted_object.rb +21 -0
  751. data/lib/stripe/resources/webhook_endpoint.rb +35 -0
  752. data/lib/stripe/resources.rb +13 -4
  753. data/lib/stripe/services/account_external_account_service.rb +1 -1
  754. data/lib/stripe/services/account_login_link_service.rb +1 -1
  755. data/lib/stripe/services/account_service.rb +12 -12
  756. data/lib/stripe/services/application_fee_service.rb +1 -1
  757. data/lib/stripe/services/apps_service.rb +1 -1
  758. data/lib/stripe/services/balance_service.rb +1 -1
  759. data/lib/stripe/services/balance_settings_service.rb +30 -0
  760. data/lib/stripe/services/billing/meter_service.rb +1 -1
  761. data/lib/stripe/services/billing_portal_service.rb +1 -1
  762. data/lib/stripe/services/billing_service.rb +1 -1
  763. data/lib/stripe/services/charge_service.rb +4 -4
  764. data/lib/stripe/services/checkout/session_service.rb +8 -6
  765. data/lib/stripe/services/checkout_service.rb +1 -1
  766. data/lib/stripe/services/climate_service.rb +1 -1
  767. data/lib/stripe/services/credit_note_service.rb +8 -9
  768. data/lib/stripe/services/customer_balance_transaction_service.rb +3 -3
  769. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +2 -2
  770. data/lib/stripe/services/customer_payment_source_service.rb +1 -1
  771. data/lib/stripe/services/customer_service.rb +6 -6
  772. data/lib/stripe/services/dispute_service.rb +1 -1
  773. data/lib/stripe/services/entitlements_service.rb +1 -1
  774. data/lib/stripe/services/exchange_rate_service.rb +4 -0
  775. data/lib/stripe/services/file_service.rb +1 -1
  776. data/lib/stripe/services/financial_connections/account_service.rb +1 -1
  777. data/lib/stripe/services/financial_connections_service.rb +1 -1
  778. data/lib/stripe/services/forwarding_service.rb +1 -1
  779. data/lib/stripe/services/identity/verification_session_service.rb +5 -5
  780. data/lib/stripe/services/identity_service.rb +1 -1
  781. data/lib/stripe/services/invoice_payment_service.rb +28 -0
  782. data/lib/stripe/services/invoice_service.rb +34 -30
  783. data/lib/stripe/services/issuing/authorization_service.rb +4 -4
  784. data/lib/stripe/services/issuing/dispute_service.rb +2 -2
  785. data/lib/stripe/services/issuing_service.rb +1 -1
  786. data/lib/stripe/services/payment_intent_service.rb +20 -15
  787. data/lib/stripe/services/payment_link_service.rb +1 -1
  788. data/lib/stripe/services/payment_method_domain_service.rb +4 -4
  789. data/lib/stripe/services/payment_method_service.rb +9 -9
  790. data/lib/stripe/services/payout_service.rb +2 -2
  791. data/lib/stripe/services/plan_service.rb +1 -1
  792. data/lib/stripe/services/price_service.rb +3 -3
  793. data/lib/stripe/services/product_service.rb +2 -2
  794. data/lib/stripe/services/promotion_code_service.rb +2 -2
  795. data/lib/stripe/services/quote_service.rb +3 -3
  796. data/lib/stripe/services/radar/early_fraud_warning_service.rb +1 -1
  797. data/lib/stripe/services/radar_service.rb +1 -1
  798. data/lib/stripe/services/reporting_service.rb +1 -1
  799. data/lib/stripe/services/setup_intent_service.rb +3 -3
  800. data/lib/stripe/services/sigma_service.rb +1 -1
  801. data/lib/stripe/services/source_service.rb +2 -2
  802. data/lib/stripe/services/subscription_item_service.rb +0 -8
  803. data/lib/stripe/services/subscription_service.rb +19 -8
  804. data/lib/stripe/services/tax/calculation_service.rb +1 -1
  805. data/lib/stripe/services/tax/transaction_service.rb +1 -1
  806. data/lib/stripe/services/tax_service.rb +1 -1
  807. data/lib/stripe/services/terminal/location_service.rb +1 -1
  808. data/lib/stripe/services/terminal/reader_service.rb +33 -0
  809. data/lib/stripe/services/terminal_service.rb +1 -1
  810. data/lib/stripe/services/test_helpers/issuing_service.rb +1 -1
  811. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +22 -0
  812. data/lib/stripe/services/test_helpers/terminal_service.rb +1 -1
  813. data/lib/stripe/services/test_helpers/treasury_service.rb +1 -1
  814. data/lib/stripe/services/test_helpers_service.rb +1 -1
  815. data/lib/stripe/services/token_service.rb +1 -1
  816. data/lib/stripe/services/transfer_service.rb +2 -2
  817. data/lib/stripe/services/treasury/financial_account_service.rb +2 -2
  818. data/lib/stripe/services/treasury_service.rb +1 -1
  819. data/lib/stripe/services/v1_services.rb +7 -5
  820. data/lib/stripe/services/v2/billing_service.rb +4 -4
  821. data/lib/stripe/services/v2/core_service.rb +3 -3
  822. data/lib/stripe/services/v2_services.rb +1 -1
  823. data/lib/stripe/services.rb +2 -3
  824. data/lib/stripe/stripe_client.rb +10 -6
  825. data/lib/stripe/stripe_configuration.rb +1 -6
  826. data/lib/stripe/stripe_context.rb +68 -0
  827. data/lib/stripe/stripe_object.rb +57 -12
  828. data/lib/stripe/stripe_service.rb +3 -1
  829. data/lib/stripe/util.rb +34 -12
  830. data/lib/stripe/version.rb +1 -1
  831. data/lib/stripe/webhook.rb +1 -1
  832. data/lib/stripe.rb +6 -1
  833. data/rbi/stripe/resources/v2/core/event_notification.rbi +43 -0
  834. data/rbi/stripe/stripe_client.rbi +17 -0
  835. data/rbi/stripe.rbi +132984 -0
  836. metadata +612 -28
  837. data/CHANGELOG.md +0 -1589
  838. data/CODE_OF_CONDUCT.md +0 -77
  839. data/CONTRIBUTORS +0 -3
  840. data/Gemfile +0 -37
  841. data/History.txt +0 -1
  842. data/LICENSE +0 -21
  843. data/Makefile +0 -22
  844. data/OPENAPI_VERSION +0 -1
  845. data/README.md +0 -422
  846. data/Rakefile +0 -34
  847. data/VERSION +0 -1
  848. data/examples/README.md +0 -16
  849. data/examples/example_template.rb +0 -36
  850. data/examples/meter_event_stream.rb +0 -57
  851. data/examples/thinevent_webhook_handler.rb +0 -39
  852. data/justfile +0 -43
  853. data/lib/stripe/resources/usage_record.rb +0 -17
  854. data/lib/stripe/resources/usage_record_summary.rb +0 -12
  855. data/lib/stripe/resources/v2/event.rb +0 -13
  856. data/lib/stripe/resources/v2/event_destination.rb +0 -13
  857. data/lib/stripe/services/invoice_upcoming_lines_service.rb +0 -17
  858. data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -23
  859. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -19
  860. data/lib/stripe/thin_event.rb +0 -37
  861. data/stripe.gemspec +0 -44
@@ -26,7 +26,7 @@ module Stripe
26
26
  # Stripe applies any customer credit on the account before determining the
27
27
  # amount due for the invoice (i.e., the amount that will be actually
28
28
  # charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge
29
- # per currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the
29
+ # per currency](https://docs.stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the
30
30
  # invoice is automatically marked paid, and we add the amount due to the
31
31
  # customer's credit balance which is applied to the next invoice.
32
32
  #
@@ -49,6 +49,922 @@ module Stripe
49
49
 
50
50
  nested_resource_class_methods :line, operations: %i[list]
51
51
 
52
+ class AutomaticTax < Stripe::StripeObject
53
+ class Liability < Stripe::StripeObject
54
+ # The connected account being referenced when `type` is `account`.
55
+ attr_reader :account
56
+ # Type of the account referenced.
57
+ attr_reader :type
58
+
59
+ def self.inner_class_types
60
+ @inner_class_types = {}
61
+ end
62
+
63
+ def self.field_remappings
64
+ @field_remappings = {}
65
+ end
66
+ end
67
+ # If Stripe disabled automatic tax, this enum describes why.
68
+ attr_reader :disabled_reason
69
+ # Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
70
+ attr_reader :enabled
71
+ # 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.
72
+ attr_reader :liability
73
+ # The tax provider powering automatic tax.
74
+ attr_reader :provider
75
+ # The status of the most recent automated tax calculation for this invoice.
76
+ attr_reader :status
77
+
78
+ def self.inner_class_types
79
+ @inner_class_types = { liability: Liability }
80
+ end
81
+
82
+ def self.field_remappings
83
+ @field_remappings = {}
84
+ end
85
+ end
86
+
87
+ class ConfirmationSecret < Stripe::StripeObject
88
+ # The client_secret of the payment that Stripe creates for the invoice after finalization.
89
+ attr_reader :client_secret
90
+ # The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization
91
+ attr_reader :type
92
+
93
+ def self.inner_class_types
94
+ @inner_class_types = {}
95
+ end
96
+
97
+ def self.field_remappings
98
+ @field_remappings = {}
99
+ end
100
+ end
101
+
102
+ class CustomField < Stripe::StripeObject
103
+ # The name of the custom field.
104
+ attr_reader :name
105
+ # The value of the custom field.
106
+ attr_reader :value
107
+
108
+ def self.inner_class_types
109
+ @inner_class_types = {}
110
+ end
111
+
112
+ def self.field_remappings
113
+ @field_remappings = {}
114
+ end
115
+ end
116
+
117
+ class CustomerAddress < Stripe::StripeObject
118
+ # City, district, suburb, town, or village.
119
+ attr_reader :city
120
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
121
+ attr_reader :country
122
+ # Address line 1, such as the street, PO Box, or company name.
123
+ attr_reader :line1
124
+ # Address line 2, such as the apartment, suite, unit, or building.
125
+ attr_reader :line2
126
+ # ZIP or postal code.
127
+ attr_reader :postal_code
128
+ # State, county, province, or region.
129
+ attr_reader :state
130
+
131
+ def self.inner_class_types
132
+ @inner_class_types = {}
133
+ end
134
+
135
+ def self.field_remappings
136
+ @field_remappings = {}
137
+ end
138
+ end
139
+
140
+ class CustomerShipping < Stripe::StripeObject
141
+ class Address < Stripe::StripeObject
142
+ # City, district, suburb, town, or village.
143
+ attr_reader :city
144
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
145
+ attr_reader :country
146
+ # Address line 1, such as the street, PO Box, or company name.
147
+ attr_reader :line1
148
+ # Address line 2, such as the apartment, suite, unit, or building.
149
+ attr_reader :line2
150
+ # ZIP or postal code.
151
+ attr_reader :postal_code
152
+ # State, county, province, or region.
153
+ attr_reader :state
154
+
155
+ def self.inner_class_types
156
+ @inner_class_types = {}
157
+ end
158
+
159
+ def self.field_remappings
160
+ @field_remappings = {}
161
+ end
162
+ end
163
+ # Attribute for field address
164
+ attr_reader :address
165
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
166
+ attr_reader :carrier
167
+ # Recipient name.
168
+ attr_reader :name
169
+ # Recipient phone (including extension).
170
+ attr_reader :phone
171
+ # 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.
172
+ attr_reader :tracking_number
173
+
174
+ def self.inner_class_types
175
+ @inner_class_types = { address: Address }
176
+ end
177
+
178
+ def self.field_remappings
179
+ @field_remappings = {}
180
+ end
181
+ end
182
+
183
+ class CustomerTaxId < Stripe::StripeObject
184
+ # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
185
+ attr_reader :type
186
+ # The value of the tax ID.
187
+ attr_reader :value
188
+
189
+ def self.inner_class_types
190
+ @inner_class_types = {}
191
+ end
192
+
193
+ def self.field_remappings
194
+ @field_remappings = {}
195
+ end
196
+ end
197
+
198
+ class FromInvoice < Stripe::StripeObject
199
+ # The relation between this invoice and the cloned invoice
200
+ attr_reader :action
201
+ # The invoice that was cloned.
202
+ attr_reader :invoice
203
+
204
+ def self.inner_class_types
205
+ @inner_class_types = {}
206
+ end
207
+
208
+ def self.field_remappings
209
+ @field_remappings = {}
210
+ end
211
+ end
212
+
213
+ class Issuer < Stripe::StripeObject
214
+ # The connected account being referenced when `type` is `account`.
215
+ attr_reader :account
216
+ # Type of the account referenced.
217
+ attr_reader :type
218
+
219
+ def self.inner_class_types
220
+ @inner_class_types = {}
221
+ end
222
+
223
+ def self.field_remappings
224
+ @field_remappings = {}
225
+ end
226
+ end
227
+
228
+ class LastFinalizationError < Stripe::StripeObject
229
+ # For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.
230
+ attr_reader :advice_code
231
+ # For card errors, the ID of the failed charge.
232
+ attr_reader :charge
233
+ # For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
234
+ attr_reader :code
235
+ # For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.
236
+ attr_reader :decline_code
237
+ # A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
238
+ attr_reader :doc_url
239
+ # A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
240
+ attr_reader :message
241
+ # For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
242
+ attr_reader :network_advice_code
243
+ # For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
244
+ attr_reader :network_decline_code
245
+ # If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
246
+ attr_reader :param
247
+ # A PaymentIntent guides you through the process of collecting a payment from your customer.
248
+ # We recommend that you create exactly one PaymentIntent for each order or
249
+ # customer session in your system. You can reference the PaymentIntent later to
250
+ # see the history of payment attempts for a particular session.
251
+ #
252
+ # A PaymentIntent transitions through
253
+ # [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)
254
+ # throughout its lifetime as it interfaces with Stripe.js to perform
255
+ # authentication flows and ultimately creates at most one successful charge.
256
+ #
257
+ # Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)
258
+ attr_reader :payment_intent
259
+ # PaymentMethod objects represent your customer's payment instruments.
260
+ # You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to
261
+ # Customer objects to store instrument details for future payments.
262
+ #
263
+ # Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
264
+ attr_reader :payment_method
265
+ # If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
266
+ attr_reader :payment_method_type
267
+ # A URL to the request log entry in your dashboard.
268
+ attr_reader :request_log_url
269
+ # A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
270
+ # For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
271
+ # Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.
272
+ #
273
+ # Create a SetupIntent when you're ready to collect your customer's payment credentials.
274
+ # Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
275
+ # The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides
276
+ # you through the setup process.
277
+ #
278
+ # Successful SetupIntents result in payment credentials that are optimized for future payments.
279
+ # For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through
280
+ # [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
281
+ # to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
282
+ # If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),
283
+ # it automatically attaches the resulting payment method to that Customer after successful setup.
284
+ # We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on
285
+ # PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.
286
+ #
287
+ # By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
288
+ #
289
+ # Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)
290
+ attr_reader :setup_intent
291
+ # Attribute for field source
292
+ attr_reader :source
293
+ # The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`
294
+ attr_reader :type
295
+
296
+ def self.inner_class_types
297
+ @inner_class_types = {}
298
+ end
299
+
300
+ def self.field_remappings
301
+ @field_remappings = {}
302
+ end
303
+ end
304
+
305
+ class Parent < Stripe::StripeObject
306
+ class QuoteDetails < Stripe::StripeObject
307
+ # The quote that generated this invoice
308
+ attr_reader :quote
309
+
310
+ def self.inner_class_types
311
+ @inner_class_types = {}
312
+ end
313
+
314
+ def self.field_remappings
315
+ @field_remappings = {}
316
+ end
317
+ end
318
+
319
+ class SubscriptionDetails < Stripe::StripeObject
320
+ # Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
321
+ # *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
322
+ attr_reader :metadata
323
+ # The subscription that generated this invoice
324
+ attr_reader :subscription
325
+ # Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
326
+ attr_reader :subscription_proration_date
327
+
328
+ def self.inner_class_types
329
+ @inner_class_types = {}
330
+ end
331
+
332
+ def self.field_remappings
333
+ @field_remappings = {}
334
+ end
335
+ end
336
+ # Details about the quote that generated this invoice
337
+ attr_reader :quote_details
338
+ # Details about the subscription that generated this invoice
339
+ attr_reader :subscription_details
340
+ # The type of parent that generated this invoice
341
+ attr_reader :type
342
+
343
+ def self.inner_class_types
344
+ @inner_class_types = {
345
+ quote_details: QuoteDetails,
346
+ subscription_details: SubscriptionDetails,
347
+ }
348
+ end
349
+
350
+ def self.field_remappings
351
+ @field_remappings = {}
352
+ end
353
+ end
354
+
355
+ class PaymentSettings < Stripe::StripeObject
356
+ class PaymentMethodOptions < Stripe::StripeObject
357
+ class AcssDebit < Stripe::StripeObject
358
+ class MandateOptions < Stripe::StripeObject
359
+ # Transaction type of the mandate.
360
+ attr_reader :transaction_type
361
+
362
+ def self.inner_class_types
363
+ @inner_class_types = {}
364
+ end
365
+
366
+ def self.field_remappings
367
+ @field_remappings = {}
368
+ end
369
+ end
370
+ # Attribute for field mandate_options
371
+ attr_reader :mandate_options
372
+ # Bank account verification method.
373
+ attr_reader :verification_method
374
+
375
+ def self.inner_class_types
376
+ @inner_class_types = { mandate_options: MandateOptions }
377
+ end
378
+
379
+ def self.field_remappings
380
+ @field_remappings = {}
381
+ end
382
+ end
383
+
384
+ class Bancontact < Stripe::StripeObject
385
+ # Preferred language of the Bancontact authorization page that the customer is redirected to.
386
+ attr_reader :preferred_language
387
+
388
+ def self.inner_class_types
389
+ @inner_class_types = {}
390
+ end
391
+
392
+ def self.field_remappings
393
+ @field_remappings = {}
394
+ end
395
+ end
396
+
397
+ class Card < Stripe::StripeObject
398
+ class Installments < Stripe::StripeObject
399
+ # Whether Installments are enabled for this Invoice.
400
+ attr_reader :enabled
401
+
402
+ def self.inner_class_types
403
+ @inner_class_types = {}
404
+ end
405
+
406
+ def self.field_remappings
407
+ @field_remappings = {}
408
+ end
409
+ end
410
+ # Attribute for field installments
411
+ attr_reader :installments
412
+ # 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. 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.
413
+ attr_reader :request_three_d_secure
414
+
415
+ def self.inner_class_types
416
+ @inner_class_types = { installments: Installments }
417
+ end
418
+
419
+ def self.field_remappings
420
+ @field_remappings = {}
421
+ end
422
+ end
423
+
424
+ class CustomerBalance < Stripe::StripeObject
425
+ class BankTransfer < Stripe::StripeObject
426
+ class EuBankTransfer < Stripe::StripeObject
427
+ # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
428
+ attr_reader :country
429
+
430
+ def self.inner_class_types
431
+ @inner_class_types = {}
432
+ end
433
+
434
+ def self.field_remappings
435
+ @field_remappings = {}
436
+ end
437
+ end
438
+ # Attribute for field eu_bank_transfer
439
+ attr_reader :eu_bank_transfer
440
+ # The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
441
+ attr_reader :type
442
+
443
+ def self.inner_class_types
444
+ @inner_class_types = { eu_bank_transfer: EuBankTransfer }
445
+ end
446
+
447
+ def self.field_remappings
448
+ @field_remappings = {}
449
+ end
450
+ end
451
+ # Attribute for field bank_transfer
452
+ attr_reader :bank_transfer
453
+ # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
454
+ attr_reader :funding_type
455
+
456
+ def self.inner_class_types
457
+ @inner_class_types = { bank_transfer: BankTransfer }
458
+ end
459
+
460
+ def self.field_remappings
461
+ @field_remappings = {}
462
+ end
463
+ end
464
+
465
+ class Konbini < Stripe::StripeObject
466
+ def self.inner_class_types
467
+ @inner_class_types = {}
468
+ end
469
+
470
+ def self.field_remappings
471
+ @field_remappings = {}
472
+ end
473
+ end
474
+
475
+ class SepaDebit < Stripe::StripeObject
476
+ def self.inner_class_types
477
+ @inner_class_types = {}
478
+ end
479
+
480
+ def self.field_remappings
481
+ @field_remappings = {}
482
+ end
483
+ end
484
+
485
+ class UsBankAccount < Stripe::StripeObject
486
+ class FinancialConnections < Stripe::StripeObject
487
+ class Filters < Stripe::StripeObject
488
+ # The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
489
+ attr_reader :account_subcategories
490
+
491
+ def self.inner_class_types
492
+ @inner_class_types = {}
493
+ end
494
+
495
+ def self.field_remappings
496
+ @field_remappings = {}
497
+ end
498
+ end
499
+ # Attribute for field filters
500
+ attr_reader :filters
501
+ # The list of permissions to request. The `payment_method` permission must be included.
502
+ attr_reader :permissions
503
+ # Data features requested to be retrieved upon account creation.
504
+ attr_reader :prefetch
505
+
506
+ def self.inner_class_types
507
+ @inner_class_types = { filters: Filters }
508
+ end
509
+
510
+ def self.field_remappings
511
+ @field_remappings = {}
512
+ end
513
+ end
514
+ # Attribute for field financial_connections
515
+ attr_reader :financial_connections
516
+ # Bank account verification method.
517
+ attr_reader :verification_method
518
+
519
+ def self.inner_class_types
520
+ @inner_class_types = { financial_connections: FinancialConnections }
521
+ end
522
+
523
+ def self.field_remappings
524
+ @field_remappings = {}
525
+ end
526
+ end
527
+ # If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
528
+ attr_reader :acss_debit
529
+ # If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
530
+ attr_reader :bancontact
531
+ # If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
532
+ attr_reader :card
533
+ # If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
534
+ attr_reader :customer_balance
535
+ # If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
536
+ attr_reader :konbini
537
+ # If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
538
+ attr_reader :sepa_debit
539
+ # If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
540
+ attr_reader :us_bank_account
541
+
542
+ def self.inner_class_types
543
+ @inner_class_types = {
544
+ acss_debit: AcssDebit,
545
+ bancontact: Bancontact,
546
+ card: Card,
547
+ customer_balance: CustomerBalance,
548
+ konbini: Konbini,
549
+ sepa_debit: SepaDebit,
550
+ us_bank_account: UsBankAccount,
551
+ }
552
+ end
553
+
554
+ def self.field_remappings
555
+ @field_remappings = {}
556
+ end
557
+ end
558
+ # ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.
559
+ attr_reader :default_mandate
560
+ # Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
561
+ attr_reader :payment_method_options
562
+ # The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
563
+ attr_reader :payment_method_types
564
+
565
+ def self.inner_class_types
566
+ @inner_class_types = { payment_method_options: PaymentMethodOptions }
567
+ end
568
+
569
+ def self.field_remappings
570
+ @field_remappings = {}
571
+ end
572
+ end
573
+
574
+ class Rendering < Stripe::StripeObject
575
+ class Pdf < Stripe::StripeObject
576
+ # Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.
577
+ attr_reader :page_size
578
+
579
+ def self.inner_class_types
580
+ @inner_class_types = {}
581
+ end
582
+
583
+ def self.field_remappings
584
+ @field_remappings = {}
585
+ end
586
+ end
587
+ # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
588
+ attr_reader :amount_tax_display
589
+ # Invoice pdf rendering options
590
+ attr_reader :pdf
591
+ # ID of the rendering template that the invoice is formatted by.
592
+ attr_reader :template
593
+ # Version of the rendering template that the invoice is using.
594
+ attr_reader :template_version
595
+
596
+ def self.inner_class_types
597
+ @inner_class_types = { pdf: Pdf }
598
+ end
599
+
600
+ def self.field_remappings
601
+ @field_remappings = {}
602
+ end
603
+ end
604
+
605
+ class ShippingCost < Stripe::StripeObject
606
+ class Tax < Stripe::StripeObject
607
+ # Amount of tax applied for this rate.
608
+ attr_reader :amount
609
+ # Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
610
+ #
611
+ # Related guide: [Tax rates](/billing/taxes/tax-rates)
612
+ attr_reader :rate
613
+ # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
614
+ attr_reader :taxability_reason
615
+ # The amount on which tax is calculated, in cents (or local equivalent).
616
+ attr_reader :taxable_amount
617
+
618
+ def self.inner_class_types
619
+ @inner_class_types = {}
620
+ end
621
+
622
+ def self.field_remappings
623
+ @field_remappings = {}
624
+ end
625
+ end
626
+ # Total shipping cost before any taxes are applied.
627
+ attr_reader :amount_subtotal
628
+ # Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
629
+ attr_reader :amount_tax
630
+ # Total shipping cost after taxes are applied.
631
+ attr_reader :amount_total
632
+ # The ID of the ShippingRate for this invoice.
633
+ attr_reader :shipping_rate
634
+ # The taxes applied to the shipping rate.
635
+ attr_reader :taxes
636
+
637
+ def self.inner_class_types
638
+ @inner_class_types = { taxes: Tax }
639
+ end
640
+
641
+ def self.field_remappings
642
+ @field_remappings = {}
643
+ end
644
+ end
645
+
646
+ class ShippingDetails < Stripe::StripeObject
647
+ class Address < Stripe::StripeObject
648
+ # City, district, suburb, town, or village.
649
+ attr_reader :city
650
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
651
+ attr_reader :country
652
+ # Address line 1, such as the street, PO Box, or company name.
653
+ attr_reader :line1
654
+ # Address line 2, such as the apartment, suite, unit, or building.
655
+ attr_reader :line2
656
+ # ZIP or postal code.
657
+ attr_reader :postal_code
658
+ # State, county, province, or region.
659
+ attr_reader :state
660
+
661
+ def self.inner_class_types
662
+ @inner_class_types = {}
663
+ end
664
+
665
+ def self.field_remappings
666
+ @field_remappings = {}
667
+ end
668
+ end
669
+ # Attribute for field address
670
+ attr_reader :address
671
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
672
+ attr_reader :carrier
673
+ # Recipient name.
674
+ attr_reader :name
675
+ # Recipient phone (including extension).
676
+ attr_reader :phone
677
+ # 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.
678
+ attr_reader :tracking_number
679
+
680
+ def self.inner_class_types
681
+ @inner_class_types = { address: Address }
682
+ end
683
+
684
+ def self.field_remappings
685
+ @field_remappings = {}
686
+ end
687
+ end
688
+
689
+ class StatusTransitions < Stripe::StripeObject
690
+ # The time that the invoice draft was finalized.
691
+ attr_reader :finalized_at
692
+ # The time that the invoice was marked uncollectible.
693
+ attr_reader :marked_uncollectible_at
694
+ # The time that the invoice was paid.
695
+ attr_reader :paid_at
696
+ # The time that the invoice was voided.
697
+ attr_reader :voided_at
698
+
699
+ def self.inner_class_types
700
+ @inner_class_types = {}
701
+ end
702
+
703
+ def self.field_remappings
704
+ @field_remappings = {}
705
+ end
706
+ end
707
+
708
+ class ThresholdReason < Stripe::StripeObject
709
+ class ItemReason < Stripe::StripeObject
710
+ # The IDs of the line items that triggered the threshold invoice.
711
+ attr_reader :line_item_ids
712
+ # The quantity threshold boundary that applied to the given line item.
713
+ attr_reader :usage_gte
714
+
715
+ def self.inner_class_types
716
+ @inner_class_types = {}
717
+ end
718
+
719
+ def self.field_remappings
720
+ @field_remappings = {}
721
+ end
722
+ end
723
+ # The total invoice amount threshold boundary if it triggered the threshold invoice.
724
+ attr_reader :amount_gte
725
+ # Indicates which line items triggered a threshold invoice.
726
+ attr_reader :item_reasons
727
+
728
+ def self.inner_class_types
729
+ @inner_class_types = { item_reasons: ItemReason }
730
+ end
731
+
732
+ def self.field_remappings
733
+ @field_remappings = {}
734
+ end
735
+ end
736
+
737
+ class TotalDiscountAmount < Stripe::StripeObject
738
+ # The amount, in cents (or local equivalent), of the discount.
739
+ attr_reader :amount
740
+ # The discount that was applied to get this discount amount.
741
+ attr_reader :discount
742
+
743
+ def self.inner_class_types
744
+ @inner_class_types = {}
745
+ end
746
+
747
+ def self.field_remappings
748
+ @field_remappings = {}
749
+ end
750
+ end
751
+
752
+ class TotalPretaxCreditAmount < Stripe::StripeObject
753
+ # The amount, in cents (or local equivalent), of the pretax credit amount.
754
+ attr_reader :amount
755
+ # The credit balance transaction that was applied to get this pretax credit amount.
756
+ attr_reader :credit_balance_transaction
757
+ # The discount that was applied to get this pretax credit amount.
758
+ attr_reader :discount
759
+ # Type of the pretax credit amount referenced.
760
+ attr_reader :type
761
+
762
+ def self.inner_class_types
763
+ @inner_class_types = {}
764
+ end
765
+
766
+ def self.field_remappings
767
+ @field_remappings = {}
768
+ end
769
+ end
770
+
771
+ class TotalTax < Stripe::StripeObject
772
+ class TaxRateDetails < Stripe::StripeObject
773
+ # Attribute for field tax_rate
774
+ attr_reader :tax_rate
775
+
776
+ def self.inner_class_types
777
+ @inner_class_types = {}
778
+ end
779
+
780
+ def self.field_remappings
781
+ @field_remappings = {}
782
+ end
783
+ end
784
+ # The amount of the tax, in cents (or local equivalent).
785
+ attr_reader :amount
786
+ # Whether this tax is inclusive or exclusive.
787
+ attr_reader :tax_behavior
788
+ # Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
789
+ attr_reader :tax_rate_details
790
+ # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
791
+ attr_reader :taxability_reason
792
+ # The amount on which tax is calculated, in cents (or local equivalent).
793
+ attr_reader :taxable_amount
794
+ # The type of tax information.
795
+ attr_reader :type
796
+
797
+ def self.inner_class_types
798
+ @inner_class_types = { tax_rate_details: TaxRateDetails }
799
+ end
800
+
801
+ def self.field_remappings
802
+ @field_remappings = {}
803
+ end
804
+ end
805
+ # The country of the business associated with this invoice, most often the business creating the invoice.
806
+ attr_reader :account_country
807
+ # The public name of the business associated with this invoice, most often the business creating the invoice.
808
+ attr_reader :account_name
809
+ # The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
810
+ attr_reader :account_tax_ids
811
+ # Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.
812
+ attr_reader :amount_due
813
+ # Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
814
+ attr_reader :amount_overpaid
815
+ # The amount, in cents (or local equivalent), that was paid.
816
+ attr_reader :amount_paid
817
+ # The difference between amount_due and amount_paid, in cents (or local equivalent).
818
+ attr_reader :amount_remaining
819
+ # This is the sum of all the shipping amounts.
820
+ attr_reader :amount_shipping
821
+ # ID of the Connect Application that created the invoice.
822
+ attr_reader :application
823
+ # Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
824
+ attr_reader :attempt_count
825
+ # Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.
826
+ attr_reader :attempted
827
+ # Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.
828
+ attr_reader :auto_advance
829
+ # Attribute for field automatic_tax
830
+ attr_reader :automatic_tax
831
+ # The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized.
832
+ attr_reader :automatically_finalizes_at
833
+ # Indicates the reason why the invoice was created.
834
+ #
835
+ # * `manual`: Unrelated to a subscription, for example, created via the invoice editor.
836
+ # * `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
837
+ # * `subscription_create`: A new subscription was created.
838
+ # * `subscription_cycle`: A subscription advanced into a new period.
839
+ # * `subscription_threshold`: A subscription reached a billing threshold.
840
+ # * `subscription_update`: A subscription was updated.
841
+ # * `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.
842
+ attr_reader :billing_reason
843
+ # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
844
+ attr_reader :collection_method
845
+ # The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
846
+ attr_reader :confirmation_secret
847
+ # Time at which the object was created. Measured in seconds since the Unix epoch.
848
+ attr_reader :created
849
+ # 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).
850
+ attr_reader :currency
851
+ # Custom fields displayed on the invoice.
852
+ attr_reader :custom_fields
853
+ # The ID of the customer who will be billed.
854
+ attr_reader :customer
855
+ # The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
856
+ attr_reader :customer_address
857
+ # The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.
858
+ attr_reader :customer_email
859
+ # The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.
860
+ attr_reader :customer_name
861
+ # The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.
862
+ attr_reader :customer_phone
863
+ # The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.
864
+ attr_reader :customer_shipping
865
+ # The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.
866
+ attr_reader :customer_tax_exempt
867
+ # The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.
868
+ attr_reader :customer_tax_ids
869
+ # ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
870
+ attr_reader :default_payment_method
871
+ # ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
872
+ attr_reader :default_source
873
+ # The tax rates applied to this invoice, if any.
874
+ attr_reader :default_tax_rates
875
+ # An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
876
+ attr_reader :description
877
+ # The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
878
+ attr_reader :discounts
879
+ # The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.
880
+ attr_reader :due_date
881
+ # The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
882
+ attr_reader :effective_at
883
+ # Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
884
+ attr_reader :ending_balance
885
+ # Footer displayed on the invoice.
886
+ attr_reader :footer
887
+ # Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.
888
+ attr_reader :from_invoice
889
+ # The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
890
+ attr_reader :hosted_invoice_url
891
+ # Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`.
892
+ attr_reader :id
893
+ # The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
894
+ attr_reader :invoice_pdf
895
+ # Attribute for field issuer
896
+ attr_reader :issuer
897
+ # The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
898
+ attr_reader :last_finalization_error
899
+ # The ID of the most recent non-draft revision of this invoice
900
+ attr_reader :latest_revision
901
+ # The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.
902
+ attr_reader :lines
903
+ # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
904
+ attr_reader :livemode
905
+ # 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.
906
+ attr_reader :metadata
907
+ # The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.
908
+ attr_reader :next_payment_attempt
909
+ # A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
910
+ attr_reader :number
911
+ # String representing the object's type. Objects of the same type share the same value.
912
+ attr_reader :object
913
+ # The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
914
+ attr_reader :on_behalf_of
915
+ # The parent that generated this invoice
916
+ attr_reader :parent
917
+ # Attribute for field payment_settings
918
+ attr_reader :payment_settings
919
+ # Payments for this invoice
920
+ attr_reader :payments
921
+ # End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.
922
+ attr_reader :period_end
923
+ # Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.
924
+ attr_reader :period_start
925
+ # Total amount of all post-payment credit notes issued for this invoice.
926
+ attr_reader :post_payment_credit_notes_amount
927
+ # Total amount of all pre-payment credit notes issued for this invoice.
928
+ attr_reader :pre_payment_credit_notes_amount
929
+ # This is the transaction number that appears on email receipts sent for this invoice.
930
+ attr_reader :receipt_number
931
+ # The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
932
+ attr_reader :rendering
933
+ # The details of the cost of shipping, including the ShippingRate applied on the invoice.
934
+ attr_reader :shipping_cost
935
+ # Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.
936
+ attr_reader :shipping_details
937
+ # Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
938
+ attr_reader :starting_balance
939
+ # Extra information about an invoice for the customer's credit card statement.
940
+ attr_reader :statement_descriptor
941
+ # The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)
942
+ attr_reader :status
943
+ # Attribute for field status_transitions
944
+ attr_reader :status_transitions
945
+ # Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
946
+ attr_reader :subtotal
947
+ # The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
948
+ attr_reader :subtotal_excluding_tax
949
+ # ID of the test clock this invoice belongs to.
950
+ attr_reader :test_clock
951
+ # Attribute for field threshold_reason
952
+ attr_reader :threshold_reason
953
+ # Total after discounts and taxes.
954
+ attr_reader :total
955
+ # The aggregate amounts calculated per discount across all line items.
956
+ attr_reader :total_discount_amounts
957
+ # The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
958
+ attr_reader :total_excluding_tax
959
+ # Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
960
+ attr_reader :total_pretax_credit_amounts
961
+ # The aggregate tax information of all line items.
962
+ attr_reader :total_taxes
963
+ # Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
964
+ attr_reader :webhooks_delivered_at
965
+ # Always true for a deleted object
966
+ attr_reader :deleted
967
+
52
968
  # Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
53
969
  def add_lines(params = {}, opts = {})
54
970
  request_stripe_object(
@@ -69,16 +985,56 @@ module Stripe
69
985
  )
70
986
  end
71
987
 
72
- # This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or <a href="#send_invoice">send](https://stripe.com/docs/api#finalize_invoice) the invoice to your customers.
988
+ # Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
989
+ #
990
+ # For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
991
+ # to the invoice, increasing its amount_paid. When the invoice is fully paid, the
992
+ # invoice's status becomes paid.
993
+ #
994
+ # If the PaymentIntent's status is already succeeded when it's attached, it's
995
+ # credited to the invoice immediately.
996
+ #
997
+ # See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more.
998
+ def attach_payment(params = {}, opts = {})
999
+ request_stripe_object(
1000
+ method: :post,
1001
+ path: format("/v1/invoices/%<invoice>s/attach_payment", { invoice: CGI.escape(self["id"]) }),
1002
+ params: params,
1003
+ opts: opts
1004
+ )
1005
+ end
1006
+
1007
+ # Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
1008
+ #
1009
+ # For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
1010
+ # to the invoice, increasing its amount_paid. When the invoice is fully paid, the
1011
+ # invoice's status becomes paid.
1012
+ #
1013
+ # If the PaymentIntent's status is already succeeded when it's attached, it's
1014
+ # credited to the invoice immediately.
1015
+ #
1016
+ # See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more.
1017
+ def self.attach_payment(invoice, params = {}, opts = {})
1018
+ request_stripe_object(
1019
+ method: :post,
1020
+ path: format("/v1/invoices/%<invoice>s/attach_payment", { invoice: CGI.escape(invoice) }),
1021
+ params: params,
1022
+ opts: opts
1023
+ )
1024
+ end
1025
+
1026
+ # This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or <a href="#send_invoice">send](https://docs.stripe.com/api#finalize_invoice) the invoice to your customers.
73
1027
  def self.create(params = {}, opts = {})
74
1028
  request_stripe_object(method: :post, path: "/v1/invoices", params: params, opts: opts)
75
1029
  end
76
1030
 
77
- # At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.
1031
+ # At any time, you can preview the upcoming invoice for a subscription or subscription schedule. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.
78
1032
  #
79
- # Note that when you are viewing an upcoming invoice, you are simply viewing a preview the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount.
1033
+ # You can also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update.
1034
+ #
1035
+ # The recommended way to get only the prorations being previewed on the invoice is to consider line items where parent.subscription_item_details.proration is true.
80
1036
  #
81
- # You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.
1037
+ # Note that when you are viewing an upcoming invoice, you are simply viewing a preview the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount.
82
1038
  #
83
1039
  # Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions)
84
1040
  def self.create_preview(params = {}, opts = {})
@@ -90,7 +1046,7 @@ module Stripe
90
1046
  )
91
1047
  end
92
1048
 
93
- # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://stripe.com/docs/api#void_invoice).
1049
+ # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://docs.stripe.com/api#void_invoice).
94
1050
  def self.delete(invoice, params = {}, opts = {})
95
1051
  request_stripe_object(
96
1052
  method: :delete,
@@ -100,7 +1056,7 @@ module Stripe
100
1056
  )
101
1057
  end
102
1058
 
103
- # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://stripe.com/docs/api#void_invoice).
1059
+ # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://docs.stripe.com/api#void_invoice).
104
1060
  def delete(params = {}, opts = {})
105
1061
  request_stripe_object(
106
1062
  method: :delete,
@@ -135,16 +1091,6 @@ module Stripe
135
1091
  request_stripe_object(method: :get, path: "/v1/invoices", params: params, opts: opts)
136
1092
  end
137
1093
 
138
- # When retrieving an upcoming invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
139
- def self.list_upcoming_line_items(params = {}, opts = {})
140
- request_stripe_object(
141
- method: :get,
142
- path: "/v1/invoices/upcoming/lines",
143
- params: params,
144
- opts: opts
145
- )
146
- end
147
-
148
1094
  # Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
149
1095
  def mark_uncollectible(params = {}, opts = {})
150
1096
  request_stripe_object(
@@ -237,22 +1183,11 @@ module Stripe
237
1183
  )
238
1184
  end
239
1185
 
240
- # At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.
241
- #
242
- # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount.
243
- #
244
- # You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.
245
- #
246
- # Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions)
247
- def self.upcoming(params = {}, opts = {})
248
- request_stripe_object(method: :get, path: "/v1/invoices/upcoming", params: params, opts: opts)
249
- end
250
-
251
- # Draft invoices are fully editable. Once an invoice is [finalized](https://stripe.com/docs/billing/invoices/workflow#finalized),
1186
+ # Draft invoices are fully editable. Once an invoice is [finalized](https://docs.stripe.com/docs/billing/invoices/workflow#finalized),
252
1187
  # monetary values, as well as collection_method, become uneditable.
253
1188
  #
254
1189
  # If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,
255
- # sending reminders for, or [automatically reconciling](https://stripe.com/docs/billing/invoices/reconciliation) invoices, pass
1190
+ # sending reminders for, or [automatically reconciling](https://docs.stripe.com/docs/billing/invoices/reconciliation) invoices, pass
256
1191
  # auto_advance=false.
257
1192
  def self.update(invoice, params = {}, opts = {})
258
1193
  request_stripe_object(
@@ -283,9 +1218,9 @@ module Stripe
283
1218
  )
284
1219
  end
285
1220
 
286
- # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/docs/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.
1221
+ # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://docs.stripe.com/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.
287
1222
  #
288
- # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or <a href="#create_credit_note">credit note](https://stripe.com/docs/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.
1223
+ # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or <a href="#create_credit_note">credit note](https://docs.stripe.com/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.
289
1224
  def void_invoice(params = {}, opts = {})
290
1225
  request_stripe_object(
291
1226
  method: :post,
@@ -295,9 +1230,9 @@ module Stripe
295
1230
  )
296
1231
  end
297
1232
 
298
- # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/docs/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.
1233
+ # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://docs.stripe.com/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.
299
1234
  #
300
- # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or <a href="#create_credit_note">credit note](https://stripe.com/docs/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.
1235
+ # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or <a href="#create_credit_note">credit note](https://docs.stripe.com/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.
301
1236
  def self.void_invoice(invoice, params = {}, opts = {})
302
1237
  request_stripe_object(
303
1238
  method: :post,
@@ -306,5 +1241,33 @@ module Stripe
306
1241
  opts: opts
307
1242
  )
308
1243
  end
1244
+
1245
+ def self.inner_class_types
1246
+ @inner_class_types = {
1247
+ automatic_tax: AutomaticTax,
1248
+ confirmation_secret: ConfirmationSecret,
1249
+ custom_fields: CustomField,
1250
+ customer_address: CustomerAddress,
1251
+ customer_shipping: CustomerShipping,
1252
+ customer_tax_ids: CustomerTaxId,
1253
+ from_invoice: FromInvoice,
1254
+ issuer: Issuer,
1255
+ last_finalization_error: LastFinalizationError,
1256
+ parent: Parent,
1257
+ payment_settings: PaymentSettings,
1258
+ rendering: Rendering,
1259
+ shipping_cost: ShippingCost,
1260
+ shipping_details: ShippingDetails,
1261
+ status_transitions: StatusTransitions,
1262
+ threshold_reason: ThresholdReason,
1263
+ total_discount_amounts: TotalDiscountAmount,
1264
+ total_pretax_credit_amounts: TotalPretaxCreditAmount,
1265
+ total_taxes: TotalTax,
1266
+ }
1267
+ end
1268
+
1269
+ def self.field_remappings
1270
+ @field_remappings = {}
1271
+ end
309
1272
  end
310
1273
  end