stripe 15.5.0 → 16.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1252) hide show
  1. checksums.yaml +4 -4
  2. data/lib/stripe/api_requestor.rb +5 -2
  3. data/lib/stripe/api_resource.rb +3 -0
  4. data/lib/stripe/api_version.rb +2 -2
  5. data/lib/stripe/event_types.rb +20 -6
  6. data/lib/stripe/events/unknown_event_notification.rb +19 -0
  7. data/lib/stripe/events/v1_billing_meter_error_report_triggered_event.rb +115 -15
  8. data/lib/stripe/events/v1_billing_meter_no_meter_found_event.rb +93 -6
  9. data/lib/stripe/events/v2_core_event_destination_ping_event.rb +35 -12
  10. data/lib/stripe/object_types.rb +3 -2
  11. data/lib/stripe/params/account_capability_list_params.rb +13 -0
  12. data/lib/stripe/params/account_capability_retrieve_params.rb +13 -0
  13. data/lib/stripe/params/account_capability_update_params.rb +18 -0
  14. data/lib/stripe/params/account_create_params.rb +2083 -0
  15. data/lib/stripe/params/account_delete_params.rb +6 -0
  16. data/lib/stripe/params/account_external_account_create_params.rb +134 -0
  17. data/lib/stripe/params/account_external_account_delete_params.rb +6 -0
  18. data/lib/stripe/params/account_external_account_list_params.rb +25 -0
  19. data/lib/stripe/params/account_external_account_retrieve_params.rb +13 -0
  20. data/lib/stripe/params/account_external_account_update_params.rb +91 -0
  21. data/lib/stripe/params/account_link_create_params.rb +52 -0
  22. data/lib/stripe/params/account_list_params.rb +42 -0
  23. data/lib/stripe/params/account_login_link_create_params.rb +13 -0
  24. data/lib/stripe/params/account_person_create_params.rb +435 -0
  25. data/lib/stripe/params/account_person_delete_params.rb +6 -0
  26. data/lib/stripe/params/account_person_list_params.rb +61 -0
  27. data/lib/stripe/params/account_person_retrieve_params.rb +13 -0
  28. data/lib/stripe/params/account_person_update_params.rb +435 -0
  29. data/lib/stripe/params/account_persons_params.rb +61 -0
  30. data/lib/stripe/params/account_reject_params.rb +16 -0
  31. data/lib/stripe/params/account_retrieve_current_params.rb +13 -0
  32. data/lib/stripe/params/account_retrieve_params.rb +13 -0
  33. data/lib/stripe/params/account_session_create_params.rb +598 -0
  34. data/lib/stripe/params/account_update_params.rb +2030 -0
  35. data/lib/stripe/params/apple_pay_domain_create_params.rb +16 -0
  36. data/lib/stripe/params/apple_pay_domain_delete_params.rb +6 -0
  37. data/lib/stripe/params/apple_pay_domain_list_params.rb +31 -0
  38. data/lib/stripe/params/apple_pay_domain_retrieve_params.rb +13 -0
  39. data/lib/stripe/params/application_fee_list_params.rb +52 -0
  40. data/lib/stripe/params/application_fee_refund_create_params.rb +19 -0
  41. data/lib/stripe/params/application_fee_refund_list_params.rb +22 -0
  42. data/lib/stripe/params/application_fee_refund_retrieve_params.rb +13 -0
  43. data/lib/stripe/params/application_fee_refund_update_params.rb +16 -0
  44. data/lib/stripe/params/application_fee_retrieve_params.rb +13 -0
  45. data/lib/stripe/params/apps/secret_create_params.rb +38 -0
  46. data/lib/stripe/params/apps/secret_delete_where_params.rb +32 -0
  47. data/lib/stripe/params/apps/secret_find_params.rb +32 -0
  48. data/lib/stripe/params/apps/secret_list_params.rb +38 -0
  49. data/lib/stripe/params/balance_retrieve_params.rb +13 -0
  50. data/lib/stripe/params/balance_settings_retrieve_params.rb +13 -0
  51. data/lib/stripe/params/balance_settings_update_params.rb +67 -0
  52. data/lib/stripe/params/balance_transaction_list_params.rb +64 -0
  53. data/lib/stripe/params/balance_transaction_retrieve_params.rb +13 -0
  54. data/lib/stripe/params/billing/alert_activate_params.rb +15 -0
  55. data/lib/stripe/params/billing/alert_archive_params.rb +15 -0
  56. data/lib/stripe/params/billing/alert_create_params.rb +52 -0
  57. data/lib/stripe/params/billing/alert_deactivate_params.rb +15 -0
  58. data/lib/stripe/params/billing/alert_list_params.rb +37 -0
  59. data/lib/stripe/params/billing/alert_retrieve_params.rb +15 -0
  60. data/lib/stripe/params/billing/credit_balance_summary_retrieve_params.rb +54 -0
  61. data/lib/stripe/params/billing/credit_balance_transaction_list_params.rb +37 -0
  62. data/lib/stripe/params/billing/credit_balance_transaction_retrieve_params.rb +15 -0
  63. data/lib/stripe/params/billing/credit_grant_create_params.rb +103 -0
  64. data/lib/stripe/params/billing/credit_grant_expire_params.rb +15 -0
  65. data/lib/stripe/params/billing/credit_grant_list_params.rb +33 -0
  66. data/lib/stripe/params/billing/credit_grant_retrieve_params.rb +15 -0
  67. data/lib/stripe/params/billing/credit_grant_update_params.rb +21 -0
  68. data/lib/stripe/params/billing/credit_grant_void_grant_params.rb +15 -0
  69. data/lib/stripe/params/billing/meter_create_params.rb +70 -0
  70. data/lib/stripe/params/billing/meter_deactivate_params.rb +15 -0
  71. data/lib/stripe/params/billing/meter_event_adjustment_create_params.rb +32 -0
  72. data/lib/stripe/params/billing/meter_event_create_params.rb +27 -0
  73. data/lib/stripe/params/billing/meter_event_summary_list_params.rb +45 -0
  74. data/lib/stripe/params/billing/meter_list_params.rb +27 -0
  75. data/lib/stripe/params/billing/meter_reactivate_params.rb +15 -0
  76. data/lib/stripe/params/billing/meter_retrieve_params.rb +15 -0
  77. data/lib/stripe/params/billing/meter_update_params.rb +18 -0
  78. data/lib/stripe/params/billing_portal/configuration_create_params.rb +225 -0
  79. data/lib/stripe/params/billing_portal/configuration_list_params.rb +37 -0
  80. data/lib/stripe/params/billing_portal/configuration_retrieve_params.rb +15 -0
  81. data/lib/stripe/params/billing_portal/configuration_update_params.rb +231 -0
  82. data/lib/stripe/params/billing_portal/session_create_params.rb +179 -0
  83. data/lib/stripe/params/charge_capture_params.rb +57 -0
  84. data/lib/stripe/params/charge_create_params.rb +172 -0
  85. data/lib/stripe/params/charge_list_params.rb +60 -0
  86. data/lib/stripe/params/charge_retrieve_params.rb +13 -0
  87. data/lib/stripe/params/charge_search_params.rb +22 -0
  88. data/lib/stripe/params/charge_update_params.rb +102 -0
  89. data/lib/stripe/params/checkout/session_create_params.rb +2445 -0
  90. data/lib/stripe/params/checkout/session_expire_params.rb +15 -0
  91. data/lib/stripe/params/checkout/session_line_item_list_params.rb +24 -0
  92. data/lib/stripe/params/checkout/session_list_line_items_params.rb +24 -0
  93. data/lib/stripe/params/checkout/session_list_params.rb +83 -0
  94. data/lib/stripe/params/checkout/session_retrieve_params.rb +15 -0
  95. data/lib/stripe/params/checkout/session_update_params.rb +179 -0
  96. data/lib/stripe/params/climate/order_cancel_params.rb +15 -0
  97. data/lib/stripe/params/climate/order_create_params.rb +49 -0
  98. data/lib/stripe/params/climate/order_list_params.rb +24 -0
  99. data/lib/stripe/params/climate/order_retrieve_params.rb +15 -0
  100. data/lib/stripe/params/climate/order_update_params.rb +29 -0
  101. data/lib/stripe/params/climate/product_list_params.rb +24 -0
  102. data/lib/stripe/params/climate/product_retrieve_params.rb +15 -0
  103. data/lib/stripe/params/climate/supplier_list_params.rb +24 -0
  104. data/lib/stripe/params/climate/supplier_retrieve_params.rb +15 -0
  105. data/lib/stripe/params/confirmation_token_create_params.rb +650 -0
  106. data/lib/stripe/params/confirmation_token_retrieve_params.rb +13 -0
  107. data/lib/stripe/params/country_spec_list_params.rb +22 -0
  108. data/lib/stripe/params/country_spec_retrieve_params.rb +13 -0
  109. data/lib/stripe/params/coupon_create_params.rb +80 -0
  110. data/lib/stripe/params/coupon_delete_params.rb +6 -0
  111. data/lib/stripe/params/coupon_list_params.rb +42 -0
  112. data/lib/stripe/params/coupon_retrieve_params.rb +13 -0
  113. data/lib/stripe/params/coupon_update_params.rb +30 -0
  114. data/lib/stripe/params/credit_note_create_params.rb +144 -0
  115. data/lib/stripe/params/credit_note_line_item_list_params.rb +22 -0
  116. data/lib/stripe/params/credit_note_list_params.rb +56 -0
  117. data/lib/stripe/params/credit_note_list_preview_line_items_params.rb +156 -0
  118. data/lib/stripe/params/credit_note_preview_lines_list_params.rb +156 -0
  119. data/lib/stripe/params/credit_note_preview_params.rb +144 -0
  120. data/lib/stripe/params/credit_note_retrieve_params.rb +13 -0
  121. data/lib/stripe/params/credit_note_update_params.rb +19 -0
  122. data/lib/stripe/params/credit_note_void_credit_note_params.rb +13 -0
  123. data/lib/stripe/params/customer_balance_transaction_create_params.rb +25 -0
  124. data/lib/stripe/params/customer_balance_transaction_list_params.rb +22 -0
  125. data/lib/stripe/params/customer_balance_transaction_retrieve_params.rb +13 -0
  126. data/lib/stripe/params/customer_balance_transaction_update_params.rb +19 -0
  127. data/lib/stripe/params/customer_cash_balance_retrieve_params.rb +13 -0
  128. data/lib/stripe/params/customer_cash_balance_transaction_list_params.rb +22 -0
  129. data/lib/stripe/params/customer_cash_balance_transaction_retrieve_params.rb +13 -0
  130. data/lib/stripe/params/customer_cash_balance_update_params.rb +24 -0
  131. data/lib/stripe/params/customer_create_funding_instructions_params.rb +46 -0
  132. data/lib/stripe/params/customer_create_params.rb +259 -0
  133. data/lib/stripe/params/customer_delete_discount_params.rb +6 -0
  134. data/lib/stripe/params/customer_delete_params.rb +6 -0
  135. data/lib/stripe/params/customer_fund_cash_balance_params.rb +22 -0
  136. data/lib/stripe/params/customer_funding_instructions_create_params.rb +46 -0
  137. data/lib/stripe/params/customer_list_params.rb +56 -0
  138. data/lib/stripe/params/customer_list_payment_methods_params.rb +35 -0
  139. data/lib/stripe/params/customer_payment_method_list_params.rb +35 -0
  140. data/lib/stripe/params/customer_payment_method_retrieve_params.rb +13 -0
  141. data/lib/stripe/params/customer_payment_source_create_params.rb +22 -0
  142. data/lib/stripe/params/customer_payment_source_delete_params.rb +13 -0
  143. data/lib/stripe/params/customer_payment_source_list_params.rb +25 -0
  144. data/lib/stripe/params/customer_payment_source_retrieve_params.rb +13 -0
  145. data/lib/stripe/params/customer_payment_source_update_params.rb +114 -0
  146. data/lib/stripe/params/customer_payment_source_verify_params.rb +16 -0
  147. data/lib/stripe/params/customer_retrieve_params.rb +13 -0
  148. data/lib/stripe/params/customer_retrieve_payment_method_params.rb +13 -0
  149. data/lib/stripe/params/customer_search_params.rb +22 -0
  150. data/lib/stripe/params/customer_session_create_params.rb +100 -0
  151. data/lib/stripe/params/customer_tax_id_create_params.rb +19 -0
  152. data/lib/stripe/params/customer_tax_id_delete_params.rb +6 -0
  153. data/lib/stripe/params/customer_tax_id_list_params.rb +22 -0
  154. data/lib/stripe/params/customer_tax_id_retrieve_params.rb +13 -0
  155. data/lib/stripe/params/customer_update_params.rb +243 -0
  156. data/lib/stripe/params/dispute_close_params.rb +13 -0
  157. data/lib/stripe/params/dispute_list_params.rb +56 -0
  158. data/lib/stripe/params/dispute_retrieve_params.rb +13 -0
  159. data/lib/stripe/params/dispute_update_params.rb +308 -0
  160. data/lib/stripe/params/entitlements/active_entitlement_list_params.rb +33 -0
  161. data/lib/stripe/params/entitlements/active_entitlement_retrieve_params.rb +15 -0
  162. data/lib/stripe/params/entitlements/feature_create_params.rb +24 -0
  163. data/lib/stripe/params/entitlements/feature_list_params.rb +37 -0
  164. data/lib/stripe/params/entitlements/feature_retrieve_params.rb +15 -0
  165. data/lib/stripe/params/entitlements/feature_update_params.rb +24 -0
  166. data/lib/stripe/params/ephemeral_key_create_params.rb +31 -0
  167. data/lib/stripe/params/ephemeral_key_delete_params.rb +13 -0
  168. data/lib/stripe/params/event_list_params.rb +60 -0
  169. data/lib/stripe/params/event_retrieve_params.rb +13 -0
  170. data/lib/stripe/params/exchange_rate_list_params.rb +22 -0
  171. data/lib/stripe/params/exchange_rate_retrieve_params.rb +13 -0
  172. data/lib/stripe/params/file_create_params.rb +36 -0
  173. data/lib/stripe/params/file_link_create_params.rb +22 -0
  174. data/lib/stripe/params/file_link_list_params.rb +56 -0
  175. data/lib/stripe/params/file_link_retrieve_params.rb +13 -0
  176. data/lib/stripe/params/file_link_update_params.rb +19 -0
  177. data/lib/stripe/params/file_list_params.rb +52 -0
  178. data/lib/stripe/params/file_retrieve_params.rb +13 -0
  179. data/lib/stripe/params/financial_connections/account_disconnect_params.rb +15 -0
  180. data/lib/stripe/params/financial_connections/account_list_owners_params.rb +33 -0
  181. data/lib/stripe/params/financial_connections/account_list_params.rb +48 -0
  182. data/lib/stripe/params/financial_connections/account_owner_list_params.rb +33 -0
  183. data/lib/stripe/params/financial_connections/account_refresh_account_params.rb +18 -0
  184. data/lib/stripe/params/financial_connections/account_refresh_params.rb +18 -0
  185. data/lib/stripe/params/financial_connections/account_retrieve_params.rb +15 -0
  186. data/lib/stripe/params/financial_connections/account_subscribe_params.rb +18 -0
  187. data/lib/stripe/params/financial_connections/account_unsubscribe_params.rb +18 -0
  188. data/lib/stripe/params/financial_connections/session_create_params.rb +65 -0
  189. data/lib/stripe/params/financial_connections/session_retrieve_params.rb +15 -0
  190. data/lib/stripe/params/financial_connections/transaction_list_params.rb +67 -0
  191. data/lib/stripe/params/financial_connections/transaction_retrieve_params.rb +15 -0
  192. data/lib/stripe/params/forwarding/request_create_params.rb +59 -0
  193. data/lib/stripe/params/forwarding/request_list_params.rb +44 -0
  194. data/lib/stripe/params/forwarding/request_retrieve_params.rb +15 -0
  195. data/lib/stripe/params/identity/verification_report_list_params.rb +62 -0
  196. data/lib/stripe/params/identity/verification_report_retrieve_params.rb +15 -0
  197. data/lib/stripe/params/identity/verification_session_cancel_params.rb +15 -0
  198. data/lib/stripe/params/identity/verification_session_create_params.rb +107 -0
  199. data/lib/stripe/params/identity/verification_session_list_params.rb +62 -0
  200. data/lib/stripe/params/identity/verification_session_redact_params.rb +15 -0
  201. data/lib/stripe/params/identity/verification_session_retrieve_params.rb +15 -0
  202. data/lib/stripe/params/identity/verification_session_update_params.rb +69 -0
  203. data/lib/stripe/params/invoice_add_lines_params.rb +231 -0
  204. data/lib/stripe/params/invoice_attach_payment_params.rb +16 -0
  205. data/lib/stripe/params/invoice_create_params.rb +589 -0
  206. data/lib/stripe/params/invoice_create_preview_params.rb +993 -0
  207. data/lib/stripe/params/invoice_delete_params.rb +6 -0
  208. data/lib/stripe/params/invoice_finalize_invoice_params.rb +16 -0
  209. data/lib/stripe/params/invoice_item_create_params.rb +145 -0
  210. data/lib/stripe/params/invoice_item_delete_params.rb +6 -0
  211. data/lib/stripe/params/invoice_item_list_params.rb +60 -0
  212. data/lib/stripe/params/invoice_item_retrieve_params.rb +13 -0
  213. data/lib/stripe/params/invoice_item_update_params.rb +129 -0
  214. data/lib/stripe/params/invoice_line_item_list_params.rb +22 -0
  215. data/lib/stripe/params/invoice_line_item_update_params.rb +217 -0
  216. data/lib/stripe/params/invoice_list_params.rb +86 -0
  217. data/lib/stripe/params/invoice_mark_uncollectible_params.rb +13 -0
  218. data/lib/stripe/params/invoice_pay_params.rb +41 -0
  219. data/lib/stripe/params/invoice_payment_list_params.rb +50 -0
  220. data/lib/stripe/params/invoice_payment_retrieve_params.rb +13 -0
  221. data/lib/stripe/params/invoice_remove_lines_params.rb +30 -0
  222. data/lib/stripe/params/invoice_rendering_template_archive_params.rb +13 -0
  223. data/lib/stripe/params/invoice_rendering_template_list_params.rb +25 -0
  224. data/lib/stripe/params/invoice_rendering_template_retrieve_params.rb +16 -0
  225. data/lib/stripe/params/invoice_rendering_template_unarchive_params.rb +13 -0
  226. data/lib/stripe/params/invoice_retrieve_params.rb +13 -0
  227. data/lib/stripe/params/invoice_search_params.rb +22 -0
  228. data/lib/stripe/params/invoice_send_invoice_params.rb +13 -0
  229. data/lib/stripe/params/invoice_update_lines_params.rb +231 -0
  230. data/lib/stripe/params/invoice_update_params.rb +557 -0
  231. data/lib/stripe/params/invoice_void_invoice_params.rb +13 -0
  232. data/lib/stripe/params/issuing/authorization_approve_params.rb +21 -0
  233. data/lib/stripe/params/issuing/authorization_capture_params.rb +265 -0
  234. data/lib/stripe/params/issuing/authorization_create_params.rb +357 -0
  235. data/lib/stripe/params/issuing/authorization_decline_params.rb +18 -0
  236. data/lib/stripe/params/issuing/authorization_expire_params.rb +15 -0
  237. data/lib/stripe/params/issuing/authorization_finalize_amount_params.rb +143 -0
  238. data/lib/stripe/params/issuing/authorization_increment_params.rb +21 -0
  239. data/lib/stripe/params/issuing/authorization_list_params.rb +62 -0
  240. data/lib/stripe/params/issuing/authorization_respond_params.rb +18 -0
  241. data/lib/stripe/params/issuing/authorization_retrieve_params.rb +15 -0
  242. data/lib/stripe/params/issuing/authorization_reverse_params.rb +18 -0
  243. data/lib/stripe/params/issuing/authorization_update_params.rb +18 -0
  244. data/lib/stripe/params/issuing/card_create_params.rb +213 -0
  245. data/lib/stripe/params/issuing/card_deliver_card_params.rb +15 -0
  246. data/lib/stripe/params/issuing/card_fail_card_params.rb +15 -0
  247. data/lib/stripe/params/issuing/card_list_params.rb +78 -0
  248. data/lib/stripe/params/issuing/card_retrieve_params.rb +15 -0
  249. data/lib/stripe/params/issuing/card_return_card_params.rb +15 -0
  250. data/lib/stripe/params/issuing/card_ship_card_params.rb +15 -0
  251. data/lib/stripe/params/issuing/card_submit_card_params.rb +15 -0
  252. data/lib/stripe/params/issuing/card_update_params.rb +181 -0
  253. data/lib/stripe/params/issuing/cardholder_create_params.rb +238 -0
  254. data/lib/stripe/params/issuing/cardholder_list_params.rb +66 -0
  255. data/lib/stripe/params/issuing/cardholder_retrieve_params.rb +15 -0
  256. data/lib/stripe/params/issuing/cardholder_update_params.rb +230 -0
  257. data/lib/stripe/params/issuing/dispute_create_params.rb +297 -0
  258. data/lib/stripe/params/issuing/dispute_list_params.rb +58 -0
  259. data/lib/stripe/params/issuing/dispute_retrieve_params.rb +15 -0
  260. data/lib/stripe/params/issuing/dispute_submit_params.rb +18 -0
  261. data/lib/stripe/params/issuing/dispute_update_params.rb +275 -0
  262. data/lib/stripe/params/issuing/personalization_design_activate_params.rb +15 -0
  263. data/lib/stripe/params/issuing/personalization_design_create_params.rb +75 -0
  264. data/lib/stripe/params/issuing/personalization_design_deactivate_params.rb +15 -0
  265. data/lib/stripe/params/issuing/personalization_design_list_params.rb +52 -0
  266. data/lib/stripe/params/issuing/personalization_design_reject_params.rb +29 -0
  267. data/lib/stripe/params/issuing/personalization_design_retrieve_params.rb +15 -0
  268. data/lib/stripe/params/issuing/personalization_design_update_params.rb +75 -0
  269. data/lib/stripe/params/issuing/physical_bundle_list_params.rb +37 -0
  270. data/lib/stripe/params/issuing/physical_bundle_retrieve_params.rb +15 -0
  271. data/lib/stripe/params/issuing/token_list_params.rb +58 -0
  272. data/lib/stripe/params/issuing/token_retrieve_params.rb +15 -0
  273. data/lib/stripe/params/issuing/token_update_params.rb +18 -0
  274. data/lib/stripe/params/issuing/transaction_create_force_capture_params.rb +316 -0
  275. data/lib/stripe/params/issuing/transaction_create_unlinked_refund_params.rb +316 -0
  276. data/lib/stripe/params/issuing/transaction_list_params.rb +62 -0
  277. data/lib/stripe/params/issuing/transaction_refund_params.rb +18 -0
  278. data/lib/stripe/params/issuing/transaction_retrieve_params.rb +15 -0
  279. data/lib/stripe/params/issuing/transaction_update_params.rb +18 -0
  280. data/lib/stripe/params/mandate_retrieve_params.rb +13 -0
  281. data/lib/stripe/params/payment_intent_apply_customer_balance_params.rb +23 -0
  282. data/lib/stripe/params/payment_intent_cancel_params.rb +16 -0
  283. data/lib/stripe/params/payment_intent_capture_params.rb +54 -0
  284. data/lib/stripe/params/payment_intent_confirm_params.rb +2379 -0
  285. data/lib/stripe/params/payment_intent_create_params.rb +2480 -0
  286. data/lib/stripe/params/payment_intent_increment_authorization_params.rb +48 -0
  287. data/lib/stripe/params/payment_intent_list_params.rb +52 -0
  288. data/lib/stripe/params/payment_intent_retrieve_params.rb +16 -0
  289. data/lib/stripe/params/payment_intent_search_params.rb +22 -0
  290. data/lib/stripe/params/payment_intent_update_params.rb +2353 -0
  291. data/lib/stripe/params/payment_intent_verify_microdeposits_params.rb +19 -0
  292. data/lib/stripe/params/payment_link_create_params.rb +776 -0
  293. data/lib/stripe/params/payment_link_line_item_list_params.rb +22 -0
  294. data/lib/stripe/params/payment_link_list_line_items_params.rb +22 -0
  295. data/lib/stripe/params/payment_link_list_params.rb +25 -0
  296. data/lib/stripe/params/payment_link_retrieve_params.rb +13 -0
  297. data/lib/stripe/params/payment_link_update_params.rb +564 -0
  298. data/lib/stripe/params/payment_method_attach_params.rb +16 -0
  299. data/lib/stripe/params/payment_method_configuration_create_params.rb +1135 -0
  300. data/lib/stripe/params/payment_method_configuration_list_params.rb +31 -0
  301. data/lib/stripe/params/payment_method_configuration_retrieve_params.rb +13 -0
  302. data/lib/stripe/params/payment_method_configuration_update_params.rb +1135 -0
  303. data/lib/stripe/params/payment_method_create_params.rb +583 -0
  304. data/lib/stripe/params/payment_method_detach_params.rb +13 -0
  305. data/lib/stripe/params/payment_method_domain_create_params.rb +19 -0
  306. data/lib/stripe/params/payment_method_domain_list_params.rb +35 -0
  307. data/lib/stripe/params/payment_method_domain_retrieve_params.rb +13 -0
  308. data/lib/stripe/params/payment_method_domain_update_params.rb +16 -0
  309. data/lib/stripe/params/payment_method_domain_validate_params.rb +13 -0
  310. data/lib/stripe/params/payment_method_list_params.rb +35 -0
  311. data/lib/stripe/params/payment_method_retrieve_params.rb +13 -0
  312. data/lib/stripe/params/payment_method_update_params.rb +120 -0
  313. data/lib/stripe/params/payout_cancel_params.rb +13 -0
  314. data/lib/stripe/params/payout_create_params.rb +51 -0
  315. data/lib/stripe/params/payout_list_params.rb +78 -0
  316. data/lib/stripe/params/payout_retrieve_params.rb +13 -0
  317. data/lib/stripe/params/payout_reverse_params.rb +16 -0
  318. data/lib/stripe/params/payout_update_params.rb +16 -0
  319. data/lib/stripe/params/plan_create_params.rb +158 -0
  320. data/lib/stripe/params/plan_delete_params.rb +6 -0
  321. data/lib/stripe/params/plan_list_params.rb +56 -0
  322. data/lib/stripe/params/plan_retrieve_params.rb +13 -0
  323. data/lib/stripe/params/plan_update_params.rb +35 -0
  324. data/lib/stripe/params/price_create_params.rb +278 -0
  325. data/lib/stripe/params/price_list_params.rb +87 -0
  326. data/lib/stripe/params/price_retrieve_params.rb +13 -0
  327. data/lib/stripe/params/price_search_params.rb +22 -0
  328. data/lib/stripe/params/price_update_params.rb +113 -0
  329. data/lib/stripe/params/product_create_params.rb +243 -0
  330. data/lib/stripe/params/product_delete_params.rb +6 -0
  331. data/lib/stripe/params/product_feature_create_params.rb +16 -0
  332. data/lib/stripe/params/product_feature_delete_params.rb +6 -0
  333. data/lib/stripe/params/product_feature_list_params.rb +22 -0
  334. data/lib/stripe/params/product_feature_retrieve_params.rb +13 -0
  335. data/lib/stripe/params/product_list_params.rb +68 -0
  336. data/lib/stripe/params/product_retrieve_params.rb +13 -0
  337. data/lib/stripe/params/product_search_params.rb +22 -0
  338. data/lib/stripe/params/product_update_params.rb +96 -0
  339. data/lib/stripe/params/promotion_code_create_params.rb +91 -0
  340. data/lib/stripe/params/promotion_code_list_params.rb +64 -0
  341. data/lib/stripe/params/promotion_code_retrieve_params.rb +13 -0
  342. data/lib/stripe/params/promotion_code_update_params.rb +38 -0
  343. data/lib/stripe/params/quote_accept_params.rb +13 -0
  344. data/lib/stripe/params/quote_cancel_params.rb +13 -0
  345. data/lib/stripe/params/quote_computed_upfront_line_items_list_params.rb +22 -0
  346. data/lib/stripe/params/quote_create_params.rb +301 -0
  347. data/lib/stripe/params/quote_finalize_quote_params.rb +16 -0
  348. data/lib/stripe/params/quote_line_item_list_params.rb +22 -0
  349. data/lib/stripe/params/quote_list_computed_upfront_line_items_params.rb +22 -0
  350. data/lib/stripe/params/quote_list_line_items_params.rb +22 -0
  351. data/lib/stripe/params/quote_list_params.rb +39 -0
  352. data/lib/stripe/params/quote_pdf_params.rb +13 -0
  353. data/lib/stripe/params/quote_retrieve_params.rb +13 -0
  354. data/lib/stripe/params/quote_update_params.rb +263 -0
  355. data/lib/stripe/params/radar/early_fraud_warning_list_params.rb +58 -0
  356. data/lib/stripe/params/radar/early_fraud_warning_retrieve_params.rb +15 -0
  357. data/lib/stripe/params/radar/value_list_create_params.rb +27 -0
  358. data/lib/stripe/params/radar/value_list_delete_params.rb +8 -0
  359. data/lib/stripe/params/radar/value_list_item_create_params.rb +21 -0
  360. data/lib/stripe/params/radar/value_list_item_delete_params.rb +8 -0
  361. data/lib/stripe/params/radar/value_list_item_list_params.rb +58 -0
  362. data/lib/stripe/params/radar/value_list_item_retrieve_params.rb +15 -0
  363. data/lib/stripe/params/radar/value_list_list_params.rb +58 -0
  364. data/lib/stripe/params/radar/value_list_retrieve_params.rb +15 -0
  365. data/lib/stripe/params/radar/value_list_update_params.rb +24 -0
  366. data/lib/stripe/params/refund_cancel_params.rb +13 -0
  367. data/lib/stripe/params/refund_create_params.rb +59 -0
  368. data/lib/stripe/params/refund_expire_params.rb +13 -0
  369. data/lib/stripe/params/refund_list_params.rb +56 -0
  370. data/lib/stripe/params/refund_retrieve_params.rb +13 -0
  371. data/lib/stripe/params/refund_update_params.rb +16 -0
  372. data/lib/stripe/params/reporting/report_run_create_params.rb +59 -0
  373. data/lib/stripe/params/reporting/report_run_list_params.rb +44 -0
  374. data/lib/stripe/params/reporting/report_run_retrieve_params.rb +15 -0
  375. data/lib/stripe/params/reporting/report_type_list_params.rb +15 -0
  376. data/lib/stripe/params/reporting/report_type_retrieve_params.rb +15 -0
  377. data/lib/stripe/params/review_approve_params.rb +13 -0
  378. data/lib/stripe/params/review_list_params.rb +42 -0
  379. data/lib/stripe/params/review_retrieve_params.rb +13 -0
  380. data/lib/stripe/params/setup_attempt_list_params.rb +55 -0
  381. data/lib/stripe/params/setup_intent_cancel_params.rb +16 -0
  382. data/lib/stripe/params/setup_intent_confirm_params.rb +1050 -0
  383. data/lib/stripe/params/setup_intent_create_params.rb +1130 -0
  384. data/lib/stripe/params/setup_intent_list_params.rb +62 -0
  385. data/lib/stripe/params/setup_intent_retrieve_params.rb +16 -0
  386. data/lib/stripe/params/setup_intent_update_params.rb +1025 -0
  387. data/lib/stripe/params/setup_intent_verify_microdeposits_params.rb +19 -0
  388. data/lib/stripe/params/shipping_rate_create_params.rb +103 -0
  389. data/lib/stripe/params/shipping_rate_list_params.rb +56 -0
  390. data/lib/stripe/params/shipping_rate_retrieve_params.rb +13 -0
  391. data/lib/stripe/params/shipping_rate_update_params.rb +44 -0
  392. data/lib/stripe/params/sigma/scheduled_query_run_list_params.rb +24 -0
  393. data/lib/stripe/params/sigma/scheduled_query_run_retrieve_params.rb +15 -0
  394. data/lib/stripe/params/source_create_params.rb +317 -0
  395. data/lib/stripe/params/source_detach_params.rb +13 -0
  396. data/lib/stripe/params/source_retrieve_params.rb +16 -0
  397. data/lib/stripe/params/source_transaction_list_params.rb +22 -0
  398. data/lib/stripe/params/source_update_params.rb +259 -0
  399. data/lib/stripe/params/source_verify_params.rb +16 -0
  400. data/lib/stripe/params/subscription_cancel_params.rb +33 -0
  401. data/lib/stripe/params/subscription_create_params.rb +704 -0
  402. data/lib/stripe/params/subscription_delete_discount_params.rb +6 -0
  403. data/lib/stripe/params/subscription_item_create_params.rb +134 -0
  404. data/lib/stripe/params/subscription_item_delete_params.rb +19 -0
  405. data/lib/stripe/params/subscription_item_list_params.rb +31 -0
  406. data/lib/stripe/params/subscription_item_retrieve_params.rb +13 -0
  407. data/lib/stripe/params/subscription_item_update_params.rb +134 -0
  408. data/lib/stripe/params/subscription_list_params.rb +129 -0
  409. data/lib/stripe/params/subscription_migrate_params.rb +35 -0
  410. data/lib/stripe/params/subscription_resume_params.rb +27 -0
  411. data/lib/stripe/params/subscription_retrieve_params.rb +13 -0
  412. data/lib/stripe/params/subscription_schedule_cancel_params.rb +19 -0
  413. data/lib/stripe/params/subscription_schedule_create_params.rb +590 -0
  414. data/lib/stripe/params/subscription_schedule_list_params.rb +122 -0
  415. data/lib/stripe/params/subscription_schedule_release_params.rb +16 -0
  416. data/lib/stripe/params/subscription_schedule_retrieve_params.rb +13 -0
  417. data/lib/stripe/params/subscription_schedule_update_params.rb +562 -0
  418. data/lib/stripe/params/subscription_search_params.rb +22 -0
  419. data/lib/stripe/params/subscription_update_params.rb +683 -0
  420. data/lib/stripe/params/tax/calculation_create_params.rb +206 -0
  421. data/lib/stripe/params/tax/calculation_line_item_list_params.rb +24 -0
  422. data/lib/stripe/params/tax/calculation_list_line_items_params.rb +24 -0
  423. data/lib/stripe/params/tax/calculation_retrieve_params.rb +15 -0
  424. data/lib/stripe/params/tax/registration_create_params.rb +2018 -0
  425. data/lib/stripe/params/tax/registration_list_params.rb +27 -0
  426. data/lib/stripe/params/tax/registration_retrieve_params.rb +15 -0
  427. data/lib/stripe/params/tax/registration_update_params.rb +21 -0
  428. data/lib/stripe/params/tax/settings_retrieve_params.rb +15 -0
  429. data/lib/stripe/params/tax/settings_update_params.rb +71 -0
  430. data/lib/stripe/params/tax/transaction_create_from_calculation_params.rb +27 -0
  431. data/lib/stripe/params/tax/transaction_create_reversal_params.rb +87 -0
  432. data/lib/stripe/params/tax/transaction_line_item_list_params.rb +24 -0
  433. data/lib/stripe/params/tax/transaction_list_line_items_params.rb +24 -0
  434. data/lib/stripe/params/tax/transaction_retrieve_params.rb +15 -0
  435. data/lib/stripe/params/tax_code_list_params.rb +22 -0
  436. data/lib/stripe/params/tax_code_retrieve_params.rb +13 -0
  437. data/lib/stripe/params/tax_id_create_params.rb +36 -0
  438. data/lib/stripe/params/tax_id_delete_params.rb +6 -0
  439. data/lib/stripe/params/tax_id_list_params.rb +39 -0
  440. data/lib/stripe/params/tax_id_retrieve_params.rb +13 -0
  441. data/lib/stripe/params/tax_rate_create_params.rb +55 -0
  442. data/lib/stripe/params/tax_rate_list_params.rb +56 -0
  443. data/lib/stripe/params/tax_rate_retrieve_params.rb +13 -0
  444. data/lib/stripe/params/tax_rate_update_params.rb +47 -0
  445. data/lib/stripe/params/terminal/configuration_create_params.rb +593 -0
  446. data/lib/stripe/params/terminal/configuration_delete_params.rb +8 -0
  447. data/lib/stripe/params/terminal/configuration_list_params.rb +33 -0
  448. data/lib/stripe/params/terminal/configuration_retrieve_params.rb +15 -0
  449. data/lib/stripe/params/terminal/configuration_update_params.rb +593 -0
  450. data/lib/stripe/params/terminal/connection_token_create_params.rb +18 -0
  451. data/lib/stripe/params/terminal/location_create_params.rb +153 -0
  452. data/lib/stripe/params/terminal/location_delete_params.rb +8 -0
  453. data/lib/stripe/params/terminal/location_list_params.rb +24 -0
  454. data/lib/stripe/params/terminal/location_retrieve_params.rb +15 -0
  455. data/lib/stripe/params/terminal/location_update_params.rb +153 -0
  456. data/lib/stripe/params/terminal/reader_cancel_action_params.rb +15 -0
  457. data/lib/stripe/params/terminal/reader_collect_inputs_params.rb +96 -0
  458. data/lib/stripe/params/terminal/reader_collect_payment_method_params.rb +51 -0
  459. data/lib/stripe/params/terminal/reader_confirm_payment_intent_params.rb +29 -0
  460. data/lib/stripe/params/terminal/reader_create_params.rb +27 -0
  461. data/lib/stripe/params/terminal/reader_delete_params.rb +8 -0
  462. data/lib/stripe/params/terminal/reader_list_params.rb +45 -0
  463. data/lib/stripe/params/terminal/reader_present_payment_method_params.rb +72 -0
  464. data/lib/stripe/params/terminal/reader_process_payment_intent_params.rb +55 -0
  465. data/lib/stripe/params/terminal/reader_process_setup_intent_params.rb +32 -0
  466. data/lib/stripe/params/terminal/reader_refund_payment_params.rb +53 -0
  467. data/lib/stripe/params/terminal/reader_retrieve_params.rb +15 -0
  468. data/lib/stripe/params/terminal/reader_set_reader_display_params.rb +52 -0
  469. data/lib/stripe/params/terminal/reader_succeed_input_collection_params.rb +18 -0
  470. data/lib/stripe/params/terminal/reader_timeout_input_collection_params.rb +15 -0
  471. data/lib/stripe/params/terminal/reader_update_params.rb +21 -0
  472. data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +652 -0
  473. data/lib/stripe/params/test_helpers/customer_fund_cash_balance_params.rb +24 -0
  474. data/lib/stripe/params/test_helpers/issuing/authorization_capture_params.rb +267 -0
  475. data/lib/stripe/params/test_helpers/issuing/authorization_create_params.rb +359 -0
  476. data/lib/stripe/params/test_helpers/issuing/authorization_expire_params.rb +17 -0
  477. data/lib/stripe/params/test_helpers/issuing/authorization_finalize_amount_params.rb +145 -0
  478. data/lib/stripe/params/test_helpers/issuing/authorization_increment_params.rb +23 -0
  479. data/lib/stripe/params/test_helpers/issuing/authorization_respond_params.rb +20 -0
  480. data/lib/stripe/params/test_helpers/issuing/authorization_reverse_params.rb +20 -0
  481. data/lib/stripe/params/test_helpers/issuing/card_deliver_card_params.rb +17 -0
  482. data/lib/stripe/params/test_helpers/issuing/card_fail_card_params.rb +17 -0
  483. data/lib/stripe/params/test_helpers/issuing/card_return_card_params.rb +17 -0
  484. data/lib/stripe/params/test_helpers/issuing/card_ship_card_params.rb +17 -0
  485. data/lib/stripe/params/test_helpers/issuing/card_submit_card_params.rb +17 -0
  486. data/lib/stripe/params/test_helpers/issuing/personalization_design_activate_params.rb +17 -0
  487. data/lib/stripe/params/test_helpers/issuing/personalization_design_deactivate_params.rb +17 -0
  488. data/lib/stripe/params/test_helpers/issuing/personalization_design_reject_params.rb +31 -0
  489. data/lib/stripe/params/test_helpers/issuing/transaction_create_force_capture_params.rb +318 -0
  490. data/lib/stripe/params/test_helpers/issuing/transaction_create_unlinked_refund_params.rb +318 -0
  491. data/lib/stripe/params/test_helpers/issuing/transaction_refund_params.rb +20 -0
  492. data/lib/stripe/params/test_helpers/refund_expire_params.rb +15 -0
  493. data/lib/stripe/params/test_helpers/terminal/reader_present_payment_method_params.rb +74 -0
  494. data/lib/stripe/params/test_helpers/terminal/reader_succeed_input_collection_params.rb +20 -0
  495. data/lib/stripe/params/test_helpers/terminal/reader_timeout_input_collection_params.rb +17 -0
  496. data/lib/stripe/params/test_helpers/test_clock_advance_params.rb +18 -0
  497. data/lib/stripe/params/test_helpers/test_clock_create_params.rb +21 -0
  498. data/lib/stripe/params/test_helpers/test_clock_delete_params.rb +8 -0
  499. data/lib/stripe/params/test_helpers/test_clock_list_params.rb +24 -0
  500. data/lib/stripe/params/test_helpers/test_clock_retrieve_params.rb +15 -0
  501. data/lib/stripe/params/test_helpers/treasury/inbound_transfer_fail_params.rb +28 -0
  502. data/lib/stripe/params/test_helpers/treasury/inbound_transfer_return_inbound_transfer_params.rb +17 -0
  503. data/lib/stripe/params/test_helpers/treasury/inbound_transfer_succeed_params.rb +17 -0
  504. data/lib/stripe/params/test_helpers/treasury/outbound_payment_fail_params.rb +17 -0
  505. data/lib/stripe/params/test_helpers/treasury/outbound_payment_post_params.rb +17 -0
  506. data/lib/stripe/params/test_helpers/treasury/outbound_payment_return_outbound_payment_params.rb +28 -0
  507. data/lib/stripe/params/test_helpers/treasury/outbound_payment_update_params.rb +57 -0
  508. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_fail_params.rb +17 -0
  509. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_post_params.rb +17 -0
  510. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_return_outbound_transfer_params.rb +28 -0
  511. data/lib/stripe/params/test_helpers/treasury/outbound_transfer_update_params.rb +57 -0
  512. data/lib/stripe/params/test_helpers/treasury/received_credit_create_params.rb +68 -0
  513. data/lib/stripe/params/test_helpers/treasury/received_debit_create_params.rb +68 -0
  514. data/lib/stripe/params/token_create_params.rb +1191 -0
  515. data/lib/stripe/params/token_retrieve_params.rb +13 -0
  516. data/lib/stripe/params/topup_cancel_params.rb +13 -0
  517. data/lib/stripe/params/topup_create_params.rb +43 -0
  518. data/lib/stripe/params/topup_list_params.rb +74 -0
  519. data/lib/stripe/params/topup_retrieve_params.rb +13 -0
  520. data/lib/stripe/params/topup_update_params.rb +19 -0
  521. data/lib/stripe/params/transfer_create_params.rb +47 -0
  522. data/lib/stripe/params/transfer_list_params.rb +56 -0
  523. data/lib/stripe/params/transfer_retrieve_params.rb +13 -0
  524. data/lib/stripe/params/transfer_reversal_create_params.rb +31 -0
  525. data/lib/stripe/params/transfer_reversal_list_params.rb +22 -0
  526. data/lib/stripe/params/transfer_reversal_retrieve_params.rb +13 -0
  527. data/lib/stripe/params/transfer_reversal_update_params.rb +16 -0
  528. data/lib/stripe/params/transfer_update_params.rb +19 -0
  529. data/lib/stripe/params/treasury/credit_reversal_create_params.rb +21 -0
  530. data/lib/stripe/params/treasury/credit_reversal_list_params.rb +41 -0
  531. data/lib/stripe/params/treasury/credit_reversal_retrieve_params.rb +15 -0
  532. data/lib/stripe/params/treasury/debit_reversal_create_params.rb +21 -0
  533. data/lib/stripe/params/treasury/debit_reversal_list_params.rb +45 -0
  534. data/lib/stripe/params/treasury/debit_reversal_retrieve_params.rb +15 -0
  535. data/lib/stripe/params/treasury/financial_account_close_params.rb +32 -0
  536. data/lib/stripe/params/treasury/financial_account_create_params.rb +201 -0
  537. data/lib/stripe/params/treasury/financial_account_features_retrieve_params.rb +15 -0
  538. data/lib/stripe/params/treasury/financial_account_features_update_params.rb +163 -0
  539. data/lib/stripe/params/treasury/financial_account_list_params.rb +54 -0
  540. data/lib/stripe/params/treasury/financial_account_retrieve_features_params.rb +15 -0
  541. data/lib/stripe/params/treasury/financial_account_retrieve_params.rb +15 -0
  542. data/lib/stripe/params/treasury/financial_account_update_features_params.rb +163 -0
  543. data/lib/stripe/params/treasury/financial_account_update_params.rb +216 -0
  544. data/lib/stripe/params/treasury/inbound_transfer_cancel_params.rb +15 -0
  545. data/lib/stripe/params/treasury/inbound_transfer_create_params.rb +45 -0
  546. data/lib/stripe/params/treasury/inbound_transfer_fail_params.rb +26 -0
  547. data/lib/stripe/params/treasury/inbound_transfer_list_params.rb +37 -0
  548. data/lib/stripe/params/treasury/inbound_transfer_retrieve_params.rb +15 -0
  549. data/lib/stripe/params/treasury/inbound_transfer_return_inbound_transfer_params.rb +15 -0
  550. data/lib/stripe/params/treasury/inbound_transfer_succeed_params.rb +15 -0
  551. data/lib/stripe/params/treasury/outbound_payment_cancel_params.rb +15 -0
  552. data/lib/stripe/params/treasury/outbound_payment_create_params.rb +190 -0
  553. data/lib/stripe/params/treasury/outbound_payment_fail_params.rb +15 -0
  554. data/lib/stripe/params/treasury/outbound_payment_list_params.rb +62 -0
  555. data/lib/stripe/params/treasury/outbound_payment_post_params.rb +15 -0
  556. data/lib/stripe/params/treasury/outbound_payment_retrieve_params.rb +15 -0
  557. data/lib/stripe/params/treasury/outbound_payment_return_outbound_payment_params.rb +26 -0
  558. data/lib/stripe/params/treasury/outbound_payment_update_params.rb +55 -0
  559. data/lib/stripe/params/treasury/outbound_transfer_cancel_params.rb +15 -0
  560. data/lib/stripe/params/treasury/outbound_transfer_create_params.rb +81 -0
  561. data/lib/stripe/params/treasury/outbound_transfer_fail_params.rb +15 -0
  562. data/lib/stripe/params/treasury/outbound_transfer_list_params.rb +37 -0
  563. data/lib/stripe/params/treasury/outbound_transfer_post_params.rb +15 -0
  564. data/lib/stripe/params/treasury/outbound_transfer_retrieve_params.rb +15 -0
  565. data/lib/stripe/params/treasury/outbound_transfer_return_outbound_transfer_params.rb +26 -0
  566. data/lib/stripe/params/treasury/outbound_transfer_update_params.rb +55 -0
  567. data/lib/stripe/params/treasury/received_credit_create_params.rb +66 -0
  568. data/lib/stripe/params/treasury/received_credit_list_params.rb +49 -0
  569. data/lib/stripe/params/treasury/received_credit_retrieve_params.rb +15 -0
  570. data/lib/stripe/params/treasury/received_debit_create_params.rb +66 -0
  571. data/lib/stripe/params/treasury/received_debit_list_params.rb +37 -0
  572. data/lib/stripe/params/treasury/received_debit_retrieve_params.rb +15 -0
  573. data/lib/stripe/params/treasury/transaction_entry_list_params.rb +84 -0
  574. data/lib/stripe/params/treasury/transaction_entry_retrieve_params.rb +15 -0
  575. data/lib/stripe/params/treasury/transaction_list_params.rb +92 -0
  576. data/lib/stripe/params/treasury/transaction_retrieve_params.rb +15 -0
  577. data/lib/stripe/params/v2/billing/meter_event_adjustment_create_params.rb +31 -0
  578. data/lib/stripe/params/v2/billing/meter_event_create_params.rb +33 -0
  579. data/lib/stripe/params/v2/billing/meter_event_session_create_params.rb +10 -0
  580. data/lib/stripe/params/v2/billing/meter_event_stream_create_params.rb +41 -0
  581. data/lib/stripe/params/v2/core/event_destination_create_params.rb +79 -0
  582. data/lib/stripe/params/v2/core/event_destination_delete_params.rb +10 -0
  583. data/lib/stripe/params/v2/core/event_destination_disable_params.rb +10 -0
  584. data/lib/stripe/params/v2/core/event_destination_enable_params.rb +10 -0
  585. data/lib/stripe/params/v2/core/event_destination_list_params.rb +20 -0
  586. data/lib/stripe/params/v2/core/event_destination_ping_params.rb +10 -0
  587. data/lib/stripe/params/v2/core/event_destination_retrieve_params.rb +17 -0
  588. data/lib/stripe/params/v2/core/event_destination_update_params.rb +47 -0
  589. data/lib/stripe/params/v2/core/event_list_params.rb +22 -0
  590. data/lib/stripe/params/v2/core/event_retrieve_params.rb +10 -0
  591. data/lib/stripe/params/webhook_endpoint_create_params.rb +39 -0
  592. data/lib/stripe/params/webhook_endpoint_delete_params.rb +6 -0
  593. data/lib/stripe/params/webhook_endpoint_list_params.rb +22 -0
  594. data/lib/stripe/params/webhook_endpoint_retrieve_params.rb +13 -0
  595. data/lib/stripe/params/webhook_endpoint_update_params.rb +35 -0
  596. data/lib/stripe/params.rb +588 -0
  597. data/lib/stripe/request_options.rb +14 -5
  598. data/lib/stripe/resources/account.rb +448 -4265
  599. data/lib/stripe/resources/account_link.rb +8 -47
  600. data/lib/stripe/resources/account_session.rb +340 -657
  601. data/lib/stripe/resources/apple_pay_domain.rb +8 -40
  602. data/lib/stripe/resources/application.rb +8 -0
  603. data/lib/stripe/resources/application_fee.rb +12 -44
  604. data/lib/stripe/resources/application_fee_refund.rb +8 -0
  605. data/lib/stripe/resources/apps/secret.rb +12 -112
  606. data/lib/stripe/resources/balance.rb +159 -0
  607. data/lib/stripe/resources/balance_settings.rb +92 -0
  608. data/lib/stripe/resources/balance_transaction.rb +12 -56
  609. data/lib/stripe/resources/bank_account.rb +40 -0
  610. data/lib/stripe/resources/billing/alert.rb +20 -100
  611. data/lib/stripe/resources/billing/alert_triggered.rb +8 -0
  612. data/lib/stripe/resources/billing/credit_balance_summary.rb +48 -0
  613. data/lib/stripe/resources/billing/credit_balance_transaction.rb +73 -29
  614. data/lib/stripe/resources/billing/credit_grant.rb +42 -151
  615. data/lib/stripe/resources/billing/meter.rb +40 -116
  616. data/lib/stripe/resources/billing/meter_event.rb +8 -20
  617. data/lib/stripe/resources/billing/meter_event_adjustment.rb +12 -22
  618. data/lib/stripe/resources/billing/meter_event_summary.rb +8 -0
  619. data/lib/stripe/resources/billing_portal/configuration.rb +120 -473
  620. data/lib/stripe/resources/billing_portal/session.rb +98 -170
  621. data/lib/stripe/resources/capability.rb +56 -0
  622. data/lib/stripe/resources/card.rb +17 -1
  623. data/lib/stripe/resources/cash_balance.rb +16 -0
  624. data/lib/stripe/resources/charge.rb +958 -414
  625. data/lib/stripe/resources/checkout/session.rb +1039 -2501
  626. data/lib/stripe/resources/climate/order.rb +28 -89
  627. data/lib/stripe/resources/climate/product.rb +13 -15
  628. data/lib/stripe/resources/climate/supplier.rb +13 -15
  629. data/lib/stripe/resources/confirmation_token.rb +895 -683
  630. data/lib/stripe/resources/connect_collection_transfer.rb +8 -0
  631. data/lib/stripe/resources/country_spec.rb +29 -15
  632. data/lib/stripe/resources/coupon.rb +19 -137
  633. data/lib/stripe/resources/credit_note.rb +66 -504
  634. data/lib/stripe/resources/credit_note_line_item.rb +44 -0
  635. data/lib/stripe/resources/customer.rb +81 -675
  636. data/lib/stripe/resources/customer_balance_transaction.rb +8 -0
  637. data/lib/stripe/resources/customer_cash_balance_transaction.rb +108 -0
  638. data/lib/stripe/resources/customer_session.rb +49 -93
  639. data/lib/stripe/resources/discount.rb +24 -4
  640. data/lib/stripe/resources/dispute.rb +159 -365
  641. data/lib/stripe/resources/entitlements/active_entitlement.rb +8 -26
  642. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +8 -0
  643. data/lib/stripe/resources/entitlements/feature.rb +8 -66
  644. data/lib/stripe/resources/ephemeral_key.rb +8 -8
  645. data/lib/stripe/resources/event.rb +20 -52
  646. data/lib/stripe/resources/exchange_rate.rb +18 -17
  647. data/lib/stripe/resources/file.rb +8 -79
  648. data/lib/stripe/resources/file_link.rb +8 -84
  649. data/lib/stripe/resources/financial_connections/account.rb +66 -110
  650. data/lib/stripe/resources/financial_connections/account_owner.rb +8 -0
  651. data/lib/stripe/resources/financial_connections/account_ownership.rb +8 -0
  652. data/lib/stripe/resources/financial_connections/session.rb +20 -55
  653. data/lib/stripe/resources/financial_connections/transaction.rb +12 -57
  654. data/lib/stripe/resources/forwarding/request.rb +48 -93
  655. data/lib/stripe/resources/funding_instructions.rb +217 -24
  656. data/lib/stripe/resources/identity/verification_report.rb +165 -56
  657. data/lib/stripe/resources/identity/verification_session.rb +124 -237
  658. data/lib/stripe/resources/invoice.rb +489 -2882
  659. data/lib/stripe/resources/invoice_item.rb +69 -309
  660. data/lib/stripe/resources/invoice_line_item.rb +126 -199
  661. data/lib/stripe/resources/invoice_payment.rb +20 -42
  662. data/lib/stripe/resources/invoice_rendering_template.rb +8 -38
  663. data/lib/stripe/resources/issuing/authorization.rb +173 -836
  664. data/lib/stripe/resources/issuing/card.rb +98 -499
  665. data/lib/stripe/resources/issuing/cardholder.rb +108 -514
  666. data/lib/stripe/resources/issuing/dispute.rb +93 -620
  667. data/lib/stripe/resources/issuing/personalization_design.rb +32 -221
  668. data/lib/stripe/resources/issuing/physical_bundle.rb +13 -28
  669. data/lib/stripe/resources/issuing/token.rb +57 -60
  670. data/lib/stripe/resources/issuing/transaction.rb +147 -696
  671. data/lib/stripe/resources/line_item.rb +24 -0
  672. data/lib/stripe/resources/login_link.rb +8 -0
  673. data/lib/stripe/resources/mandate.rb +225 -12
  674. data/lib/stripe/resources/payment_intent.rb +1129 -7346
  675. data/lib/stripe/resources/payment_link.rb +333 -1357
  676. data/lib/stripe/resources/payment_method.rb +807 -784
  677. data/lib/stripe/resources/payment_method_configuration.rb +940 -2311
  678. data/lib/stripe/resources/payment_method_domain.rb +107 -63
  679. data/lib/stripe/resources/payout.rb +12 -150
  680. data/lib/stripe/resources/person.rb +184 -4
  681. data/lib/stripe/resources/plan.rb +20 -235
  682. data/lib/stripe/resources/price.rb +66 -480
  683. data/lib/stripe/resources/product.rb +23 -411
  684. data/lib/stripe/resources/product_feature.rb +8 -0
  685. data/lib/stripe/resources/promotion_code.rb +40 -172
  686. data/lib/stripe/resources/quote.rb +219 -651
  687. data/lib/stripe/resources/radar/early_fraud_warning.rb +8 -51
  688. data/lib/stripe/resources/radar/value_list.rb +8 -92
  689. data/lib/stripe/resources/radar/value_list_item.rb +8 -68
  690. data/lib/stripe/resources/refund.rb +367 -152
  691. data/lib/stripe/resources/reporting/report_run.rb +12 -93
  692. data/lib/stripe/resources/reporting/report_type.rb +8 -8
  693. data/lib/stripe/resources/reserve_transaction.rb +8 -0
  694. data/lib/stripe/resources/reversal.rb +8 -0
  695. data/lib/stripe/resources/review.rb +20 -43
  696. data/lib/stripe/resources/setup_attempt.rb +286 -65
  697. data/lib/stripe/resources/setup_intent.rb +336 -3359
  698. data/lib/stripe/resources/shipping_rate.rb +44 -187
  699. data/lib/stripe/resources/sigma/scheduled_query_run.rb +13 -15
  700. data/lib/stripe/resources/source.rb +268 -583
  701. data/lib/stripe/resources/source_mandate_notification.rb +32 -0
  702. data/lib/stripe/resources/source_transaction.rb +54 -0
  703. data/lib/stripe/resources/subscription.rb +272 -1581
  704. data/lib/stripe/resources/subscription_item.rb +12 -298
  705. data/lib/stripe/resources/subscription_schedule.rb +236 -1282
  706. data/lib/stripe/resources/tax/calculation.rb +111 -220
  707. data/lib/stripe/resources/tax/calculation_line_item.rb +32 -0
  708. data/lib/stripe/resources/tax/registration.rb +1274 -2096
  709. data/lib/stripe/resources/tax/settings.rb +61 -64
  710. data/lib/stripe/resources/tax/transaction.rb +95 -122
  711. data/lib/stripe/resources/tax/transaction_line_item.rb +16 -0
  712. data/lib/stripe/resources/tax_code.rb +8 -17
  713. data/lib/stripe/resources/tax_deducted_at_source.rb +8 -0
  714. data/lib/stripe/resources/tax_id.rb +20 -65
  715. data/lib/stripe/resources/tax_rate.rb +12 -142
  716. data/lib/stripe/resources/terminal/configuration.rb +302 -1173
  717. data/lib/stripe/resources/terminal/connection_token.rb +8 -11
  718. data/lib/stripe/resources/terminal/location.rb +72 -126
  719. data/lib/stripe/resources/terminal/reader.rb +237 -501
  720. data/lib/stripe/resources/test_helpers/test_clock.rb +20 -43
  721. data/lib/stripe/resources/token.rb +8 -1191
  722. data/lib/stripe/resources/topup.rb +8 -132
  723. data/lib/stripe/resources/transfer.rb +8 -109
  724. data/lib/stripe/resources/treasury/credit_reversal.rb +12 -46
  725. data/lib/stripe/resources/treasury/debit_reversal.rb +20 -50
  726. data/lib/stripe/resources/treasury/financial_account.rb +55 -639
  727. data/lib/stripe/resources/treasury/financial_account_features.rb +192 -0
  728. data/lib/stripe/resources/treasury/inbound_transfer.rb +67 -115
  729. data/lib/stripe/resources/treasury/outbound_payment.rb +104 -334
  730. data/lib/stripe/resources/treasury/outbound_transfer.rb +95 -200
  731. data/lib/stripe/resources/treasury/received_credit.rb +78 -101
  732. data/lib/stripe/resources/treasury/received_debit.rb +70 -89
  733. data/lib/stripe/resources/treasury/transaction.rb +32 -82
  734. data/lib/stripe/resources/treasury/transaction_entry.rb +20 -74
  735. data/lib/stripe/resources/v2/billing/meter_event.rb +8 -0
  736. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +16 -0
  737. data/lib/stripe/resources/v2/billing/meter_event_session.rb +8 -0
  738. data/lib/stripe/resources/v2/core/event.rb +67 -0
  739. data/lib/stripe/resources/v2/core/event_destination.rb +119 -0
  740. data/lib/stripe/resources/v2/core/event_notification.rb +62 -0
  741. data/lib/stripe/resources/v2/deleted_object.rb +21 -0
  742. data/lib/stripe/resources/webhook_endpoint.rb +8 -85
  743. data/lib/stripe/resources.rb +4 -2
  744. data/lib/stripe/services/account_capability_service.rb +0 -32
  745. data/lib/stripe/services/account_external_account_service.rb +0 -249
  746. data/lib/stripe/services/account_link_service.rb +0 -48
  747. data/lib/stripe/services/account_login_link_service.rb +0 -9
  748. data/lib/stripe/services/account_person_service.rb +0 -958
  749. data/lib/stripe/services/account_service.rb +0 -4149
  750. data/lib/stripe/services/account_session_service.rb +0 -637
  751. data/lib/stripe/services/apple_pay_domain_service.rb +0 -50
  752. data/lib/stripe/services/application_fee_refund_service.rb +0 -54
  753. data/lib/stripe/services/application_fee_service.rb +0 -57
  754. data/lib/stripe/services/apps/secret_service.rb +0 -116
  755. data/lib/stripe/services/balance_service.rb +0 -9
  756. data/lib/stripe/services/balance_settings_service.rb +30 -0
  757. data/lib/stripe/services/balance_transaction_service.rb +0 -69
  758. data/lib/stripe/services/billing/alert_service.rb +0 -113
  759. data/lib/stripe/services/billing/credit_balance_summary_service.rb +0 -48
  760. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -40
  761. data/lib/stripe/services/billing/credit_grant_service.rb +0 -166
  762. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +0 -26
  763. data/lib/stripe/services/billing/meter_event_service.rb +0 -21
  764. data/lib/stripe/services/billing/meter_event_summary_service.rb +0 -39
  765. data/lib/stripe/services/billing/meter_service.rb +0 -130
  766. data/lib/stripe/services/billing_portal/configuration_service.rb +0 -486
  767. data/lib/stripe/services/billing_portal/session_service.rb +0 -173
  768. data/lib/stripe/services/charge_service.rb +0 -402
  769. data/lib/stripe/services/checkout/session_line_item_service.rb +0 -18
  770. data/lib/stripe/services/checkout/session_service.rb +0 -2494
  771. data/lib/stripe/services/climate/order_service.rb +0 -102
  772. data/lib/stripe/services/climate/product_service.rb +0 -27
  773. data/lib/stripe/services/climate/supplier_service.rb +0 -27
  774. data/lib/stripe/services/confirmation_token_service.rb +0 -9
  775. data/lib/stripe/services/country_spec_service.rb +0 -27
  776. data/lib/stripe/services/coupon_service.rb +0 -151
  777. data/lib/stripe/services/credit_note_line_item_service.rb +0 -18
  778. data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -152
  779. data/lib/stripe/services/credit_note_service.rb +0 -365
  780. data/lib/stripe/services/customer_balance_transaction_service.rb +0 -63
  781. data/lib/stripe/services/customer_cash_balance_service.rb +0 -29
  782. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +0 -27
  783. data/lib/stripe/services/customer_funding_instructions_service.rb +0 -42
  784. data/lib/stripe/services/customer_payment_method_service.rb +0 -40
  785. data/lib/stripe/services/customer_payment_source_service.rb +0 -179
  786. data/lib/stripe/services/customer_service.rb +0 -575
  787. data/lib/stripe/services/customer_session_service.rb +0 -96
  788. data/lib/stripe/services/customer_tax_id_service.rb +0 -44
  789. data/lib/stripe/services/dispute_service.rb +0 -374
  790. data/lib/stripe/services/entitlements/active_entitlement_service.rb +0 -36
  791. data/lib/stripe/services/entitlements/feature_service.rb +0 -76
  792. data/lib/stripe/services/ephemeral_key_service.rb +0 -36
  793. data/lib/stripe/services/event_service.rb +0 -65
  794. data/lib/stripe/services/exchange_rate_service.rb +4 -27
  795. data/lib/stripe/services/file_link_service.rb +0 -94
  796. data/lib/stripe/services/file_service.rb +0 -89
  797. data/lib/stripe/services/financial_connections/account_owner_service.rb +0 -27
  798. data/lib/stripe/services/financial_connections/account_service.rb +0 -96
  799. data/lib/stripe/services/financial_connections/session_service.rb +0 -68
  800. data/lib/stripe/services/financial_connections/transaction_service.rb +0 -70
  801. data/lib/stripe/services/forwarding/request_service.rb +0 -106
  802. data/lib/stripe/services/identity/verification_report_service.rb +0 -65
  803. data/lib/stripe/services/identity/verification_session_service.rb +0 -247
  804. data/lib/stripe/services/invoice_item_service.rb +0 -333
  805. data/lib/stripe/services/invoice_line_item_service.rb +0 -221
  806. data/lib/stripe/services/invoice_payment_service.rb +0 -55
  807. data/lib/stripe/services/invoice_rendering_template_service.rb +0 -51
  808. data/lib/stripe/services/invoice_service.rb +0 -2778
  809. data/lib/stripe/services/issuing/authorization_service.rb +0 -104
  810. data/lib/stripe/services/issuing/card_service.rb +0 -463
  811. data/lib/stripe/services/issuing/cardholder_service.rb +0 -525
  812. data/lib/stripe/services/issuing/dispute_service.rb +0 -633
  813. data/lib/stripe/services/issuing/personalization_design_service.rb +0 -193
  814. data/lib/stripe/services/issuing/physical_bundle_service.rb +0 -40
  815. data/lib/stripe/services/issuing/token_service.rb +0 -73
  816. data/lib/stripe/services/issuing/transaction_service.rb +0 -77
  817. data/lib/stripe/services/mandate_service.rb +0 -9
  818. data/lib/stripe/services/payment_intent_service.rb +0 -7332
  819. data/lib/stripe/services/payment_link_line_item_service.rb +0 -18
  820. data/lib/stripe/services/payment_link_service.rb +0 -1352
  821. data/lib/stripe/services/payment_method_configuration_service.rb +0 -2256
  822. data/lib/stripe/services/payment_method_domain_service.rb +0 -76
  823. data/lib/stripe/services/payment_method_service.rb +0 -762
  824. data/lib/stripe/services/payout_service.rb +0 -163
  825. data/lib/stripe/services/plan_service.rb +0 -248
  826. data/lib/stripe/services/price_service.rb +0 -493
  827. data/lib/stripe/services/product_feature_service.rb +0 -41
  828. data/lib/stripe/services/product_service.rb +0 -424
  829. data/lib/stripe/services/promotion_code_service.rb +1 -179
  830. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +0 -18
  831. data/lib/stripe/services/quote_line_item_service.rb +0 -18
  832. data/lib/stripe/services/quote_service.rb +0 -628
  833. data/lib/stripe/services/radar/early_fraud_warning_service.rb +0 -61
  834. data/lib/stripe/services/radar/value_list_item_service.rb +0 -78
  835. data/lib/stripe/services/radar/value_list_service.rb +0 -102
  836. data/lib/stripe/services/refund_service.rb +0 -137
  837. data/lib/stripe/services/reporting/report_run_service.rb +0 -106
  838. data/lib/stripe/services/reporting/report_type_service.rb +0 -18
  839. data/lib/stripe/services/review_service.rb +0 -56
  840. data/lib/stripe/services/setup_attempt_service.rb +0 -51
  841. data/lib/stripe/services/setup_intent_service.rb +0 -3275
  842. data/lib/stripe/services/shipping_rate_service.rb +0 -200
  843. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +0 -27
  844. data/lib/stripe/services/source_service.rb +0 -601
  845. data/lib/stripe/services/source_transaction_service.rb +0 -18
  846. data/lib/stripe/services/subscription_item_service.rb +0 -311
  847. data/lib/stripe/services/subscription_schedule_service.rb +0 -1295
  848. data/lib/stripe/services/subscription_service.rb +0 -1594
  849. data/lib/stripe/services/tax/calculation_line_item_service.rb +0 -18
  850. data/lib/stripe/services/tax/calculation_service.rb +0 -209
  851. data/lib/stripe/services/tax/registration_service.rb +0 -2063
  852. data/lib/stripe/services/tax/settings_service.rb +0 -74
  853. data/lib/stripe/services/tax/transaction_line_item_service.rb +0 -18
  854. data/lib/stripe/services/tax/transaction_service.rb +0 -111
  855. data/lib/stripe/services/tax_code_service.rb +0 -27
  856. data/lib/stripe/services/tax_id_service.rb +0 -78
  857. data/lib/stripe/services/tax_rate_service.rb +0 -155
  858. data/lib/stripe/services/terminal/configuration_service.rb +0 -1186
  859. data/lib/stripe/services/terminal/connection_token_service.rb +0 -12
  860. data/lib/stripe/services/terminal/location_service.rb +0 -143
  861. data/lib/stripe/services/terminal/reader_service.rb +0 -427
  862. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +0 -641
  863. data/lib/stripe/services/test_helpers/customer_service.rb +0 -18
  864. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +0 -745
  865. data/lib/stripe/services/test_helpers/issuing/card_service.rb +0 -45
  866. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +0 -41
  867. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +0 -632
  868. data/lib/stripe/services/test_helpers/refund_service.rb +0 -9
  869. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -87
  870. data/lib/stripe/services/test_helpers/test_clock_service.rb +0 -56
  871. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +0 -38
  872. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +0 -87
  873. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +0 -87
  874. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +0 -60
  875. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +0 -60
  876. data/lib/stripe/services/token_service.rb +0 -1201
  877. data/lib/stripe/services/topup_service.rb +0 -142
  878. data/lib/stripe/services/transfer_reversal_service.rb +0 -66
  879. data/lib/stripe/services/transfer_service.rb +0 -119
  880. data/lib/stripe/services/treasury/credit_reversal_service.rb +0 -59
  881. data/lib/stripe/services/treasury/debit_reversal_service.rb +0 -63
  882. data/lib/stripe/services/treasury/financial_account_features_service.rb +0 -166
  883. data/lib/stripe/services/treasury/financial_account_service.rb +0 -488
  884. data/lib/stripe/services/treasury/inbound_transfer_service.rb +0 -88
  885. data/lib/stripe/services/treasury/outbound_payment_service.rb +0 -258
  886. data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -124
  887. data/lib/stripe/services/treasury/received_credit_service.rb +0 -52
  888. data/lib/stripe/services/treasury/received_debit_service.rb +0 -40
  889. data/lib/stripe/services/treasury/transaction_entry_service.rb +0 -87
  890. data/lib/stripe/services/treasury/transaction_service.rb +0 -95
  891. data/lib/stripe/services/v1_services.rb +2 -1
  892. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +0 -23
  893. data/lib/stripe/services/v2/billing/meter_event_service.rb +0 -25
  894. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +0 -2
  895. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +0 -33
  896. data/lib/stripe/services/v2/core/event_destination_service.rb +0 -137
  897. data/lib/stripe/services/v2/core/event_service.rb +0 -16
  898. data/lib/stripe/services/webhook_endpoint_service.rb +0 -95
  899. data/lib/stripe/services.rb +1 -0
  900. data/lib/stripe/stripe_client.rb +8 -5
  901. data/lib/stripe/stripe_configuration.rb +1 -6
  902. data/lib/stripe/stripe_context.rb +68 -0
  903. data/lib/stripe/stripe_object.rb +33 -9
  904. data/lib/stripe/util.rb +24 -13
  905. data/lib/stripe/version.rb +1 -1
  906. data/lib/stripe.rb +3 -1
  907. data/rbi/stripe/resources/v2/core/event_notification.rbi +43 -0
  908. data/rbi/stripe/stripe_client.rbi +17 -0
  909. data/rbi/stripe.rbi +132984 -0
  910. metadata +600 -345
  911. data/API_VERSION +0 -1
  912. data/CHANGELOG.md +0 -1769
  913. data/CODE_OF_CONDUCT.md +0 -77
  914. data/CONTRIBUTING.md +0 -25
  915. data/CONTRIBUTORS +0 -3
  916. data/Gemfile +0 -41
  917. data/History.txt +0 -1
  918. data/LICENSE +0 -21
  919. data/Makefile +0 -22
  920. data/OPENAPI_VERSION +0 -1
  921. data/README.md +0 -426
  922. data/Rakefile +0 -34
  923. data/VERSION +0 -1
  924. data/examples/README.md +0 -16
  925. data/examples/example_template.rb +0 -36
  926. data/examples/meter_event_stream.rb +0 -57
  927. data/examples/thinevent_webhook_handler.rb +0 -39
  928. data/justfile +0 -43
  929. data/lib/stripe/resources/v2/event.rb +0 -41
  930. data/lib/stripe/resources/v2/event_destination.rb +0 -73
  931. data/lib/stripe/thin_event.rb +0 -37
  932. data/rbi/stripe/resources/account.rbi +0 -4991
  933. data/rbi/stripe/resources/account_link.rbi +0 -76
  934. data/rbi/stripe/resources/account_session.rbi +0 -1173
  935. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -88
  936. data/rbi/stripe/resources/application.rbi +0 -20
  937. data/rbi/stripe/resources/application_fee.rbi +0 -118
  938. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  939. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  940. data/rbi/stripe/resources/balance.rbi +0 -230
  941. data/rbi/stripe/resources/balance_transaction.rbi +0 -147
  942. data/rbi/stripe/resources/bank_account.rbi +0 -127
  943. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  944. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  945. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  946. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  947. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  948. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  949. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  950. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  951. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  952. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -712
  953. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  954. data/rbi/stripe/resources/capability.rbi +0 -125
  955. data/rbi/stripe/resources/card.rbi +0 -125
  956. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  957. data/rbi/stripe/resources/charge.rbi +0 -2136
  958. data/rbi/stripe/resources/checkout/session.rbi +0 -4105
  959. data/rbi/stripe/resources/climate/order.rbi +0 -245
  960. data/rbi/stripe/resources/climate/product.rbi +0 -75
  961. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  962. data/rbi/stripe/resources/confirmation_token.rbi +0 -1818
  963. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  964. data/rbi/stripe/resources/country_spec.rbi +0 -85
  965. data/rbi/stripe/resources/coupon.rbi +0 -250
  966. data/rbi/stripe/resources/credit_note.rbi +0 -752
  967. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  968. data/rbi/stripe/resources/customer.rbi +0 -993
  969. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  970. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  971. data/rbi/stripe/resources/customer_session.rbi +0 -200
  972. data/rbi/stripe/resources/discount.rbi +0 -53
  973. data/rbi/stripe/resources/dispute.rbi +0 -761
  974. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  975. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  976. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  977. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  978. data/rbi/stripe/resources/event.rbi +0 -137
  979. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  980. data/rbi/stripe/resources/file.rbi +0 -143
  981. data/rbi/stripe/resources/file_link.rbi +0 -141
  982. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  983. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  984. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  985. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  986. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  987. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  988. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  989. data/rbi/stripe/resources/identity/verification_report.rbi +0 -360
  990. data/rbi/stripe/resources/identity/verification_session.rbi +0 -564
  991. data/rbi/stripe/resources/invoice.rbi +0 -3894
  992. data/rbi/stripe/resources/invoice_item.rbi +0 -470
  993. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  994. data/rbi/stripe/resources/invoice_payment.rbi +0 -121
  995. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  996. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  997. data/rbi/stripe/resources/issuing/card.rbi +0 -749
  998. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  999. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  1000. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  1001. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  1002. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  1003. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  1004. data/rbi/stripe/resources/line_item.rbi +0 -72
  1005. data/rbi/stripe/resources/login_link.rbi +0 -19
  1006. data/rbi/stripe/resources/mandate.rbi +0 -191
  1007. data/rbi/stripe/resources/payment_intent.rbi +0 -10011
  1008. data/rbi/stripe/resources/payment_link.rbi +0 -1891
  1009. data/rbi/stripe/resources/payment_method.rbi +0 -1770
  1010. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3550
  1011. data/rbi/stripe/resources/payment_method_domain.rbi +0 -228
  1012. data/rbi/stripe/resources/payout.rbi +0 -307
  1013. data/rbi/stripe/resources/person.rbi +0 -401
  1014. data/rbi/stripe/resources/plan.rbi +0 -371
  1015. data/rbi/stripe/resources/price.rbi +0 -694
  1016. data/rbi/stripe/resources/product.rbi +0 -553
  1017. data/rbi/stripe/resources/product_feature.rbi +0 -26
  1018. data/rbi/stripe/resources/promotion_code.rbi +0 -264
  1019. data/rbi/stripe/resources/quote.rbi +0 -1137
  1020. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  1021. data/rbi/stripe/resources/radar/value_list.rbi +0 -168
  1022. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -129
  1023. data/rbi/stripe/resources/refund.rbi +0 -523
  1024. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  1025. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  1026. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  1027. data/rbi/stripe/resources/reversal.rbi +0 -51
  1028. data/rbi/stripe/resources/review.rbi +0 -154
  1029. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  1030. data/rbi/stripe/resources/setup_intent.rbi +0 -3974
  1031. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  1032. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  1033. data/rbi/stripe/resources/source.rbi +0 -1496
  1034. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  1035. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  1036. data/rbi/stripe/resources/subscription.rbi +0 -2154
  1037. data/rbi/stripe/resources/subscription_item.rbi +0 -404
  1038. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1795
  1039. data/rbi/stripe/resources/tax/calculation.rbi +0 -478
  1040. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -91
  1041. data/rbi/stripe/resources/tax/registration.rbi +0 -3216
  1042. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  1043. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  1044. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  1045. data/rbi/stripe/resources/tax_code.rbi +0 -44
  1046. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  1047. data/rbi/stripe/resources/tax_id.rbi +0 -165
  1048. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  1049. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1647
  1050. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  1051. data/rbi/stripe/resources/terminal/location.rbi +0 -222
  1052. data/rbi/stripe/resources/terminal/reader.rbi +0 -1016
  1053. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -132
  1054. data/rbi/stripe/resources/token.rbi +0 -1281
  1055. data/rbi/stripe/resources/topup.rbi +0 -222
  1056. data/rbi/stripe/resources/transfer.rbi +0 -199
  1057. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  1058. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  1059. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -869
  1060. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  1061. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  1062. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  1063. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  1064. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  1065. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  1066. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  1067. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  1068. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  1069. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  1070. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  1071. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  1072. data/rbi/stripe/resources/v2/event.rbi +0 -48
  1073. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  1074. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -168
  1075. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  1076. data/rbi/stripe/services/account_external_account_service.rbi +0 -304
  1077. data/rbi/stripe/services/account_link_service.rbi +0 -60
  1078. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  1079. data/rbi/stripe/services/account_person_service.rbi +0 -1007
  1080. data/rbi/stripe/services/account_service.rbi +0 -4281
  1081. data/rbi/stripe/services/account_session_service.rbi +0 -748
  1082. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -76
  1083. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  1084. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  1085. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  1086. data/rbi/stripe/services/apps_service.rbi +0 -9
  1087. data/rbi/stripe/services/balance_service.rbi +0 -21
  1088. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  1089. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  1090. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  1091. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  1092. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  1093. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  1094. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  1095. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  1096. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  1097. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -561
  1098. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  1099. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  1100. data/rbi/stripe/services/billing_service.rbi +0 -15
  1101. data/rbi/stripe/services/charge_service.rbi +0 -448
  1102. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  1103. data/rbi/stripe/services/checkout/session_service.rbi +0 -2697
  1104. data/rbi/stripe/services/checkout_service.rbi +0 -9
  1105. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  1106. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  1107. data/rbi/stripe/services/climate/supplier_service.rbi +0 -46
  1108. data/rbi/stripe/services/climate_service.rbi +0 -11
  1109. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  1110. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  1111. data/rbi/stripe/services/coupon_service.rbi +0 -194
  1112. data/rbi/stripe/services/credit_note_line_item_service.rbi +0 -31
  1113. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  1114. data/rbi/stripe/services/credit_note_service.rbi +0 -415
  1115. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  1116. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  1117. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  1118. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  1119. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  1120. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  1121. data/rbi/stripe/services/customer_service.rbi +0 -635
  1122. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  1123. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -70
  1124. data/rbi/stripe/services/dispute_service.rbi +0 -424
  1125. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  1126. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  1127. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  1128. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  1129. data/rbi/stripe/services/event_service.rbi +0 -83
  1130. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  1131. data/rbi/stripe/services/file_link_service.rbi +0 -124
  1132. data/rbi/stripe/services/file_service.rbi +0 -116
  1133. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  1134. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  1135. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  1136. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  1137. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  1138. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  1139. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  1140. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  1141. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -339
  1142. data/rbi/stripe/services/identity_service.rbi +0 -10
  1143. data/rbi/stripe/services/invoice_item_service.rbi +0 -366
  1144. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  1145. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  1146. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  1147. data/rbi/stripe/services/invoice_service.rbi +0 -3073
  1148. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  1149. data/rbi/stripe/services/issuing/card_service.rbi +0 -503
  1150. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  1151. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  1152. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  1153. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  1154. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  1155. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  1156. data/rbi/stripe/services/issuing_service.rbi +0 -16
  1157. data/rbi/stripe/services/mandate_service.rbi +0 -20
  1158. data/rbi/stripe/services/payment_intent_service.rbi +0 -8010
  1159. data/rbi/stripe/services/payment_link_line_item_service.rbi +0 -31
  1160. data/rbi/stripe/services/payment_link_service.rbi +0 -1441
  1161. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2487
  1162. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  1163. data/rbi/stripe/services/payment_method_service.rbi +0 -781
  1164. data/rbi/stripe/services/payout_service.rbi +0 -209
  1165. data/rbi/stripe/services/plan_service.rbi +0 -282
  1166. data/rbi/stripe/services/price_service.rbi +0 -546
  1167. data/rbi/stripe/services/product_feature_service.rbi +0 -67
  1168. data/rbi/stripe/services/product_service.rbi +0 -477
  1169. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  1170. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  1171. data/rbi/stripe/services/quote_line_item_service.rbi +0 -31
  1172. data/rbi/stripe/services/quote_service.rbi +0 -695
  1173. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  1174. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -109
  1175. data/rbi/stripe/services/radar/value_list_service.rbi +0 -141
  1176. data/rbi/stripe/services/radar_service.rbi +0 -11
  1177. data/rbi/stripe/services/refund_service.rbi +0 -185
  1178. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  1179. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  1180. data/rbi/stripe/services/reporting_service.rbi +0 -10
  1181. data/rbi/stripe/services/review_service.rbi +0 -84
  1182. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  1183. data/rbi/stripe/services/setup_intent_service.rbi +0 -3709
  1184. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  1185. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  1186. data/rbi/stripe/services/sigma_service.rbi +0 -9
  1187. data/rbi/stripe/services/source_service.rbi +0 -663
  1188. data/rbi/stripe/services/source_transaction_service.rbi +0 -31
  1189. data/rbi/stripe/services/subscription_item_service.rbi +0 -350
  1190. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1425
  1191. data/rbi/stripe/services/subscription_service.rbi +0 -1768
  1192. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +0 -33
  1193. data/rbi/stripe/services/tax/calculation_service.rbi +0 -234
  1194. data/rbi/stripe/services/tax/registration_service.rbi +0 -2278
  1195. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  1196. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +0 -33
  1197. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  1198. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  1199. data/rbi/stripe/services/tax_id_service.rbi +0 -110
  1200. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  1201. data/rbi/stripe/services/tax_service.rbi +0 -12
  1202. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1328
  1203. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  1204. data/rbi/stripe/services/terminal/location_service.rbi +0 -182
  1205. data/rbi/stripe/services/terminal/reader_service.rbi +0 -540
  1206. data/rbi/stripe/services/terminal_service.rbi +0 -12
  1207. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -746
  1208. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  1209. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  1210. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  1211. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  1212. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  1213. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  1214. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  1215. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -117
  1216. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  1217. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -90
  1218. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  1219. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  1220. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  1221. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  1222. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  1223. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  1224. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  1225. data/rbi/stripe/services/token_service.rbi +0 -1255
  1226. data/rbi/stripe/services/topup_service.rbi +0 -176
  1227. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  1228. data/rbi/stripe/services/transfer_service.rbi +0 -152
  1229. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  1230. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  1231. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  1232. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -566
  1233. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  1234. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  1235. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  1236. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  1237. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  1238. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  1239. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  1240. data/rbi/stripe/services/treasury_service.rbi +0 -18
  1241. data/rbi/stripe/services/v1_services.rbi +0 -77
  1242. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  1243. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  1244. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -18
  1245. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  1246. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  1247. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -192
  1248. data/rbi/stripe/services/v2/core/event_service.rbi +0 -36
  1249. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  1250. data/rbi/stripe/services/v2_services.rbi +0 -10
  1251. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -129
  1252. data/stripe.gemspec +0 -44
