stripe 15.3.0 → 15.4.0.pre.beta.2

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 (591) hide show
  1. checksums.yaml +4 -4
  2. data/API_VERSION +1 -1
  3. data/CHANGELOG.md +1603 -667
  4. data/README.md +1 -1
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_requestor.rb +32 -0
  7. data/lib/stripe/api_version.rb +1 -2
  8. data/lib/stripe/errors.rb +60 -0
  9. data/lib/stripe/event_types.rb +102 -0
  10. data/lib/stripe/events/v2_core_account_closed_event.rb +21 -0
  11. data/lib/stripe/events/v2_core_account_created_event.rb +21 -0
  12. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  14. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  15. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  16. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  17. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  18. data/lib/stripe/events/v2_core_account_including_configuration_storer_capability_status_updated_event.rb +23 -0
  19. data/lib/stripe/events/v2_core_account_including_configuration_storer_updated_event.rb +21 -0
  20. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +21 -0
  21. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  22. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  23. data/lib/stripe/events/v2_core_account_link_completed_event.rb +13 -0
  24. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  25. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  26. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  27. data/lib/stripe/events/v2_core_account_updated_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  30. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  33. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  34. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  41. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  48. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  49. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  50. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +21 -0
  51. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  52. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  53. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  54. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  55. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  56. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  57. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  58. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  59. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  60. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +21 -0
  61. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +21 -0
  62. data/lib/stripe/events/v2_off_session_payment_requires_capture_event.rb +21 -0
  63. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +21 -0
  64. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +21 -0
  65. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +21 -0
  66. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +21 -0
  67. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +21 -0
  68. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +21 -0
  69. data/lib/stripe/object_types.rb +50 -0
  70. data/lib/stripe/resources/account.rb +653 -1
  71. data/lib/stripe/resources/account_notice.rb +123 -0
  72. data/lib/stripe/resources/account_session.rb +256 -1
  73. data/lib/stripe/resources/balance_settings.rb +105 -0
  74. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  75. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  76. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  77. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  78. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  79. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  80. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  81. data/lib/stripe/resources/card.rb +2 -0
  82. data/lib/stripe/resources/cash_balance.rb +2 -0
  83. data/lib/stripe/resources/charge.rb +1538 -0
  84. data/lib/stripe/resources/checkout/session.rb +326 -2
  85. data/lib/stripe/resources/confirmation_token.rb +170 -0
  86. data/lib/stripe/resources/coupon.rb +30 -1
  87. data/lib/stripe/resources/credit_note.rb +6 -0
  88. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  89. data/lib/stripe/resources/customer.rb +2 -0
  90. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  91. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  92. data/lib/stripe/resources/customer_session.rb +6 -1
  93. data/lib/stripe/resources/discount.rb +2 -0
  94. data/lib/stripe/resources/dispute.rb +2 -0
  95. data/lib/stripe/resources/event.rb +31 -0
  96. data/lib/stripe/resources/financial_connections/account.rb +22 -1
  97. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  98. data/lib/stripe/resources/financial_connections/institution.rb +92 -0
  99. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  100. data/lib/stripe/resources/fx_quote.rb +184 -0
  101. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  102. data/lib/stripe/resources/invoice.rb +1063 -16
  103. data/lib/stripe/resources/invoice_item.rb +78 -2
  104. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  105. data/lib/stripe/resources/invoice_payment.rb +2 -53
  106. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  107. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  108. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  109. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  110. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  111. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  112. data/lib/stripe/resources/line_item.rb +37 -0
  113. data/lib/stripe/resources/mandate.rb +24 -0
  114. data/lib/stripe/resources/margin.rb +115 -0
  115. data/lib/stripe/resources/order.rb +2958 -0
  116. data/lib/stripe/resources/payment_attempt_record.rb +1099 -0
  117. data/lib/stripe/resources/payment_intent.rb +8540 -3584
  118. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +72 -0
  119. data/lib/stripe/resources/payment_method.rb +192 -1
  120. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  121. data/lib/stripe/resources/payment_record.rb +1628 -0
  122. data/lib/stripe/resources/payout.rb +6 -0
  123. data/lib/stripe/resources/price.rb +30 -0
  124. data/lib/stripe/resources/privacy/redaction_job.rb +298 -0
  125. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +33 -0
  126. data/lib/stripe/resources/promotion_code.rb +10 -0
  127. data/lib/stripe/resources/quote.rb +2038 -7
  128. data/lib/stripe/resources/quote_line.rb +274 -0
  129. data/lib/stripe/resources/quote_preview_invoice.rb +663 -0
  130. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +371 -0
  131. data/lib/stripe/resources/refund.rb +9 -0
  132. data/lib/stripe/resources/setup_attempt.rb +21 -0
  133. data/lib/stripe/resources/setup_intent.rb +578 -9
  134. data/lib/stripe/resources/source.rb +29 -0
  135. data/lib/stripe/resources/subscription.rb +288 -9
  136. data/lib/stripe/resources/subscription_item.rb +84 -3
  137. data/lib/stripe/resources/subscription_schedule.rb +1007 -10
  138. data/lib/stripe/resources/tax/association.rb +66 -0
  139. data/lib/stripe/resources/tax/form.rb +211 -0
  140. data/lib/stripe/resources/tax_id.rb +12 -2
  141. data/lib/stripe/resources/terminal/reader.rb +8 -0
  142. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  143. data/lib/stripe/resources/transfer.rb +6 -0
  144. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  145. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  146. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  147. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  148. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  149. data/lib/stripe/resources/v2/core/account.rb +1919 -0
  150. data/lib/stripe/resources/v2/core/account_link.rb +56 -0
  151. data/lib/stripe/resources/v2/core/person.rb +276 -0
  152. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +74 -0
  153. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +39 -0
  154. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +20 -0
  155. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +22 -0
  156. data/lib/stripe/resources/v2/money_management/adjustment.rb +51 -0
  157. data/lib/stripe/resources/v2/money_management/financial_account.rb +77 -0
  158. data/lib/stripe/resources/v2/money_management/financial_address.rb +68 -0
  159. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +94 -0
  160. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +129 -0
  161. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +82 -0
  162. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +45 -0
  163. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +117 -0
  164. data/lib/stripe/resources/v2/money_management/payout_method.rb +75 -0
  165. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +49 -0
  166. data/lib/stripe/resources/v2/money_management/received_credit.rb +122 -0
  167. data/lib/stripe/resources/v2/money_management/received_debit.rb +84 -0
  168. data/lib/stripe/resources/v2/money_management/transaction.rb +78 -0
  169. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +68 -0
  170. data/lib/stripe/resources/v2/payments/off_session_payment.rb +72 -0
  171. data/lib/stripe/resources.rb +106 -0
  172. data/lib/stripe/services/account_notice_service.rb +101 -0
  173. data/lib/stripe/services/account_service.rb +562 -1
  174. data/lib/stripe/services/account_session_service.rb +226 -1
  175. data/lib/stripe/services/balance_settings_service.rb +96 -0
  176. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  177. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  178. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  179. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  180. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  181. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  182. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  183. data/lib/stripe/services/capital_service.rb +15 -0
  184. data/lib/stripe/services/charge_service.rb +1418 -0
  185. data/lib/stripe/services/checkout/session_service.rb +243 -2
  186. data/lib/stripe/services/coupon_service.rb +17 -1
  187. data/lib/stripe/services/credit_note_service.rb +4 -0
  188. data/lib/stripe/services/customer_session_service.rb +4 -1
  189. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -122
  190. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  191. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  192. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  193. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  194. data/lib/stripe/services/financial_connections_service.rb +2 -1
  195. data/lib/stripe/services/fx_quote_service.rb +123 -0
  196. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  197. data/lib/stripe/services/invoice_item_service.rb +74 -2
  198. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  199. data/lib/stripe/services/invoice_service.rb +1014 -16
  200. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  201. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  202. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  203. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  204. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  205. data/lib/stripe/services/issuing_service.rb +5 -1
  206. data/lib/stripe/services/margin_service.rb +119 -0
  207. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  208. data/lib/stripe/services/order_service.rb +2388 -0
  209. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  210. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/payment_intent_amount_details_line_item_service.rb} +20 -16
  211. data/lib/stripe/services/payment_intent_service.rb +4879 -391
  212. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  213. data/lib/stripe/services/payment_method_service.rb +120 -1
  214. data/lib/stripe/services/payment_record_service.rb +542 -0
  215. data/lib/stripe/services/payout_service.rb +4 -0
  216. data/lib/stripe/services/price_service.rb +19 -0
  217. data/lib/stripe/services/privacy/redaction_job_service.rb +240 -0
  218. data/{rbi/stripe/services/tax/calculation_line_item_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +21 -17
  219. data/lib/stripe/services/privacy_service.rb +13 -0
  220. data/lib/stripe/services/promotion_code_service.rb +8 -0
  221. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  222. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  223. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  224. data/lib/stripe/services/quote_service.rb +1723 -8
  225. data/lib/stripe/services/setup_intent_service.rb +538 -9
  226. data/lib/stripe/services/subscription_item_service.rb +75 -3
  227. data/lib/stripe/services/subscription_schedule_service.rb +911 -10
  228. data/lib/stripe/services/subscription_service.rb +249 -9
  229. data/lib/stripe/services/tax/association_service.rb +31 -0
  230. data/lib/stripe/services/tax/form_service.rb +100 -0
  231. data/lib/stripe/services/tax_id_service.rb +8 -2
  232. data/lib/stripe/services/tax_service.rb +3 -1
  233. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  234. data/lib/stripe/services/terminal_service.rb +2 -1
  235. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +97 -0
  236. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  237. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  238. data/lib/stripe/services/transfer_service.rb +4 -0
  239. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  240. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  241. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  242. data/lib/stripe/services/v1_services.rb +11 -2
  243. data/lib/stripe/services/v2/core/account_link_service.rb +76 -0
  244. data/lib/stripe/services/v2/core/account_service.rb +4486 -0
  245. data/lib/stripe/services/v2/core/accounts/person_service.rb +1045 -0
  246. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +130 -0
  247. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +107 -0
  248. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  249. data/lib/stripe/services/v2/core_service.rb +4 -1
  250. data/lib/stripe/services/v2/money_management/adjustment_service.rb +74 -0
  251. data/lib/stripe/services/v2/money_management/financial_account_service.rb +116 -0
  252. data/lib/stripe/services/v2/money_management/financial_address_service.rb +82 -0
  253. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +125 -0
  254. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +95 -0
  255. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +199 -0
  256. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +235 -0
  257. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +172 -0
  258. data/lib/stripe/services/v2/money_management/payout_method_service.rb +90 -0
  259. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  260. data/lib/stripe/services/v2/money_management/received_credit_service.rb +70 -0
  261. data/lib/stripe/services/v2/money_management/received_debit_service.rb +43 -0
  262. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +69 -0
  263. data/lib/stripe/services/v2/money_management/transaction_service.rb +73 -0
  264. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  265. data/lib/stripe/services/v2/payment_service.rb +15 -0
  266. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +137 -0
  267. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  268. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +49 -0
  269. data/lib/stripe/services/v2_services.rb +4 -1
  270. data/lib/stripe/services.rb +53 -1
  271. data/lib/stripe/stripe_configuration.rb +3 -1
  272. data/lib/stripe/stripe_object.rb +1 -1
  273. data/lib/stripe/util.rb +7 -1
  274. data/lib/stripe/version.rb +1 -1
  275. data/lib/stripe.rb +53 -0
  276. data/rbi/stripe.rbi +194513 -0
  277. data/stripe.gemspec +4 -1
  278. metadata +164 -325
  279. data/lib/stripe/services/invoice_payment_service.rb +0 -83
  280. data/rbi/stripe/resources/account.rbi +0 -4995
  281. data/rbi/stripe/resources/account_link.rbi +0 -74
  282. data/rbi/stripe/resources/account_session.rbi +0 -1013
  283. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -88
  284. data/rbi/stripe/resources/application.rbi +0 -20
  285. data/rbi/stripe/resources/application_fee.rbi +0 -118
  286. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  287. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  288. data/rbi/stripe/resources/balance.rbi +0 -235
  289. data/rbi/stripe/resources/balance_transaction.rbi +0 -147
  290. data/rbi/stripe/resources/bank_account.rbi +0 -127
  291. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  292. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  293. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  294. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  295. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  296. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  297. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  298. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  299. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  300. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -645
  301. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  302. data/rbi/stripe/resources/capability.rbi +0 -125
  303. data/rbi/stripe/resources/card.rbi +0 -125
  304. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  305. data/rbi/stripe/resources/charge.rbi +0 -2086
  306. data/rbi/stripe/resources/checkout/session.rbi +0 -4060
  307. data/rbi/stripe/resources/climate/order.rbi +0 -245
  308. data/rbi/stripe/resources/climate/product.rbi +0 -75
  309. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  310. data/rbi/stripe/resources/confirmation_token.rbi +0 -1818
  311. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  312. data/rbi/stripe/resources/country_spec.rbi +0 -85
  313. data/rbi/stripe/resources/coupon.rbi +0 -250
  314. data/rbi/stripe/resources/credit_note.rbi +0 -752
  315. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  316. data/rbi/stripe/resources/customer.rbi +0 -1005
  317. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  318. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  319. data/rbi/stripe/resources/customer_session.rbi +0 -200
  320. data/rbi/stripe/resources/discount.rbi +0 -53
  321. data/rbi/stripe/resources/dispute.rbi +0 -761
  322. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  323. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  324. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  325. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  326. data/rbi/stripe/resources/event.rbi +0 -149
  327. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  328. data/rbi/stripe/resources/file.rbi +0 -143
  329. data/rbi/stripe/resources/file_link.rbi +0 -141
  330. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  331. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  332. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  333. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  334. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  335. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  336. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  337. data/rbi/stripe/resources/identity/verification_report.rbi +0 -360
  338. data/rbi/stripe/resources/identity/verification_session.rbi +0 -564
  339. data/rbi/stripe/resources/invoice.rbi +0 -3842
  340. data/rbi/stripe/resources/invoice_item.rbi +0 -470
  341. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  342. data/rbi/stripe/resources/invoice_payment.rbi +0 -121
  343. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  344. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  345. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  346. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  347. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  348. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  349. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  350. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  351. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  352. data/rbi/stripe/resources/line_item.rbi +0 -72
  353. data/rbi/stripe/resources/login_link.rbi +0 -19
  354. data/rbi/stripe/resources/mandate.rbi +0 -191
  355. data/rbi/stripe/resources/payment_intent.rbi +0 -9987
  356. data/rbi/stripe/resources/payment_link.rbi +0 -1801
  357. data/rbi/stripe/resources/payment_method.rbi +0 -1770
  358. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3550
  359. data/rbi/stripe/resources/payment_method_domain.rbi +0 -228
  360. data/rbi/stripe/resources/payout.rbi +0 -300
  361. data/rbi/stripe/resources/person.rbi +0 -401
  362. data/rbi/stripe/resources/plan.rbi +0 -371
  363. data/rbi/stripe/resources/price.rbi +0 -694
  364. data/rbi/stripe/resources/product.rbi +0 -555
  365. data/rbi/stripe/resources/product_feature.rbi +0 -26
  366. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  367. data/rbi/stripe/resources/quote.rbi +0 -1145
  368. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  369. data/rbi/stripe/resources/radar/value_list.rbi +0 -168
  370. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -129
  371. data/rbi/stripe/resources/refund.rbi +0 -523
  372. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  373. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  374. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  375. data/rbi/stripe/resources/reversal.rbi +0 -51
  376. data/rbi/stripe/resources/review.rbi +0 -154
  377. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  378. data/rbi/stripe/resources/setup_intent.rbi +0 -3978
  379. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  380. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  381. data/rbi/stripe/resources/source.rbi +0 -1496
  382. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  383. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  384. data/rbi/stripe/resources/subscription.rbi +0 -2080
  385. data/rbi/stripe/resources/subscription_item.rbi +0 -404
  386. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1645
  387. data/rbi/stripe/resources/tax/calculation.rbi +0 -478
  388. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -91
  389. data/rbi/stripe/resources/tax/registration.rbi +0 -2732
  390. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  391. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  392. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  393. data/rbi/stripe/resources/tax_code.rbi +0 -44
  394. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  395. data/rbi/stripe/resources/tax_id.rbi +0 -165
  396. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  397. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1387
  398. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  399. data/rbi/stripe/resources/terminal/location.rbi +0 -222
  400. data/rbi/stripe/resources/terminal/reader.rbi +0 -994
  401. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -132
  402. data/rbi/stripe/resources/token.rbi +0 -1283
  403. data/rbi/stripe/resources/topup.rbi +0 -222
  404. data/rbi/stripe/resources/transfer.rbi +0 -199
  405. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  406. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  407. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -869
  408. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  409. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  410. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  411. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  412. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  413. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  414. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  415. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  416. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  417. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  418. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  419. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  420. data/rbi/stripe/resources/v2/event.rbi +0 -48
  421. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  422. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -168
  423. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  424. data/rbi/stripe/services/account_link_service.rbi +0 -58
  425. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  426. data/rbi/stripe/services/account_person_service.rbi +0 -1011
  427. data/rbi/stripe/services/account_service.rbi +0 -4281
  428. data/rbi/stripe/services/account_session_service.rbi +0 -646
  429. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -76
  430. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  431. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  432. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  433. data/rbi/stripe/services/apps_service.rbi +0 -9
  434. data/rbi/stripe/services/balance_service.rbi +0 -21
  435. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  436. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  437. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  438. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  439. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  440. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  441. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  442. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  443. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  444. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -511
  445. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  446. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  447. data/rbi/stripe/services/billing_service.rbi +0 -15
  448. data/rbi/stripe/services/charge_service.rbi +0 -448
  449. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  450. data/rbi/stripe/services/checkout/session_service.rbi +0 -2670
  451. data/rbi/stripe/services/checkout_service.rbi +0 -9
  452. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  453. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  454. data/rbi/stripe/services/climate_service.rbi +0 -11
  455. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  456. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  457. data/rbi/stripe/services/coupon_service.rbi +0 -194
  458. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  459. data/rbi/stripe/services/credit_note_service.rbi +0 -415
  460. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  461. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  462. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  463. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  464. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  465. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  466. data/rbi/stripe/services/customer_service.rbi +0 -647
  467. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  468. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -70
  469. data/rbi/stripe/services/dispute_service.rbi +0 -424
  470. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  471. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  472. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  473. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  474. data/rbi/stripe/services/event_service.rbi +0 -83
  475. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  476. data/rbi/stripe/services/file_link_service.rbi +0 -124
  477. data/rbi/stripe/services/file_service.rbi +0 -116
  478. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  479. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  480. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  481. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  482. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  483. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  484. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  485. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  486. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -339
  487. data/rbi/stripe/services/identity_service.rbi +0 -10
  488. data/rbi/stripe/services/invoice_item_service.rbi +0 -366
  489. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  490. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  491. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  492. data/rbi/stripe/services/invoice_service.rbi +0 -3011
  493. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  494. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  495. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  496. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  497. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  498. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  499. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  500. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  501. data/rbi/stripe/services/issuing_service.rbi +0 -16
  502. data/rbi/stripe/services/mandate_service.rbi +0 -20
  503. data/rbi/stripe/services/payment_intent_service.rbi +0 -7989
  504. data/rbi/stripe/services/payment_link_service.rbi +0 -1352
  505. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2487
  506. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  507. data/rbi/stripe/services/payment_method_service.rbi +0 -781
  508. data/rbi/stripe/services/payout_service.rbi +0 -205
  509. data/rbi/stripe/services/plan_service.rbi +0 -282
  510. data/rbi/stripe/services/price_service.rbi +0 -546
  511. data/rbi/stripe/services/product_feature_service.rbi +0 -67
  512. data/rbi/stripe/services/product_service.rbi +0 -477
  513. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  514. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  515. data/rbi/stripe/services/quote_service.rbi +0 -699
  516. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  517. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -109
  518. data/rbi/stripe/services/radar/value_list_service.rbi +0 -141
  519. data/rbi/stripe/services/radar_service.rbi +0 -11
  520. data/rbi/stripe/services/refund_service.rbi +0 -185
  521. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  522. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  523. data/rbi/stripe/services/reporting_service.rbi +0 -10
  524. data/rbi/stripe/services/review_service.rbi +0 -84
  525. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  526. data/rbi/stripe/services/setup_intent_service.rbi +0 -3709
  527. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  528. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  529. data/rbi/stripe/services/sigma_service.rbi +0 -9
  530. data/rbi/stripe/services/source_service.rbi +0 -663
  531. data/rbi/stripe/services/subscription_item_service.rbi +0 -350
  532. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1301
  533. data/rbi/stripe/services/subscription_service.rbi +0 -1684
  534. data/rbi/stripe/services/tax/calculation_service.rbi +0 -234
  535. data/rbi/stripe/services/tax/registration_service.rbi +0 -1858
  536. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  537. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  538. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  539. data/rbi/stripe/services/tax_id_service.rbi +0 -110
  540. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  541. data/rbi/stripe/services/tax_service.rbi +0 -12
  542. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1118
  543. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  544. data/rbi/stripe/services/terminal/location_service.rbi +0 -182
  545. data/rbi/stripe/services/terminal/reader_service.rbi +0 -540
  546. data/rbi/stripe/services/terminal_service.rbi +0 -12
  547. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -746
  548. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  549. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  550. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  551. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  552. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  553. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  554. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  555. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -93
  556. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  557. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -90
  558. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  559. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  560. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  561. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  562. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  563. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  564. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  565. data/rbi/stripe/services/token_service.rbi +0 -1257
  566. data/rbi/stripe/services/topup_service.rbi +0 -176
  567. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  568. data/rbi/stripe/services/transfer_service.rbi +0 -152
  569. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  570. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  571. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  572. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -566
  573. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  574. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  575. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  576. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  577. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  578. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  579. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  580. data/rbi/stripe/services/treasury_service.rbi +0 -18
  581. data/rbi/stripe/services/v1_services.rbi +0 -77
  582. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  583. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  584. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -18
  585. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  586. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  587. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -192
  588. data/rbi/stripe/services/v2/core/event_service.rbi +0 -36
  589. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  590. data/rbi/stripe/services/v2_services.rbi +0 -10
  591. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -129
@@ -1,432 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice.
7
- #
8
- # Each line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items).
9
- class InvoiceLineItem < APIResource
10
- class DiscountAmount < Stripe::StripeObject
11
- # The amount, in cents (or local equivalent), of the discount.
12
- sig { returns(Integer) }
13
- attr_reader :amount
14
- # The discount that was applied to get this discount amount.
15
- sig { returns(T.any(String, Stripe::Discount)) }
16
- attr_reader :discount
17
- end
18
- class Parent < Stripe::StripeObject
19
- class InvoiceItemDetails < Stripe::StripeObject
20
- class ProrationDetails < Stripe::StripeObject
21
- class CreditedItems < Stripe::StripeObject
22
- # Invoice containing the credited invoice line items
23
- sig { returns(String) }
24
- attr_reader :invoice
25
- # Credited invoice line items
26
- sig { returns(T::Array[String]) }
27
- attr_reader :invoice_line_items
28
- end
29
- # For a credit proration `line_item`, the original debit line_items to which the credit proration applies.
30
- sig { returns(T.nilable(CreditedItems)) }
31
- attr_reader :credited_items
32
- end
33
- # The invoice item that generated this line item
34
- sig { returns(String) }
35
- attr_reader :invoice_item
36
- # Whether this is a proration
37
- sig { returns(T::Boolean) }
38
- attr_reader :proration
39
- # Additional details for proration line items
40
- sig { returns(T.nilable(ProrationDetails)) }
41
- attr_reader :proration_details
42
- # The subscription that the invoice item belongs to
43
- sig { returns(T.nilable(String)) }
44
- attr_reader :subscription
45
- end
46
- class SubscriptionItemDetails < Stripe::StripeObject
47
- class ProrationDetails < Stripe::StripeObject
48
- class CreditedItems < Stripe::StripeObject
49
- # Invoice containing the credited invoice line items
50
- sig { returns(String) }
51
- attr_reader :invoice
52
- # Credited invoice line items
53
- sig { returns(T::Array[String]) }
54
- attr_reader :invoice_line_items
55
- end
56
- # For a credit proration `line_item`, the original debit line_items to which the credit proration applies.
57
- sig { returns(T.nilable(CreditedItems)) }
58
- attr_reader :credited_items
59
- end
60
- # The invoice item that generated this line item
61
- sig { returns(T.nilable(String)) }
62
- attr_reader :invoice_item
63
- # Whether this is a proration
64
- sig { returns(T::Boolean) }
65
- attr_reader :proration
66
- # Additional details for proration line items
67
- sig { returns(T.nilable(ProrationDetails)) }
68
- attr_reader :proration_details
69
- # The subscription that the subscription item belongs to
70
- sig { returns(T.nilable(String)) }
71
- attr_reader :subscription
72
- # The subscription item that generated this line item
73
- sig { returns(String) }
74
- attr_reader :subscription_item
75
- end
76
- # Details about the invoice item that generated this line item
77
- sig { returns(T.nilable(InvoiceItemDetails)) }
78
- attr_reader :invoice_item_details
79
- # Details about the subscription item that generated this line item
80
- sig { returns(T.nilable(SubscriptionItemDetails)) }
81
- attr_reader :subscription_item_details
82
- # The type of parent that generated this line item
83
- sig { returns(String) }
84
- attr_reader :type
85
- end
86
- class Period < Stripe::StripeObject
87
- # The end of the period, which must be greater than or equal to the start. This value is inclusive.
88
- sig { returns(Integer) }
89
- attr_reader :end
90
- # The start of the period. This value is inclusive.
91
- sig { returns(Integer) }
92
- attr_reader :start
93
- end
94
- class PretaxCreditAmount < Stripe::StripeObject
95
- # The amount, in cents (or local equivalent), of the pretax credit amount.
96
- sig { returns(Integer) }
97
- attr_reader :amount
98
- # The credit balance transaction that was applied to get this pretax credit amount.
99
- sig { returns(T.nilable(T.any(String, Stripe::Billing::CreditBalanceTransaction))) }
100
- attr_reader :credit_balance_transaction
101
- # The discount that was applied to get this pretax credit amount.
102
- sig { returns(T.any(String, Stripe::Discount)) }
103
- attr_reader :discount
104
- # Type of the pretax credit amount referenced.
105
- sig { returns(String) }
106
- attr_reader :type
107
- end
108
- class Pricing < Stripe::StripeObject
109
- class PriceDetails < Stripe::StripeObject
110
- # The ID of the price this item is associated with.
111
- sig { returns(String) }
112
- attr_reader :price
113
- # The ID of the product this item is associated with.
114
- sig { returns(String) }
115
- attr_reader :product
116
- end
117
- # Attribute for field price_details
118
- sig { returns(PriceDetails) }
119
- attr_reader :price_details
120
- # The type of the pricing details.
121
- sig { returns(String) }
122
- attr_reader :type
123
- # The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
124
- sig { returns(T.nilable(String)) }
125
- attr_reader :unit_amount_decimal
126
- end
127
- class Tax < Stripe::StripeObject
128
- class TaxRateDetails < Stripe::StripeObject
129
- # Attribute for field tax_rate
130
- sig { returns(String) }
131
- attr_reader :tax_rate
132
- end
133
- # The amount of the tax, in cents (or local equivalent).
134
- sig { returns(Integer) }
135
- attr_reader :amount
136
- # Whether this tax is inclusive or exclusive.
137
- sig { returns(String) }
138
- attr_reader :tax_behavior
139
- # Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
140
- sig { returns(T.nilable(TaxRateDetails)) }
141
- attr_reader :tax_rate_details
142
- # 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.
143
- sig { returns(String) }
144
- attr_reader :taxability_reason
145
- # The amount on which tax is calculated, in cents (or local equivalent).
146
- sig { returns(T.nilable(Integer)) }
147
- attr_reader :taxable_amount
148
- # The type of tax information.
149
- sig { returns(String) }
150
- attr_reader :type
151
- end
152
- # The amount, in cents (or local equivalent).
153
- sig { returns(Integer) }
154
- attr_reader :amount
155
- # 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).
156
- sig { returns(String) }
157
- attr_reader :currency
158
- # An arbitrary string attached to the object. Often useful for displaying to users.
159
- sig { returns(T.nilable(String)) }
160
- attr_reader :description
161
- # The amount of discount calculated per discount for this line item.
162
- sig { returns(T.nilable(T::Array[DiscountAmount])) }
163
- attr_reader :discount_amounts
164
- # If true, discounts will apply to this line item. Always false for prorations.
165
- sig { returns(T::Boolean) }
166
- attr_reader :discountable
167
- # The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
168
- sig { returns(T::Array[T.any(String, Stripe::Discount)]) }
169
- attr_reader :discounts
170
- # Unique identifier for the object.
171
- sig { returns(String) }
172
- attr_reader :id
173
- # The ID of the invoice that contains this line item.
174
- sig { returns(T.nilable(String)) }
175
- attr_reader :invoice
176
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
177
- sig { returns(T::Boolean) }
178
- attr_reader :livemode
179
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
180
- sig { returns(T::Hash[String, String]) }
181
- attr_reader :metadata
182
- # String representing the object's type. Objects of the same type share the same value.
183
- sig { returns(String) }
184
- attr_reader :object
185
- # The parent that generated this line item.
186
- sig { returns(T.nilable(Parent)) }
187
- attr_reader :parent
188
- # Attribute for field period
189
- sig { returns(Period) }
190
- attr_reader :period
191
- # Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.
192
- sig { returns(T.nilable(T::Array[PretaxCreditAmount])) }
193
- attr_reader :pretax_credit_amounts
194
- # The pricing information of the line item.
195
- sig { returns(T.nilable(Pricing)) }
196
- attr_reader :pricing
197
- # The quantity of the subscription, if the line item is a subscription or a proration.
198
- sig { returns(T.nilable(Integer)) }
199
- attr_reader :quantity
200
- # Attribute for field subscription
201
- sig { returns(T.nilable(T.any(String, Stripe::Subscription))) }
202
- attr_reader :subscription
203
- # The tax information of the line item.
204
- sig { returns(T.nilable(T::Array[Tax])) }
205
- attr_reader :taxes
206
- class UpdateParams < Stripe::RequestParams
207
- class Discount < Stripe::RequestParams
208
- # ID of the coupon to create a new discount for.
209
- sig { returns(T.nilable(String)) }
210
- attr_accessor :coupon
211
- # ID of an existing discount on the object (or one of its ancestors) to reuse.
212
- sig { returns(T.nilable(String)) }
213
- attr_accessor :discount
214
- # ID of the promotion code to create a new discount for.
215
- sig { returns(T.nilable(String)) }
216
- attr_accessor :promotion_code
217
- sig {
218
- params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
219
- }
220
- def initialize(coupon: nil, discount: nil, promotion_code: nil); end
221
- end
222
- class Period < Stripe::RequestParams
223
- # The end of the period, which must be greater than or equal to the start. This value is inclusive.
224
- sig { returns(Integer) }
225
- attr_accessor :end
226
- # The start of the period. This value is inclusive.
227
- sig { returns(Integer) }
228
- attr_accessor :start
229
- sig { params(end_: Integer, start: Integer).void }
230
- def initialize(end_: nil, start: nil); end
231
- end
232
- class PriceData < Stripe::RequestParams
233
- class ProductData < Stripe::RequestParams
234
- # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
235
- sig { returns(T.nilable(String)) }
236
- attr_accessor :description
237
- # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
238
- sig { returns(T.nilable(T::Array[String])) }
239
- attr_accessor :images
240
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
241
- sig { returns(T.nilable(T::Hash[String, String])) }
242
- attr_accessor :metadata
243
- # The product's name, meant to be displayable to the customer.
244
- sig { returns(String) }
245
- attr_accessor :name
246
- # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
247
- sig { returns(T.nilable(String)) }
248
- attr_accessor :tax_code
249
- sig {
250
- params(description: T.nilable(String), images: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: String, tax_code: T.nilable(String)).void
251
- }
252
- def initialize(
253
- description: nil,
254
- images: nil,
255
- metadata: nil,
256
- name: nil,
257
- tax_code: nil
258
- ); end
259
- end
260
- # 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).
261
- sig { returns(String) }
262
- attr_accessor :currency
263
- # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
264
- sig { returns(T.nilable(String)) }
265
- attr_accessor :product
266
- # Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
267
- sig { returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData::ProductData)) }
268
- attr_accessor :product_data
269
- # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
270
- sig { returns(T.nilable(String)) }
271
- attr_accessor :tax_behavior
272
- # A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
273
- sig { returns(T.nilable(Integer)) }
274
- attr_accessor :unit_amount
275
- # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
276
- sig { returns(T.nilable(String)) }
277
- attr_accessor :unit_amount_decimal
278
- sig {
279
- params(currency: String, product: T.nilable(String), product_data: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData::ProductData), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
280
- }
281
- def initialize(
282
- currency: nil,
283
- product: nil,
284
- product_data: nil,
285
- tax_behavior: nil,
286
- unit_amount: nil,
287
- unit_amount_decimal: nil
288
- ); end
289
- end
290
- class Pricing < Stripe::RequestParams
291
- # The ID of the price object.
292
- sig { returns(T.nilable(String)) }
293
- attr_accessor :price
294
- sig { params(price: T.nilable(String)).void }
295
- def initialize(price: nil); end
296
- end
297
- class TaxAmount < Stripe::RequestParams
298
- class TaxRateData < Stripe::RequestParams
299
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
300
- sig { returns(T.nilable(String)) }
301
- attr_accessor :country
302
- # An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
303
- sig { returns(T.nilable(String)) }
304
- attr_accessor :description
305
- # The display name of the tax rate, which will be shown to users.
306
- sig { returns(String) }
307
- attr_accessor :display_name
308
- # This specifies if the tax rate is inclusive or exclusive.
309
- sig { returns(T::Boolean) }
310
- attr_accessor :inclusive
311
- # The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
312
- sig { returns(T.nilable(String)) }
313
- attr_accessor :jurisdiction
314
- # The level of the jurisdiction that imposes this tax rate.
315
- sig { returns(T.nilable(String)) }
316
- attr_accessor :jurisdiction_level
317
- # The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
318
- sig { returns(Float) }
319
- attr_accessor :percentage
320
- # [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
321
- sig { returns(T.nilable(String)) }
322
- attr_accessor :state
323
- # The high-level tax type, such as `vat` or `sales_tax`.
324
- sig { returns(T.nilable(String)) }
325
- attr_accessor :tax_type
326
- sig {
327
- params(country: T.nilable(String), description: T.nilable(String), display_name: String, inclusive: T::Boolean, jurisdiction: T.nilable(String), jurisdiction_level: T.nilable(String), percentage: Float, state: T.nilable(String), tax_type: T.nilable(String)).void
328
- }
329
- def initialize(
330
- country: nil,
331
- description: nil,
332
- display_name: nil,
333
- inclusive: nil,
334
- jurisdiction: nil,
335
- jurisdiction_level: nil,
336
- percentage: nil,
337
- state: nil,
338
- tax_type: nil
339
- ); end
340
- end
341
- # The amount, in cents (or local equivalent), of the tax.
342
- sig { returns(Integer) }
343
- attr_accessor :amount
344
- # Data to find or create a TaxRate object.
345
- #
346
- # Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.
347
- sig { returns(::Stripe::InvoiceLineItem::UpdateParams::TaxAmount::TaxRateData) }
348
- attr_accessor :tax_rate_data
349
- # The reasoning behind this tax, for example, if the product is tax exempt.
350
- sig { returns(T.nilable(String)) }
351
- attr_accessor :taxability_reason
352
- # The amount on which tax is calculated, in cents (or local equivalent).
353
- sig { returns(Integer) }
354
- attr_accessor :taxable_amount
355
- sig {
356
- params(amount: Integer, tax_rate_data: ::Stripe::InvoiceLineItem::UpdateParams::TaxAmount::TaxRateData, taxability_reason: T.nilable(String), taxable_amount: Integer).void
357
- }
358
- def initialize(
359
- amount: nil,
360
- tax_rate_data: nil,
361
- taxability_reason: nil,
362
- taxable_amount: nil
363
- ); end
364
- end
365
- # The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
366
- sig { returns(T.nilable(Integer)) }
367
- attr_accessor :amount
368
- # An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
369
- sig { returns(T.nilable(String)) }
370
- attr_accessor :description
371
- # Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
372
- sig { returns(T.nilable(T::Boolean)) }
373
- attr_accessor :discountable
374
- # The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
375
- sig {
376
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::Discount]))))
377
- }
378
- attr_accessor :discounts
379
- # Specifies which fields in the response should be expanded.
380
- sig { returns(T.nilable(T::Array[String])) }
381
- attr_accessor :expand
382
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
383
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
384
- attr_accessor :metadata
385
- # The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
386
- sig { returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Period)) }
387
- attr_accessor :period
388
- # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
389
- sig { returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData)) }
390
- attr_accessor :price_data
391
- # The pricing information for the invoice item.
392
- sig { returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Pricing)) }
393
- attr_accessor :pricing
394
- # Non-negative integer. The quantity of units for the line item.
395
- sig { returns(T.nilable(Integer)) }
396
- attr_accessor :quantity
397
- # A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
398
- sig {
399
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::TaxAmount]))))
400
- }
401
- attr_accessor :tax_amounts
402
- # The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
403
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
404
- attr_accessor :tax_rates
405
- sig {
406
- params(amount: T.nilable(Integer), description: T.nilable(String), discountable: T.nilable(T::Boolean), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::Discount]))), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), period: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Period), price_data: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData), pricing: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Pricing), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::TaxAmount]))), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void
407
- }
408
- def initialize(
409
- amount: nil,
410
- description: nil,
411
- discountable: nil,
412
- discounts: nil,
413
- expand: nil,
414
- metadata: nil,
415
- period: nil,
416
- price_data: nil,
417
- pricing: nil,
418
- quantity: nil,
419
- tax_amounts: nil,
420
- tax_rates: nil
421
- ); end
422
- end
423
- # Updates an invoice's line item. Some fields, such as tax_amounts, only live on the invoice line item,
424
- # so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice
425
- # item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.
426
- # Updating an invoice's line item is only possible before the invoice is finalized.
427
- sig {
428
- params(invoice: String, line_item_id: String, params: T.any(::Stripe::InvoiceLineItem::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceLineItem)
429
- }
430
- def self.update(invoice, line_item_id, params = {}, opts = {}); end
431
- end
432
- end
@@ -1,121 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # Invoice Payments represent payments made against invoices. Invoice Payments can
7
- # be accessed in two ways:
8
- # 1. By expanding the `payments` field on the [Invoice](https://stripe.com/docs/api#invoice) resource.
9
- # 2. By using the Invoice Payment retrieve and list endpoints.
10
- #
11
- # Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices.
12
- # This resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and
13
- # monitor the allocation details of the payments.
14
- class InvoicePayment < APIResource
15
- class Payment < Stripe::StripeObject
16
- # ID of the successful charge for this payment when `type` is `charge`.Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead.
17
- sig { returns(T.any(String, Stripe::Charge)) }
18
- attr_reader :charge
19
- # ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019.
20
- sig { returns(T.any(String, Stripe::PaymentIntent)) }
21
- attr_reader :payment_intent
22
- # Type of payment object associated with this invoice payment.
23
- sig { returns(String) }
24
- attr_reader :type
25
- end
26
- class StatusTransitions < Stripe::StripeObject
27
- # The time that the payment was canceled.
28
- sig { returns(T.nilable(Integer)) }
29
- attr_reader :canceled_at
30
- # The time that the payment succeeded.
31
- sig { returns(T.nilable(Integer)) }
32
- attr_reader :paid_at
33
- end
34
- # Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent’s `amount_received` is not sufficient to pay all of the invoices that it is attached to.
35
- sig { returns(T.nilable(Integer)) }
36
- attr_reader :amount_paid
37
- # Amount intended to be paid toward this invoice, in cents (or local equivalent)
38
- sig { returns(Integer) }
39
- attr_reader :amount_requested
40
- # Time at which the object was created. Measured in seconds since the Unix epoch.
41
- sig { returns(Integer) }
42
- attr_reader :created
43
- # 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).
44
- sig { returns(String) }
45
- attr_reader :currency
46
- # Unique identifier for the object.
47
- sig { returns(String) }
48
- attr_reader :id
49
- # The invoice that was paid.
50
- sig { returns(T.any(String, Stripe::Invoice)) }
51
- attr_reader :invoice
52
- # Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s `amount_remaining`. The PaymentIntent associated with the default payment can’t be edited or canceled directly.
53
- sig { returns(T::Boolean) }
54
- attr_reader :is_default
55
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
56
- sig { returns(T::Boolean) }
57
- attr_reader :livemode
58
- # String representing the object's type. Objects of the same type share the same value.
59
- sig { returns(String) }
60
- attr_reader :object
61
- # Attribute for field payment
62
- sig { returns(Payment) }
63
- attr_reader :payment
64
- # The status of the payment, one of `open`, `paid`, or `canceled`.
65
- sig { returns(String) }
66
- attr_reader :status
67
- # Attribute for field status_transitions
68
- sig { returns(StatusTransitions) }
69
- attr_reader :status_transitions
70
- class ListParams < Stripe::RequestParams
71
- class Payment < Stripe::RequestParams
72
- # Only return invoice payments associated by this payment intent ID.
73
- sig { returns(T.nilable(String)) }
74
- attr_accessor :payment_intent
75
- # Only return invoice payments associated by this payment type.
76
- sig { returns(String) }
77
- attr_accessor :type
78
- sig { params(payment_intent: T.nilable(String), type: String).void }
79
- def initialize(payment_intent: nil, type: nil); end
80
- end
81
- # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
82
- sig { returns(T.nilable(String)) }
83
- attr_accessor :ending_before
84
- # Specifies which fields in the response should be expanded.
85
- sig { returns(T.nilable(T::Array[String])) }
86
- attr_accessor :expand
87
- # The identifier of the invoice whose payments to return.
88
- sig { returns(T.nilable(String)) }
89
- attr_accessor :invoice
90
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
91
- sig { returns(T.nilable(Integer)) }
92
- attr_accessor :limit
93
- # The payment details of the invoice payments to return.
94
- sig { returns(T.nilable(::Stripe::InvoicePayment::ListParams::Payment)) }
95
- attr_accessor :payment
96
- # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
97
- sig { returns(T.nilable(String)) }
98
- attr_accessor :starting_after
99
- # The status of the invoice payments to return.
100
- sig { returns(T.nilable(String)) }
101
- attr_accessor :status
102
- sig {
103
- params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: T.nilable(String), limit: T.nilable(Integer), payment: T.nilable(::Stripe::InvoicePayment::ListParams::Payment), starting_after: T.nilable(String), status: T.nilable(String)).void
104
- }
105
- def initialize(
106
- ending_before: nil,
107
- expand: nil,
108
- invoice: nil,
109
- limit: nil,
110
- payment: nil,
111
- starting_after: nil,
112
- status: nil
113
- ); end
114
- end
115
- # When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
116
- sig {
117
- params(params: T.any(::Stripe::InvoicePayment::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
118
- }
119
- def self.list(params = {}, opts = {}); end
120
- end
121
- end
@@ -1,104 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates
7
- # can be created from within the Dashboard, and they can be used over the API when creating invoices.
8
- class InvoiceRenderingTemplate < APIResource
9
- # Time at which the object was created. Measured in seconds since the Unix epoch.
10
- sig { returns(Integer) }
11
- attr_reader :created
12
- # Unique identifier for the object.
13
- sig { returns(String) }
14
- attr_reader :id
15
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
16
- sig { returns(T::Boolean) }
17
- attr_reader :livemode
18
- # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
19
- sig { returns(T.nilable(T::Hash[String, String])) }
20
- attr_reader :metadata
21
- # A brief description of the template, hidden from customers
22
- sig { returns(T.nilable(String)) }
23
- attr_reader :nickname
24
- # String representing the object's type. Objects of the same type share the same value.
25
- sig { returns(String) }
26
- attr_reader :object
27
- # The status of the template, one of `active` or `archived`.
28
- sig { returns(String) }
29
- attr_reader :status
30
- # Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering
31
- sig { returns(Integer) }
32
- attr_reader :version
33
- class ListParams < Stripe::RequestParams
34
- # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
35
- sig { returns(T.nilable(String)) }
36
- attr_accessor :ending_before
37
- # Specifies which fields in the response should be expanded.
38
- sig { returns(T.nilable(T::Array[String])) }
39
- attr_accessor :expand
40
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
41
- sig { returns(T.nilable(Integer)) }
42
- attr_accessor :limit
43
- # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
44
- sig { returns(T.nilable(String)) }
45
- attr_accessor :starting_after
46
- # Attribute for param field status
47
- sig { returns(T.nilable(String)) }
48
- attr_accessor :status
49
- sig {
50
- params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
51
- }
52
- def initialize(
53
- ending_before: nil,
54
- expand: nil,
55
- limit: nil,
56
- starting_after: nil,
57
- status: nil
58
- ); end
59
- end
60
- class ArchiveParams < Stripe::RequestParams
61
- # Specifies which fields in the response should be expanded.
62
- sig { returns(T.nilable(T::Array[String])) }
63
- attr_accessor :expand
64
- sig { params(expand: T.nilable(T::Array[String])).void }
65
- def initialize(expand: nil); end
66
- end
67
- class UnarchiveParams < Stripe::RequestParams
68
- # Specifies which fields in the response should be expanded.
69
- sig { returns(T.nilable(T::Array[String])) }
70
- attr_accessor :expand
71
- sig { params(expand: T.nilable(T::Array[String])).void }
72
- def initialize(expand: nil); end
73
- end
74
- # Updates the status of an invoice rendering template to ‘archived' so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.
75
- sig {
76
- params(params: T.any(::Stripe::InvoiceRenderingTemplate::ArchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceRenderingTemplate)
77
- }
78
- def archive(params = {}, opts = {}); end
79
-
80
- # Updates the status of an invoice rendering template to ‘archived' so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.
81
- sig {
82
- params(template: String, params: T.any(::Stripe::InvoiceRenderingTemplate::ArchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceRenderingTemplate)
83
- }
84
- def self.archive(template, params = {}, opts = {}); end
85
-
86
- # List all templates, ordered by creation date, with the most recently created template appearing first.
87
- sig {
88
- params(params: T.any(::Stripe::InvoiceRenderingTemplate::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
89
- }
90
- def self.list(params = {}, opts = {}); end
91
-
92
- # Unarchive an invoice rendering template so it can be used on new Stripe objects again.
93
- sig {
94
- params(params: T.any(::Stripe::InvoiceRenderingTemplate::UnarchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceRenderingTemplate)
95
- }
96
- def unarchive(params = {}, opts = {}); end
97
-
98
- # Unarchive an invoice rendering template so it can be used on new Stripe objects again.
99
- sig {
100
- params(template: String, params: T.any(::Stripe::InvoiceRenderingTemplate::UnarchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceRenderingTemplate)
101
- }
102
- def self.unarchive(template, params = {}, opts = {}); end
103
- end
104
- end