stripe 21.1.0 → 21.2.0.pre.beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (505) hide show
  1. checksums.yaml +4 -4
  2. data/lib/stripe/api_requestor.rb +4 -0
  3. data/lib/stripe/api_version.rb +2 -2
  4. data/lib/stripe/errors.rb +6 -0
  5. data/lib/stripe/event_types.rb +193 -0
  6. data/lib/stripe/events/unknown_event_notification.rb +1 -0
  7. data/lib/stripe/events/v2_core_account_including_configuration_money_manager_capability_status_updated_event.rb +63 -0
  8. data/lib/stripe/events/v2_core_account_including_configuration_money_manager_updated_event.rb +44 -0
  9. data/lib/stripe/events/v2_core_approval_request_approved_event.rb +44 -0
  10. data/lib/stripe/events/v2_core_approval_request_canceled_event.rb +44 -0
  11. data/lib/stripe/events/v2_core_approval_request_created_event.rb +44 -0
  12. data/lib/stripe/events/v2_core_approval_request_expired_event.rb +44 -0
  13. data/lib/stripe/events/v2_core_approval_request_failed_event.rb +44 -0
  14. data/lib/stripe/events/v2_core_approval_request_rejected_event.rb +44 -0
  15. data/lib/stripe/events/v2_core_approval_request_succeeded_event.rb +44 -0
  16. data/lib/stripe/events/v2_core_batch_job_batch_failed_event.rb +44 -0
  17. data/lib/stripe/events/v2_core_batch_job_canceled_event.rb +44 -0
  18. data/lib/stripe/events/v2_core_batch_job_completed_event.rb +44 -0
  19. data/lib/stripe/events/v2_core_batch_job_created_event.rb +44 -0
  20. data/lib/stripe/events/v2_core_batch_job_ready_for_upload_event.rb +44 -0
  21. data/lib/stripe/events/v2_core_batch_job_timeout_event.rb +44 -0
  22. data/lib/stripe/events/v2_core_batch_job_updated_event.rb +44 -0
  23. data/lib/stripe/events/v2_core_batch_job_upload_timeout_event.rb +44 -0
  24. data/lib/stripe/events/v2_core_batch_job_validating_event.rb +44 -0
  25. data/lib/stripe/events/v2_core_batch_job_validation_failed_event.rb +44 -0
  26. data/lib/stripe/events/v2_core_health_event_generation_failure_resolved_event.rb +80 -0
  27. data/lib/stripe/events/v2_data_query_run_created_event.rb +44 -0
  28. data/lib/stripe/events/v2_data_query_run_failed_event.rb +44 -0
  29. data/lib/stripe/events/v2_data_query_run_succeeded_event.rb +44 -0
  30. data/lib/stripe/events/v2_data_query_run_updated_event.rb +44 -0
  31. data/lib/stripe/events/v2_data_report_run_created_event.rb +44 -0
  32. data/lib/stripe/events/v2_data_report_run_failed_event.rb +44 -0
  33. data/lib/stripe/events/v2_data_report_run_succeeded_event.rb +44 -0
  34. data/lib/stripe/events/v2_data_report_run_updated_event.rb +44 -0
  35. data/lib/stripe/events/v2_data_reporting_query_run_created_event.rb +44 -0
  36. data/lib/stripe/events/v2_data_reporting_query_run_failed_event.rb +44 -0
  37. data/lib/stripe/events/v2_data_reporting_query_run_succeeded_event.rb +44 -0
  38. data/lib/stripe/events/v2_data_reporting_query_run_updated_event.rb +44 -0
  39. data/lib/stripe/events/v2_extend_workflow_run_failed_event.rb +75 -0
  40. data/lib/stripe/events/v2_extend_workflow_run_started_event.rb +44 -0
  41. data/lib/stripe/events/v2_extend_workflow_run_succeeded_event.rb +44 -0
  42. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +44 -0
  43. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +44 -0
  44. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +44 -0
  45. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +44 -0
  46. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +44 -0
  47. data/lib/stripe/events/v2_money_management_outbound_transfer_under_review_event.rb +44 -0
  48. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +44 -0
  49. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +44 -0
  50. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +44 -0
  51. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +44 -0
  52. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +44 -0
  53. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +44 -0
  54. data/lib/stripe/events/v2_orchestrated_commerce_agreement_confirmed_event.rb +97 -0
  55. data/lib/stripe/events/v2_orchestrated_commerce_agreement_created_event.rb +97 -0
  56. data/lib/stripe/events/v2_orchestrated_commerce_agreement_partially_confirmed_event.rb +97 -0
  57. data/lib/stripe/events/v2_orchestrated_commerce_agreement_terminated_event.rb +97 -0
  58. data/lib/stripe/events/v2_signals_account_evaluation_complete_event.rb +44 -0
  59. data/lib/stripe/events/v2_signals_account_signal_fraudulent_merchant_ready_event.rb +44 -0
  60. data/lib/stripe/events/v2_signals_account_signal_fraudulent_website_ready_event.rb +44 -0
  61. data/lib/stripe/object_types.rb +52 -0
  62. data/lib/stripe/params/account_create_params.rb +299 -1
  63. data/lib/stripe/params/account_notice_list_params.rb +25 -0
  64. data/lib/stripe/params/account_notice_retrieve_params.rb +13 -0
  65. data/lib/stripe/params/account_notice_update_params.rb +36 -0
  66. data/lib/stripe/params/account_session_create_params.rb +191 -0
  67. data/lib/stripe/params/account_update_params.rb +261 -0
  68. data/lib/stripe/params/balance_settings_update_params.rb +9 -1
  69. data/lib/stripe/params/billing/analytics/meter_usage_retrieve_params.rb +65 -0
  70. data/lib/stripe/params/capital/financing_offer_create_params.rb +37 -0
  71. data/lib/stripe/params/capital/financing_offer_list_params.rb +58 -0
  72. data/lib/stripe/params/capital/financing_offer_mark_delivered_params.rb +15 -0
  73. data/lib/stripe/params/capital/financing_offer_refill_params.rb +37 -0
  74. data/lib/stripe/params/capital/financing_offer_retrieve_params.rb +15 -0
  75. data/lib/stripe/params/capital/financing_summary_retrieve_params.rb +15 -0
  76. data/lib/stripe/params/capital/financing_transaction_list_params.rb +45 -0
  77. data/lib/stripe/params/capital/financing_transaction_retrieve_params.rb +15 -0
  78. data/lib/stripe/params/charge_capture_params.rb +1646 -0
  79. data/lib/stripe/params/charge_update_params.rb +1646 -0
  80. data/lib/stripe/params/checkout/session_create_params.rb +87 -3
  81. data/lib/stripe/params/checkout/session_update_params.rb +161 -1
  82. data/lib/stripe/params/confirmation_token_create_params.rb +92 -0
  83. data/lib/stripe/params/coupon_create_params.rb +48 -1
  84. data/lib/stripe/params/customer_balance_transaction_create_params.rb +23 -1
  85. data/lib/stripe/params/customer_session_create_params.rb +32 -1
  86. data/lib/stripe/params/external_account_create_params.rb +134 -0
  87. data/lib/stripe/params/external_account_delete_params.rb +6 -0
  88. data/lib/stripe/params/external_account_list_params.rb +25 -0
  89. data/lib/stripe/params/external_account_retrieve_params.rb +13 -0
  90. data/lib/stripe/params/external_account_update_params.rb +91 -0
  91. data/lib/stripe/params/financial_connections/account_inferred_balance_list_params.rb +24 -0
  92. data/lib/stripe/params/financial_connections/authorization_retrieve_params.rb +15 -0
  93. data/lib/stripe/params/financial_connections/institution_list_params.rb +24 -0
  94. data/lib/stripe/params/financial_connections/institution_retrieve_params.rb +15 -0
  95. data/lib/stripe/params/financial_connections/session_create_params.rb +38 -1
  96. data/lib/stripe/params/fx_quote_create_params.rb +71 -0
  97. data/lib/stripe/params/fx_quote_list_params.rb +22 -0
  98. data/lib/stripe/params/fx_quote_retrieve_params.rb +13 -0
  99. data/lib/stripe/params/invoice_add_lines_params.rb +33 -1
  100. data/lib/stripe/params/invoice_attach_payment_params.rb +43 -1
  101. data/lib/stripe/params/invoice_create_params.rb +64 -2
  102. data/lib/stripe/params/invoice_create_preview_params.rb +772 -9
  103. data/lib/stripe/params/invoice_detach_payment_params.rb +16 -0
  104. data/lib/stripe/params/invoice_item_create_params.rb +33 -1
  105. data/lib/stripe/params/invoice_item_update_params.rb +33 -1
  106. data/lib/stripe/params/invoice_line_item_update_params.rb +33 -1
  107. data/lib/stripe/params/invoice_update_lines_params.rb +33 -1
  108. data/lib/stripe/params/invoice_update_params.rb +64 -2
  109. data/lib/stripe/params/issuing/cardholder_create_params.rb +2 -1
  110. data/lib/stripe/params/issuing/cardholder_update_params.rb +4 -0
  111. data/lib/stripe/params/issuing/credit_underwriting_record_correct_params.rb +163 -0
  112. data/lib/stripe/params/issuing/credit_underwriting_record_create_from_application_params.rb +50 -0
  113. data/lib/stripe/params/issuing/credit_underwriting_record_create_from_proactive_review_params.rb +128 -0
  114. data/lib/stripe/params/issuing/credit_underwriting_record_list_params.rb +24 -0
  115. data/lib/stripe/params/issuing/credit_underwriting_record_report_decision_params.rb +86 -0
  116. data/lib/stripe/params/issuing/credit_underwriting_record_retrieve_params.rb +15 -0
  117. data/lib/stripe/params/issuing/dispute_settlement_detail_list_params.rb +33 -0
  118. data/lib/stripe/params/issuing/dispute_settlement_detail_retrieve_params.rb +15 -0
  119. data/lib/stripe/params/issuing/fraud_liability_debit_list_params.rb +44 -0
  120. data/lib/stripe/params/issuing/fraud_liability_debit_retrieve_params.rb +15 -0
  121. data/lib/stripe/params/issuing/transaction_list_params.rb +4 -0
  122. data/lib/stripe/params/mandate_list_params.rb +39 -0
  123. data/lib/stripe/params/margin_create_params.rb +25 -0
  124. data/lib/stripe/params/margin_list_params.rb +25 -0
  125. data/lib/stripe/params/margin_retrieve_params.rb +13 -0
  126. data/lib/stripe/params/margin_update_params.rb +22 -0
  127. data/lib/stripe/params/order_create_params.rb +2083 -0
  128. data/lib/stripe/params/order_list_params.rb +25 -0
  129. data/lib/stripe/params/order_retrieve_params.rb +13 -0
  130. data/lib/stripe/params/order_submit_params.rb +16 -0
  131. data/lib/stripe/params/order_update_params.rb +2087 -0
  132. data/lib/stripe/params/payment_intent_capture_params.rb +981 -1
  133. data/lib/stripe/params/payment_intent_confirm_params.rb +2391 -100
  134. data/lib/stripe/params/payment_intent_create_params.rb +2391 -100
  135. data/lib/stripe/params/payment_intent_decrement_authorization_params.rb +297 -0
  136. data/lib/stripe/params/payment_intent_increment_authorization_params.rb +37 -0
  137. data/lib/stripe/params/payment_intent_trigger_action_params.rb +27 -0
  138. data/lib/stripe/params/payment_intent_update_params.rb +2423 -101
  139. data/lib/stripe/params/payment_method_configuration_create_params.rb +105 -0
  140. data/lib/stripe/params/payment_method_configuration_update_params.rb +105 -0
  141. data/lib/stripe/params/payment_method_create_params.rb +88 -0
  142. data/lib/stripe/params/payment_plan_create_params.rb +128 -0
  143. data/lib/stripe/params/payment_plan_list_params.rb +25 -0
  144. data/lib/stripe/params/payment_plan_retrieve_params.rb +13 -0
  145. data/lib/stripe/params/payment_plan_update_params.rb +105 -0
  146. data/lib/stripe/params/price_update_params.rb +19 -0
  147. data/lib/stripe/params/privacy/redaction_job_cancel_params.rb +15 -0
  148. data/lib/stripe/params/privacy/redaction_job_create_params.rb +67 -0
  149. data/lib/stripe/params/privacy/redaction_job_list_params.rb +27 -0
  150. data/lib/stripe/params/privacy/redaction_job_retrieve_params.rb +15 -0
  151. data/lib/stripe/params/privacy/redaction_job_run_params.rb +15 -0
  152. data/lib/stripe/params/privacy/redaction_job_update_params.rb +18 -0
  153. data/lib/stripe/params/privacy/redaction_job_validate_params.rb +15 -0
  154. data/lib/stripe/params/privacy/redaction_job_validation_error_list_params.rb +24 -0
  155. data/lib/stripe/params/quote_create_params.rb +809 -3
  156. data/lib/stripe/params/quote_line_list_params.rb +22 -0
  157. data/lib/stripe/params/quote_list_lines_params.rb +22 -0
  158. data/lib/stripe/params/quote_list_params.rb +4 -0
  159. data/lib/stripe/params/quote_list_preview_invoice_lines_params.rb +22 -0
  160. data/lib/stripe/params/quote_mark_draft_params.rb +13 -0
  161. data/lib/stripe/params/quote_mark_stale_params.rb +16 -0
  162. data/lib/stripe/params/quote_preview_invoice_list_params.rb +22 -0
  163. data/lib/stripe/params/quote_preview_subscription_schedule_list_params.rb +22 -0
  164. data/lib/stripe/params/quote_reestimate_params.rb +13 -0
  165. data/lib/stripe/params/quote_update_params.rb +817 -4
  166. data/lib/stripe/params/radar/billing_evaluation_create_params.rb +231 -0
  167. data/lib/stripe/params/reserve/hold_list_params.rb +53 -0
  168. data/lib/stripe/params/reserve/hold_retrieve_params.rb +15 -0
  169. data/lib/stripe/params/reserve/plan_list_params.rb +37 -0
  170. data/lib/stripe/params/reserve/plan_retrieve_params.rb +15 -0
  171. data/lib/stripe/params/reserve/release_list_params.rb +41 -0
  172. data/lib/stripe/params/reserve/release_retrieve_params.rb +15 -0
  173. data/lib/stripe/params/setup_intent_confirm_params.rb +122 -3
  174. data/lib/stripe/params/setup_intent_create_params.rb +122 -3
  175. data/lib/stripe/params/setup_intent_update_params.rb +122 -3
  176. data/lib/stripe/params/shared_payment/granted_token_create_params.rb +47 -0
  177. data/lib/stripe/params/shared_payment/granted_token_retrieve_params.rb +15 -0
  178. data/lib/stripe/params/shared_payment/granted_token_revoke_params.rb +15 -0
  179. data/lib/stripe/params/shared_payment/issued_token_create_params.rb +71 -0
  180. data/lib/stripe/params/shared_payment/issued_token_retrieve_params.rb +15 -0
  181. data/lib/stripe/params/shared_payment/issued_token_revoke_params.rb +15 -0
  182. data/lib/stripe/params/subscription_create_params.rb +133 -6
  183. data/lib/stripe/params/subscription_item_create_params.rb +50 -3
  184. data/lib/stripe/params/subscription_item_update_params.rb +33 -2
  185. data/lib/stripe/params/subscription_schedule_amend_params.rb +578 -0
  186. data/lib/stripe/params/subscription_schedule_create_params.rb +167 -5
  187. data/lib/stripe/params/subscription_schedule_update_params.rb +167 -5
  188. data/lib/stripe/params/subscription_update_params.rb +116 -5
  189. data/lib/stripe/params/tax/form_list_params.rb +51 -0
  190. data/lib/stripe/params/tax/form_pdf_params.rb +15 -0
  191. data/lib/stripe/params/tax/form_retrieve_params.rb +15 -0
  192. data/lib/stripe/params/terminal/reader_collected_data_retrieve_params.rb +15 -0
  193. data/lib/stripe/params/test_helpers/capital/financing_offer_create_params.rb +39 -0
  194. data/lib/stripe/params/test_helpers/capital/financing_offer_refill_params.rb +39 -0
  195. data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +92 -0
  196. data/lib/stripe/params/test_helpers/shared_payment/granted_token_create_params.rb +49 -0
  197. data/lib/stripe/params/test_helpers/shared_payment/granted_token_revoke_params.rb +17 -0
  198. data/lib/stripe/params/test_helpers/treasury/received_credit_create_params.rb +25 -1
  199. data/lib/stripe/params/test_helpers/treasury/received_debit_create_params.rb +25 -1
  200. data/lib/stripe/params/transfer_create_params.rb +4 -0
  201. data/lib/stripe/params/treasury/financial_account_create_params.rb +8 -1
  202. data/lib/stripe/params/treasury/financial_account_features_update_params.rb +4 -1
  203. data/lib/stripe/params/treasury/financial_account_update_features_params.rb +4 -1
  204. data/lib/stripe/params/treasury/financial_account_update_params.rb +8 -1
  205. data/lib/stripe/params/treasury/outbound_payment_create_params.rb +19 -0
  206. data/lib/stripe/params/treasury/outbound_transfer_create_params.rb +24 -0
  207. data/lib/stripe/params/treasury/received_credit_create_params.rb +25 -1
  208. data/lib/stripe/params/treasury/received_debit_create_params.rb +25 -1
  209. data/lib/stripe/params/v2/billing/bill_setting_create_params.rb +74 -0
  210. data/lib/stripe/params/v2/billing/bill_setting_list_params.rb +21 -0
  211. data/lib/stripe/params/v2/billing/bill_setting_retrieve_params.rb +10 -0
  212. data/lib/stripe/params/v2/billing/bill_setting_update_params.rb +80 -0
  213. data/lib/stripe/params/v2/billing/bill_settings/version_list_params.rb +19 -0
  214. data/lib/stripe/params/v2/billing/bill_settings/version_retrieve_params.rb +12 -0
  215. data/lib/stripe/params/v2/billing/collection_setting_create_params.rb +257 -0
  216. data/lib/stripe/params/v2/billing/collection_setting_list_params.rb +21 -0
  217. data/lib/stripe/params/v2/billing/collection_setting_retrieve_params.rb +10 -0
  218. data/lib/stripe/params/v2/billing/collection_setting_update_params.rb +263 -0
  219. data/lib/stripe/params/v2/billing/collection_settings/version_list_params.rb +19 -0
  220. data/lib/stripe/params/v2/billing/collection_settings/version_retrieve_params.rb +12 -0
  221. data/lib/stripe/params/v2/billing/profile_create_params.rb +37 -0
  222. data/lib/stripe/params/v2/billing/profile_list_params.rb +40 -0
  223. data/lib/stripe/params/v2/billing/profile_retrieve_params.rb +10 -0
  224. data/lib/stripe/params/v2/billing/profile_update_params.rb +35 -0
  225. data/lib/stripe/params/v2/core/account_create_params.rb +392 -5
  226. data/lib/stripe/params/v2/core/account_token_create_params.rb +29 -1
  227. data/lib/stripe/params/v2/core/account_update_params.rb +376 -4
  228. data/lib/stripe/params/v2/core/approval_request_cancel_params.rb +10 -0
  229. data/lib/stripe/params/v2/core/approval_request_list_params.rb +47 -0
  230. data/lib/stripe/params/v2/core/approval_request_retrieve_params.rb +10 -0
  231. data/lib/stripe/params/v2/core/approval_request_update_params.rb +17 -0
  232. data/lib/stripe/params/v2/core/batch_job_cancel_params.rb +10 -0
  233. data/lib/stripe/params/v2/core/batch_job_create_params.rb +53 -0
  234. data/lib/stripe/params/v2/core/batch_job_retrieve_params.rb +10 -0
  235. data/lib/stripe/params/v2/core/vault/gb_bank_account_create_params.rb +21 -0
  236. data/lib/stripe/params/v2/data/query_run_create_params.rb +50 -0
  237. data/lib/stripe/params/v2/data/query_run_retrieve_params.rb +23 -0
  238. data/lib/stripe/params/v2/data/report_list_params.rb +23 -0
  239. data/lib/stripe/params/v2/data/report_retrieve_params.rb +17 -0
  240. data/lib/stripe/params/v2/data/report_run_create_params.rb +48 -0
  241. data/lib/stripe/params/v2/data/report_run_retrieve_params.rb +23 -0
  242. data/lib/stripe/params/v2/data/reporting/query_run_create_params.rb +31 -0
  243. data/lib/stripe/params/v2/data/reporting/query_run_retrieve_params.rb +12 -0
  244. data/lib/stripe/params/v2/data/schema_list_params.rb +26 -0
  245. data/lib/stripe/params/v2/data/schema_retrieve_params.rb +10 -0
  246. data/lib/stripe/params/v2/extend/workflow_invoke_params.rb +17 -0
  247. data/lib/stripe/params/v2/extend/workflow_list_params.rb +21 -0
  248. data/lib/stripe/params/v2/extend/workflow_retrieve_params.rb +10 -0
  249. data/lib/stripe/params/v2/extend/workflow_run_list_params.rb +23 -0
  250. data/lib/stripe/params/v2/extend/workflow_run_retrieve_params.rb +10 -0
  251. data/lib/stripe/params/v2/iam/activity_log_list_params.rb +26 -0
  252. data/lib/stripe/params/v2/iam/activity_log_retrieve_params.rb +10 -0
  253. data/lib/stripe/params/v2/money_management/financial_account_close_params.rb +30 -0
  254. data/lib/stripe/params/v2/money_management/financial_account_create_params.rb +35 -0
  255. data/lib/stripe/params/v2/money_management/outbound_payment_create_params.rb +21 -0
  256. data/lib/stripe/params/v2/money_management/outbound_payment_quote_create_params.rb +113 -0
  257. data/lib/stripe/params/v2/money_management/outbound_payment_quote_retrieve_params.rb +10 -0
  258. data/lib/stripe/params/v2/money_management/outbound_setup_intent_create_params.rb +61 -1
  259. data/lib/stripe/params/v2/money_management/outbound_setup_intent_update_params.rb +22 -1
  260. data/lib/stripe/params/v2/money_management/outbound_transfer_cancel_params.rb +10 -0
  261. data/lib/stripe/params/v2/money_management/outbound_transfer_create_params.rb +112 -0
  262. data/lib/stripe/params/v2/money_management/outbound_transfer_list_params.rb +48 -0
  263. data/lib/stripe/params/v2/money_management/outbound_transfer_retrieve_params.rb +10 -0
  264. data/lib/stripe/params/v2/money_management/payout_method_disable_params.rb +10 -0
  265. data/lib/stripe/params/v2/money_management/received_debit_list_params.rb +37 -0
  266. data/lib/stripe/params/v2/money_management/received_debit_retrieve_params.rb +10 -0
  267. data/lib/stripe/params/v2/money_management/test_helpers/financial_address_generate_microdeposits_params.rb +12 -0
  268. data/lib/stripe/params/v2/network/business_profile_me_params.rb +10 -0
  269. data/lib/stripe/params/v2/network/business_profile_retrieve_params.rb +10 -0
  270. data/lib/stripe/params/v2/orchestrated_commerce/agreement_confirm_params.rb +10 -0
  271. data/lib/stripe/params/v2/orchestrated_commerce/agreement_create_params.rb +17 -0
  272. data/lib/stripe/params/v2/orchestrated_commerce/agreement_list_params.rb +20 -0
  273. data/lib/stripe/params/v2/orchestrated_commerce/agreement_retrieve_params.rb +10 -0
  274. data/lib/stripe/params/v2/orchestrated_commerce/agreement_terminate_params.rb +10 -0
  275. data/lib/stripe/params/v2/signals/account_activity_create_params.rb +200 -0
  276. data/lib/stripe/params/v2/signals/account_activity_delete_params.rb +10 -0
  277. data/lib/stripe/params/v2/signals/account_activity_retrieve_params.rb +10 -0
  278. data/lib/stripe/params/v2/signals/account_evaluation_create_params.rb +192 -0
  279. data/lib/stripe/params/v2/signals/account_evaluation_retrieve_params.rb +10 -0
  280. data/lib/stripe/params/v2/signals/account_signal_list_params.rb +35 -0
  281. data/lib/stripe/params/v2/signals/account_signal_retrieve_params.rb +10 -0
  282. data/lib/stripe/params.rb +365 -0
  283. data/lib/stripe/resources/account.rb +176 -1
  284. data/lib/stripe/resources/account_notice.rb +94 -0
  285. data/lib/stripe/resources/account_session.rb +162 -0
  286. data/lib/stripe/resources/balance.rb +83 -0
  287. data/lib/stripe/resources/balance_settings.rb +4 -0
  288. data/lib/stripe/resources/billing/alert_triggered.rb +4 -0
  289. data/lib/stripe/resources/billing/analytics/meter_usage.rb +33 -0
  290. data/lib/stripe/resources/billing/analytics/meter_usage_row.rb +38 -0
  291. data/lib/stripe/resources/capital/financing_offer.rb +185 -0
  292. data/lib/stripe/resources/capital/financing_summary.rb +82 -0
  293. data/lib/stripe/resources/capital/financing_transaction.rb +99 -0
  294. data/lib/stripe/resources/card.rb +18 -1
  295. data/lib/stripe/resources/charge.rb +227 -1
  296. data/lib/stripe/resources/checkout/session.rb +91 -3
  297. data/lib/stripe/resources/confirmation_token.rb +131 -0
  298. data/lib/stripe/resources/coupon.rb +58 -1
  299. data/lib/stripe/resources/credit_note_line_item.rb +18 -0
  300. data/lib/stripe/resources/customer.rb +16 -0
  301. data/lib/stripe/resources/customer_session.rb +36 -0
  302. data/lib/stripe/resources/dispute.rb +18 -0
  303. data/lib/stripe/resources/event.rb +64 -1
  304. data/lib/stripe/resources/financial_connections/account.rb +45 -1
  305. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +35 -0
  306. data/lib/stripe/resources/financial_connections/authorization.rb +24 -1
  307. data/lib/stripe/resources/financial_connections/institution.rb +127 -0
  308. data/lib/stripe/resources/financial_connections/session.rb +92 -0
  309. data/lib/stripe/resources/fx_quote.rb +147 -0
  310. data/lib/stripe/resources/invoice.rb +126 -1
  311. data/lib/stripe/resources/invoice_item.rb +2 -0
  312. data/lib/stripe/resources/invoice_line_item.rb +40 -0
  313. data/lib/stripe/resources/issuing/authorization.rb +16 -0
  314. data/lib/stripe/resources/issuing/card.rb +16 -0
  315. data/lib/stripe/resources/issuing/cardholder.rb +16 -0
  316. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +263 -0
  317. data/lib/stripe/resources/issuing/dispute.rb +16 -1
  318. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +71 -0
  319. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +51 -0
  320. data/lib/stripe/resources/issuing/settlement.rb +61 -0
  321. data/lib/stripe/resources/issuing/transaction.rb +18 -0
  322. data/lib/stripe/resources/line_item.rb +42 -0
  323. data/lib/stripe/resources/mandate.rb +12 -0
  324. data/lib/stripe/resources/margin.rb +64 -0
  325. data/lib/stripe/resources/order.rb +927 -0
  326. data/lib/stripe/resources/payment_attempt_record.rb +177 -1
  327. data/lib/stripe/resources/payment_intent.rb +1018 -13
  328. data/lib/stripe/resources/payment_method.rb +151 -0
  329. data/lib/stripe/resources/payment_method_configuration.rb +170 -0
  330. data/lib/stripe/resources/payment_plan.rb +213 -0
  331. data/lib/stripe/resources/payment_record.rb +177 -1
  332. data/lib/stripe/resources/price.rb +20 -0
  333. data/lib/stripe/resources/privacy/redaction_job.rb +189 -0
  334. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +49 -0
  335. data/lib/stripe/resources/quote.rb +569 -2
  336. data/lib/stripe/resources/quote_line.rb +525 -0
  337. data/lib/stripe/resources/quote_preview_invoice.rb +1261 -0
  338. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +968 -0
  339. data/lib/stripe/resources/radar/billing_evaluation.rb +281 -0
  340. data/lib/stripe/resources/radar/value_list_item.rb +15 -1
  341. data/lib/stripe/resources/refund.rb +18 -0
  342. data/lib/stripe/resources/reserve/hold.rb +7 -0
  343. data/lib/stripe/resources/reserve/plan.rb +7 -0
  344. data/lib/stripe/resources/reserve/release.rb +12 -0
  345. data/lib/stripe/resources/setup_attempt.rb +35 -0
  346. data/lib/stripe/resources/setup_intent.rb +38 -1
  347. data/lib/stripe/resources/shared_payment/granted_token.rb +681 -0
  348. data/lib/stripe/resources/shared_payment/issued_token.rb +310 -0
  349. data/lib/stripe/resources/source.rb +54 -0
  350. data/lib/stripe/resources/subscription.rb +73 -0
  351. data/lib/stripe/resources/subscription_item.rb +22 -1
  352. data/lib/stripe/resources/subscription_schedule.rb +198 -3
  353. data/lib/stripe/resources/tax/form.rb +264 -0
  354. data/lib/stripe/resources/terminal/reader.rb +8 -0
  355. data/lib/stripe/resources/terminal/reader_collected_data.rb +47 -0
  356. data/lib/stripe/resources/token.rb +15 -1
  357. data/lib/stripe/resources/transfer.rb +2 -0
  358. data/lib/stripe/resources/treasury/financial_account.rb +2 -0
  359. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  360. data/lib/stripe/resources/treasury/outbound_payment.rb +2 -0
  361. data/lib/stripe/resources/treasury/outbound_transfer.rb +30 -0
  362. data/lib/stripe/resources/treasury/received_credit.rb +30 -0
  363. data/lib/stripe/resources/treasury/received_debit.rb +32 -0
  364. data/lib/stripe/resources/v2/billing/bill_setting.rb +102 -0
  365. data/lib/stripe/resources/v2/billing/bill_setting_version.rb +91 -0
  366. data/lib/stripe/resources/v2/billing/collection_setting.rb +327 -0
  367. data/lib/stripe/resources/v2/billing/collection_setting_version.rb +316 -0
  368. data/lib/stripe/resources/v2/billing/profile.rb +47 -0
  369. data/lib/stripe/resources/v2/core/account.rb +802 -2
  370. data/lib/stripe/resources/v2/core/approval_request.rb +395 -0
  371. data/lib/stripe/resources/v2/core/batch_job.rb +536 -0
  372. data/lib/stripe/resources/v2/core/event_notification.rb +1 -0
  373. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +91 -1
  374. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +26 -1
  375. data/lib/stripe/resources/v2/data/query_run.rb +255 -0
  376. data/lib/stripe/resources/v2/data/report.rb +104 -0
  377. data/lib/stripe/resources/v2/data/report_run.rb +246 -0
  378. data/lib/stripe/resources/v2/data/reporting/query_run.rb +143 -0
  379. data/lib/stripe/resources/v2/data/schema.rb +121 -0
  380. data/lib/stripe/resources/v2/extend/workflow.rb +80 -0
  381. data/lib/stripe/resources/v2/extend/workflow_run.rb +158 -0
  382. data/lib/stripe/resources/v2/iam/activity_log.rb +926 -0
  383. data/lib/stripe/resources/v2/money_management/adjustment.rb +4 -0
  384. data/lib/stripe/resources/v2/money_management/financial_account.rb +50 -1
  385. data/lib/stripe/resources/v2/money_management/financial_address_generated_microdeposits.rb +33 -0
  386. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +2 -0
  387. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +63 -1
  388. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +255 -0
  389. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +31 -1
  390. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +260 -0
  391. data/lib/stripe/resources/v2/money_management/payout_method.rb +77 -1
  392. data/lib/stripe/resources/v2/money_management/received_credit.rb +2 -0
  393. data/lib/stripe/resources/v2/money_management/received_debit.rb +177 -0
  394. data/lib/stripe/resources/v2/money_management/recipient_verification.rb +2 -0
  395. data/lib/stripe/resources/v2/network/business_profile.rb +84 -0
  396. data/lib/stripe/resources/v2/orchestrated_commerce/agreement.rb +93 -0
  397. data/lib/stripe/resources/v2/signals/account_activity.rb +252 -0
  398. data/lib/stripe/resources/v2/signals/account_evaluation.rb +249 -0
  399. data/lib/stripe/resources/v2/signals/account_signal.rb +184 -0
  400. data/lib/stripe/resources.rb +339 -0
  401. data/lib/stripe/services/account_notice_service.rb +39 -0
  402. data/lib/stripe/services/account_service.rb +15 -0
  403. data/lib/stripe/services/billing/analytics/meter_usage_service.rb +21 -0
  404. data/lib/stripe/services/billing/analytics_service.rb +15 -0
  405. data/lib/stripe/services/billing_service.rb +2 -1
  406. data/lib/stripe/services/capital/financing_offer_service.rb +42 -0
  407. data/lib/stripe/services/capital/financing_summary_service.rb +19 -0
  408. data/lib/stripe/services/capital/financing_transaction_service.rb +31 -0
  409. data/lib/stripe/services/capital_service.rb +15 -0
  410. data/lib/stripe/services/coupon_service.rb +14 -0
  411. data/lib/stripe/services/customer_service.rb +15 -0
  412. data/lib/stripe/services/external_account_service.rb +68 -0
  413. data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +19 -0
  414. data/lib/stripe/services/financial_connections/account_service.rb +3 -1
  415. data/lib/stripe/services/financial_connections/authorization_service.rb +19 -0
  416. data/lib/stripe/services/financial_connections/institution_service.rb +30 -0
  417. data/lib/stripe/services/financial_connections_service.rb +3 -1
  418. data/lib/stripe/services/fx_quote_service.rb +27 -0
  419. data/lib/stripe/services/invoice_service.rb +11 -0
  420. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +74 -0
  421. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +30 -0
  422. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +30 -0
  423. data/lib/stripe/services/issuing_service.rb +5 -1
  424. data/lib/stripe/services/mandate_service.rb +5 -0
  425. data/lib/stripe/services/margin_service.rb +50 -0
  426. data/lib/stripe/services/order_service.rb +53 -0
  427. data/lib/stripe/services/payment_intent_service.rb +37 -0
  428. data/lib/stripe/services/payment_plan_service.rb +50 -0
  429. data/lib/stripe/services/privacy/redaction_job_service.rb +104 -0
  430. data/lib/stripe/services/privacy/redaction_job_validation_error_service.rb +19 -0
  431. data/lib/stripe/services/privacy_service.rb +13 -0
  432. data/lib/stripe/services/promotion_code_service.rb +29 -0
  433. data/lib/stripe/services/quote_line_service.rb +17 -0
  434. data/lib/stripe/services/quote_preview_invoice_service.rb +17 -0
  435. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +17 -0
  436. data/lib/stripe/services/quote_service.rb +49 -1
  437. data/lib/stripe/services/radar/billing_evaluation_service.rb +19 -0
  438. data/lib/stripe/services/radar_service.rb +2 -1
  439. data/lib/stripe/services/reserve/hold_service.rb +30 -0
  440. data/lib/stripe/services/reserve/plan_service.rb +30 -0
  441. data/lib/stripe/services/reserve/release_service.rb +30 -0
  442. data/lib/stripe/services/reserve_service.rb +15 -0
  443. data/lib/stripe/services/shared_payment/granted_token_service.rb +19 -0
  444. data/lib/stripe/services/shared_payment/issued_token_service.rb +41 -0
  445. data/lib/stripe/services/shared_payment_service.rb +14 -0
  446. data/lib/stripe/services/subscription_schedule_service.rb +11 -0
  447. data/lib/stripe/services/subscription_service.rb +45 -0
  448. data/lib/stripe/services/tax/form_service.rb +37 -0
  449. data/lib/stripe/services/tax_service.rb +2 -1
  450. data/lib/stripe/services/terminal/reader_collected_data_service.rb +19 -0
  451. data/lib/stripe/services/terminal_service.rb +2 -1
  452. data/lib/stripe/services/test_helpers/capital/financing_offer_service.rb +32 -0
  453. data/lib/stripe/services/test_helpers/capital_service.rb +15 -0
  454. data/lib/stripe/services/test_helpers/shared_payment/granted_token_service.rb +32 -0
  455. data/lib/stripe/services/test_helpers/shared_payment_service.rb +15 -0
  456. data/lib/stripe/services/test_helpers_service.rb +3 -1
  457. data/lib/stripe/services/v1_services.rb +11 -1
  458. data/lib/stripe/services/v2/billing/bill_setting_service.rb +61 -0
  459. data/lib/stripe/services/v2/billing/bill_settings/version_service.rb +34 -0
  460. data/lib/stripe/services/v2/billing/collection_setting_service.rb +69 -0
  461. data/lib/stripe/services/v2/billing/collection_settings/version_service.rb +34 -0
  462. data/lib/stripe/services/v2/billing/profile_service.rb +54 -0
  463. data/lib/stripe/services/v2/billing_service.rb +4 -1
  464. data/lib/stripe/services/v2/core/approval_request_service.rb +58 -0
  465. data/lib/stripe/services/v2/core/batch_job_service.rb +43 -0
  466. data/lib/stripe/services/v2/core_service.rb +3 -1
  467. data/lib/stripe/services/v2/data/query_run_service.rb +34 -0
  468. data/lib/stripe/services/v2/data/report_run_service.rb +36 -0
  469. data/lib/stripe/services/v2/data/report_service.rb +34 -0
  470. data/lib/stripe/services/v2/data/reporting/query_run_service.rb +35 -0
  471. data/lib/stripe/services/v2/data/reporting_service.rb +17 -0
  472. data/lib/stripe/services/v2/data/schema_service.rb +32 -0
  473. data/lib/stripe/services/v2/data_service.rb +19 -0
  474. data/lib/stripe/services/v2/extend/workflow_run_service.rb +32 -0
  475. data/lib/stripe/services/v2/extend/workflow_service.rb +45 -0
  476. data/lib/stripe/services/v2/extend_service.rb +16 -0
  477. data/lib/stripe/services/v2/iam/activity_log_service.rb +32 -0
  478. data/lib/stripe/services/v2/iam_service.rb +15 -0
  479. data/lib/stripe/services/v2/money_management/financial_account_service.rb +27 -0
  480. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +35 -0
  481. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +61 -0
  482. data/lib/stripe/services/v2/money_management/payout_method_service.rb +15 -0
  483. data/lib/stripe/services/v2/money_management/received_debit_service.rb +32 -0
  484. data/lib/stripe/services/v2/money_management/test_helpers/financial_address_service.rb +13 -0
  485. data/lib/stripe/services/v2/money_management_service.rb +5 -1
  486. data/lib/stripe/services/v2/network/business_profile_service.rb +32 -0
  487. data/lib/stripe/services/v2/network_service.rb +15 -0
  488. data/lib/stripe/services/v2/orchestrated_commerce/agreement_service.rb +65 -0
  489. data/lib/stripe/services/v2/orchestrated_commerce_service.rb +15 -0
  490. data/lib/stripe/services/v2/signals/account_activity_service.rb +43 -0
  491. data/lib/stripe/services/v2/signals/account_evaluation_service.rb +32 -0
  492. data/lib/stripe/services/v2/signals/account_signal_service.rb +32 -0
  493. data/lib/stripe/services/v2/signals_service.rb +17 -0
  494. data/lib/stripe/services/v2_services.rb +7 -1
  495. data/lib/stripe/services.rb +186 -0
  496. data/lib/stripe/stripe_client.rb +4 -1
  497. data/lib/stripe/stripe_configuration.rb +3 -1
  498. data/lib/stripe/stripe_event_notification_handler.rb +216 -0
  499. data/lib/stripe/stripe_object.rb +1 -1
  500. data/lib/stripe/util.rb +7 -1
  501. data/lib/stripe/version.rb +1 -1
  502. data/lib/stripe.rb +53 -0
  503. data/rbi/stripe/resources/v2/core/event_notification.rbi +2 -0
  504. data/rbi/stripe.rbi +100059 -38254
  505. metadata +330 -3