@@ -55,6 +55,14 @@ module Stripe
55
55
  attr_reader :account
56
56
  # Type of the account referenced.
57
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
58
66
  end
59
67
  # If Stripe disabled automatic tax, this enum describes why.
60
68
  attr_reader :disabled_reason
@@ -66,6 +74,14 @@ module Stripe
66
74
  attr_reader :provider
67
75
  # The status of the most recent automated tax calculation for this invoice.
68
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
69
85
  end
70
86
 
71
87
  class ConfirmationSecret < Stripe::StripeObject
@@ -73,6 +89,14 @@ module Stripe
73
89
  attr_reader :client_secret
74
90
  # The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization
75
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
76
100
  end
77
101
 
78
102
  class CustomField < Stripe::StripeObject
@@ -80,6 +104,14 @@ module Stripe
80
104
  attr_reader :name
81
105
  # The value of the custom field.
82
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
83
115
  end
84
116
 
85
117
  class CustomerAddress < Stripe::StripeObject
@@ -87,14 +119,22 @@ module Stripe
87
119
  attr_reader :city
88
120
  # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
89
121
  attr_reader :country
90
- # Address line 1 (e.g., street, PO Box, or company name).
122
+ # Address line 1, such as the street, PO Box, or company name.
91
123
  attr_reader :line1
