stripe 20.2.0.pre.beta.1 → 21.0.0

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