@@ -0,0 +1,1261 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ module Stripe
5
+ # Invoices are statements of amounts owed by a customer. A quote preview invoice shows the invoice
6
+ # that would be generated by accepting the quote.
7
+ class QuotePreviewInvoice < APIResource
8
+ OBJECT_NAME = "quote_preview_invoice"
9
+ def self.object_name
10
+ "quote_preview_invoice"
11
+ end
12
+
13
+ class AmountsDue < ::Stripe::StripeObject
14
+ # Incremental amount due for this payment in cents (or local equivalent).
15
+ attr_reader :amount
16
+ # The amount in cents (or local equivalent) that was paid for this payment.
17
+ attr_reader :amount_paid
18
+ # The difference between the payment’s amount and amount_paid, in cents (or local equivalent).
19
+ attr_reader :amount_remaining
20
+ # Number of days from when invoice is finalized until the payment is due.
21
+ attr_reader :days_until_due
22
+ # An arbitrary string attached to the object. Often useful for displaying to users.
23
+ attr_reader :description
24
+ # Date on which a payment plan’s payment is due.
25
+ attr_reader :due_date
26
+ # Timestamp when the payment was paid.
27
+ attr_reader :paid_at
28
+ # The status of the payment, one of `open`, `paid`, or `past_due`
29
+ attr_reader :status
30
+
31
+ def self.inner_class_types
32
+ @inner_class_types = {}
33
+ end
34
+
35
+ def self.field_remappings
36
+ @field_remappings = {}
37
+ end
38
+ end
39
+
40
+ class AppliesTo < ::Stripe::StripeObject
41
+ # A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
42
+ attr_reader :new_reference
43
+ # The ID of the schedule the line applies to.
44
+ attr_reader :subscription_schedule
45
+ # Describes whether the quote line is affecting a new schedule or an existing schedule.
46
+ attr_reader :type
47
+
48
+ def self.inner_class_types
49
+ @inner_class_types = {}
50
+ end
51
+
52
+ def self.field_remappings
53
+ @field_remappings = {}
54
+ end
55
+ end
56
+
57
+ class AutomaticTax < ::Stripe::StripeObject
58
+ class Liability < ::Stripe::StripeObject
59
+ # The connected account being referenced when `type` is `account`.
60
+ attr_reader :account
61
+ # Type of the account referenced.
62
+ attr_reader :type
63
+
64
+ def self.inner_class_types
65
+ @inner_class_types = {}
66
+ end
67
+
68
+ def self.field_remappings
69
+ @field_remappings = {}
70
+ end
71
+ end
72
+ # If Stripe disabled automatic tax, this enum describes why.
73
+ attr_reader :disabled_reason
74
+ # Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
75
+ attr_reader :enabled
76
+ # 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.
77
+ attr_reader :liability
78
+ # The tax provider powering automatic tax.
79
+ attr_reader :provider
80
+ # The status of the most recent automated tax calculation for this invoice.
81
+ attr_reader :status
82
+
83
+ def self.inner_class_types
84
+ @inner_class_types = { liability: Liability }
85
+ end
86
+
87
+ def self.field_remappings
88
+ @field_remappings = {}
89
+ end
90
+ end
91
+
92
+ class ConfirmationSecret < ::Stripe::StripeObject
93
+ # The client_secret of the payment that Stripe creates for the invoice after finalization.
94
+ attr_reader :client_secret
95
+ # The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization
96
+ attr_reader :type
97
+
98
+ def self.inner_class_types
99
+ @inner_class_types = {}
100
+ end
101
+
102
+ def self.field_remappings
103
+ @field_remappings = {}
104
+ end
105
+ end
106
+
107
+ class CustomField < ::Stripe::StripeObject
108
+ # The name of the custom field.
109
+ attr_reader :name
110
+ # The value of the custom field.
111
+ attr_reader :value
112
+
113
+ def self.inner_class_types
114
+ @inner_class_types = {}
115
+ end
116
+
117
+ def self.field_remappings
118
+ @field_remappings = {}
119
+ end
120
+ end
121
+
122
+ class CustomerAddress < ::Stripe::StripeObject
123
+ # City, district, suburb, town, or village.
124
+ attr_reader :city
125
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
126
+ attr_reader :country
127
+ # Address line 1, such as the street, PO Box, or company name.
128
+ attr_reader :line1
129
+ # Address line 2, such as the apartment, suite, unit, or building.
130
+ attr_reader :line2
131
+ # ZIP or postal code.
132
+ attr_reader :postal_code
133
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
134
+ attr_reader :state
135
+
136
+ def self.inner_class_types
137
+ @inner_class_types = {}
138
+ end
139
+
140
+ def self.field_remappings
141
+ @field_remappings = {}
142
+ end
143
+ end
144
+
145
+ class CustomerBalance < ::Stripe::StripeObject
146
+ # The total amount of customer balance applied to this invoice (automatically + manually).
147
+ attr_reader :applied_balance
148
+ # The amount of customer balance automatically applied during invoice finalization.
149
+ attr_reader :automatically_applied_balance
150
+ # The total amount of customer balance manually applied after finalization.
151
+ attr_reader :manually_applied_balance
152
+
153
+ def self.inner_class_types
154
+ @inner_class_types = {}
155
+ end
156
+
157
+ def self.field_remappings
158
+ @field_remappings = {}
159
+ end
160
+ end
161
+
162
+ class CustomerShipping < ::Stripe::StripeObject
163
+ class Address < ::Stripe::StripeObject
164
+ # City, district, suburb, town, or village.
165
+ attr_reader :city
166
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
167
+ attr_reader :country
168
+ # Address line 1, such as the street, PO Box, or company name.
169
+ attr_reader :line1
170
+ # Address line 2, such as the apartment, suite, unit, or building.
171
+ attr_reader :line2
172
+ # ZIP or postal code.
173
+ attr_reader :postal_code
174
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
175
+ attr_reader :state
176
+
177
+ def self.inner_class_types
178
+ @inner_class_types = {}
179
+ end
180
+
181
+ def self.field_remappings
182
+ @field_remappings = {}
183
+ end
184
+ end
185
+ # Attribute for field address
186
+ attr_reader :address
187
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
188
+ attr_reader :carrier
189
+ # Recipient name.
190
+ attr_reader :name
191
+ # Recipient phone (including extension).
192
+ attr_reader :phone
193
+ # 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.
194
+ attr_reader :tracking_number
195
+
196
+ def self.inner_class_types
197
+ @inner_class_types = { address: Address }
198
+ end
199
+
200
+ def self.field_remappings
201
+ @field_remappings = {}
202
+ end
203
+ end
204
+
205
+ class CustomerTaxId < ::Stripe::StripeObject
206
+ # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `au_acn`, `nz_bn`, `pt_nif`, `cz_dic`, `fr_siret`, `fr_siren`, `fr_spi`, `sm_coe`, `tt_vat`, `tt_bir`, `mu_vat`, `mz_nuit`, `au_wpn`, `md_cf`, `is_kt`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, `ic_nif`, `gh_tin`, `bw_vat`, `ci_vat`, or `unknown`
207
+ attr_reader :type
208
+ # The value of the tax ID.
209
+ attr_reader :value
210
+
211
+ def self.inner_class_types
212
+ @inner_class_types = {}
213
+ end
214
+
215
+ def self.field_remappings
216
+ @field_remappings = {}
217
+ end
218
+ end
219
+
220
+ class FromInvoice < ::Stripe::StripeObject
221
+ # The relation between this invoice and the cloned invoice
222
+ attr_reader :action
223
+ # The invoice that was cloned.
224
+ attr_reader :invoice
225
+
226
+ def self.inner_class_types
227
+ @inner_class_types = {}
228
+ end
229
+
230
+ def self.field_remappings
231
+ @field_remappings = {}
232
+ end
233
+ end
234
+
235
+ class Issuer < ::Stripe::StripeObject
236
+ # The connected account being referenced when `type` is `account`.
237
+ attr_reader :account
238
+ # Type of the account referenced.
239
+ attr_reader :type
240
+
241
+ def self.inner_class_types
242
+ @inner_class_types = {}
243
+ end
244
+
245
+ def self.field_remappings
246
+ @field_remappings = {}
247
+ end
248
+ end
249
+
250
+ class LastFinalizationError < ::Stripe::StripeObject
251
+ # For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines/card#retrying-issuer-declines) if they provide one.
252
+ attr_reader :advice_code
253
+ # For card errors, the ID of the failed charge.
254
+ attr_reader :charge
255
+ # For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported.
256
+ attr_reader :code
257
+ # For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one.
258
+ attr_reader :decline_code
259
+ # A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported.
260
+ attr_reader :doc_url
261
+ # A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
262
+ attr_reader :message
263
+ # For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
264
+ attr_reader :network_advice_code
265
+ # For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
266
+ attr_reader :network_decline_code
267
+ # If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
268
+ attr_reader :param
269
+ # A PaymentIntent guides you through the process of collecting a payment from your customer.
270
+ # We recommend that you create exactly one PaymentIntent for each order or
271
+ # customer session in your system. You can reference the PaymentIntent later to
272
+ # see the history of payment attempts for a particular session.
273
+ #
274
+ # A PaymentIntent transitions through
275
+ # [multiple statuses](/payments/paymentintents/lifecycle)
276
+ # throughout its lifetime as it interfaces with Stripe.js to perform
277
+ # authentication flows and ultimately creates at most one successful charge.
278
+ #
279
+ # Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents)
280
+ attr_reader :payment_intent
281
+ # PaymentMethod objects represent your customer's payment instruments.
282
+ # You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to
283
+ # Customer objects to store instrument details for future payments.
284
+ #
285
+ # Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios).
286
+ attr_reader :payment_method
287
+ # If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
288
+ attr_reader :payment_method_type
289
+ # A URL to the request log entry in your dashboard.
290
+ attr_reader :request_log_url
291
+ # A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
292
+ # For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
293
+ # Later, you can use [PaymentIntents](https://docs.stripe.com/api#payment_intents) to drive the payment flow.
294
+ #
295
+ # Create a SetupIntent when you're ready to collect your customer's payment credentials.
296
+ # Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
297
+ # The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides
298
+ # you through the setup process.
299
+ #
300
+ # Successful SetupIntents result in payment credentials that are optimized for future payments.
301
+ # For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through
302
+ # [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
303
+ # to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
304
+ # If you use the SetupIntent with a [Customer](https://docs.stripe.com/api#setup_intent_object-customer),
305
+ # it automatically attaches the resulting payment method to that Customer after successful setup.
306
+ # We recommend using SetupIntents or [setup_future_usage](https://docs.stripe.com/api#payment_intent_object-setup_future_usage) on
307
+ # PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.
308
+ #
309
+ # By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
310
+ #
311
+ # Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)
312
+ attr_reader :setup_intent
313
+ # Attribute for field source
314
+ attr_reader :source
315
+ # The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`
316
+ attr_reader :type
317
+
318
+ def self.inner_class_types
319
+ @inner_class_types = {}
320
+ end
321
+
322
+ def self.field_remappings
323
+ @field_remappings = {}
324
+ end
325
+ end
326
+
327
+ class Parent < ::Stripe::StripeObject
328
+ class QuoteDetails < ::Stripe::StripeObject
329
+ # The quote that generated this invoice
330
+ attr_reader :quote
331
+
332
+ def self.inner_class_types
333
+ @inner_class_types = {}
334
+ end
335
+
336
+ def self.field_remappings
337
+ @field_remappings = {}
338
+ end
339
+ end
340
+
341
+ class SubscriptionDetails < ::Stripe::StripeObject
342
+ class PauseCollection < ::Stripe::StripeObject
343
+ # The payment collection behavior for this subscription while paused.
344
+ attr_reader :behavior
345
+ # The time after which the subscription will resume collecting payments.
346
+ attr_reader :resumes_at
347
+
348
+ def self.inner_class_types
349
+ @inner_class_types = {}
350
+ end
351
+
352
+ def self.field_remappings
353
+ @field_remappings = {}
354
+ end
355
+ end
356
+ # Set of [key-value pairs](https://docs.stripe.com/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
357
+ # *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
358
+ attr_reader :metadata
359
+ # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
360
+ attr_reader :pause_collection
361
+ # The subscription that generated this invoice
362
+ attr_reader :subscription
363
+ # Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
364
+ attr_reader :subscription_proration_date
365
+
366
+ def self.inner_class_types
367
+ @inner_class_types = { pause_collection: PauseCollection }
368
+ end
369
+
370
+ def self.field_remappings
371
+ @field_remappings = {}
372
+ end
373
+ end
374
+ # Details about the quote that generated this invoice
375
+ attr_reader :quote_details
376
+ # Details about the subscription that generated this invoice
377
+ attr_reader :subscription_details
378
+ # The type of parent that generated this invoice
379
+ attr_reader :type
380
+
381
+ def self.inner_class_types
382
+ @inner_class_types = {
383
+ quote_details: QuoteDetails,
384
+ subscription_details: SubscriptionDetails,
385
+ }
386
+ end
387
+
388
+ def self.field_remappings
389
+ @field_remappings = {}
390
+ end
391
+ end
392
+
393
+ class PaymentSettings < ::Stripe::StripeObject
394
+ class PaymentMethodOptions < ::Stripe::StripeObject
395
+ class AcssDebit < ::Stripe::StripeObject
396
+ class MandateOptions < ::Stripe::StripeObject
397
+ # Transaction type of the mandate.
398
+ attr_reader :transaction_type
399
+
400
+ def self.inner_class_types
401
+ @inner_class_types = {}
402
+ end
403
+
404
+ def self.field_remappings
405
+ @field_remappings = {}
406
+ end
407
+ end
408
+ # Attribute for field mandate_options
409
+ attr_reader :mandate_options
410
+ # Bank account verification method. The default value is `automatic`.
411
+ attr_reader :verification_method
412
+
413
+ def self.inner_class_types
414
+ @inner_class_types = { mandate_options: MandateOptions }
415
+ end
416
+
417
+ def self.field_remappings
418
+ @field_remappings = {}
419
+ end
420
+ end
421
+
422
+ class Bancontact < ::Stripe::StripeObject
423
+ # Preferred language of the Bancontact authorization page that the customer is redirected to.
424
+ attr_reader :preferred_language
425
+
426
+ def self.inner_class_types
427
+ @inner_class_types = {}
428
+ end
429
+
430
+ def self.field_remappings
431
+ @field_remappings = {}
432
+ end
433
+ end
434
+
435
+ class Billie < ::Stripe::StripeObject
436
+ class CompanyDetails < ::Stripe::StripeObject
437
+ class RegisteredAddress < ::Stripe::StripeObject
438
+ # City, district, suburb, town, or village.
439
+ attr_reader :city
440
+ # Two-letter country code.
441
+ attr_reader :country
442
+ # Address line 1 (for example, street, PO Box, or company name).
443
+ attr_reader :line1
444
+ # Address line 2 (for example, apartment, suite, unit, or building).
445
+ attr_reader :line2
446
+ # ZIP or postal code.
447
+ attr_reader :postal_code
448
+ # State, county, province, or region.
449
+ attr_reader :state
450
+
451
+ def self.inner_class_types
452
+ @inner_class_types = {}
453
+ end
454
+
455
+ def self.field_remappings
456
+ @field_remappings = {}
457
+ end
458
+ end
459
+ # Attribute for field registered_address
460
+ attr_reader :registered_address
461
+ # Company or entity name.
462
+ attr_reader :registered_name
463
+ # The official registration number for the given registration type.
464
+ attr_reader :registration_number
465
+ # Type of registration the company or entity holds in their registered country.
466
+ attr_reader :registration_type
467
+ # VAT ID number.
468
+ attr_reader :vat
469
+
470
+ def self.inner_class_types
471
+ @inner_class_types = { registered_address: RegisteredAddress }
472
+ end
473
+
474
+ def self.field_remappings
475
+ @field_remappings = {}
476
+ end
477
+ end
478
+ # Attribute for field company_details
479
+ attr_reader :company_details
480
+ # An identifier or reference that this payment corresponds to.
481
+ attr_reader :reference
482
+
483
+ def self.inner_class_types
484
+ @inner_class_types = { company_details: CompanyDetails }
485
+ end
486
+
487
+ def self.field_remappings
488
+ @field_remappings = {}
489
+ end
490
+ end
491
+
492
+ class Blik < ::Stripe::StripeObject
493
+ def self.inner_class_types
494
+ @inner_class_types = {}
495
+ end
496
+
497
+ def self.field_remappings
498
+ @field_remappings = {}
499
+ end
500
+ end
501
+
502
+ class Card < ::Stripe::StripeObject
503
+ class Installments < ::Stripe::StripeObject
504
+ # Whether Installments are enabled for this Invoice.
505
+ attr_reader :enabled
506
+
507
+ def self.inner_class_types
508
+ @inner_class_types = {}
509
+ end
510
+
511
+ def self.field_remappings
512
+ @field_remappings = {}
513
+ end
514
+ end
515
+ # Attribute for field installments
516
+ attr_reader :installments
517
+ # 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
518
+ attr_reader :request_three_d_secure
519
+
520
+ def self.inner_class_types
521
+ @inner_class_types = { installments: Installments }
522
+ end
523
+
524
+ def self.field_remappings
525
+ @field_remappings = {}
526
+ end
527
+ end
528
+
529
+ class CustomerBalance < ::Stripe::StripeObject
530
+ class BankTransfer < ::Stripe::StripeObject
531
+ class EuBankTransfer < ::Stripe::StripeObject
532
+ # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`.
533
+ attr_reader :country
534
+
535
+ def self.inner_class_types
536
+ @inner_class_types = {}
537
+ end
538
+
539
+ def self.field_remappings
540
+ @field_remappings = {}
541
+ end
542
+ end
543
+ # Attribute for field eu_bank_transfer
544
+ attr_reader :eu_bank_transfer
545
+ # 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`.
546
+ attr_reader :type
547
+
548
+ def self.inner_class_types
549
+ @inner_class_types = { eu_bank_transfer: EuBankTransfer }
550
+ end
551
+
552
+ def self.field_remappings
553
+ @field_remappings = {}
554
+ end
555
+ end
556
+ # Attribute for field bank_transfer
557
+ attr_reader :bank_transfer
558
+ # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
559
+ attr_reader :funding_type
560
+
561
+ def self.inner_class_types
562
+ @inner_class_types = { bank_transfer: BankTransfer }
563
+ end
564
+
565
+ def self.field_remappings
566
+ @field_remappings = {}
567
+ end
568
+ end
569
+
570
+ class IdBankTransfer < ::Stripe::StripeObject
571
+ def self.inner_class_types
572
+ @inner_class_types = {}
573
+ end
574
+
575
+ def self.field_remappings
576
+ @field_remappings = {}
577
+ end
578
+ end
579
+
580
+ class Konbini < ::Stripe::StripeObject
581
+ def self.inner_class_types
582
+ @inner_class_types = {}
583
+ end
584
+
585
+ def self.field_remappings
586
+ @field_remappings = {}
587
+ end
588
+ end
589
+
590
+ class Payto < ::Stripe::StripeObject
591
+ class MandateOptions < ::Stripe::StripeObject
592
+ # The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
593
+ attr_reader :amount
594
+ # Only `maximum` is supported.
595
+ attr_reader :amount_type
596
+ # The purpose for which payments are made. Has a default value based on your merchant category code.
597
+ attr_reader :purpose
598
+
599
+ def self.inner_class_types
600
+ @inner_class_types = {}
601
+ end
602
+
603
+ def self.field_remappings
604
+ @field_remappings = {}
605
+ end
606
+ end
607
+ # Attribute for field mandate_options
608
+ attr_reader :mandate_options
609
+
610
+ def self.inner_class_types
611
+ @inner_class_types = { mandate_options: MandateOptions }
612
+ end
613
+
614
+ def self.field_remappings
615
+ @field_remappings = {}
616
+ end
617
+ end
618
+
619
+ class Pix < ::Stripe::StripeObject
620
+ # Determines if the amount includes the IOF tax.
621
+ attr_reader :amount_includes_iof
622
+ # The number of seconds after PaymentIntent confirmation when the Pix expires (between 60 and 1209600, inclusive). If unspecified, defaults to 14400 seconds (4 hours).
623
+ attr_reader :expires_after_seconds
624
+
625
+ def self.inner_class_types
626
+ @inner_class_types = {}
627
+ end
628
+
629
+ def self.field_remappings
630
+ @field_remappings = {}
631
+ end
632
+ end
633
+
634
+ class SepaDebit < ::Stripe::StripeObject
635
+ def self.inner_class_types
636
+ @inner_class_types = {}
637
+ end
638
+
639
+ def self.field_remappings
640
+ @field_remappings = {}
641
+ end
642
+ end
643
+
644
+ class Upi < ::Stripe::StripeObject
645
+ class MandateOptions < ::Stripe::StripeObject
646
+ # Amount to be charged for future payments.
647
+ attr_reader :amount
648
+ # One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
649
+ attr_reader :amount_type
650
+ # A description of the mandate or subscription that is meant to be displayed to the customer.
651
+ attr_reader :description
652
+ # End date of the mandate or subscription.
653
+ attr_reader :end_date
654
+
655
+ def self.inner_class_types
656
+ @inner_class_types = {}
657
+ end
658
+
659
+ def self.field_remappings
660
+ @field_remappings = {}
661
+ end
662
+ end
663
+ # Attribute for field mandate_options
664
+ attr_reader :mandate_options
665
+
666
+ def self.inner_class_types
667
+ @inner_class_types = { mandate_options: MandateOptions }
668
+ end
669
+
670
+ def self.field_remappings
671
+ @field_remappings = {}
672
+ end
673
+ end
674
+
675
+ class UsBankAccount < ::Stripe::StripeObject
676
+ class FinancialConnections < ::Stripe::StripeObject
677
+ class Filters < ::Stripe::StripeObject
678
+ # The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
679
+ attr_reader :account_subcategories
680
+ # The institution to use to filter for possible accounts to link.
681
+ attr_reader :institution
682
+
683
+ def self.inner_class_types
684
+ @inner_class_types = {}
685
+ end
686
+
687
+ def self.field_remappings
688
+ @field_remappings = {}
689
+ end
690
+ end
691
+ # Attribute for field filters
692
+ attr_reader :filters
693
+ # The list of permissions to request. The `payment_method` permission must be included.
694
+ attr_reader :permissions
695
+ # Data features requested to be retrieved upon account creation.
696
+ attr_reader :prefetch
697
+
698
+ def self.inner_class_types
699
+ @inner_class_types = { filters: Filters }
700
+ end
701
+
702
+ def self.field_remappings
703
+ @field_remappings = {}
704
+ end
705
+ end
706
+ # Attribute for field financial_connections
707
+ attr_reader :financial_connections
708
+ # Bank account verification method. The default value is `automatic`.
709
+ attr_reader :verification_method
710
+
711
+ def self.inner_class_types
712
+ @inner_class_types = { financial_connections: FinancialConnections }
713
+ end
714
+
715
+ def self.field_remappings
716
+ @field_remappings = {}
717
+ end
718
+ end
719
+ # 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.
720
+ attr_reader :acss_debit
721
+ # If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
722
+ attr_reader :bancontact
723
+ # If paying by `billie`, this sub-hash contains details about the Billie payment method options to pass to the invoice’s PaymentIntent.
724
+ attr_reader :billie
725
+ # If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice’s PaymentIntent.
726
+ attr_reader :blik
727
+ # If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
728
+ attr_reader :card
729
+ # If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
730
+ attr_reader :customer_balance
731
+ # If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
732
+ attr_reader :id_bank_transfer
733
+ # If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
734
+ attr_reader :konbini
735
+ # If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
736
+ attr_reader :payto
737
+ # If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
738
+ attr_reader :pix
739
+ # 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.
740
+ attr_reader :sepa_debit
741
+ # If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
742
+ attr_reader :upi
743
+ # 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.
744
+ attr_reader :us_bank_account
745
+
746
+ def self.inner_class_types
747
+ @inner_class_types = {
748
+ acss_debit: AcssDebit,
749
+ bancontact: Bancontact,
750
+ billie: Billie,
751
+ blik: Blik,
752
+ card: Card,
753
+ customer_balance: CustomerBalance,
754
+ id_bank_transfer: IdBankTransfer,
755
+ konbini: Konbini,
756
+ payto: Payto,
757
+ pix: Pix,
758
+ sepa_debit: SepaDebit,
759
+ upi: Upi,
760
+ us_bank_account: UsBankAccount,
761
+ }
762
+ end
763
+
764
+ def self.field_remappings
765
+ @field_remappings = {}
766
+ end
767
+ end
768
+ # 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.
769
+ attr_reader :default_mandate
770
+ # Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
771
+ attr_reader :payment_method_options
772
+ # 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).
773
+ attr_reader :payment_method_types
774
+
775
+ def self.inner_class_types
776
+ @inner_class_types = { payment_method_options: PaymentMethodOptions }
777
+ end
778
+
779
+ def self.field_remappings
780
+ @field_remappings = {}
781
+ end
782
+ end
783
+
784
+ class Rendering < ::Stripe::StripeObject
785
+ class Pdf < ::Stripe::StripeObject
786
+ # 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.
787
+ attr_reader :page_size
788
+
789
+ def self.inner_class_types
790
+ @inner_class_types = {}
791
+ end
792
+
793
+ def self.field_remappings
794
+ @field_remappings = {}
795
+ end
796
+ end
797
+ # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
798
+ attr_reader :amount_tax_display
799
+ # Invoice pdf rendering options
800
+ attr_reader :pdf
801
+ # ID of the rendering template that the invoice is formatted by.
802
+ attr_reader :template
803
+ # Version of the rendering template that the invoice is using.
804
+ attr_reader :template_version
805
+
806
+ def self.inner_class_types
807
+ @inner_class_types = { pdf: Pdf }
808
+ end
809
+
810
+ def self.field_remappings
811
+ @field_remappings = {}
812
+ end
813
+ end
814
+
815
+ class ShippingCost < ::Stripe::StripeObject
816
+ class Tax < ::Stripe::StripeObject
817
+ # Amount of tax applied for this rate.
818
+ attr_reader :amount
819
+ # 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.
820
+ #
821
+ # Related guide: [Tax rates](/billing/taxes/tax-rates)
822
+ attr_reader :rate
823
+ # 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.
824
+ attr_reader :taxability_reason
825
+ # The amount on which tax is calculated, in cents (or local equivalent).
826
+ attr_reader :taxable_amount
827
+
828
+ def self.inner_class_types
829
+ @inner_class_types = {}
830
+ end
831
+
832
+ def self.field_remappings
833
+ @field_remappings = {}
834
+ end
835
+ end
836
+ # Total shipping cost before any taxes are applied.
837
+ attr_reader :amount_subtotal
838
+ # Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
839
+ attr_reader :amount_tax
840
+ # Total shipping cost after taxes are applied.
841
+ attr_reader :amount_total
842
+ # The ID of the ShippingRate for this invoice.
843
+ attr_reader :shipping_rate
844
+ # The taxes applied to the shipping rate.
845
+ attr_reader :taxes
846
+
847
+ def self.inner_class_types
848
+ @inner_class_types = { taxes: Tax }
849
+ end
850
+
851
+ def self.field_remappings
852
+ @field_remappings = {}
853
+ end
854
+ end
855
+
856
+ class ShippingDetails < ::Stripe::StripeObject
857
+ class Address < ::Stripe::StripeObject
858
+ # City, district, suburb, town, or village.
859
+ attr_reader :city
860
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
861
+ attr_reader :country
862
+ # Address line 1, such as the street, PO Box, or company name.
863
+ attr_reader :line1
864
+ # Address line 2, such as the apartment, suite, unit, or building.
865
+ attr_reader :line2
866
+ # ZIP or postal code.
867
+ attr_reader :postal_code
868
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
869
+ attr_reader :state
870
+
871
+ def self.inner_class_types
872
+ @inner_class_types = {}
873
+ end
874
+
875
+ def self.field_remappings
876
+ @field_remappings = {}
877
+ end
878
+ end
879
+ # Attribute for field address
880
+ attr_reader :address
881
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
882
+ attr_reader :carrier
883
+ # Recipient name.
884
+ attr_reader :name
885
+ # Recipient phone (including extension).
886
+ attr_reader :phone
887
+ # 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.
888
+ attr_reader :tracking_number
889
+
890
+ def self.inner_class_types
891
+ @inner_class_types = { address: Address }
892
+ end
893
+
894
+ def self.field_remappings
895
+ @field_remappings = {}
896
+ end
897
+ end
898
+
899
+ class StatusDetails < ::Stripe::StripeObject
900
+ class Uncollectible < ::Stripe::StripeObject
901
+ # The reason why the invoice is uncollectible.
902
+ attr_reader :reason
903
+
904
+ def self.inner_class_types
905
+ @inner_class_types = {}
906
+ end
907
+
908
+ def self.field_remappings
909
+ @field_remappings = {}
910
+ end
911
+ end
912
+ # Attribute for field uncollectible
913
+ attr_reader :uncollectible
914
+
915
+ def self.inner_class_types
916
+ @inner_class_types = { uncollectible: Uncollectible }
917
+ end
918
+
919
+ def self.field_remappings
920
+ @field_remappings = {}
921
+ end
922
+ end
923
+
924
+ class StatusTransitions < ::Stripe::StripeObject
925
+ # The time that the invoice draft was finalized.
926
+ attr_reader :finalized_at
927
+ # The time that the invoice was marked uncollectible.
928
+ attr_reader :marked_uncollectible_at
929
+ # The time that the invoice was paid.
930
+ attr_reader :paid_at
931
+ # The time that the invoice was voided.
932
+ attr_reader :voided_at
933
+
934
+ def self.inner_class_types
935
+ @inner_class_types = {}
936
+ end
937
+
938
+ def self.field_remappings
939
+ @field_remappings = {}
940
+ end
941
+ end
942
+
943
+ class ThresholdReason < ::Stripe::StripeObject
944
+ class ItemReason < ::Stripe::StripeObject
945
+ # The IDs of the line items that triggered the threshold invoice.
946
+ attr_reader :line_item_ids
947
+ # The quantity threshold boundary that applied to the given line item.
948
+ attr_reader :usage_gte
949
+
950
+ def self.inner_class_types
951
+ @inner_class_types = {}
952
+ end
953
+
954
+ def self.field_remappings
955
+ @field_remappings = {}
956
+ end
957
+ end
958
+ # The total invoice amount threshold boundary if it triggered the threshold invoice.
959
+ attr_reader :amount_gte
960
+ # Indicates which line items triggered a threshold invoice.
961
+ attr_reader :item_reasons
962
+
963
+ def self.inner_class_types
964
+ @inner_class_types = { item_reasons: ItemReason }
965
+ end
966
+
967
+ def self.field_remappings
968
+ @field_remappings = {}
969
+ end
970
+ end
971
+
972
+ class TotalDiscountAmount < ::Stripe::StripeObject
973
+ # The amount, in cents (or local equivalent), of the discount.
974
+ attr_reader :amount
975
+ # The discount that was applied to get this discount amount.
976
+ attr_reader :discount
977
+
978
+ def self.inner_class_types
979
+ @inner_class_types = {}
980
+ end
981
+
982
+ def self.field_remappings
983
+ @field_remappings = {}
984
+ end
985
+ end
986
+
987
+ class TotalMarginAmount < ::Stripe::StripeObject
988
+ # The amount, in cents (or local equivalent), of the reduction in line item amount.
989
+ attr_reader :amount
990
+ # The margin that was applied to get this margin amount.
991
+ attr_reader :margin
992
+
993
+ def self.inner_class_types
994
+ @inner_class_types = {}
995
+ end
996
+
997
+ def self.field_remappings
998
+ @field_remappings = {}
999
+ end
1000
+ end
1001
+
1002
+ class TotalPretaxCreditAmount < ::Stripe::StripeObject
1003
+ # The amount, in cents (or local equivalent), of the pretax credit amount.
1004
+ attr_reader :amount
1005
+ # The credit balance transaction that was applied to get this pretax credit amount.
1006
+ attr_reader :credit_balance_transaction
1007
+ # The discount that was applied to get this pretax credit amount.
1008
+ attr_reader :discount
1009
+ # The margin that was applied to get this pretax credit amount.
1010
+ attr_reader :margin
1011
+ # Type of the pretax credit amount referenced.
1012
+ attr_reader :type
1013
+
1014
+ def self.inner_class_types
1015
+ @inner_class_types = {}
1016
+ end
1017
+
1018
+ def self.field_remappings
1019
+ @field_remappings = {}
1020
+ end
1021
+ end
1022
+
1023
+ class TotalTax < ::Stripe::StripeObject
1024
+ class TaxRateDetails < ::Stripe::StripeObject
1025
+ # ID of the tax rate
1026
+ attr_reader :tax_rate
1027
+
1028
+ def self.inner_class_types
1029
+ @inner_class_types = {}
1030
+ end
1031
+
1032
+ def self.field_remappings
1033
+ @field_remappings = {}
1034
+ end
1035
+ end
1036
+ # The amount of the tax, in cents (or local equivalent).
1037
+ attr_reader :amount
1038
+ # Whether this tax is inclusive or exclusive.
1039
+ attr_reader :tax_behavior
1040
+ # Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
1041
+ attr_reader :tax_rate_details
1042
+ # 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.
1043
+ attr_reader :taxability_reason
1044
+ # The amount on which tax is calculated, in cents (or local equivalent).
1045
+ attr_reader :taxable_amount
1046
+ # The type of tax information.
1047
+ attr_reader :type
1048
+
1049
+ def self.inner_class_types
1050
+ @inner_class_types = { tax_rate_details: TaxRateDetails }
1051
+ end
1052
+
1053
+ def self.field_remappings
1054
+ @field_remappings = {}
1055
+ end
1056
+ end
1057
+ # The country of the business associated with this invoice, most often the business creating the invoice.
1058
+ attr_reader :account_country
1059
+ # The public name of the business associated with this invoice, most often the business creating the invoice.
1060
+ attr_reader :account_name
1061
+ # The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
1062
+ attr_reader :account_tax_ids
1063
+ # Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.
1064
+ attr_reader :amount_due
1065
+ # Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
1066
+ attr_reader :amount_overpaid
1067
+ # The amount, in cents (or local equivalent), that was paid.
1068
+ attr_reader :amount_paid
1069
+ # Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
1070
+ attr_reader :amount_paid_off_stripe
1071
+ # The difference between amount_due and amount_paid, in cents (or local equivalent).
1072
+ attr_reader :amount_remaining
1073
+ # This is the sum of all the shipping amounts.
1074
+ attr_reader :amount_shipping
1075
+ # List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
1076
+ attr_reader :amounts_due
1077
+ # ID of the Connect Application that created the invoice.
1078
+ attr_reader :application
1079
+ # Attribute for field applies_to
1080
+ attr_reader :applies_to
1081
+ # Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
1082
+ attr_reader :attempt_count
1083
+ # Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.
1084
+ attr_reader :attempted
1085
+ # Attribute for field automatic_tax
1086
+ attr_reader :automatic_tax
1087
+ # The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized.
1088
+ attr_reader :automatically_finalizes_at
1089
+ # Indicates the reason why the invoice was created.
1090
+ #
1091
+ # * `manual`: Unrelated to a subscription, for example, created via the invoice editor.
1092
+ # * `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
1093
+ # * `subscription_create`: A new subscription was created.
1094
+ # * `subscription_cycle`: A subscription advanced into a new period.
1095
+ # * `subscription_threshold`: A subscription reached a billing threshold.
1096
+ # * `subscription_update`: A subscription was updated.
1097
+ # * `upcoming`: Reserved for upcoming invoices created through the Create Preview Invoice API or when an `invoice.upcoming` event is generated for an upcoming invoice on a subscription.
1098
+ attr_reader :billing_reason
1099
+ # 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.
1100
+ attr_reader :collection_method
1101
+ # The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
1102
+ attr_reader :confirmation_secret
1103
+ # Time at which the object was created. Measured in seconds since the Unix epoch.
1104
+ attr_reader :created
1105
+ # 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).
1106
+ attr_reader :currency
1107
+ # Custom fields displayed on the invoice.
1108
+ attr_reader :custom_fields
1109
+ # The ID of the account representing the customer to bill.
1110
+ attr_reader :customer_account
1111
+ # The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
1112
+ attr_reader :customer_address
1113
+ # The customer balance amounts applied to this invoice.
1114
+ attr_reader :customer_balance
1115
+ # The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.
1116
+ attr_reader :customer_email
1117
+ # The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.
1118
+ attr_reader :customer_name
1119
+ # The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.
1120
+ attr_reader :customer_phone
1121
+ # The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.
1122
+ attr_reader :customer_shipping
1123
+ # The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.
1124
+ attr_reader :customer_tax_exempt
1125
+ # The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.
1126
+ attr_reader :customer_tax_ids
1127
+ # The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
1128
+ attr_reader :default_margins
1129
+ # 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.
1130
+ attr_reader :default_payment_method
1131
+ # 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.
1132
+ attr_reader :default_source
1133
+ # The tax rates applied to this invoice, if any.
1134
+ attr_reader :default_tax_rates
1135
+ # An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
1136
+ attr_reader :description
1137
+ # The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
1138
+ attr_reader :discounts
1139
+ # The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.
1140
+ attr_reader :due_date
1141
+ # 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.
1142
+ attr_reader :effective_at
1143
+ # Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
1144
+ attr_reader :ending_balance
1145
+ # Footer displayed on the invoice.
1146
+ attr_reader :footer
1147
+ # Details of the invoice that was cloned. See the [revision documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details.
1148
+ attr_reader :from_invoice
1149
+ # Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`.
1150
+ attr_reader :id
1151
+ # Attribute for field issuer
1152
+ attr_reader :issuer
1153
+ # The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
1154
+ attr_reader :last_finalization_error
1155
+ # The ID of the most recent non-draft revision of this invoice
1156
+ attr_reader :latest_revision
1157
+ # The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.
1158
+ attr_reader :lines
1159
+ # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
1160
+ attr_reader :livemode
1161
+ # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
1162
+ attr_reader :metadata
1163
+ # The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.
1164
+ attr_reader :next_payment_attempt
1165
+ # A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
1166
+ attr_reader :number
1167
+ # String representing the object's type. Objects of the same type share the same value.
1168
+ attr_reader :object
1169
+ # 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://docs.stripe.com/billing/invoices/connect) documentation for details.
1170
+ attr_reader :on_behalf_of
1171
+ # The parent that generated this invoice
1172
+ attr_reader :parent
1173
+ # Attribute for field payment_settings
1174
+ attr_reader :payment_settings
1175
+ # Payments for this invoice. Use [invoice payment](/api/invoice-payment) to get more details.
1176
+ attr_reader :payments
1177
+ # The latest timestamp at which invoice items can be associated with this invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.
1178
+ attr_reader :period_end
1179
+ # The earliest timestamp at which invoice items can be associated with this invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.
1180
+ attr_reader :period_start
1181
+ # Total amount of all post-payment credit notes issued for this invoice.
1182
+ attr_reader :post_payment_credit_notes_amount
1183
+ # Total amount of all pre-payment credit notes issued for this invoice.
1184
+ attr_reader :pre_payment_credit_notes_amount
1185
+ # This is the transaction number that appears on email receipts sent for this invoice.
1186
+ attr_reader :receipt_number
1187
+ # The rendering-related settings that control how invoices render in customer-facing interfaces such as the PDF or hosted invoice page.
1188
+ attr_reader :rendering
1189
+ # The details of the cost of shipping, including the ShippingRate applied on the invoice.
1190
+ attr_reader :shipping_cost
1191
+ # 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.
1192
+ attr_reader :shipping_details
1193
+ # Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
1194
+ attr_reader :starting_balance
1195
+ # Extra information about an invoice for the customer's credit card statement.
1196
+ attr_reader :statement_descriptor
1197
+ # The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview)
1198
+ attr_reader :status
1199
+ # Attribute for field status_details
1200
+ attr_reader :status_details
1201
+ # Attribute for field status_transitions
1202
+ attr_reader :status_transitions
1203
+ # Attribute for field subscription
1204
+ attr_reader :subscription
1205
+ # Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
1206
+ attr_reader :subtotal
1207
+ # The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
1208
+ attr_reader :subtotal_excluding_tax
1209
+ # ID of the test clock this invoice belongs to.
1210
+ attr_reader :test_clock
1211
+ # Attribute for field threshold_reason
1212
+ attr_reader :threshold_reason
1213
+ # Total after discounts and taxes.
1214
+ attr_reader :total
1215
+ # The aggregate amounts calculated per discount across all line items.
1216
+ attr_reader :total_discount_amounts
1217
+ # The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
1218
+ attr_reader :total_excluding_tax
1219
+ # The aggregate amounts calculated per margin across all line items.
1220
+ attr_reader :total_margin_amounts
1221
+ # Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
1222
+ attr_reader :total_pretax_credit_amounts
1223
+ # The aggregate tax information of all line items.
1224
+ attr_reader :total_taxes
1225
+ # Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://docs.stripe.com/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
1226
+ attr_reader :webhooks_delivered_at
1227
+
1228
+ def self.inner_class_types
1229
+ @inner_class_types = {
1230
+ amounts_due: AmountsDue,
1231
+ applies_to: AppliesTo,
1232
+ automatic_tax: AutomaticTax,
1233
+ confirmation_secret: ConfirmationSecret,
1234
+ custom_fields: CustomField,
1235
+ customer_address: CustomerAddress,
1236
+ customer_balance: CustomerBalance,
1237
+ customer_shipping: CustomerShipping,
1238
+ customer_tax_ids: CustomerTaxId,
1239
+ from_invoice: FromInvoice,
1240
+ issuer: Issuer,
1241
+ last_finalization_error: LastFinalizationError,
1242
+ parent: Parent,
1243
+ payment_settings: PaymentSettings,
1244
+ rendering: Rendering,
1245
+ shipping_cost: ShippingCost,
1246
+ shipping_details: ShippingDetails,
1247
+ status_details: StatusDetails,
1248
+ status_transitions: StatusTransitions,
1249
+ threshold_reason: ThresholdReason,
1250
+ total_discount_amounts: TotalDiscountAmount,
1251
+ total_margin_amounts: TotalMarginAmount,
1252
+ total_pretax_credit_amounts: TotalPretaxCreditAmount,
1253
+ total_taxes: TotalTax,
1254
+ }
1255
+ end
1256
+
1257
+ def self.field_remappings
1258
+ @field_remappings = {}
1259
+ end
1260
+ end
1261
+ end