92
- # Address line 2 (e.g., apartment, suite, unit, or building).
124
+ # Address line 2, such as the apartment, suite, unit, or building.
93
125
  attr_reader :line2
94
126
  # ZIP or postal code.
95
127
  attr_reader :postal_code
96
128
  # State, county, province, or region.
97
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
98
138
  end
99
139
 
100
140
  class CustomerShipping < Stripe::StripeObject
@@ -103,14 +143,22 @@ module Stripe
103
143
  attr_reader :city
104
144
  # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
105
145
  attr_reader :country
106
- # Address line 1 (e.g., street, PO Box, or company name).
146
+ # Address line 1, such as the street, PO Box, or company name.
107
147
  attr_reader :line1
108
- # Address line 2 (e.g., apartment, suite, unit, or building).
148
+ # Address line 2, such as the apartment, suite, unit, or building.
109
149
  attr_reader :line2
110
150
  # ZIP or postal code.
111
151
  attr_reader :postal_code
112
152
  # State, county, province, or region.
113
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
114
162
  end
115
163
  # Attribute for field address
116
164
  attr_reader :address
@@ -122,6 +170,14 @@ module Stripe
122
170
  attr_reader :phone
123
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.
124
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
125
181
  end
126
182
 
127
183
  class CustomerTaxId < Stripe::StripeObject
@@ -129,6 +185,14 @@ module Stripe
129
185
  attr_reader :type
130
186
  # The value of the tax ID.
131
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
132
196
  end
133
197
 
134
198
  class FromInvoice < Stripe::StripeObject
@@ -136,6 +200,14 @@ module Stripe
136
200
  attr_reader :action
137
201
  # The invoice that was cloned.
138
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
139
211
  end
140
212
 
141
213
  class Issuer < Stripe::StripeObject
@@ -143,6 +215,14 @@ module Stripe
143
215
  attr_reader :account
144
216
  # Type of the account referenced.
145
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
146
226
  end
147
227
 
148
228
  class LastFinalizationError < Stripe::StripeObject
@@ -212,12 +292,28 @@ module Stripe
212
292
  attr_reader :source
213
293
  # The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`
214
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
215
303
  end
216
304
 
217
305
  class Parent < Stripe::StripeObject
218
306
  class QuoteDetails < Stripe::StripeObject
219
307
  # The quote that generated this invoice
220
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
221
317
  end
222
318
 
223
319
  class SubscriptionDetails < Stripe::StripeObject
@@ -228,6 +324,14 @@ module Stripe
228
324
  attr_reader :subscription
229
325
  # Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
230
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
231
335
  end
232
336
  # Details about the quote that generated this invoice
233
337
  attr_reader :quote_details
@@ -235,6 +339,17 @@ module Stripe
235
339
  attr_reader :subscription_details
236
340
  # The type of parent that generated this invoice
237
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
238
353
  end
239
354
 
240
355
  class PaymentSettings < Stripe::StripeObject
@@ -243,27 +358,67 @@ module Stripe
243
358
  class MandateOptions < Stripe::StripeObject
244
359
  # Transaction type of the mandate.
245
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
246
369
  end
247
370
  # Attribute for field mandate_options
248
371
  attr_reader :mandate_options
249
372
  # Bank account verification method.
250
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
251
382
  end
252
383
 
253
384
  class Bancontact < Stripe::StripeObject
254
385
  # Preferred language of the Bancontact authorization page that the customer is redirected to.
255
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
256
395
  end
257
396
 
258
397
  class Card < Stripe::StripeObject
259
398
  class Installments < Stripe::StripeObject
260
399
  # Whether Installments are enabled for this Invoice.
261
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
262
409
  end
263
410
  # Attribute for field installments
264
411
  attr_reader :installments
265
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.
266
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
267
422
  end
268
423
 
269
424
  class CustomerBalance < Stripe::StripeObject
@@ -271,2956 +426,380 @@ module Stripe
271
426
  class EuBankTransfer < Stripe::StripeObject
272
427
  # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
273
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
274
437
  end
275
438
  # Attribute for field eu_bank_transfer
276
439
  attr_reader :eu_bank_transfer
277
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`.
278
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
279
450
  end
280
451
  # Attribute for field bank_transfer
281
452
  attr_reader :bank_transfer
282
453
  # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
283
454
  attr_reader :funding_type
284
- end
285
-
286
- class Konbini < Stripe::StripeObject; end
287
- class SepaDebit < Stripe::StripeObject; end
288
-
289
- class UsBankAccount < Stripe::StripeObject
290
- class FinancialConnections < Stripe::StripeObject
291
- class Filters < Stripe::StripeObject
292
- # The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
293
- attr_reader :account_subcategories
294
- end
295
- # Attribute for field filters
296
- attr_reader :filters
297
- # The list of permissions to request. The `payment_method` permission must be included.
298
- attr_reader :permissions
299
- # Data features requested to be retrieved upon account creation.
300
- attr_reader :prefetch
301
- end
302
- # Attribute for field financial_connections
303
- attr_reader :financial_connections
304
- # Bank account verification method.
305
- attr_reader :verification_method
306
- end
307
- # 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.
308
- attr_reader :acss_debit
309
- # If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
310
- attr_reader :bancontact
311
- # If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
312
- attr_reader :card
313
- # If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
314
- attr_reader :customer_balance
315
- # If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
316
- attr_reader :konbini
317
- # 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.
318
- attr_reader :sepa_debit
319
- # 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.
320
- attr_reader :us_bank_account
321
- end
322
- # 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.
323
- attr_reader :default_mandate
324
- # Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
325
- attr_reader :payment_method_options
326
- # 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).
327
- attr_reader :payment_method_types
328
- end
329
-
330
- class Rendering < Stripe::StripeObject
331
- class Pdf < Stripe::StripeObject
332
- # 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.
333
- attr_reader :page_size
334
- end
335
- # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
336
- attr_reader :amount_tax_display
337
- # Invoice pdf rendering options
338
- attr_reader :pdf
339
- # ID of the rendering template that the invoice is formatted by.
340
- attr_reader :template
341
- # Version of the rendering template that the invoice is using.
342
- attr_reader :template_version
343
- end
344
-
345
- class ShippingCost < Stripe::StripeObject
346
- class Tax < Stripe::StripeObject
347
- # Amount of tax applied for this rate.
348
- attr_reader :amount
349
- # 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.
350
- #
351
- # Related guide: [Tax rates](/billing/taxes/tax-rates)
352
- attr_reader :rate
353
- # 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.
354
- attr_reader :taxability_reason
355
- # The amount on which tax is calculated, in cents (or local equivalent).
356
- attr_reader :taxable_amount
357
- end
358
- # Total shipping cost before any taxes are applied.
359
- attr_reader :amount_subtotal
360
- # Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
361
- attr_reader :amount_tax
362
- # Total shipping cost after taxes are applied.
363
- attr_reader :amount_total
364
- # The ID of the ShippingRate for this invoice.
365
- attr_reader :shipping_rate
366
- # The taxes applied to the shipping rate.
367
- attr_reader :taxes
368
- end
369
-
370
- class ShippingDetails < Stripe::StripeObject
371
- class Address < Stripe::StripeObject
372
- # City, district, suburb, town, or village.
373
- attr_reader :city
374
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
375
- attr_reader :country
376
- # Address line 1 (e.g., street, PO Box, or company name).
377
- attr_reader :line1
378
- # Address line 2 (e.g., apartment, suite, unit, or building).
379
- attr_reader :line2
380
- # ZIP or postal code.
381
- attr_reader :postal_code
382
- # State, county, province, or region.
383
- attr_reader :state
384
- end
385
- # Attribute for field address
386
- attr_reader :address
387
- # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
388
- attr_reader :carrier
389
- # Recipient name.
390
- attr_reader :name
391
- # Recipient phone (including extension).
392
- attr_reader :phone
393
- # 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.
394
- attr_reader :tracking_number
395
- end
396
455
 
397
- class StatusTransitions < Stripe::StripeObject
398
- # The time that the invoice draft was finalized.
399
- attr_reader :finalized_at
400
- # The time that the invoice was marked uncollectible.
401
- attr_reader :marked_uncollectible_at
402
- # The time that the invoice was paid.
403
- attr_reader :paid_at
404
- # The time that the invoice was voided.
405
- attr_reader :voided_at
406
- end
407
-
408
- class ThresholdReason < Stripe::StripeObject
409
- class ItemReason < Stripe::StripeObject
410
- # The IDs of the line items that triggered the threshold invoice.
411
- attr_reader :line_item_ids
412
- # The quantity threshold boundary that applied to the given line item.
413
- attr_reader :usage_gte
414
- end
415
- # The total invoice amount threshold boundary if it triggered the threshold invoice.
416
- attr_reader :amount_gte
417
- # Indicates which line items triggered a threshold invoice.
418
- attr_reader :item_reasons
419
- end
420
-
421
- class TotalDiscountAmount < Stripe::StripeObject
422
- # The amount, in cents (or local equivalent), of the discount.
423
- attr_reader :amount
424
- # The discount that was applied to get this discount amount.
425
- attr_reader :discount
426
- end
427
-
428
- class TotalPretaxCreditAmount < Stripe::StripeObject
429
- # The amount, in cents (or local equivalent), of the pretax credit amount.
430
- attr_reader :amount
431
- # The credit balance transaction that was applied to get this pretax credit amount.
432
- attr_reader :credit_balance_transaction
433
- # The discount that was applied to get this pretax credit amount.
434
- attr_reader :discount
435
- # Type of the pretax credit amount referenced.
436
- attr_reader :type
437
- end
438
-
439
- class TotalTax < Stripe::StripeObject
440
- class TaxRateDetails < Stripe::StripeObject
441
- # Attribute for field tax_rate
442
- attr_reader :tax_rate
443
- end
444
- # The amount of the tax, in cents (or local equivalent).
445
- attr_reader :amount
446
- # Whether this tax is inclusive or exclusive.
447
- attr_reader :tax_behavior
448
- # Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
449
- attr_reader :tax_rate_details
450
- # 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.
451
- attr_reader :taxability_reason
452
- # The amount on which tax is calculated, in cents (or local equivalent).
453
- attr_reader :taxable_amount
454
- # The type of tax information.
455
- attr_reader :type
456
- end
457
-
458
- class DeleteParams < Stripe::RequestParams; end
459
-
460
- class UpdateParams < Stripe::RequestParams
461
- class AutomaticTax < Stripe::RequestParams
462
- class Liability < Stripe::RequestParams
463
- # The connected account being referenced when `type` is `account`.
464
- attr_accessor :account
465
- # Type of the account referenced in the request.
466
- attr_accessor :type
467
-
468
- def initialize(account: nil, type: nil)
469
- @account = account
470
- @type = type
471
- end
472
- end
473
- # 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.
474
- attr_accessor :enabled
475
- # 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.
476
- attr_accessor :liability
477
-
478
- def initialize(enabled: nil, liability: nil)
479
- @enabled = enabled
480
- @liability = liability
481
- end
482
- end
483
-
484
- class CustomField < Stripe::RequestParams
485
- # The name of the custom field. This may be up to 40 characters.
486
- attr_accessor :name
487
- # The value of the custom field. This may be up to 140 characters.
488
- attr_accessor :value
489
-
490
- def initialize(name: nil, value: nil)
491
- @name = name
492
- @value = value
493
- end
494
- end
495
-
496
- class Discount < Stripe::RequestParams
497
- # ID of the coupon to create a new discount for.
498
- attr_accessor :coupon
499
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
500
- attr_accessor :discount
501
- # ID of the promotion code to create a new discount for.
502
- attr_accessor :promotion_code
503
-
504
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
505
- @coupon = coupon
506
- @discount = discount
507
- @promotion_code = promotion_code
508
- end
509
- end
510
-
511
- class Issuer < Stripe::RequestParams
512
- # The connected account being referenced when `type` is `account`.
513
- attr_accessor :account
514
- # Type of the account referenced in the request.
515
- attr_accessor :type
516
-
517
- def initialize(account: nil, type: nil)
518
- @account = account
519
- @type = type
520
- end
521
- end
522
-
523
- class PaymentSettings < Stripe::RequestParams
524
- class PaymentMethodOptions < Stripe::RequestParams
525
- class AcssDebit < Stripe::RequestParams
526
- class MandateOptions < Stripe::RequestParams
527
- # Transaction type of the mandate.
528
- attr_accessor :transaction_type
529
-
530
- def initialize(transaction_type: nil)
531
- @transaction_type = transaction_type
532
- end
533
- end
534
- # Additional fields for Mandate creation
535
- attr_accessor :mandate_options
536
- # Verification method for the intent
537
- attr_accessor :verification_method
538
-
539
- def initialize(mandate_options: nil, verification_method: nil)
540
- @mandate_options = mandate_options
541
- @verification_method = verification_method
542
- end
543
- end
544
-
545
- class Bancontact < Stripe::RequestParams
546
- # Preferred language of the Bancontact authorization page that the customer is redirected to.
547
- attr_accessor :preferred_language
548
-
549
- def initialize(preferred_language: nil)
550
- @preferred_language = preferred_language
551
- end
552
- end
553
-
554
- class Card < Stripe::RequestParams
555
- class Installments < Stripe::RequestParams
556
- class Plan < Stripe::RequestParams
557
- # For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
558
- attr_accessor :count
559
- # For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
560
- # One of `month`.
561
- attr_accessor :interval
562
- # Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
563
- attr_accessor :type
564
-
565
- def initialize(count: nil, interval: nil, type: nil)
566
- @count = count
567
- @interval = interval
568
- @type = type
569
- end
570
- end
571
- # Setting to true enables installments for this invoice.
572
- # Setting to false will prevent any selected plan from applying to a payment.
573
- attr_accessor :enabled
574
- # The selected installment plan to use for this invoice.
575
- attr_accessor :plan
576
-
577
- def initialize(enabled: nil, plan: nil)
578
- @enabled = enabled
579
- @plan = plan
580
- end
581
- end
582
- # Installment configuration for payments attempted on this invoice.
583
- #
584
- # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
585
- attr_accessor :installments
586
- # 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.
587
- attr_accessor :request_three_d_secure
588
-
589
- def initialize(installments: nil, request_three_d_secure: nil)
590
- @installments = installments
591
- @request_three_d_secure = request_three_d_secure
592
- end
593
- end
594
-
595
- class CustomerBalance < Stripe::RequestParams
596
- class BankTransfer < Stripe::RequestParams
597
- class EuBankTransfer < Stripe::RequestParams
598
- # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
599
- attr_accessor :country
600
-
601
- def initialize(country: nil)
602
- @country = country
603
- end
604
- end
605
- # Configuration for eu_bank_transfer funding type.
606
- attr_accessor :eu_bank_transfer
607
- # 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`.
608
- attr_accessor :type
609
-
610
- def initialize(eu_bank_transfer: nil, type: nil)
611
- @eu_bank_transfer = eu_bank_transfer
612
- @type = type
613
- end
614
- end
615
- # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
616
- attr_accessor :bank_transfer
617
- # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
618
- attr_accessor :funding_type
619
-
620
- def initialize(bank_transfer: nil, funding_type: nil)
621
- @bank_transfer = bank_transfer
622
- @funding_type = funding_type
623
- end
624
- end
625
-
626
- class Konbini < Stripe::RequestParams; end
627
- class SepaDebit < Stripe::RequestParams; end
628
-
629
- class UsBankAccount < Stripe::RequestParams
630
- class FinancialConnections < Stripe::RequestParams
631
- class Filters < Stripe::RequestParams
632
- # The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
633
- attr_accessor :account_subcategories
634
-
635
- def initialize(account_subcategories: nil)
636
- @account_subcategories = account_subcategories
637
- end
638
- end
639
- # Provide filters for the linked accounts that the customer can select for the payment method.
640
- attr_accessor :filters
641
- # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
642
- attr_accessor :permissions
643
- # List of data features that you would like to retrieve upon account creation.
644
- attr_accessor :prefetch
645
-
646
- def initialize(filters: nil, permissions: nil, prefetch: nil)
647
- @filters = filters
648
- @permissions = permissions
649
- @prefetch = prefetch
650
- end
651
- end
652
- # Additional fields for Financial Connections Session creation
653
- attr_accessor :financial_connections
654
- # Verification method for the intent
655
- attr_accessor :verification_method
656
-
657
- def initialize(financial_connections: nil, verification_method: nil)
658
- @financial_connections = financial_connections
659
- @verification_method = verification_method
660
- end
661
- end
662
- # 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.
663
- attr_accessor :acss_debit
664
- # If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
665
- attr_accessor :bancontact
666
- # If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
667
- attr_accessor :card
668
- # If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
669
- attr_accessor :customer_balance
670
- # If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
671
- attr_accessor :konbini
672
- # 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.
673
- attr_accessor :sepa_debit
674
- # 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.
675
- attr_accessor :us_bank_account
676
-
677
- def initialize(
678
- acss_debit: nil,
679
- bancontact: nil,
680
- card: nil,
681
- customer_balance: nil,
682
- konbini: nil,
683
- sepa_debit: nil,
684
- us_bank_account: nil
685
- )
686
- @acss_debit = acss_debit
687
- @bancontact = bancontact
688
- @card = card
689
- @customer_balance = customer_balance
690
- @konbini = konbini
691
- @sepa_debit = sepa_debit
692
- @us_bank_account = us_bank_account
693
- end
694
- end
695
- # 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.
696
- attr_accessor :default_mandate
697
- # Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
698
- attr_accessor :payment_method_options
699
- # 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). Should not be specified with payment_method_configuration
700
- attr_accessor :payment_method_types
701
-
702
- def initialize(default_mandate: nil, payment_method_options: nil, payment_method_types: nil)
703
- @default_mandate = default_mandate
704
- @payment_method_options = payment_method_options
705
- @payment_method_types = payment_method_types
706
- end
707
- end
708
-
709
- class Rendering < Stripe::RequestParams
710
- class Pdf < Stripe::RequestParams
711
- # Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.
712
- # If set to `auto`, invoice PDF page size defaults to `a4` for customers with
713
- # Japanese locale and `letter` for customers with other locales.
714
- attr_accessor :page_size
715
-
716
- def initialize(page_size: nil)
717
- @page_size = page_size
718
- end
719
- end
720
- # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
721
- attr_accessor :amount_tax_display
722
- # Invoice pdf rendering options
723
- attr_accessor :pdf
724
- # ID of the invoice rendering template to use for this invoice.
725
- attr_accessor :template
726
- # The specific version of invoice rendering template to use for this invoice.
727
- attr_accessor :template_version
728
-
729
- def initialize(amount_tax_display: nil, pdf: nil, template: nil, template_version: nil)
730
- @amount_tax_display = amount_tax_display
731
- @pdf = pdf
732
- @template = template
733
- @template_version = template_version
734
- end
735
- end
736
-
737
- class ShippingCost < Stripe::RequestParams
738
- class ShippingRateData < Stripe::RequestParams
739
- class DeliveryEstimate < Stripe::RequestParams
740
- class Maximum < Stripe::RequestParams
741
- # A unit of time.
742
- attr_accessor :unit
743
- # Must be greater than 0.
744
- attr_accessor :value
745
-
746
- def initialize(unit: nil, value: nil)
747
- @unit = unit
748
- @value = value
749
- end
750
- end
751
-
752
- class Minimum < Stripe::RequestParams
753
- # A unit of time.
754
- attr_accessor :unit
755
- # Must be greater than 0.
756
- attr_accessor :value
757
-
758
- def initialize(unit: nil, value: nil)
759
- @unit = unit
760
- @value = value
761
- end
762
- end
763
- # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
764
- attr_accessor :maximum
765
- # The lower bound of the estimated range. If empty, represents no lower bound.
766
- attr_accessor :minimum
767
-
768
- def initialize(maximum: nil, minimum: nil)
769
- @maximum = maximum
770
- @minimum = minimum
771
- end
772
- end
773
-
774
- class FixedAmount < Stripe::RequestParams
775
- class CurrencyOptions < Stripe::RequestParams
776
- # A non-negative integer in cents representing how much to charge.
777
- attr_accessor :amount
778
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
779
- attr_accessor :tax_behavior
780
-
781
- def initialize(amount: nil, tax_behavior: nil)
782
- @amount = amount
783
- @tax_behavior = tax_behavior
784
- end
785
- end
786
- # A non-negative integer in cents representing how much to charge.
787
- attr_accessor :amount
788
- # 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).
789
- attr_accessor :currency
790
- # Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
791
- attr_accessor :currency_options
792
-
793
- def initialize(amount: nil, currency: nil, currency_options: nil)
794
- @amount = amount
795
- @currency = currency
796
- @currency_options = currency_options
797
- end
798
- end
799
- # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
800
- attr_accessor :delivery_estimate
801
- # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
802
- attr_accessor :display_name
803
- # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
804
- attr_accessor :fixed_amount
805
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
806
- attr_accessor :metadata
807
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
808
- attr_accessor :tax_behavior
809
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
810
- attr_accessor :tax_code
811
- # The type of calculation to use on the shipping rate.
812
- attr_accessor :type
813
-
814
- def initialize(
815
- delivery_estimate: nil,
816
- display_name: nil,
817
- fixed_amount: nil,
818
- metadata: nil,
819
- tax_behavior: nil,
820
- tax_code: nil,
821
- type: nil
822
- )
823
- @delivery_estimate = delivery_estimate
824
- @display_name = display_name
825
- @fixed_amount = fixed_amount
826
- @metadata = metadata
827
- @tax_behavior = tax_behavior
828
- @tax_code = tax_code
829
- @type = type
830
- end
831
- end
832
- # The ID of the shipping rate to use for this order.
833
- attr_accessor :shipping_rate
834
- # Parameters to create a new ad-hoc shipping rate for this order.
835
- attr_accessor :shipping_rate_data
836
-
837
- def initialize(shipping_rate: nil, shipping_rate_data: nil)
838
- @shipping_rate = shipping_rate
839
- @shipping_rate_data = shipping_rate_data
840
- end
841
- end
842
-
843
- class ShippingDetails < Stripe::RequestParams
844
- class Address < Stripe::RequestParams
845
- # City, district, suburb, town, or village.
846
- attr_accessor :city
847
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
848
- attr_accessor :country
849
- # Address line 1 (e.g., street, PO Box, or company name).
850
- attr_accessor :line1
851
- # Address line 2 (e.g., apartment, suite, unit, or building).
852
- attr_accessor :line2
853
- # ZIP or postal code.
854
- attr_accessor :postal_code
855
- # State, county, province, or region.
856
- attr_accessor :state
857
-
858
- def initialize(
859
- city: nil,
860
- country: nil,
861
- line1: nil,
862
- line2: nil,
863
- postal_code: nil,
864
- state: nil
865
- )
866
- @city = city
867
- @country = country
868
- @line1 = line1
869
- @line2 = line2
870
- @postal_code = postal_code
871
- @state = state
872
- end
873
- end
874
- # Shipping address
875
- attr_accessor :address
876
- # Recipient name.
877
- attr_accessor :name
878
- # Recipient phone (including extension)
879
- attr_accessor :phone
880
-
881
- def initialize(address: nil, name: nil, phone: nil)
882
- @address = address
883
- @name = name
884
- @phone = phone
885
- end
886
- end
887
-
888
- class TransferData < Stripe::RequestParams
889
- # The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
890
- attr_accessor :amount
891
- # ID of an existing, connected Stripe account.
892
- attr_accessor :destination
893
-
894
- def initialize(amount: nil, destination: nil)
895
- @amount = amount
896
- @destination = destination
897
- end
898
- end
899
- # The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
900
- attr_accessor :account_tax_ids
901
- # A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
902
- attr_accessor :application_fee_amount
903
- # Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice.
904
- attr_accessor :auto_advance
905
- # Settings for automatic tax lookup for this invoice.
906
- attr_accessor :automatic_tax
907
- # The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state. To turn off automatic finalization, set `auto_advance` to false.
908
- attr_accessor :automatically_finalizes_at
909
- # Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.
910
- attr_accessor :collection_method
911
- # A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields.
912
- attr_accessor :custom_fields
913
- # The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.
914
- attr_accessor :days_until_due
915
- # 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.
916
- attr_accessor :default_payment_method
917
- # 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.
918
- attr_accessor :default_source
919
- # The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates.
920
- attr_accessor :default_tax_rates
921
- # An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
922
- attr_accessor :description
923
- # The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts.
924
- attr_accessor :discounts
925
- # The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.
926
- attr_accessor :due_date
927
- # 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.
928
- attr_accessor :effective_at
929
- # Specifies which fields in the response should be expanded.
930
- attr_accessor :expand
931
- # Footer to be displayed on the invoice.
932
- attr_accessor :footer
933
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
934
- attr_accessor :issuer
935
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
936
- attr_accessor :metadata
937
- # Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.
938
- attr_accessor :number
939
- # 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.
940
- attr_accessor :on_behalf_of
941
- # Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
942
- attr_accessor :payment_settings
943
- # The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
944
- attr_accessor :rendering
945
- # Settings for the cost of shipping for this invoice.
946
- attr_accessor :shipping_cost
947
- # 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.
948
- attr_accessor :shipping_details
949
- # Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.
950
- attr_accessor :statement_descriptor
951
- # If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value.
952
- attr_accessor :transfer_data
953
-
954
- def initialize(
955
- account_tax_ids: nil,
956
- application_fee_amount: nil,
957
- auto_advance: nil,
958
- automatic_tax: nil,
959
- automatically_finalizes_at: nil,
960
- collection_method: nil,
961
- custom_fields: nil,
962
- days_until_due: nil,
963
- default_payment_method: nil,
964
- default_source: nil,
965
- default_tax_rates: nil,
966
- description: nil,
967
- discounts: nil,
968
- due_date: nil,
969
- effective_at: nil,
970
- expand: nil,
971
- footer: nil,
972
- issuer: nil,
973
- metadata: nil,
974
- number: nil,
975
- on_behalf_of: nil,
976
- payment_settings: nil,
977
- rendering: nil,
978
- shipping_cost: nil,
979
- shipping_details: nil,
980
- statement_descriptor: nil,
981
- transfer_data: nil
982
- )
983
- @account_tax_ids = account_tax_ids
984
- @application_fee_amount = application_fee_amount
985
- @auto_advance = auto_advance
986
- @automatic_tax = automatic_tax
987
- @automatically_finalizes_at = automatically_finalizes_at
988
- @collection_method = collection_method
989
- @custom_fields = custom_fields
990
- @days_until_due = days_until_due
991
- @default_payment_method = default_payment_method
992
- @default_source = default_source
993
- @default_tax_rates = default_tax_rates
994
- @description = description
995
- @discounts = discounts
996
- @due_date = due_date
997
- @effective_at = effective_at
998
- @expand = expand
999
- @footer = footer
1000
- @issuer = issuer
1001
- @metadata = metadata
1002
- @number = number
1003
- @on_behalf_of = on_behalf_of
1004
- @payment_settings = payment_settings
1005
- @rendering = rendering
1006
- @shipping_cost = shipping_cost
1007
- @shipping_details = shipping_details
1008
- @statement_descriptor = statement_descriptor
1009
- @transfer_data = transfer_data
1010
- end
1011
- end
1012
-
1013
- class ListParams < Stripe::RequestParams
1014
- class Created < Stripe::RequestParams
1015
- # Minimum value to filter by (exclusive)
1016
- attr_accessor :gt
1017
- # Minimum value to filter by (inclusive)
1018
- attr_accessor :gte
1019
- # Maximum value to filter by (exclusive)
1020
- attr_accessor :lt
1021
- # Maximum value to filter by (inclusive)
1022
- attr_accessor :lte
1023
-
1024
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
1025
- @gt = gt
1026
- @gte = gte
1027
- @lt = lt
1028
- @lte = lte
1029
- end
1030
- end
1031
-
1032
- class DueDate < Stripe::RequestParams
1033
- # Minimum value to filter by (exclusive)
1034
- attr_accessor :gt
1035
- # Minimum value to filter by (inclusive)
1036
- attr_accessor :gte
1037
- # Maximum value to filter by (exclusive)
1038
- attr_accessor :lt
1039
- # Maximum value to filter by (inclusive)
1040
- attr_accessor :lte
1041
-
1042
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
1043
- @gt = gt
1044
- @gte = gte
1045
- @lt = lt
1046
- @lte = lte
1047
- end
1048
- end
1049
- # The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.
1050
- attr_accessor :collection_method
1051
- # Only return invoices that were created during the given date interval.
1052
- attr_accessor :created
1053
- # Only return invoices for the customer specified by this customer ID.
1054
- attr_accessor :customer
1055
- # Attribute for param field due_date
1056
- attr_accessor :due_date
1057
- # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
1058
- attr_accessor :ending_before
1059
- # Specifies which fields in the response should be expanded.
1060
- attr_accessor :expand
1061
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1062
- attr_accessor :limit
1063
- # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
1064
- attr_accessor :starting_after
1065
- # The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)
1066
- attr_accessor :status
1067
- # Only return invoices for the subscription specified by this subscription ID.
1068
- attr_accessor :subscription
1069
-
1070
- def initialize(
1071
- collection_method: nil,
1072
- created: nil,
1073
- customer: nil,
1074
- due_date: nil,
1075
- ending_before: nil,
1076
- expand: nil,
1077
- limit: nil,
1078
- starting_after: nil,
1079
- status: nil,
1080
- subscription: nil
1081
- )
1082
- @collection_method = collection_method
1083
- @created = created
1084
- @customer = customer
1085
- @due_date = due_date
1086
- @ending_before = ending_before
1087
- @expand = expand
1088
- @limit = limit
1089
- @starting_after = starting_after
1090
- @status = status
1091
- @subscription = subscription
1092
- end
1093
- end
1094
-
1095
- class CreateParams < Stripe::RequestParams
1096
- class AutomaticTax < Stripe::RequestParams
1097
- class Liability < Stripe::RequestParams
1098
- # The connected account being referenced when `type` is `account`.
1099
- attr_accessor :account
1100
- # Type of the account referenced in the request.
1101
- attr_accessor :type
1102
-
1103
- def initialize(account: nil, type: nil)
1104
- @account = account
1105
- @type = type
1106
- end
1107
- end
1108
- # 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.
1109
- attr_accessor :enabled
1110
- # 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.
1111
- attr_accessor :liability
1112
-
1113
- def initialize(enabled: nil, liability: nil)
1114
- @enabled = enabled
1115
- @liability = liability
1116
- end
1117
- end
1118
-
1119
- class CustomField < Stripe::RequestParams
1120
- # The name of the custom field. This may be up to 40 characters.
1121
- attr_accessor :name
1122
- # The value of the custom field. This may be up to 140 characters.
1123
- attr_accessor :value
1124
-
1125
- def initialize(name: nil, value: nil)
1126
- @name = name
1127
- @value = value
1128
- end
1129
- end
1130
-
1131
- class Discount < Stripe::RequestParams
1132
- # ID of the coupon to create a new discount for.
1133
- attr_accessor :coupon
1134
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
1135
- attr_accessor :discount
1136
- # ID of the promotion code to create a new discount for.
1137
- attr_accessor :promotion_code
1138
-
1139
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
1140
- @coupon = coupon
1141
- @discount = discount
1142
- @promotion_code = promotion_code
1143
- end
1144
- end
1145
-
1146
- class FromInvoice < Stripe::RequestParams
1147
- # The relation between the new invoice and the original invoice. Currently, only 'revision' is permitted
1148
- attr_accessor :action
1149
- # The `id` of the invoice that will be cloned.
1150
- attr_accessor :invoice
1151
-
1152
- def initialize(action: nil, invoice: nil)
1153
- @action = action
1154
- @invoice = invoice
1155
- end
1156
- end
1157
-
1158
- class Issuer < Stripe::RequestParams
1159
- # The connected account being referenced when `type` is `account`.
1160
- attr_accessor :account
1161
- # Type of the account referenced in the request.
1162
- attr_accessor :type
1163
-
1164
- def initialize(account: nil, type: nil)
1165
- @account = account
1166
- @type = type
1167
- end
1168
- end
1169
-
1170
- class PaymentSettings < Stripe::RequestParams
1171
- class PaymentMethodOptions < Stripe::RequestParams
1172
- class AcssDebit < Stripe::RequestParams
1173
- class MandateOptions < Stripe::RequestParams
1174
- # Transaction type of the mandate.
1175
- attr_accessor :transaction_type
1176
-
1177
- def initialize(transaction_type: nil)
1178
- @transaction_type = transaction_type
1179
- end
1180
- end
1181
- # Additional fields for Mandate creation
1182
- attr_accessor :mandate_options
1183
- # Verification method for the intent
1184
- attr_accessor :verification_method
1185
-
1186
- def initialize(mandate_options: nil, verification_method: nil)
1187
- @mandate_options = mandate_options
1188
- @verification_method = verification_method
1189
- end
1190
- end
1191
-
1192
- class Bancontact < Stripe::RequestParams
1193
- # Preferred language of the Bancontact authorization page that the customer is redirected to.
1194
- attr_accessor :preferred_language
1195
-
1196
- def initialize(preferred_language: nil)
1197
- @preferred_language = preferred_language
1198
- end
1199
- end
1200
-
1201
- class Card < Stripe::RequestParams
1202
- class Installments < Stripe::RequestParams
1203
- class Plan < Stripe::RequestParams
1204
- # For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
1205
- attr_accessor :count
1206
- # For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
1207
- # One of `month`.
1208
- attr_accessor :interval
1209
- # Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
1210
- attr_accessor :type
1211
-
1212
- def initialize(count: nil, interval: nil, type: nil)
1213
- @count = count
1214
- @interval = interval
1215
- @type = type
1216
- end
1217
- end
1218
- # Setting to true enables installments for this invoice.
1219
- # Setting to false will prevent any selected plan from applying to a payment.
1220
- attr_accessor :enabled
1221
- # The selected installment plan to use for this invoice.
1222
- attr_accessor :plan
1223
-
1224
- def initialize(enabled: nil, plan: nil)
1225
- @enabled = enabled
1226
- @plan = plan
1227
- end
1228
- end
1229
- # Installment configuration for payments attempted on this invoice.
1230
- #
1231
- # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
1232
- attr_accessor :installments
1233
- # 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.
1234
- attr_accessor :request_three_d_secure
1235
-
1236
- def initialize(installments: nil, request_three_d_secure: nil)
1237
- @installments = installments
1238
- @request_three_d_secure = request_three_d_secure
1239
- end
1240
- end
1241
-
1242
- class CustomerBalance < Stripe::RequestParams
1243
- class BankTransfer < Stripe::RequestParams
1244
- class EuBankTransfer < Stripe::RequestParams
1245
- # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
1246
- attr_accessor :country
1247
-
1248
- def initialize(country: nil)
1249
- @country = country
1250
- end
1251
- end
1252
- # Configuration for eu_bank_transfer funding type.
1253
- attr_accessor :eu_bank_transfer
1254
- # 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`.
1255
- attr_accessor :type
1256
-
1257
- def initialize(eu_bank_transfer: nil, type: nil)
1258
- @eu_bank_transfer = eu_bank_transfer
1259
- @type = type
1260
- end
1261
- end
1262
- # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
1263
- attr_accessor :bank_transfer
1264
- # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
1265
- attr_accessor :funding_type
1266
-
1267
- def initialize(bank_transfer: nil, funding_type: nil)
1268
- @bank_transfer = bank_transfer
1269
- @funding_type = funding_type
1270
- end
1271
- end
1272
-
1273
- class Konbini < Stripe::RequestParams; end
1274
- class SepaDebit < Stripe::RequestParams; end
1275
-
1276
- class UsBankAccount < Stripe::RequestParams
1277
- class FinancialConnections < Stripe::RequestParams
1278
- class Filters < Stripe::RequestParams
1279
- # The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
1280
- attr_accessor :account_subcategories
1281
-
1282
- def initialize(account_subcategories: nil)
1283
- @account_subcategories = account_subcategories
1284
- end
1285
- end
1286
- # Provide filters for the linked accounts that the customer can select for the payment method.
1287
- attr_accessor :filters
1288
- # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
1289
- attr_accessor :permissions
1290
- # List of data features that you would like to retrieve upon account creation.
1291
- attr_accessor :prefetch
1292
-
1293
- def initialize(filters: nil, permissions: nil, prefetch: nil)
1294
- @filters = filters
1295
- @permissions = permissions
1296
- @prefetch = prefetch
1297
- end
1298
- end
1299
- # Additional fields for Financial Connections Session creation
1300
- attr_accessor :financial_connections
1301
- # Verification method for the intent
1302
- attr_accessor :verification_method
1303
-
1304
- def initialize(financial_connections: nil, verification_method: nil)
1305
- @financial_connections = financial_connections
1306
- @verification_method = verification_method
1307
- end
1308
- end
1309
- # 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.
1310
- attr_accessor :acss_debit
1311
- # If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
1312
- attr_accessor :bancontact
1313
- # If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
1314
- attr_accessor :card
1315
- # If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
1316
- attr_accessor :customer_balance
1317
- # If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
1318
- attr_accessor :konbini
1319
- # 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.
1320
- attr_accessor :sepa_debit
1321
- # 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.
1322
- attr_accessor :us_bank_account
1323
-
1324
- def initialize(
1325
- acss_debit: nil,
1326
- bancontact: nil,
1327
- card: nil,
1328
- customer_balance: nil,
1329
- konbini: nil,
1330
- sepa_debit: nil,
1331
- us_bank_account: nil
1332
- )
1333
- @acss_debit = acss_debit
1334
- @bancontact = bancontact
1335
- @card = card
1336
- @customer_balance = customer_balance
1337
- @konbini = konbini
1338
- @sepa_debit = sepa_debit
1339
- @us_bank_account = us_bank_account
1340
- end
1341
- end
1342
- # 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.
1343
- attr_accessor :default_mandate
1344
- # Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
1345
- attr_accessor :payment_method_options
1346
- # 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). Should not be specified with payment_method_configuration
1347
- attr_accessor :payment_method_types
1348
-
1349
- def initialize(default_mandate: nil, payment_method_options: nil, payment_method_types: nil)
1350
- @default_mandate = default_mandate
1351
- @payment_method_options = payment_method_options
1352
- @payment_method_types = payment_method_types
1353
- end
1354
- end
1355
-
1356
- class Rendering < Stripe::RequestParams
1357
- class Pdf < Stripe::RequestParams
1358
- # Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.
1359
- # If set to `auto`, invoice PDF page size defaults to `a4` for customers with
1360
- # Japanese locale and `letter` for customers with other locales.
1361
- attr_accessor :page_size
1362
-
1363
- def initialize(page_size: nil)
1364
- @page_size = page_size
1365
- end
1366
- end
1367
- # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
1368
- attr_accessor :amount_tax_display
1369
- # Invoice pdf rendering options
1370
- attr_accessor :pdf
1371
- # ID of the invoice rendering template to use for this invoice.
1372
- attr_accessor :template
1373
- # The specific version of invoice rendering template to use for this invoice.
1374
- attr_accessor :template_version
1375
-
1376
- def initialize(amount_tax_display: nil, pdf: nil, template: nil, template_version: nil)
1377
- @amount_tax_display = amount_tax_display
1378
- @pdf = pdf
1379
- @template = template
1380
- @template_version = template_version
1381
- end
1382
- end
1383
-
1384
- class ShippingCost < Stripe::RequestParams
1385
- class ShippingRateData < Stripe::RequestParams
1386
- class DeliveryEstimate < Stripe::RequestParams
1387
- class Maximum < Stripe::RequestParams
1388
- # A unit of time.
1389
- attr_accessor :unit
1390
- # Must be greater than 0.
1391
- attr_accessor :value
1392
-
1393
- def initialize(unit: nil, value: nil)
1394
- @unit = unit
1395
- @value = value
1396
- end
1397
- end
1398
-
1399
- class Minimum < Stripe::RequestParams
1400
- # A unit of time.
1401
- attr_accessor :unit
1402
- # Must be greater than 0.
1403
- attr_accessor :value
1404
-
1405
- def initialize(unit: nil, value: nil)
1406
- @unit = unit
1407
- @value = value
1408
- end
1409
- end
1410
- # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
1411
- attr_accessor :maximum
1412
- # The lower bound of the estimated range. If empty, represents no lower bound.
1413
- attr_accessor :minimum
1414
-
1415
- def initialize(maximum: nil, minimum: nil)
1416
- @maximum = maximum
1417
- @minimum = minimum
1418
- end
1419
- end
1420
-
1421
- class FixedAmount < Stripe::RequestParams
1422
- class CurrencyOptions < Stripe::RequestParams
1423
- # A non-negative integer in cents representing how much to charge.
1424
- attr_accessor :amount
1425
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
1426
- attr_accessor :tax_behavior
1427
-
1428
- def initialize(amount: nil, tax_behavior: nil)
1429
- @amount = amount
1430
- @tax_behavior = tax_behavior
1431
- end
1432
- end
1433
- # A non-negative integer in cents representing how much to charge.
1434
- attr_accessor :amount
1435
- # 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).
1436
- attr_accessor :currency
1437
- # Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
1438
- attr_accessor :currency_options
1439
-
1440
- def initialize(amount: nil, currency: nil, currency_options: nil)
1441
- @amount = amount
1442
- @currency = currency
1443
- @currency_options = currency_options
1444
- end
1445
- end
1446
- # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
1447
- attr_accessor :delivery_estimate
1448
- # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
1449
- attr_accessor :display_name
1450
- # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
1451
- attr_accessor :fixed_amount
1452
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1453
- attr_accessor :metadata
1454
- # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
1455
- attr_accessor :tax_behavior
1456
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
1457
- attr_accessor :tax_code
1458
- # The type of calculation to use on the shipping rate.
1459
- attr_accessor :type
1460
-
1461
- def initialize(
1462
- delivery_estimate: nil,
1463
- display_name: nil,
1464
- fixed_amount: nil,
1465
- metadata: nil,
1466
- tax_behavior: nil,
1467
- tax_code: nil,
1468
- type: nil
1469
- )
1470
- @delivery_estimate = delivery_estimate
1471
- @display_name = display_name
1472
- @fixed_amount = fixed_amount
1473
- @metadata = metadata
1474
- @tax_behavior = tax_behavior
1475
- @tax_code = tax_code
1476
- @type = type
1477
- end
1478
- end
1479
- # The ID of the shipping rate to use for this order.
1480
- attr_accessor :shipping_rate
1481
- # Parameters to create a new ad-hoc shipping rate for this order.
1482
- attr_accessor :shipping_rate_data
1483
-
1484
- def initialize(shipping_rate: nil, shipping_rate_data: nil)
1485
- @shipping_rate = shipping_rate
1486
- @shipping_rate_data = shipping_rate_data
1487
- end
1488
- end
1489
-
1490
- class ShippingDetails < Stripe::RequestParams
1491
- class Address < Stripe::RequestParams
1492
- # City, district, suburb, town, or village.
1493
- attr_accessor :city
1494
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1495
- attr_accessor :country
1496
- # Address line 1 (e.g., street, PO Box, or company name).
1497
- attr_accessor :line1
1498
- # Address line 2 (e.g., apartment, suite, unit, or building).
1499
- attr_accessor :line2
1500
- # ZIP or postal code.
1501
- attr_accessor :postal_code
1502
- # State, county, province, or region.
1503
- attr_accessor :state
1504
-
1505
- def initialize(
1506
- city: nil,
1507
- country: nil,
1508
- line1: nil,
1509
- line2: nil,
1510
- postal_code: nil,
1511
- state: nil
1512
- )
1513
- @city = city
1514
- @country = country
1515
- @line1 = line1
1516
- @line2 = line2
1517
- @postal_code = postal_code
1518
- @state = state
1519
- end
1520
- end
1521
- # Shipping address
1522
- attr_accessor :address
1523
- # Recipient name.
1524
- attr_accessor :name
1525
- # Recipient phone (including extension)
1526
- attr_accessor :phone
1527
-
1528
- def initialize(address: nil, name: nil, phone: nil)
1529
- @address = address
1530
- @name = name
1531
- @phone = phone
1532
- end
1533
- end
1534
-
1535
- class TransferData < Stripe::RequestParams
1536
- # The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
1537
- attr_accessor :amount
1538
- # ID of an existing, connected Stripe account.
1539
- attr_accessor :destination
1540
-
1541
- def initialize(amount: nil, destination: nil)
1542
- @amount = amount
1543
- @destination = destination
1544
- end
1545
- end
1546
- # The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
1547
- attr_accessor :account_tax_ids
1548
- # A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
1549
- attr_accessor :application_fee_amount
1550
- # 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. Defaults to false.
1551
- attr_accessor :auto_advance
1552
- # Settings for automatic tax lookup for this invoice.
1553
- attr_accessor :automatic_tax
1554
- # The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state.
1555
- attr_accessor :automatically_finalizes_at
1556
- # 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. Defaults to `charge_automatically`.
1557
- attr_accessor :collection_method
1558
- # The currency to create this invoice in. Defaults to that of `customer` if not specified.
1559
- attr_accessor :currency
1560
- # A list of up to 4 custom fields to be displayed on the invoice.
1561
- attr_accessor :custom_fields
1562
- # The ID of the customer who will be billed.
1563
- attr_accessor :customer
1564
- # The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
1565
- attr_accessor :days_until_due
1566
- # 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.
1567
- attr_accessor :default_payment_method
1568
- # 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.
1569
- attr_accessor :default_source
1570
- # The tax rates that will apply to any line item that does not have `tax_rates` set.
1571
- attr_accessor :default_tax_rates
1572
- # An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
1573
- attr_accessor :description
1574
- # The coupons and promotion codes to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts.
1575
- attr_accessor :discounts
1576
- # The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`.
1577
- attr_accessor :due_date
1578
- # 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.
1579
- attr_accessor :effective_at
1580
- # Specifies which fields in the response should be expanded.
1581
- attr_accessor :expand
1582
- # Footer to be displayed on the invoice.
1583
- attr_accessor :footer
1584
- # Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.
1585
- attr_accessor :from_invoice
1586
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1587
- attr_accessor :issuer
1588
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1589
- attr_accessor :metadata
1590
- # Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.
1591
- attr_accessor :number
1592
- # 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.
1593
- attr_accessor :on_behalf_of
1594
- # Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
1595
- attr_accessor :payment_settings
1596
- # How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.
1597
- attr_accessor :pending_invoice_items_behavior
1598
- # The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
1599
- attr_accessor :rendering
1600
- # Settings for the cost of shipping for this invoice.
1601
- attr_accessor :shipping_cost
1602
- # 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.
1603
- attr_accessor :shipping_details
1604
- # Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.
1605
- attr_accessor :statement_descriptor
1606
- # The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected.
1607
- attr_accessor :subscription
1608
- # If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
1609
- attr_accessor :transfer_data
1610
-
1611
- def initialize(
1612
- account_tax_ids: nil,
1613
- application_fee_amount: nil,
1614
- auto_advance: nil,
1615
- automatic_tax: nil,
1616
- automatically_finalizes_at: nil,
1617
- collection_method: nil,
1618
- currency: nil,
1619
- custom_fields: nil,
1620
- customer: nil,
1621
- days_until_due: nil,
1622
- default_payment_method: nil,
1623
- default_source: nil,
1624
- default_tax_rates: nil,
1625
- description: nil,
1626
- discounts: nil,
1627
- due_date: nil,
1628
- effective_at: nil,
1629
- expand: nil,
1630
- footer: nil,
1631
- from_invoice: nil,
1632
- issuer: nil,
1633
- metadata: nil,
1634
- number: nil,
1635
- on_behalf_of: nil,
1636
- payment_settings: nil,
1637
- pending_invoice_items_behavior: nil,
1638
- rendering: nil,
1639
- shipping_cost: nil,
1640
- shipping_details: nil,
1641
- statement_descriptor: nil,
1642
- subscription: nil,
1643
- transfer_data: nil
1644
- )
1645
- @account_tax_ids = account_tax_ids
1646
- @application_fee_amount = application_fee_amount
1647
- @auto_advance = auto_advance
1648
- @automatic_tax = automatic_tax
1649
- @automatically_finalizes_at = automatically_finalizes_at
1650
- @collection_method = collection_method
1651
- @currency = currency
1652
- @custom_fields = custom_fields
1653
- @customer = customer
1654
- @days_until_due = days_until_due
1655
- @default_payment_method = default_payment_method
1656
- @default_source = default_source
1657
- @default_tax_rates = default_tax_rates
1658
- @description = description
1659
- @discounts = discounts
1660
- @due_date = due_date
1661
- @effective_at = effective_at
1662
- @expand = expand
1663
- @footer = footer
1664
- @from_invoice = from_invoice
1665
- @issuer = issuer
1666
- @metadata = metadata
1667
- @number = number
1668
- @on_behalf_of = on_behalf_of
1669
- @payment_settings = payment_settings
1670
- @pending_invoice_items_behavior = pending_invoice_items_behavior
1671
- @rendering = rendering
1672
- @shipping_cost = shipping_cost
1673
- @shipping_details = shipping_details
1674
- @statement_descriptor = statement_descriptor
1675
- @subscription = subscription
1676
- @transfer_data = transfer_data
1677
- end
1678
- end
1679
-
1680
- class SearchParams < Stripe::RequestParams
1681
- # Specifies which fields in the response should be expanded.
1682
- attr_accessor :expand
1683
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1684
- attr_accessor :limit
1685
- # A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
1686
- attr_accessor :page
1687
- # The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices).
1688
- attr_accessor :query
1689
-
1690
- def initialize(expand: nil, limit: nil, page: nil, query: nil)
1691
- @expand = expand
1692
- @limit = limit
1693
- @page = page
1694
- @query = query
1695
- end
1696
- end
1697
-
1698
- class AddLinesParams < Stripe::RequestParams
1699
- class Line < Stripe::RequestParams
1700
- class Discount < Stripe::RequestParams
1701
- # ID of the coupon to create a new discount for.
1702
- attr_accessor :coupon
1703
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
1704
- attr_accessor :discount
1705
- # ID of the promotion code to create a new discount for.
1706
- attr_accessor :promotion_code
1707
-
1708
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
1709
- @coupon = coupon
1710
- @discount = discount
1711
- @promotion_code = promotion_code
1712
- end
1713
- end
1714
-
1715
- class Period < Stripe::RequestParams
1716
- # The end of the period, which must be greater than or equal to the start. This value is inclusive.
1717
- attr_accessor :end
1718
- # The start of the period. This value is inclusive.
1719
- attr_accessor :start
1720
-
1721
- def initialize(end_: nil, start: nil)
1722
- @end = end_
1723
- @start = start
1724
- end
1725
- end
1726
-
1727
- class PriceData < Stripe::RequestParams
1728
- class ProductData < Stripe::RequestParams
1729
- # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
1730
- attr_accessor :description
1731
- # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
1732
- attr_accessor :images
1733
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1734
- attr_accessor :metadata
1735
- # The product's name, meant to be displayable to the customer.
1736
- attr_accessor :name
1737
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
1738
- attr_accessor :tax_code
1739
-
1740
- def initialize(description: nil, images: nil, metadata: nil, name: nil, tax_code: nil)
1741
- @description = description
1742
- @images = images
1743
- @metadata = metadata
1744
- @name = name
1745
- @tax_code = tax_code
1746
- end
1747
- end
1748
- # 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).
1749
- attr_accessor :currency
1750
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
1751
- attr_accessor :product
1752
- # Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
1753
- attr_accessor :product_data
1754
- # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
1755
- attr_accessor :tax_behavior
1756
- # A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
1757
- attr_accessor :unit_amount
1758
- # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
1759
- attr_accessor :unit_amount_decimal
1760
-
1761
- def initialize(
1762
- currency: nil,
1763
- product: nil,
1764
- product_data: nil,
1765
- tax_behavior: nil,
1766
- unit_amount: nil,
1767
- unit_amount_decimal: nil
1768
- )
1769
- @currency = currency
1770
- @product = product
1771
- @product_data = product_data
1772
- @tax_behavior = tax_behavior
1773
- @unit_amount = unit_amount
1774
- @unit_amount_decimal = unit_amount_decimal
1775
- end
1776
- end
1777
-
1778
- class Pricing < Stripe::RequestParams
1779
- # The ID of the price object.
1780
- attr_accessor :price
1781
-
1782
- def initialize(price: nil)
1783
- @price = price
1784
- end
1785
- end
1786
-
1787
- class TaxAmount < Stripe::RequestParams
1788
- class TaxRateData < Stripe::RequestParams
1789
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1790
- attr_accessor :country
1791
- # An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
1792
- attr_accessor :description
1793
- # The display name of the tax rate, which will be shown to users.
1794
- attr_accessor :display_name
1795
- # This specifies if the tax rate is inclusive or exclusive.
1796
- attr_accessor :inclusive
1797
- # The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
1798
- attr_accessor :jurisdiction
1799
- # The level of the jurisdiction that imposes this tax rate.
1800
- attr_accessor :jurisdiction_level
1801
- # The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
1802
- attr_accessor :percentage
1803
- # [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
1804
- attr_accessor :state
1805
- # The high-level tax type, such as `vat` or `sales_tax`.
1806
- attr_accessor :tax_type
1807
-
1808
- def initialize(
1809
- country: nil,
1810
- description: nil,
1811
- display_name: nil,
1812
- inclusive: nil,
1813
- jurisdiction: nil,
1814
- jurisdiction_level: nil,
1815
- percentage: nil,
1816
- state: nil,
1817
- tax_type: nil
1818
- )
1819
- @country = country
1820
- @description = description
1821
- @display_name = display_name
1822
- @inclusive = inclusive
1823
- @jurisdiction = jurisdiction
1824
- @jurisdiction_level = jurisdiction_level
1825
- @percentage = percentage
1826
- @state = state
1827
- @tax_type = tax_type
1828
- end
1829
- end
1830
- # The amount, in cents (or local equivalent), of the tax.
1831
- attr_accessor :amount
1832
- # Data to find or create a TaxRate object.
1833
- #
1834
- # Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.
1835
- attr_accessor :tax_rate_data
1836
- # The reasoning behind this tax, for example, if the product is tax exempt.
1837
- attr_accessor :taxability_reason
1838
- # The amount on which tax is calculated, in cents (or local equivalent).
1839
- attr_accessor :taxable_amount
1840
-
1841
- def initialize(
1842
- amount: nil,
1843
- tax_rate_data: nil,
1844
- taxability_reason: nil,
1845
- taxable_amount: nil
1846
- )
1847
- @amount = amount
1848
- @tax_rate_data = tax_rate_data
1849
- @taxability_reason = taxability_reason
1850
- @taxable_amount = taxable_amount
1851
- end
1852
- end
1853
- # The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
1854
- attr_accessor :amount
1855
- # An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
1856
- attr_accessor :description
1857
- # Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
1858
- attr_accessor :discountable
1859
- # The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
1860
- attr_accessor :discounts
1861
- # ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.
1862
- attr_accessor :invoice_item
1863
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1864
- attr_accessor :metadata
1865
- # The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
1866
- attr_accessor :period
1867
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
1868
- attr_accessor :price_data
1869
- # The pricing information for the invoice item.
1870
- attr_accessor :pricing
1871
- # Non-negative integer. The quantity of units for the line item.
1872
- attr_accessor :quantity
1873
- # A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
1874
- attr_accessor :tax_amounts
1875
- # The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
1876
- attr_accessor :tax_rates
1877
-
1878
- def initialize(
1879
- amount: nil,
1880
- description: nil,
1881
- discountable: nil,
1882
- discounts: nil,
1883
- invoice_item: nil,
1884
- metadata: nil,
1885
- period: nil,
1886
- price_data: nil,
1887
- pricing: nil,
1888
- quantity: nil,
1889
- tax_amounts: nil,
1890
- tax_rates: nil
1891
- )
1892
- @amount = amount
1893
- @description = description
1894
- @discountable = discountable
1895
- @discounts = discounts
1896
- @invoice_item = invoice_item
1897
- @metadata = metadata
1898
- @period = period
1899
- @price_data = price_data
1900
- @pricing = pricing
1901
- @quantity = quantity
1902
- @tax_amounts = tax_amounts
1903
- @tax_rates = tax_rates
1904
- end
1905
- end
1906
- # Specifies which fields in the response should be expanded.
1907
- attr_accessor :expand
1908
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1909
- attr_accessor :invoice_metadata
1910
- # The line items to add.
1911
- attr_accessor :lines
1912
-
1913
- def initialize(expand: nil, invoice_metadata: nil, lines: nil)
1914
- @expand = expand
1915
- @invoice_metadata = invoice_metadata
1916
- @lines = lines
1917
- end
1918
- end
1919
-
1920
- class AttachPaymentParams < Stripe::RequestParams
1921
- # Specifies which fields in the response should be expanded.
1922
- attr_accessor :expand
1923
- # The ID of the PaymentIntent to attach to the invoice.
1924
- attr_accessor :payment_intent
1925
-
1926
- def initialize(expand: nil, payment_intent: nil)
1927
- @expand = expand
1928
- @payment_intent = payment_intent
1929
- end
1930
- end
1931
-
1932
- class FinalizeInvoiceParams < Stripe::RequestParams
1933
- # 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.
1934
- attr_accessor :auto_advance
1935
- # Specifies which fields in the response should be expanded.
1936
- attr_accessor :expand
1937
-
1938
- def initialize(auto_advance: nil, expand: nil)
1939
- @auto_advance = auto_advance
1940
- @expand = expand
1941
- end
1942
- end
1943
-
1944
- class MarkUncollectibleParams < Stripe::RequestParams
1945
- # Specifies which fields in the response should be expanded.
1946
- attr_accessor :expand
1947
-
1948
- def initialize(expand: nil)
1949
- @expand = expand
1950
- end
1951
- end
1952
-
1953
- class PayParams < Stripe::RequestParams
1954
- # Specifies which fields in the response should be expanded.
1955
- attr_accessor :expand
1956
- # In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due.
1957
- #
1958
- # Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`.
1959
- attr_accessor :forgive
1960
- # ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set.
1961
- attr_accessor :mandate
1962
- # Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session).
1963
- attr_accessor :off_session
1964
- # Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`.
1965
- attr_accessor :paid_out_of_band
1966
- # A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.
1967
- attr_accessor :payment_method
1968
- # A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.
1969
- attr_accessor :source
1970
-
1971
- def initialize(
1972
- expand: nil,
1973
- forgive: nil,
1974
- mandate: nil,
1975
- off_session: nil,
1976
- paid_out_of_band: nil,
1977
- payment_method: nil,
1978
- source: nil
1979
- )
1980
- @expand = expand
1981
- @forgive = forgive
1982
- @mandate = mandate
1983
- @off_session = off_session
1984
- @paid_out_of_band = paid_out_of_band
1985
- @payment_method = payment_method
1986
- @source = source
1987
- end
1988
- end
1989
-
1990
- class RemoveLinesParams < Stripe::RequestParams
1991
- class Line < Stripe::RequestParams
1992
- # Either `delete` or `unassign`. Deleted line items are permanently deleted. Unassigned line items can be reassigned to an invoice.
1993
- attr_accessor :behavior
1994
- # ID of an existing line item to remove from this invoice.
1995
- attr_accessor :id
1996
-
1997
- def initialize(behavior: nil, id: nil)
1998
- @behavior = behavior
1999
- @id = id
2000
- end
2001
- end
2002
- # Specifies which fields in the response should be expanded.
2003
- attr_accessor :expand
2004
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
2005
- attr_accessor :invoice_metadata
2006
- # The line items to remove.
2007
- attr_accessor :lines
2008
-
2009
- def initialize(expand: nil, invoice_metadata: nil, lines: nil)
2010
- @expand = expand
2011
- @invoice_metadata = invoice_metadata
2012
- @lines = lines
2013
- end
2014
- end
2015
-
2016
- class SendInvoiceParams < Stripe::RequestParams
2017
- # Specifies which fields in the response should be expanded.
2018
- attr_accessor :expand
2019
-
2020
- def initialize(expand: nil)
2021
- @expand = expand
2022
- end
2023
- end
2024
-
2025
- class UpdateLinesParams < Stripe::RequestParams
2026
- class Line < Stripe::RequestParams
2027
- class Discount < Stripe::RequestParams
2028
- # ID of the coupon to create a new discount for.
2029
- attr_accessor :coupon
2030
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
2031
- attr_accessor :discount
2032
- # ID of the promotion code to create a new discount for.
2033
- attr_accessor :promotion_code
2034
-
2035
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
2036
- @coupon = coupon
2037
- @discount = discount
2038
- @promotion_code = promotion_code
2039
- end
2040
- end
2041
-
2042
- class Period < Stripe::RequestParams
2043
- # The end of the period, which must be greater than or equal to the start. This value is inclusive.
2044
- attr_accessor :end
2045
- # The start of the period. This value is inclusive.
2046
- attr_accessor :start
2047
-
2048
- def initialize(end_: nil, start: nil)
2049
- @end = end_
2050
- @start = start
2051
- end
2052
- end
2053
-
2054
- class PriceData < Stripe::RequestParams
2055
- class ProductData < Stripe::RequestParams
2056
- # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
2057
- attr_accessor :description
2058
- # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
2059
- attr_accessor :images
2060
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
2061
- attr_accessor :metadata
2062
- # The product's name, meant to be displayable to the customer.
2063
- attr_accessor :name
2064
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
2065
- attr_accessor :tax_code
2066
-
2067
- def initialize(description: nil, images: nil, metadata: nil, name: nil, tax_code: nil)
2068
- @description = description
2069
- @images = images
2070
- @metadata = metadata
2071
- @name = name
2072
- @tax_code = tax_code
2073
- end
2074
- end
2075
- # 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).
2076
- attr_accessor :currency
2077
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
2078
- attr_accessor :product
2079
- # Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
2080
- attr_accessor :product_data
2081
- # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
2082
- attr_accessor :tax_behavior
2083
- # A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
2084
- attr_accessor :unit_amount
2085
- # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
2086
- attr_accessor :unit_amount_decimal
2087
-
2088
- def initialize(
2089
- currency: nil,
2090
- product: nil,
2091
- product_data: nil,
2092
- tax_behavior: nil,
2093
- unit_amount: nil,
2094
- unit_amount_decimal: nil
2095
- )
2096
- @currency = currency
2097
- @product = product
2098
- @product_data = product_data
2099
- @tax_behavior = tax_behavior
2100
- @unit_amount = unit_amount
2101
- @unit_amount_decimal = unit_amount_decimal
2102
- end
2103
- end
2104
-
2105
- class Pricing < Stripe::RequestParams
2106
- # The ID of the price object.
2107
- attr_accessor :price
2108
-
2109
- def initialize(price: nil)
2110
- @price = price
2111
- end
2112
- end
2113
-
2114
- class TaxAmount < Stripe::RequestParams
2115
- class TaxRateData < Stripe::RequestParams
2116
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2117
- attr_accessor :country
2118
- # An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
2119
- attr_accessor :description
2120
- # The display name of the tax rate, which will be shown to users.
2121
- attr_accessor :display_name
2122
- # This specifies if the tax rate is inclusive or exclusive.
2123
- attr_accessor :inclusive
2124
- # The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
2125
- attr_accessor :jurisdiction
2126
- # The level of the jurisdiction that imposes this tax rate.
2127
- attr_accessor :jurisdiction_level
2128
- # The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
2129
- attr_accessor :percentage
2130
- # [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
2131
- attr_accessor :state
2132
- # The high-level tax type, such as `vat` or `sales_tax`.
2133
- attr_accessor :tax_type
2134
-
2135
- def initialize(
2136
- country: nil,
2137
- description: nil,
2138
- display_name: nil,
2139
- inclusive: nil,
2140
- jurisdiction: nil,
2141
- jurisdiction_level: nil,
2142
- percentage: nil,
2143
- state: nil,
2144
- tax_type: nil
2145
- )
2146
- @country = country
2147
- @description = description
2148
- @display_name = display_name
2149
- @inclusive = inclusive
2150
- @jurisdiction = jurisdiction
2151
- @jurisdiction_level = jurisdiction_level
2152
- @percentage = percentage
2153
- @state = state
2154
- @tax_type = tax_type
2155
- end
2156
- end
2157
- # The amount, in cents (or local equivalent), of the tax.
2158
- attr_accessor :amount
2159
- # Data to find or create a TaxRate object.
2160
- #
2161
- # Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.
2162
- attr_accessor :tax_rate_data
2163
- # The reasoning behind this tax, for example, if the product is tax exempt.
2164
- attr_accessor :taxability_reason
2165
- # The amount on which tax is calculated, in cents (or local equivalent).
2166
- attr_accessor :taxable_amount
2167
-
2168
- def initialize(
2169
- amount: nil,
2170
- tax_rate_data: nil,
2171
- taxability_reason: nil,
2172
- taxable_amount: nil
2173
- )
2174
- @amount = amount
2175
- @tax_rate_data = tax_rate_data
2176
- @taxability_reason = taxability_reason
2177
- @taxable_amount = taxable_amount
2178
- end
2179
- end
2180
- # The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
2181
- attr_accessor :amount
2182
- # An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
2183
- attr_accessor :description
2184
- # Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
2185
- attr_accessor :discountable
2186
- # The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
2187
- attr_accessor :discounts
2188
- # ID of an existing line item on the invoice.
2189
- attr_accessor :id
2190
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
2191
- attr_accessor :metadata
2192
- # The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
2193
- attr_accessor :period
2194
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
2195
- attr_accessor :price_data
2196
- # The pricing information for the invoice item.
2197
- attr_accessor :pricing
2198
- # Non-negative integer. The quantity of units for the line item.
2199
- attr_accessor :quantity
2200
- # A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
2201
- attr_accessor :tax_amounts
2202
- # The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
2203
- attr_accessor :tax_rates
2204
-
2205
- def initialize(
2206
- amount: nil,
2207
- description: nil,
2208
- discountable: nil,
2209
- discounts: nil,
2210
- id: nil,
2211
- metadata: nil,
2212
- period: nil,
2213
- price_data: nil,
2214
- pricing: nil,
2215
- quantity: nil,
2216
- tax_amounts: nil,
2217
- tax_rates: nil
2218
- )
2219
- @amount = amount
2220
- @description = description
2221
- @discountable = discountable
2222
- @discounts = discounts
2223
- @id = id
2224
- @metadata = metadata
2225
- @period = period
2226
- @price_data = price_data
2227
- @pricing = pricing
2228
- @quantity = quantity
2229
- @tax_amounts = tax_amounts
2230
- @tax_rates = tax_rates
2231
- end
2232
- end
2233
- # Specifies which fields in the response should be expanded.
2234
- attr_accessor :expand
2235
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
2236
- attr_accessor :invoice_metadata
2237
- # The line items to update.
2238
- attr_accessor :lines
2239
-
2240
- def initialize(expand: nil, invoice_metadata: nil, lines: nil)
2241
- @expand = expand
2242
- @invoice_metadata = invoice_metadata
2243
- @lines = lines
2244
- end
2245
- end
2246
-
2247
- class VoidInvoiceParams < Stripe::RequestParams
2248
- # Specifies which fields in the response should be expanded.
2249
- attr_accessor :expand
2250
-
2251
- def initialize(expand: nil)
2252
- @expand = expand
2253
- end
2254
- end
2255
-
2256
- class CreatePreviewParams < Stripe::RequestParams
2257
- class AutomaticTax < Stripe::RequestParams
2258
- class Liability < Stripe::RequestParams
2259
- # The connected account being referenced when `type` is `account`.
2260
- attr_accessor :account
2261
- # Type of the account referenced in the request.
2262
- attr_accessor :type
2263
-
2264
- def initialize(account: nil, type: nil)
2265
- @account = account
2266
- @type = type
2267
- end
2268
- end
2269
- # 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.
2270
- attr_accessor :enabled
2271
- # 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.
2272
- attr_accessor :liability
2273
-
2274
- def initialize(enabled: nil, liability: nil)
2275
- @enabled = enabled
2276
- @liability = liability
2277
- end
2278
- end
456
+ def self.inner_class_types
457
+ @inner_class_types = { bank_transfer: BankTransfer }
458
+ end
2279
459
 
2280
- class CustomerDetails < Stripe::RequestParams
2281
- class Address < Stripe::RequestParams
2282
- # City, district, suburb, town, or village.
2283
- attr_accessor :city
2284
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2285
- attr_accessor :country
2286
- # Address line 1 (e.g., street, PO Box, or company name).
2287
- attr_accessor :line1
2288
- # Address line 2 (e.g., apartment, suite, unit, or building).
2289
- attr_accessor :line2
2290
- # ZIP or postal code.
2291
- attr_accessor :postal_code
2292
- # State, county, province, or region.
2293
- attr_accessor :state
2294
-
2295
- def initialize(
2296
- city: nil,
2297
- country: nil,
2298
- line1: nil,
2299
- line2: nil,
2300
- postal_code: nil,
2301
- state: nil
2302
- )
2303
- @city = city
2304
- @country = country
2305
- @line1 = line1
2306
- @line2 = line2
2307
- @postal_code = postal_code
2308
- @state = state
460
+ def self.field_remappings
461
+ @field_remappings = {}
2309
462
  end
2310
463
  end
2311
464
 
2312
- class Shipping < Stripe::RequestParams
2313
- class Address < Stripe::RequestParams
2314
- # City, district, suburb, town, or village.
2315
- attr_accessor :city
2316
- # A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2317
- attr_accessor :country
2318
- # Address line 1 (e.g., street, PO Box, or company name).
2319
- attr_accessor :line1
2320
- # Address line 2 (e.g., apartment, suite, unit, or building).
2321
- attr_accessor :line2
2322
- # ZIP or postal code.
2323
- attr_accessor :postal_code
2324
- # State, county, province, or region.
2325
- attr_accessor :state
2326
-
2327
- def initialize(
2328
- city: nil,
2329
- country: nil,
2330
- line1: nil,
2331
- line2: nil,
2332
- postal_code: nil,
2333
- state: nil
2334
- )
2335
- @city = city
2336
- @country = country
2337
- @line1 = line1
2338
- @line2 = line2
2339
- @postal_code = postal_code
2340
- @state = state
2341
- end
465
+ class Konbini < Stripe::StripeObject
466
+ def self.inner_class_types
467
+ @inner_class_types = {}
2342
468
  end
2343
- # Customer shipping address.
2344
- attr_accessor :address
2345
- # Customer name.
2346
- attr_accessor :name
2347
- # Customer phone (including extension).
2348
- attr_accessor :phone
2349
-
2350
- def initialize(address: nil, name: nil, phone: nil)
2351
- @address = address
2352
- @name = name
2353
- @phone = phone
469
+
470
+ def self.field_remappings
471
+ @field_remappings = {}
2354
472
  end
2355
473
  end
2356
474
 
2357
- class Tax < Stripe::RequestParams
2358
- # A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
2359
- attr_accessor :ip_address
475
+ class SepaDebit < Stripe::StripeObject
476
+ def self.inner_class_types
477
+ @inner_class_types = {}
478
+ end
2360
479
 
2361
- def initialize(ip_address: nil)
2362
- @ip_address = ip_address
480
+ def self.field_remappings
481
+ @field_remappings = {}
2363
482
  end
2364
483
  end
2365
484
 
2366
- class TaxId < Stripe::RequestParams
2367
- # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
2368
- attr_accessor :type
2369
- # Value of the tax ID.
2370
- attr_accessor :value
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
2371
490
 
2372
- def initialize(type: nil, value: nil)
2373
- @type = type
2374
- @value = value
2375
- end
2376
- end
2377
- # The customer's address.
2378
- attr_accessor :address
2379
- # The customer's shipping information. Appears on invoices emailed to this customer.
2380
- attr_accessor :shipping
2381
- # Tax details about the customer.
2382
- attr_accessor :tax
2383
- # The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
2384
- attr_accessor :tax_exempt
2385
- # The customer's tax IDs.
2386
- attr_accessor :tax_ids
2387
-
2388
- def initialize(address: nil, shipping: nil, tax: nil, tax_exempt: nil, tax_ids: nil)
2389
- @address = address
2390
- @shipping = shipping
2391
- @tax = tax
2392
- @tax_exempt = tax_exempt
2393
- @tax_ids = tax_ids
2394
- end
2395
- end
491
+ def self.inner_class_types
492
+ @inner_class_types = {}
493
+ end
2396
494
 
2397
- class Discount < Stripe::RequestParams
2398
- # ID of the coupon to create a new discount for.
2399
- attr_accessor :coupon
2400
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
2401
- attr_accessor :discount
2402
- # ID of the promotion code to create a new discount for.
2403
- attr_accessor :promotion_code
2404
-
2405
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
2406
- @coupon = coupon
2407
- @discount = discount
2408
- @promotion_code = promotion_code
2409
- end
2410
- end
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
2411
505
 
2412
- class InvoiceItem < Stripe::RequestParams
2413
- class Discount < Stripe::RequestParams
2414
- # ID of the coupon to create a new discount for.
2415
- attr_accessor :coupon
2416
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
2417
- attr_accessor :discount
2418
- # ID of the promotion code to create a new discount for.
2419
- attr_accessor :promotion_code
2420
-
2421
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
2422
- @coupon = coupon
2423
- @discount = discount
2424
- @promotion_code = promotion_code
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
2425
513
  end
2426
- end
514
+ # Attribute for field financial_connections
515
+ attr_reader :financial_connections
516
+ # Bank account verification method.
517
+ attr_reader :verification_method
2427
518
 
2428
- class Period < Stripe::RequestParams
2429
- # The end of the period, which must be greater than or equal to the start. This value is inclusive.
2430
- attr_accessor :end
2431
- # The start of the period. This value is inclusive.
2432
- attr_accessor :start
519
+ def self.inner_class_types
520
+ @inner_class_types = { financial_connections: FinancialConnections }
521
+ end
2433
522
 
2434
- def initialize(end_: nil, start: nil)
2435
- @end = end_
2436
- @start = start
523
+ def self.field_remappings
524
+ @field_remappings = {}
2437
525
  end
2438
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
2439
541
 
2440
- class PriceData < Stripe::RequestParams
2441
- # 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).
2442
- attr_accessor :currency
2443
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
2444
- attr_accessor :product
2445
- # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
2446
- attr_accessor :tax_behavior
2447
- # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
2448
- attr_accessor :unit_amount
2449
- # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
2450
- attr_accessor :unit_amount_decimal
2451
-
2452
- def initialize(
2453
- currency: nil,
2454
- product: nil,
2455
- tax_behavior: nil,
2456
- unit_amount: nil,
2457
- unit_amount_decimal: nil
2458
- )
2459
- @currency = currency
2460
- @product = product
2461
- @tax_behavior = tax_behavior
2462
- @unit_amount = unit_amount
2463
- @unit_amount_decimal = unit_amount_decimal
2464
- end
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
+ }
2465
552
  end
2466
- # The integer amount in cents (or local equivalent) of previewed invoice item.
2467
- attr_accessor :amount
2468
- # 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). Only applicable to new invoice items.
2469
- attr_accessor :currency
2470
- # An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
2471
- attr_accessor :description
2472
- # Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.
2473
- attr_accessor :discountable
2474
- # The coupons to redeem into discounts for the invoice item in the preview.
2475
- attr_accessor :discounts
2476
- # The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.
2477
- attr_accessor :invoiceitem
2478
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
2479
- attr_accessor :metadata
2480
- # The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
2481
- attr_accessor :period
2482
- # The ID of the price object. One of `price` or `price_data` is required.
2483
- attr_accessor :price
2484
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
2485
- attr_accessor :price_data
2486
- # Non-negative integer. The quantity of units for the invoice item.
2487
- attr_accessor :quantity
2488
- # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
2489
- attr_accessor :tax_behavior
2490
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
2491
- attr_accessor :tax_code
2492
- # The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.
2493
- attr_accessor :tax_rates
2494
- # The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
2495
- attr_accessor :unit_amount
2496
- # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
2497
- attr_accessor :unit_amount_decimal
2498
-
2499
- def initialize(
2500
- amount: nil,
2501
- currency: nil,
2502
- description: nil,
2503
- discountable: nil,
2504
- discounts: nil,
2505
- invoiceitem: nil,
2506
- metadata: nil,
2507
- period: nil,
2508
- price: nil,
2509
- price_data: nil,
2510
- quantity: nil,
2511
- tax_behavior: nil,
2512
- tax_code: nil,
2513
- tax_rates: nil,
2514
- unit_amount: nil,
2515
- unit_amount_decimal: nil
2516
- )
2517
- @amount = amount
2518
- @currency = currency
2519
- @description = description
2520
- @discountable = discountable
2521
- @discounts = discounts
2522
- @invoiceitem = invoiceitem
2523
- @metadata = metadata
2524
- @period = period
2525
- @price = price
2526
- @price_data = price_data
2527
- @quantity = quantity
2528
- @tax_behavior = tax_behavior
2529
- @tax_code = tax_code
2530
- @tax_rates = tax_rates
2531
- @unit_amount = unit_amount
2532
- @unit_amount_decimal = unit_amount_decimal
553
+
554
+ def self.field_remappings
555
+ @field_remappings = {}
2533
556
  end
2534
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
2535
564
 
2536
- class Issuer < Stripe::RequestParams
2537
- # The connected account being referenced when `type` is `account`.
2538
- attr_accessor :account
2539
- # Type of the account referenced in the request.
2540
- attr_accessor :type
565
+ def self.inner_class_types
566
+ @inner_class_types = { payment_method_options: PaymentMethodOptions }
567
+ end
2541
568
 
2542
- def initialize(account: nil, type: nil)
2543
- @account = account
2544
- @type = type
2545
- end
569
+ def self.field_remappings
570
+ @field_remappings = {}
2546
571
  end
572
+ end
2547
573
 
2548
- class ScheduleDetails < Stripe::RequestParams
2549
- class BillingMode < Stripe::RequestParams
2550
- # Controls the calculation and orchestration of prorations and invoices for subscriptions.
2551
- attr_accessor :type
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
2552
578
 
2553
- def initialize(type: nil)
2554
- @type = type
2555
- end
579
+ def self.inner_class_types
580
+ @inner_class_types = {}
2556
581
  end
2557
582
 
2558
- class Phase < Stripe::RequestParams
2559
- class AddInvoiceItem < Stripe::RequestParams
2560
- class Discount < Stripe::RequestParams
2561
- # ID of the coupon to create a new discount for.
2562
- attr_accessor :coupon
2563
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
2564
- attr_accessor :discount
2565
- # ID of the promotion code to create a new discount for.
2566
- attr_accessor :promotion_code
2567
-
2568
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
2569
- @coupon = coupon
2570
- @discount = discount
2571
- @promotion_code = promotion_code
2572
- end
2573
- end
2574
-
2575
- class Period < Stripe::RequestParams
2576
- class End < Stripe::RequestParams
2577
- # A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
2578
- attr_accessor :timestamp
2579
- # Select how to calculate the end of the invoice item period.
2580
- attr_accessor :type
2581
-
2582
- def initialize(timestamp: nil, type: nil)
2583
- @timestamp = timestamp
2584
- @type = type
2585
- end
2586
- end
2587
-
2588
- class Start < Stripe::RequestParams
2589
- # A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
2590
- attr_accessor :timestamp
2591
- # Select how to calculate the start of the invoice item period.
2592
- attr_accessor :type
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
2593
595
 
2594
- def initialize(timestamp: nil, type: nil)
2595
- @timestamp = timestamp
2596
- @type = type
2597
- end
2598
- end
2599
- # End of the invoice item period.
2600
- attr_accessor :end
2601
- # Start of the invoice item period.
2602
- attr_accessor :start
2603
-
2604
- def initialize(end_: nil, start: nil)
2605
- @end = end_
2606
- @start = start
2607
- end
2608
- end
596
+ def self.inner_class_types
597
+ @inner_class_types = { pdf: Pdf }
598
+ end
2609
599
 
2610
- class PriceData < Stripe::RequestParams
2611
- # 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).
2612
- attr_accessor :currency
2613
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
2614
- attr_accessor :product
2615
- # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
2616
- attr_accessor :tax_behavior
2617
- # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
2618
- attr_accessor :unit_amount
2619
- # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
2620
- attr_accessor :unit_amount_decimal
2621
-
2622
- def initialize(
2623
- currency: nil,
2624
- product: nil,
2625
- tax_behavior: nil,
2626
- unit_amount: nil,
2627
- unit_amount_decimal: nil
2628
- )
2629
- @currency = currency
2630
- @product = product
2631
- @tax_behavior = tax_behavior
2632
- @unit_amount = unit_amount
2633
- @unit_amount_decimal = unit_amount_decimal
2634
- end
2635
- end
2636
- # The coupons to redeem into discounts for the item.
2637
- attr_accessor :discounts
2638
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
2639
- attr_accessor :metadata
2640
- # The period associated with this invoice item. Defaults to the period of the underlying subscription that surrounds the start of the phase.
2641
- attr_accessor :period
2642
- # The ID of the price object. One of `price` or `price_data` is required.
2643
- attr_accessor :price
2644
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
2645
- attr_accessor :price_data
2646
- # Quantity for this item. Defaults to 1.
2647
- attr_accessor :quantity
2648
- # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
2649
- attr_accessor :tax_rates
2650
-
2651
- def initialize(
2652
- discounts: nil,
2653
- metadata: nil,
2654
- period: nil,
2655
- price: nil,
2656
- price_data: nil,
2657
- quantity: nil,
2658
- tax_rates: nil
2659
- )
2660
- @discounts = discounts
2661
- @metadata = metadata
2662
- @period = period
2663
- @price = price
2664
- @price_data = price_data
2665
- @quantity = quantity
2666
- @tax_rates = tax_rates
2667
- end
2668
- end
600
+ def self.field_remappings
601
+ @field_remappings = {}
602
+ end
603
+ end
2669
604
 
2670
- class AutomaticTax < Stripe::RequestParams
2671
- class Liability < Stripe::RequestParams
2672
- # The connected account being referenced when `type` is `account`.
2673
- attr_accessor :account
2674
- # Type of the account referenced in the request.
2675
- attr_accessor :type
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
2676
617
 
2677
- def initialize(account: nil, type: nil)
2678
- @account = account
2679
- @type = type
2680
- end
2681
- end
2682
- # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
2683
- attr_accessor :enabled
2684
- # 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.
2685
- attr_accessor :liability
2686
-
2687
- def initialize(enabled: nil, liability: nil)
2688
- @enabled = enabled
2689
- @liability = liability
2690
- end
2691
- end
618
+ def self.inner_class_types
619
+ @inner_class_types = {}
620
+ end
2692
621
 
2693
- class BillingThresholds < Stripe::RequestParams
2694
- # Monetary threshold that triggers the subscription to advance to a new billing period
2695
- attr_accessor :amount_gte
2696
- # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
2697
- attr_accessor :reset_billing_cycle_anchor
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
2698
636
 
2699
- def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil)
2700
- @amount_gte = amount_gte
2701
- @reset_billing_cycle_anchor = reset_billing_cycle_anchor
2702
- end
2703
- end
637
+ def self.inner_class_types
638
+ @inner_class_types = { taxes: Tax }
639
+ end
2704
640
 
2705
- class Discount < Stripe::RequestParams
2706
- # ID of the coupon to create a new discount for.
2707
- attr_accessor :coupon
2708
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
2709
- attr_accessor :discount
2710
- # ID of the promotion code to create a new discount for.
2711
- attr_accessor :promotion_code
2712
-
2713
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
2714
- @coupon = coupon
2715
- @discount = discount
2716
- @promotion_code = promotion_code
2717
- end
2718
- end
641
+ def self.field_remappings
642
+ @field_remappings = {}
643
+ end
644
+ end
2719
645
 
2720
- class Duration < Stripe::RequestParams
2721
- # Specifies phase duration. Either `day`, `week`, `month` or `year`.
2722
- attr_accessor :interval
2723
- # The multiplier applied to the interval.
2724
- attr_accessor :interval_count
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
2725
660
 
2726
- def initialize(interval: nil, interval_count: nil)
2727
- @interval = interval
2728
- @interval_count = interval_count
2729
- end
2730
- end
661
+ def self.inner_class_types
662
+ @inner_class_types = {}
663
+ end
2731
664
 
2732
- class InvoiceSettings < Stripe::RequestParams
2733
- class Issuer < Stripe::RequestParams
2734
- # The connected account being referenced when `type` is `account`.
2735
- attr_accessor :account
2736
- # Type of the account referenced in the request.
2737
- attr_accessor :type
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
2738
679
 
2739
- def initialize(account: nil, type: nil)
2740
- @account = account
2741
- @type = type
2742
- end
2743
- end
2744
- # The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
2745
- attr_accessor :account_tax_ids
2746
- # Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
2747
- attr_accessor :days_until_due
2748
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
2749
- attr_accessor :issuer
2750
-
2751
- def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil)
2752
- @account_tax_ids = account_tax_ids
2753
- @days_until_due = days_until_due
2754
- @issuer = issuer
2755
- end
2756
- end
680
+ def self.inner_class_types
681
+ @inner_class_types = { address: Address }
682
+ end
2757
683
 
2758
- class Item < Stripe::RequestParams
2759
- class BillingThresholds < Stripe::RequestParams
2760
- # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
2761
- attr_accessor :usage_gte
684
+ def self.field_remappings
685
+ @field_remappings = {}
686
+ end
687
+ end
2762
688
 
2763
- def initialize(usage_gte: nil)
2764
- @usage_gte = usage_gte
2765
- end
2766
- end
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
2767
698
 
2768
- class Discount < Stripe::RequestParams
2769
- # ID of the coupon to create a new discount for.
2770
- attr_accessor :coupon
2771
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
2772
- attr_accessor :discount
2773
- # ID of the promotion code to create a new discount for.
2774
- attr_accessor :promotion_code
2775
-
2776
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
2777
- @coupon = coupon
2778
- @discount = discount
2779
- @promotion_code = promotion_code
2780
- end
2781
- end
699
+ def self.inner_class_types
700
+ @inner_class_types = {}
701
+ end
2782
702
 
2783
- class PriceData < Stripe::RequestParams
2784
- class Recurring < Stripe::RequestParams
2785
- # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
2786
- attr_accessor :interval
2787
- # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
2788
- attr_accessor :interval_count
2789
-
2790
- def initialize(interval: nil, interval_count: nil)
2791
- @interval = interval
2792
- @interval_count = interval_count
2793
- end
2794
- end
2795
- # 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).
2796
- attr_accessor :currency
2797
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
2798
- attr_accessor :product
2799
- # The recurring components of a price such as `interval` and `interval_count`.
2800
- attr_accessor :recurring
2801
- # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
2802
- attr_accessor :tax_behavior
2803
- # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
2804
- attr_accessor :unit_amount
2805
- # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
2806
- attr_accessor :unit_amount_decimal
2807
-
2808
- def initialize(
2809
- currency: nil,
2810
- product: nil,
2811
- recurring: nil,
2812
- tax_behavior: nil,
2813
- unit_amount: nil,
2814
- unit_amount_decimal: nil
2815
- )
2816
- @currency = currency
2817
- @product = product
2818
- @recurring = recurring
2819
- @tax_behavior = tax_behavior
2820
- @unit_amount = unit_amount
2821
- @unit_amount_decimal = unit_amount_decimal
2822
- end
2823
- end
2824
- # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
2825
- attr_accessor :billing_thresholds
2826
- # The coupons to redeem into discounts for the subscription item.
2827
- attr_accessor :discounts
2828
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
2829
- attr_accessor :metadata
2830
- # The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
2831
- attr_accessor :plan
2832
- # The ID of the price object.
2833
- attr_accessor :price
2834
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
2835
- attr_accessor :price_data
2836
- # Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
2837
- attr_accessor :quantity
2838
- # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
2839
- attr_accessor :tax_rates
2840
-
2841
- def initialize(
2842
- billing_thresholds: nil,
2843
- discounts: nil,
2844
- metadata: nil,
2845
- plan: nil,
2846
- price: nil,
2847
- price_data: nil,
2848
- quantity: nil,
2849
- tax_rates: nil
2850
- )
2851
- @billing_thresholds = billing_thresholds
2852
- @discounts = discounts
2853
- @metadata = metadata
2854
- @plan = plan
2855
- @price = price
2856
- @price_data = price_data
2857
- @quantity = quantity
2858
- @tax_rates = tax_rates
2859
- end
2860
- end
703
+ def self.field_remappings
704
+ @field_remappings = {}
705
+ end
706
+ end
2861
707
 
2862
- class TransferData < Stripe::RequestParams
2863
- # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
2864
- attr_accessor :amount_percent
2865
- # ID of an existing, connected Stripe account.
2866
- attr_accessor :destination
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
2867
714
 
2868
- def initialize(amount_percent: nil, destination: nil)
2869
- @amount_percent = amount_percent
2870
- @destination = destination
2871
- end
2872
- end
2873
- # A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
2874
- attr_accessor :add_invoice_items
2875
- # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
2876
- attr_accessor :application_fee_percent
2877
- # Automatic tax settings for this phase.
2878
- attr_accessor :automatic_tax
2879
- # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
2880
- attr_accessor :billing_cycle_anchor
2881
- # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
2882
- attr_accessor :billing_thresholds
2883
- # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
2884
- attr_accessor :collection_method
2885
- # 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).
2886
- attr_accessor :currency
2887
- # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
2888
- attr_accessor :default_payment_method
2889
- # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
2890
- attr_accessor :default_tax_rates
2891
- # Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
2892
- attr_accessor :description
2893
- # The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
2894
- attr_accessor :discounts
2895
- # The number of intervals the phase should last. If set, `end_date` must not be set.
2896
- attr_accessor :duration
2897
- # The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
2898
- attr_accessor :end_date
2899
- # All invoices will be billed using the specified settings.
2900
- attr_accessor :invoice_settings
2901
- # List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
2902
- attr_accessor :items
2903
- # Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. This parameter is deprecated and will be removed in a future version. Use `duration` instead.
2904
- attr_accessor :iterations
2905
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
2906
- attr_accessor :metadata
2907
- # The account on behalf of which to charge, for each of the associated subscription's invoices.
2908
- attr_accessor :on_behalf_of
2909
- # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
2910
- attr_accessor :proration_behavior
2911
- # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
2912
- attr_accessor :start_date
2913
- # The data with which to automatically create a Transfer for each of the associated subscription's invoices.
2914
- attr_accessor :transfer_data
2915
- # If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
2916
- attr_accessor :trial
2917
- # Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
2918
- attr_accessor :trial_end
2919
-
2920
- def initialize(
2921
- add_invoice_items: nil,
2922
- application_fee_percent: nil,
2923
- automatic_tax: nil,
2924
- billing_cycle_anchor: nil,
2925
- billing_thresholds: nil,
2926
- collection_method: nil,
2927
- currency: nil,
2928
- default_payment_method: nil,
2929
- default_tax_rates: nil,
2930
- description: nil,
2931
- discounts: nil,
2932
- duration: nil,
2933
- end_date: nil,
2934
- invoice_settings: nil,
2935
- items: nil,
2936
- iterations: nil,
2937
- metadata: nil,
2938
- on_behalf_of: nil,
2939
- proration_behavior: nil,
2940
- start_date: nil,
2941
- transfer_data: nil,
2942
- trial: nil,
2943
- trial_end: nil
2944
- )
2945
- @add_invoice_items = add_invoice_items
2946
- @application_fee_percent = application_fee_percent
2947
- @automatic_tax = automatic_tax
2948
- @billing_cycle_anchor = billing_cycle_anchor
2949
- @billing_thresholds = billing_thresholds
2950
- @collection_method = collection_method
2951
- @currency = currency
2952
- @default_payment_method = default_payment_method
2953
- @default_tax_rates = default_tax_rates
2954
- @description = description
2955
- @discounts = discounts
2956
- @duration = duration
2957
- @end_date = end_date
2958
- @invoice_settings = invoice_settings
2959
- @items = items
2960
- @iterations = iterations
2961
- @metadata = metadata
2962
- @on_behalf_of = on_behalf_of
2963
- @proration_behavior = proration_behavior
2964
- @start_date = start_date
2965
- @transfer_data = transfer_data
2966
- @trial = trial
2967
- @trial_end = trial_end
2968
- end
715
+ def self.inner_class_types
716
+ @inner_class_types = {}
2969
717
  end
2970
- # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
2971
- attr_accessor :billing_mode
2972
- # Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
2973
- attr_accessor :end_behavior
2974
- # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
2975
- attr_accessor :phases
2976
- # In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
2977
- attr_accessor :proration_behavior
2978
-
2979
- def initialize(billing_mode: nil, end_behavior: nil, phases: nil, proration_behavior: nil)
2980
- @billing_mode = billing_mode
2981
- @end_behavior = end_behavior
2982
- @phases = phases
2983
- @proration_behavior = proration_behavior
718
+
719
+ def self.field_remappings
720
+ @field_remappings = {}
2984
721
  end
2985
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
2986
731
 
2987
- class SubscriptionDetails < Stripe::RequestParams
2988
- class BillingMode < Stripe::RequestParams
2989
- # Controls the calculation and orchestration of prorations and invoices for subscriptions.
2990
- attr_accessor :type
732
+ def self.field_remappings
733
+ @field_remappings = {}
734
+ end
735
+ end
2991
736
 
2992
- def initialize(type: nil)
2993
- @type = type
2994
- end
2995
- end
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
2996
742
 
2997
- class Item < Stripe::RequestParams
2998
- class BillingThresholds < Stripe::RequestParams
2999
- # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
3000
- attr_accessor :usage_gte
743
+ def self.inner_class_types
744
+ @inner_class_types = {}
745
+ end
3001
746
 
3002
- def initialize(usage_gte: nil)
3003
- @usage_gte = usage_gte
3004
- end
3005
- end
747
+ def self.field_remappings
748
+ @field_remappings = {}
749
+ end
750
+ end
3006
751
 
3007
- class Discount < Stripe::RequestParams
3008
- # ID of the coupon to create a new discount for.
3009
- attr_accessor :coupon
3010
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
3011
- attr_accessor :discount
3012
- # ID of the promotion code to create a new discount for.
3013
- attr_accessor :promotion_code
3014
-
3015
- def initialize(coupon: nil, discount: nil, promotion_code: nil)
3016
- @coupon = coupon
3017
- @discount = discount
3018
- @promotion_code = promotion_code
3019
- end
3020
- end
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
3021
761
 
3022
- class PriceData < Stripe::RequestParams
3023
- class Recurring < Stripe::RequestParams
3024
- # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
3025
- attr_accessor :interval
3026
- # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
3027
- attr_accessor :interval_count
762
+ def self.inner_class_types
763
+ @inner_class_types = {}
764
+ end
3028
765
 
3029
- def initialize(interval: nil, interval_count: nil)
3030
- @interval = interval
3031
- @interval_count = interval_count
3032
- end
3033
- end
3034
- # 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).
3035
- attr_accessor :currency
3036
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
3037
- attr_accessor :product
3038
- # The recurring components of a price such as `interval` and `interval_count`.
3039
- attr_accessor :recurring
3040
- # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
3041
- attr_accessor :tax_behavior
3042
- # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
3043
- attr_accessor :unit_amount
3044
- # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
3045
- attr_accessor :unit_amount_decimal
3046
-
3047
- def initialize(
3048
- currency: nil,
3049
- product: nil,
3050
- recurring: nil,
3051
- tax_behavior: nil,
3052
- unit_amount: nil,
3053
- unit_amount_decimal: nil
3054
- )
3055
- @currency = currency
3056
- @product = product
3057
- @recurring = recurring
3058
- @tax_behavior = tax_behavior
3059
- @unit_amount = unit_amount
3060
- @unit_amount_decimal = unit_amount_decimal
3061
- end
3062
- end
3063
- # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
3064
- attr_accessor :billing_thresholds
3065
- # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
3066
- attr_accessor :clear_usage
3067
- # A flag that, if set to `true`, will delete the specified item.
3068
- attr_accessor :deleted
3069
- # The coupons to redeem into discounts for the subscription item.
3070
- attr_accessor :discounts
3071
- # Subscription item to update.
3072
- attr_accessor :id
3073
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
3074
- attr_accessor :metadata
3075
- # Plan ID for this item, as a string.
3076
- attr_accessor :plan
3077
- # The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
3078
- attr_accessor :price
3079
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
3080
- attr_accessor :price_data
3081
- # Quantity for this item.
3082
- attr_accessor :quantity
3083
- # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
3084
- attr_accessor :tax_rates
3085
-
3086
- def initialize(
3087
- billing_thresholds: nil,
3088
- clear_usage: nil,
3089
- deleted: nil,
3090
- discounts: nil,
3091
- id: nil,
3092
- metadata: nil,
3093
- plan: nil,
3094
- price: nil,
3095
- price_data: nil,
3096
- quantity: nil,
3097
- tax_rates: nil
3098
- )
3099
- @billing_thresholds = billing_thresholds
3100
- @clear_usage = clear_usage
3101
- @deleted = deleted
3102
- @discounts = discounts
3103
- @id = id
3104
- @metadata = metadata
3105
- @plan = plan
3106
- @price = price
3107
- @price_data = price_data
3108
- @quantity = quantity
3109
- @tax_rates = tax_rates
3110
- end
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 = {}
3111
778
  end
3112
- # For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.
3113
- attr_accessor :billing_cycle_anchor
3114
- # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
3115
- attr_accessor :billing_mode
3116
- # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
3117
- attr_accessor :cancel_at
3118
- # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
3119
- attr_accessor :cancel_at_period_end
3120
- # This simulates the subscription being canceled or expired immediately.
3121
- attr_accessor :cancel_now
3122
- # If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.
3123
- attr_accessor :default_tax_rates
3124
- # A list of up to 20 subscription items, each with an attached price.
3125
- attr_accessor :items
3126
- # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
3127
- attr_accessor :proration_behavior
3128
- # If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.
3129
- attr_accessor :proration_date
3130
- # For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.
3131
- attr_accessor :resume_at
3132
- # Date a subscription is intended to start (can be future or past).
3133
- attr_accessor :start_date
3134
- # If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required.
3135
- attr_accessor :trial_end
3136
-
3137
- def initialize(
3138
- billing_cycle_anchor: nil,
3139
- billing_mode: nil,
3140
- cancel_at: nil,
3141
- cancel_at_period_end: nil,
3142
- cancel_now: nil,
3143
- default_tax_rates: nil,
3144
- items: nil,
3145
- proration_behavior: nil,
3146
- proration_date: nil,
3147
- resume_at: nil,
3148
- start_date: nil,
3149
- trial_end: nil
3150
- )
3151
- @billing_cycle_anchor = billing_cycle_anchor
3152
- @billing_mode = billing_mode
3153
- @cancel_at = cancel_at
3154
- @cancel_at_period_end = cancel_at_period_end
3155
- @cancel_now = cancel_now
3156
- @default_tax_rates = default_tax_rates
3157
- @items = items
3158
- @proration_behavior = proration_behavior
3159
- @proration_date = proration_date
3160
- @resume_at = resume_at
3161
- @start_date = start_date
3162
- @trial_end = trial_end
779
+
780
+ def self.field_remappings
781
+ @field_remappings = {}
3163
782
  end
3164
783
  end
3165
- # Settings for automatic tax lookup for this invoice preview.
3166
- attr_accessor :automatic_tax
3167
- # The currency to preview this invoice in. Defaults to that of `customer` if not specified.
3168
- attr_accessor :currency
3169
- # The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
3170
- attr_accessor :customer
3171
- # Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
3172
- attr_accessor :customer_details
3173
- # The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.
3174
- attr_accessor :discounts
3175
- # Specifies which fields in the response should be expanded.
3176
- attr_accessor :expand
3177
- # List of invoice items to add or update in the upcoming invoice preview (up to 250).
3178
- attr_accessor :invoice_items
3179
- # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
3180
- attr_accessor :issuer
3181
- # 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.
3182
- attr_accessor :on_behalf_of
3183
- # Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.
3184
- attr_accessor :preview_mode
3185
- # The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
3186
- attr_accessor :schedule
3187
- # The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.
3188
- attr_accessor :schedule_details
3189
- # The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.
3190
- attr_accessor :subscription
3191
- # The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.
3192
- attr_accessor :subscription_details
3193
-
3194
- def initialize(
3195
- automatic_tax: nil,
3196
- currency: nil,
3197
- customer: nil,
3198
- customer_details: nil,
3199
- discounts: nil,
3200
- expand: nil,
3201
- invoice_items: nil,
3202
- issuer: nil,
3203
- on_behalf_of: nil,
3204
- preview_mode: nil,
3205
- schedule: nil,
3206
- schedule_details: nil,
3207
- subscription: nil,
3208
- subscription_details: nil
3209
- )
3210
- @automatic_tax = automatic_tax
3211
- @currency = currency
3212
- @customer = customer
3213
- @customer_details = customer_details
3214
- @discounts = discounts
3215
- @expand = expand
3216
- @invoice_items = invoice_items
3217
- @issuer = issuer
3218
- @on_behalf_of = on_behalf_of
3219
- @preview_mode = preview_mode
3220
- @schedule = schedule
3221
- @schedule_details = schedule_details
3222
- @subscription = subscription
3223
- @subscription_details = subscription_details
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 = {}
3224
803
  end
3225
804
  end
3226
805
  # The country of the business associated with this invoice, most often the business creating the invoice.
@@ -3662,5 +1241,33 @@ module Stripe
3662
1241
  opts: opts
3663
1242
  )
3664
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
3665
1272
  end
3666
1273
  end