stripe 15.2.0 → 15.3.0.pre.beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (587) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1600 -670
  3. data/VERSION +1 -1
  4. data/lib/stripe/api_requestor.rb +28 -0
  5. data/lib/stripe/api_version.rb +1 -1
  6. data/lib/stripe/errors.rb +54 -0
  7. data/lib/stripe/event_types.rb +98 -0
  8. data/lib/stripe/events/v2_core_account_closed_event.rb +21 -0
  9. data/lib/stripe/events/v2_core_account_created_event.rb +21 -0
  10. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  11. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  12. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  14. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  15. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  16. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +21 -0
  17. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  18. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  19. data/lib/stripe/events/v2_core_account_link_completed_event.rb +13 -0
  20. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  21. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  22. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  23. data/lib/stripe/events/v2_core_account_updated_event.rb +21 -0
  24. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +21 -0
  25. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  26. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +21 -0
  27. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  30. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  33. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  34. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +21 -0
  41. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  48. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  49. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  50. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  51. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  52. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  53. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  54. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  55. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  56. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +21 -0
  57. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +21 -0
  58. data/lib/stripe/events/v2_off_session_payment_requires_capture_event.rb +21 -0
  59. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +21 -0
  60. data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +21 -0
  61. data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +21 -0
  62. data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +21 -0
  63. data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +21 -0
  64. data/lib/stripe/events/v2_payments_off_session_payment_succeeded_event.rb +21 -0
  65. data/lib/stripe/object_types.rb +50 -0
  66. data/lib/stripe/resources/account.rb +653 -1
  67. data/lib/stripe/resources/account_notice.rb +123 -0
  68. data/lib/stripe/resources/account_session.rb +256 -1
  69. data/lib/stripe/resources/balance_settings.rb +105 -0
  70. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  71. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  72. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  73. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  74. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  75. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  76. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  77. data/lib/stripe/resources/card.rb +2 -0
  78. data/lib/stripe/resources/cash_balance.rb +2 -0
  79. data/lib/stripe/resources/charge.rb +1538 -0
  80. data/lib/stripe/resources/checkout/session.rb +330 -2
  81. data/lib/stripe/resources/confirmation_token.rb +170 -0
  82. data/lib/stripe/resources/coupon.rb +30 -1
  83. data/lib/stripe/resources/credit_note.rb +6 -0
  84. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  85. data/lib/stripe/resources/customer.rb +2 -0
  86. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  87. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  88. data/lib/stripe/resources/customer_session.rb +6 -1
  89. data/lib/stripe/resources/discount.rb +2 -0
  90. data/lib/stripe/resources/event.rb +31 -0
  91. data/lib/stripe/resources/financial_connections/account.rb +22 -1
  92. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  93. data/lib/stripe/resources/financial_connections/institution.rb +92 -0
  94. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  95. data/lib/stripe/resources/fx_quote.rb +184 -0
  96. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  97. data/lib/stripe/resources/invoice.rb +1070 -16
  98. data/lib/stripe/resources/invoice_item.rb +78 -2
  99. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  100. data/lib/stripe/resources/invoice_payment.rb +2 -53
  101. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  102. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  103. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  104. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  105. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  106. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  107. data/lib/stripe/resources/line_item.rb +37 -0
  108. data/lib/stripe/resources/mandate.rb +24 -0
  109. data/lib/stripe/resources/margin.rb +115 -0
  110. data/lib/stripe/resources/order.rb +2806 -0
  111. data/lib/stripe/resources/payment_attempt_record.rb +1086 -0
  112. data/lib/stripe/resources/payment_intent.rb +7694 -2738
  113. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +72 -0
  114. data/lib/stripe/resources/payment_method.rb +192 -1
  115. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  116. data/lib/stripe/resources/payment_record.rb +1615 -0
  117. data/lib/stripe/resources/payout.rb +6 -0
  118. data/lib/stripe/resources/price.rb +30 -0
  119. data/lib/stripe/resources/privacy/redaction_job.rb +298 -0
  120. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +33 -0
  121. data/lib/stripe/resources/promotion_code.rb +10 -0
  122. data/lib/stripe/resources/quote.rb +2046 -6
  123. data/lib/stripe/resources/quote_line.rb +274 -0
  124. data/lib/stripe/resources/quote_preview_invoice.rb +663 -0
  125. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +364 -0
  126. data/lib/stripe/resources/refund.rb +9 -0
  127. data/lib/stripe/resources/setup_attempt.rb +21 -0
  128. data/lib/stripe/resources/setup_intent.rb +578 -9
  129. data/lib/stripe/resources/source.rb +29 -0
  130. data/lib/stripe/resources/subscription.rb +333 -9
  131. data/lib/stripe/resources/subscription_item.rb +84 -3
  132. data/lib/stripe/resources/subscription_schedule.rb +1013 -10
  133. data/lib/stripe/resources/tax/association.rb +66 -0
  134. data/lib/stripe/resources/tax/form.rb +211 -0
  135. data/lib/stripe/resources/tax_id.rb +12 -2
  136. data/lib/stripe/resources/terminal/reader.rb +156 -0
  137. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  138. data/lib/stripe/resources/transfer.rb +6 -0
  139. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  140. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  141. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  142. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  143. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  144. data/lib/stripe/resources/v2/core/account.rb +1746 -0
  145. data/lib/stripe/resources/v2/core/account_link.rb +56 -0
  146. data/lib/stripe/resources/v2/core/person.rb +276 -0
  147. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +74 -0
  148. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +39 -0
  149. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +20 -0
  150. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +22 -0
  151. data/lib/stripe/resources/v2/money_management/adjustment.rb +51 -0
  152. data/lib/stripe/resources/v2/money_management/financial_account.rb +58 -0
  153. data/lib/stripe/resources/v2/money_management/financial_address.rb +68 -0
  154. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +94 -0
  155. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +129 -0
  156. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +82 -0
  157. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +45 -0
  158. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +117 -0
  159. data/lib/stripe/resources/v2/money_management/payout_method.rb +75 -0
  160. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +49 -0
  161. data/lib/stripe/resources/v2/money_management/received_credit.rb +116 -0
  162. data/lib/stripe/resources/v2/money_management/received_debit.rb +84 -0
  163. data/lib/stripe/resources/v2/money_management/transaction.rb +78 -0
  164. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +68 -0
  165. data/lib/stripe/resources/v2/payments/off_session_payment.rb +74 -0
  166. data/lib/stripe/resources.rb +104 -0
  167. data/lib/stripe/services/account_notice_service.rb +101 -0
  168. data/lib/stripe/services/account_service.rb +562 -1
  169. data/lib/stripe/services/account_session_service.rb +226 -1
  170. data/lib/stripe/services/balance_settings_service.rb +96 -0
  171. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  172. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  173. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  174. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  175. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  176. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  177. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  178. data/lib/stripe/services/capital_service.rb +15 -0
  179. data/lib/stripe/services/charge_service.rb +1418 -0
  180. data/lib/stripe/services/checkout/session_service.rb +247 -2
  181. data/lib/stripe/services/coupon_service.rb +17 -1
  182. data/lib/stripe/services/credit_note_service.rb +4 -0
  183. data/lib/stripe/services/customer_session_service.rb +4 -1
  184. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -122
  185. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  186. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  187. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  188. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  189. data/lib/stripe/services/financial_connections_service.rb +2 -1
  190. data/lib/stripe/services/fx_quote_service.rb +123 -0
  191. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  192. data/lib/stripe/services/invoice_item_service.rb +74 -2
  193. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  194. data/lib/stripe/services/invoice_service.rb +1021 -16
  195. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  196. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  197. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  198. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  199. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  200. data/lib/stripe/services/issuing_service.rb +5 -1
  201. data/lib/stripe/services/margin_service.rb +119 -0
  202. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  203. data/lib/stripe/services/order_service.rb +2236 -0
  204. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  205. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/payment_intent_amount_details_line_item_service.rb} +20 -16
  206. data/lib/stripe/services/payment_intent_service.rb +4733 -245
  207. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  208. data/lib/stripe/services/payment_method_service.rb +120 -1
  209. data/lib/stripe/services/payment_record_service.rb +542 -0
  210. data/lib/stripe/services/payout_service.rb +4 -0
  211. data/lib/stripe/services/price_service.rb +19 -0
  212. data/lib/stripe/services/privacy/redaction_job_service.rb +240 -0
  213. data/{rbi/stripe/services/tax/calculation_line_item_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +21 -17
  214. data/lib/stripe/services/privacy_service.rb +13 -0
  215. data/lib/stripe/services/promotion_code_service.rb +8 -0
  216. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  217. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  218. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +35 -0
  219. data/lib/stripe/services/quote_service.rb +1730 -7
  220. data/lib/stripe/services/setup_intent_service.rb +538 -9
  221. data/lib/stripe/services/subscription_item_service.rb +75 -3
  222. data/lib/stripe/services/subscription_schedule_service.rb +915 -10
  223. data/lib/stripe/services/subscription_service.rb +276 -9
  224. data/lib/stripe/services/tax/association_service.rb +31 -0
  225. data/lib/stripe/services/tax/form_service.rb +100 -0
  226. data/lib/stripe/services/tax_id_service.rb +8 -2
  227. data/lib/stripe/services/tax_service.rb +3 -1
  228. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  229. data/lib/stripe/services/terminal/reader_service.rb +90 -0
  230. data/lib/stripe/services/terminal_service.rb +2 -1
  231. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +97 -0
  232. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  233. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  234. data/lib/stripe/services/transfer_service.rb +4 -0
  235. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  236. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  237. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  238. data/lib/stripe/services/v1_services.rb +11 -2
  239. data/lib/stripe/services/v2/core/account_link_service.rb +76 -0
  240. data/lib/stripe/services/v2/core/account_service.rb +4138 -0
  241. data/lib/stripe/services/v2/core/accounts/person_service.rb +1046 -0
  242. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +131 -0
  243. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +107 -0
  244. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  245. data/lib/stripe/services/v2/core_service.rb +4 -1
  246. data/lib/stripe/services/v2/money_management/adjustment_service.rb +74 -0
  247. data/lib/stripe/services/v2/money_management/financial_account_service.rb +43 -0
  248. data/lib/stripe/services/v2/money_management/financial_address_service.rb +81 -0
  249. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +125 -0
  250. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +95 -0
  251. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +200 -0
  252. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +235 -0
  253. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +172 -0
  254. data/lib/stripe/services/v2/money_management/payout_method_service.rb +91 -0
  255. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  256. data/lib/stripe/services/v2/money_management/received_credit_service.rb +70 -0
  257. data/lib/stripe/services/v2/money_management/received_debit_service.rb +43 -0
  258. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +69 -0
  259. data/lib/stripe/services/v2/money_management/transaction_service.rb +73 -0
  260. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  261. data/lib/stripe/services/v2/payment_service.rb +15 -0
  262. data/lib/stripe/services/v2/payments/off_session_payment_service.rb +138 -0
  263. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  264. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +49 -0
  265. data/lib/stripe/services/v2_services.rb +5 -2
  266. data/lib/stripe/services.rb +53 -1
  267. data/lib/stripe/stripe_configuration.rb +3 -1
  268. data/lib/stripe/stripe_object.rb +1 -1
  269. data/lib/stripe/util.rb +7 -1
  270. data/lib/stripe/version.rb +1 -1
  271. data/lib/stripe.rb +53 -0
  272. data/rbi/stripe.rbi +191639 -0
  273. data/stripe.gemspec +4 -1
  274. metadata +161 -324
  275. data/lib/stripe/services/invoice_payment_service.rb +0 -83
  276. data/rbi/stripe/resources/account.rbi +0 -4926
  277. data/rbi/stripe/resources/account_link.rbi +0 -74
  278. data/rbi/stripe/resources/account_session.rbi +0 -1013
  279. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -88
  280. data/rbi/stripe/resources/application.rbi +0 -20
  281. data/rbi/stripe/resources/application_fee.rbi +0 -118
  282. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  283. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  284. data/rbi/stripe/resources/balance.rbi +0 -235
  285. data/rbi/stripe/resources/balance_transaction.rbi +0 -147
  286. data/rbi/stripe/resources/bank_account.rbi +0 -127
  287. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  288. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  289. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  290. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  291. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  292. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  293. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  294. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  295. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  296. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -645
  297. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  298. data/rbi/stripe/resources/capability.rbi +0 -125
  299. data/rbi/stripe/resources/card.rbi +0 -125
  300. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  301. data/rbi/stripe/resources/charge.rbi +0 -2069
  302. data/rbi/stripe/resources/checkout/session.rbi +0 -4004
  303. data/rbi/stripe/resources/climate/order.rbi +0 -245
  304. data/rbi/stripe/resources/climate/product.rbi +0 -75
  305. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  306. data/rbi/stripe/resources/confirmation_token.rbi +0 -1807
  307. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  308. data/rbi/stripe/resources/country_spec.rbi +0 -85
  309. data/rbi/stripe/resources/coupon.rbi +0 -250
  310. data/rbi/stripe/resources/credit_note.rbi +0 -752
  311. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  312. data/rbi/stripe/resources/customer.rbi +0 -1005
  313. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  314. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  315. data/rbi/stripe/resources/customer_session.rbi +0 -200
  316. data/rbi/stripe/resources/discount.rbi +0 -53
  317. data/rbi/stripe/resources/dispute.rbi +0 -761
  318. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  319. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  320. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  321. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  322. data/rbi/stripe/resources/event.rbi +0 -149
  323. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  324. data/rbi/stripe/resources/file.rbi +0 -143
  325. data/rbi/stripe/resources/file_link.rbi +0 -141
  326. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  327. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  328. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  329. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  330. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  331. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  332. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  333. data/rbi/stripe/resources/identity/verification_report.rbi +0 -360
  334. data/rbi/stripe/resources/identity/verification_session.rbi +0 -526
  335. data/rbi/stripe/resources/invoice.rbi +0 -3812
  336. data/rbi/stripe/resources/invoice_item.rbi +0 -473
  337. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  338. data/rbi/stripe/resources/invoice_payment.rbi +0 -121
  339. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  340. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  341. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  342. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  343. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  344. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  345. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  346. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  347. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  348. data/rbi/stripe/resources/line_item.rbi +0 -72
  349. data/rbi/stripe/resources/login_link.rbi +0 -19
  350. data/rbi/stripe/resources/mandate.rbi +0 -187
  351. data/rbi/stripe/resources/payment_intent.rbi +0 -9647
  352. data/rbi/stripe/resources/payment_link.rbi +0 -1801
  353. data/rbi/stripe/resources/payment_method.rbi +0 -1761
  354. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3550
  355. data/rbi/stripe/resources/payment_method_domain.rbi +0 -228
  356. data/rbi/stripe/resources/payout.rbi +0 -300
  357. data/rbi/stripe/resources/person.rbi +0 -401
  358. data/rbi/stripe/resources/plan.rbi +0 -371
  359. data/rbi/stripe/resources/price.rbi +0 -694
  360. data/rbi/stripe/resources/product.rbi +0 -555
  361. data/rbi/stripe/resources/product_feature.rbi +0 -26
  362. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  363. data/rbi/stripe/resources/quote.rbi +0 -1126
  364. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  365. data/rbi/stripe/resources/radar/value_list.rbi +0 -168
  366. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -129
  367. data/rbi/stripe/resources/refund.rbi +0 -523
  368. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  369. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  370. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  371. data/rbi/stripe/resources/reversal.rbi +0 -51
  372. data/rbi/stripe/resources/review.rbi +0 -154
  373. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  374. data/rbi/stripe/resources/setup_intent.rbi +0 -3655
  375. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  376. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  377. data/rbi/stripe/resources/source.rbi +0 -1496
  378. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  379. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  380. data/rbi/stripe/resources/subscription.rbi +0 -2027
  381. data/rbi/stripe/resources/subscription_item.rbi +0 -404
  382. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1623
  383. data/rbi/stripe/resources/tax/calculation.rbi +0 -478
  384. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -91
  385. data/rbi/stripe/resources/tax/registration.rbi +0 -2713
  386. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  387. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  388. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  389. data/rbi/stripe/resources/tax_code.rbi +0 -44
  390. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  391. data/rbi/stripe/resources/tax_id.rbi +0 -165
  392. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  393. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1386
  394. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  395. data/rbi/stripe/resources/terminal/location.rbi +0 -222
  396. data/rbi/stripe/resources/terminal/reader.rbi +0 -847
  397. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -132
  398. data/rbi/stripe/resources/token.rbi +0 -1283
  399. data/rbi/stripe/resources/topup.rbi +0 -222
  400. data/rbi/stripe/resources/transfer.rbi +0 -199
  401. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  402. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  403. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -865
  404. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  405. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  406. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  407. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  408. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  409. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  410. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  411. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  412. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  413. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  414. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  415. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  416. data/rbi/stripe/resources/v2/event.rbi +0 -48
  417. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  418. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -168
  419. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  420. data/rbi/stripe/services/account_link_service.rbi +0 -58
  421. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  422. data/rbi/stripe/services/account_person_service.rbi +0 -1011
  423. data/rbi/stripe/services/account_service.rbi +0 -4213
  424. data/rbi/stripe/services/account_session_service.rbi +0 -646
  425. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -76
  426. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  427. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  428. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  429. data/rbi/stripe/services/apps_service.rbi +0 -9
  430. data/rbi/stripe/services/balance_service.rbi +0 -21
  431. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  432. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  433. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  434. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  435. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  436. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  437. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  438. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  439. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  440. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -511
  441. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  442. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  443. data/rbi/stripe/services/billing_service.rbi +0 -15
  444. data/rbi/stripe/services/charge_service.rbi +0 -448
  445. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  446. data/rbi/stripe/services/checkout/session_service.rbi +0 -2614
  447. data/rbi/stripe/services/checkout_service.rbi +0 -9
  448. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  449. data/rbi/stripe/services/climate/product_service.rbi +0 -46
  450. data/rbi/stripe/services/climate_service.rbi +0 -11
  451. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  452. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  453. data/rbi/stripe/services/coupon_service.rbi +0 -194
  454. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  455. data/rbi/stripe/services/credit_note_service.rbi +0 -415
  456. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  457. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  458. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  459. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  460. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  461. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  462. data/rbi/stripe/services/customer_service.rbi +0 -647
  463. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  464. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -70
  465. data/rbi/stripe/services/dispute_service.rbi +0 -424
  466. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  467. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  468. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  469. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  470. data/rbi/stripe/services/event_service.rbi +0 -83
  471. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  472. data/rbi/stripe/services/file_link_service.rbi +0 -124
  473. data/rbi/stripe/services/file_service.rbi +0 -116
  474. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  475. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  476. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  477. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  478. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  479. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  480. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  481. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  482. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -323
  483. data/rbi/stripe/services/identity_service.rbi +0 -10
  484. data/rbi/stripe/services/invoice_item_service.rbi +0 -366
  485. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  486. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  487. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  488. data/rbi/stripe/services/invoice_service.rbi +0 -2981
  489. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  490. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  491. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  492. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  493. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  494. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  495. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  496. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  497. data/rbi/stripe/services/issuing_service.rbi +0 -16
  498. data/rbi/stripe/services/mandate_service.rbi +0 -20
  499. data/rbi/stripe/services/payment_intent_service.rbi +0 -7659
  500. data/rbi/stripe/services/payment_link_service.rbi +0 -1352
  501. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2487
  502. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  503. data/rbi/stripe/services/payment_method_service.rbi +0 -776
  504. data/rbi/stripe/services/payout_service.rbi +0 -205
  505. data/rbi/stripe/services/plan_service.rbi +0 -282
  506. data/rbi/stripe/services/price_service.rbi +0 -546
  507. data/rbi/stripe/services/product_feature_service.rbi +0 -67
  508. data/rbi/stripe/services/product_service.rbi +0 -477
  509. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  510. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  511. data/rbi/stripe/services/quote_service.rbi +0 -686
  512. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  513. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -109
  514. data/rbi/stripe/services/radar/value_list_service.rbi +0 -141
  515. data/rbi/stripe/services/radar_service.rbi +0 -11
  516. data/rbi/stripe/services/refund_service.rbi +0 -185
  517. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  518. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  519. data/rbi/stripe/services/reporting_service.rbi +0 -10
  520. data/rbi/stripe/services/review_service.rbi +0 -84
  521. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  522. data/rbi/stripe/services/setup_intent_service.rbi +0 -3391
  523. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  524. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  525. data/rbi/stripe/services/sigma_service.rbi +0 -9
  526. data/rbi/stripe/services/source_service.rbi +0 -663
  527. data/rbi/stripe/services/subscription_item_service.rbi +0 -350
  528. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1290
  529. data/rbi/stripe/services/subscription_service.rbi +0 -1648
  530. data/rbi/stripe/services/tax/calculation_service.rbi +0 -234
  531. data/rbi/stripe/services/tax/registration_service.rbi +0 -1845
  532. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  533. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  534. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  535. data/rbi/stripe/services/tax_id_service.rbi +0 -110
  536. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  537. data/rbi/stripe/services/tax_service.rbi +0 -12
  538. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1118
  539. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  540. data/rbi/stripe/services/terminal/location_service.rbi +0 -182
  541. data/rbi/stripe/services/terminal/reader_service.rbi +0 -455
  542. data/rbi/stripe/services/terminal_service.rbi +0 -12
  543. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -739
  544. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  545. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  546. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  547. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  548. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  549. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  550. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  551. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -93
  552. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  553. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -90
  554. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  555. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  556. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  557. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  558. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  559. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  560. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  561. data/rbi/stripe/services/token_service.rbi +0 -1257
  562. data/rbi/stripe/services/topup_service.rbi +0 -176
  563. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  564. data/rbi/stripe/services/transfer_service.rbi +0 -152
  565. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  566. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  567. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  568. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -562
  569. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  570. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  571. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  572. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  573. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  574. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  575. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  576. data/rbi/stripe/services/treasury_service.rbi +0 -18
  577. data/rbi/stripe/services/v1_services.rbi +0 -77
  578. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  579. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  580. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -18
  581. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  582. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  583. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -192
  584. data/rbi/stripe/services/v2/core/event_service.rbi +0 -36
  585. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  586. data/rbi/stripe/services/v2_services.rbi +0 -10
  587. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -129
@@ -1,752 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # Issue a credit note to adjust an invoice's amount after the invoice is finalized.
7
- #
8
- # Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)
9
- class CreditNote < 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 PretaxCreditAmount < Stripe::StripeObject
19
- # The amount, in cents (or local equivalent), of the pretax credit amount.
20
- sig { returns(Integer) }
21
- attr_reader :amount
22
- # The credit balance transaction that was applied to get this pretax credit amount.
23
- sig { returns(T.any(String, Stripe::Billing::CreditBalanceTransaction)) }
24
- attr_reader :credit_balance_transaction
25
- # The discount that was applied to get this pretax credit amount.
26
- sig { returns(T.any(String, Stripe::Discount)) }
27
- attr_reader :discount
28
- # Type of the pretax credit amount referenced.
29
- sig { returns(String) }
30
- attr_reader :type
31
- end
32
- class Refund < Stripe::StripeObject
33
- # Amount of the refund that applies to this credit note, in cents (or local equivalent).
34
- sig { returns(Integer) }
35
- attr_reader :amount_refunded
36
- # ID of the refund.
37
- sig { returns(T.any(String, Stripe::Refund)) }
38
- attr_reader :refund
39
- end
40
- class ShippingCost < Stripe::StripeObject
41
- class Tax < Stripe::StripeObject
42
- # Amount of tax applied for this rate.
43
- sig { returns(Integer) }
44
- attr_reader :amount
45
- # 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.
46
- #
47
- # Related guide: [Tax rates](/billing/taxes/tax-rates)
48
- sig { returns(Stripe::TaxRate) }
49
- attr_reader :rate
50
- # 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.
51
- sig { returns(T.nilable(String)) }
52
- attr_reader :taxability_reason
53
- # The amount on which tax is calculated, in cents (or local equivalent).
54
- sig { returns(T.nilable(Integer)) }
55
- attr_reader :taxable_amount
56
- end
57
- # Total shipping cost before any taxes are applied.
58
- sig { returns(Integer) }
59
- attr_reader :amount_subtotal
60
- # Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
61
- sig { returns(Integer) }
62
- attr_reader :amount_tax
63
- # Total shipping cost after taxes are applied.
64
- sig { returns(Integer) }
65
- attr_reader :amount_total
66
- # The ID of the ShippingRate for this invoice.
67
- sig { returns(T.nilable(T.any(String, Stripe::ShippingRate))) }
68
- attr_reader :shipping_rate
69
- # The taxes applied to the shipping rate.
70
- sig { returns(T::Array[Tax]) }
71
- attr_reader :taxes
72
- end
73
- class TotalTax < Stripe::StripeObject
74
- class TaxRateDetails < Stripe::StripeObject
75
- # Attribute for field tax_rate
76
- sig { returns(String) }
77
- attr_reader :tax_rate
78
- end
79
- # The amount of the tax, in cents (or local equivalent).
80
- sig { returns(Integer) }
81
- attr_reader :amount
82
- # Whether this tax is inclusive or exclusive.
83
- sig { returns(String) }
84
- attr_reader :tax_behavior
85
- # Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
86
- sig { returns(T.nilable(TaxRateDetails)) }
87
- attr_reader :tax_rate_details
88
- # 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.
89
- sig { returns(String) }
90
- attr_reader :taxability_reason
91
- # The amount on which tax is calculated, in cents (or local equivalent).
92
- sig { returns(T.nilable(Integer)) }
93
- attr_reader :taxable_amount
94
- # The type of tax information.
95
- sig { returns(String) }
96
- attr_reader :type
97
- end
98
- # The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
99
- sig { returns(Integer) }
100
- attr_reader :amount
101
- # This is the sum of all the shipping amounts.
102
- sig { returns(Integer) }
103
- attr_reader :amount_shipping
104
- # Time at which the object was created. Measured in seconds since the Unix epoch.
105
- sig { returns(Integer) }
106
- attr_reader :created
107
- # 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).
108
- sig { returns(String) }
109
- attr_reader :currency
110
- # ID of the customer.
111
- sig { returns(T.any(String, Stripe::Customer)) }
112
- attr_reader :customer
113
- # Customer balance transaction related to this credit note.
114
- sig { returns(T.nilable(T.any(String, Stripe::CustomerBalanceTransaction))) }
115
- attr_reader :customer_balance_transaction
116
- # The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
117
- sig { returns(Integer) }
118
- attr_reader :discount_amount
119
- # The aggregate amounts calculated per discount for all line items.
120
- sig { returns(T::Array[DiscountAmount]) }
121
- attr_reader :discount_amounts
122
- # The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
123
- sig { returns(T.nilable(Integer)) }
124
- attr_reader :effective_at
125
- # Unique identifier for the object.
126
- sig { returns(String) }
127
- attr_reader :id
128
- # ID of the invoice.
129
- sig { returns(T.any(String, Stripe::Invoice)) }
130
- attr_reader :invoice
131
- # Line items that make up the credit note
132
- sig { returns(Stripe::ListObject) }
133
- attr_reader :lines
134
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
135
- sig { returns(T::Boolean) }
136
- attr_reader :livemode
137
- # Customer-facing text that appears on the credit note PDF.
138
- sig { returns(T.nilable(String)) }
139
- attr_reader :memo
140
- # 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.
141
- sig { returns(T.nilable(T::Hash[String, String])) }
142
- attr_reader :metadata
143
- # A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
144
- sig { returns(String) }
145
- attr_reader :number
146
- # String representing the object's type. Objects of the same type share the same value.
147
- sig { returns(String) }
148
- attr_reader :object
149
- # Amount that was credited outside of Stripe.
150
- sig { returns(T.nilable(Integer)) }
151
- attr_reader :out_of_band_amount
152
- # The link to download the PDF of the credit note.
153
- sig { returns(String) }
154
- attr_reader :pdf
155
- # The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
156
- sig { returns(Integer) }
157
- attr_reader :post_payment_amount
158
- # The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced.
159
- sig { returns(Integer) }
160
- attr_reader :pre_payment_amount
161
- # The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
162
- sig { returns(T::Array[PretaxCreditAmount]) }
163
- attr_reader :pretax_credit_amounts
164
- # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
165
- sig { returns(T.nilable(String)) }
166
- attr_reader :reason
167
- # Refunds related to this credit note.
168
- sig { returns(T::Array[Refund]) }
169
- attr_reader :refunds
170
- # The details of the cost of shipping, including the ShippingRate applied to the invoice.
171
- sig { returns(T.nilable(ShippingCost)) }
172
- attr_reader :shipping_cost
173
- # Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
174
- sig { returns(String) }
175
- attr_reader :status
176
- # The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
177
- sig { returns(Integer) }
178
- attr_reader :subtotal
179
- # The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
180
- sig { returns(T.nilable(Integer)) }
181
- attr_reader :subtotal_excluding_tax
182
- # The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
183
- sig { returns(Integer) }
184
- attr_reader :total
185
- # The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
186
- sig { returns(T.nilable(Integer)) }
187
- attr_reader :total_excluding_tax
188
- # The aggregate tax information for all line items.
189
- sig { returns(T.nilable(T::Array[TotalTax])) }
190
- attr_reader :total_taxes
191
- # Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid.
192
- sig { returns(String) }
193
- attr_reader :type
194
- # The time that the credit note was voided.
195
- sig { returns(T.nilable(Integer)) }
196
- attr_reader :voided_at
197
- class ListParams < Stripe::RequestParams
198
- class Created < Stripe::RequestParams
199
- # Minimum value to filter by (exclusive)
200
- sig { returns(T.nilable(Integer)) }
201
- attr_accessor :gt
202
- # Minimum value to filter by (inclusive)
203
- sig { returns(T.nilable(Integer)) }
204
- attr_accessor :gte
205
- # Maximum value to filter by (exclusive)
206
- sig { returns(T.nilable(Integer)) }
207
- attr_accessor :lt
208
- # Maximum value to filter by (inclusive)
209
- sig { returns(T.nilable(Integer)) }
210
- attr_accessor :lte
211
- sig {
212
- params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
213
- }
214
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
215
- end
216
- # Only return credit notes that were created during the given date interval.
217
- sig { returns(T.nilable(T.any(::Stripe::CreditNote::ListParams::Created, Integer))) }
218
- attr_accessor :created
219
- # Only return credit notes for the customer specified by this customer ID.
220
- sig { returns(T.nilable(String)) }
221
- attr_accessor :customer
222
- # 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.
223
- sig { returns(T.nilable(String)) }
224
- attr_accessor :ending_before
225
- # Specifies which fields in the response should be expanded.
226
- sig { returns(T.nilable(T::Array[String])) }
227
- attr_accessor :expand
228
- # Only return credit notes for the invoice specified by this invoice ID.
229
- sig { returns(T.nilable(String)) }
230
- attr_accessor :invoice
231
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
232
- sig { returns(T.nilable(Integer)) }
233
- attr_accessor :limit
234
- # 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.
235
- sig { returns(T.nilable(String)) }
236
- attr_accessor :starting_after
237
- sig {
238
- params(created: T.nilable(T.any(::Stripe::CreditNote::ListParams::Created, Integer)), customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: T.nilable(String), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
239
- }
240
- def initialize(
241
- created: nil,
242
- customer: nil,
243
- ending_before: nil,
244
- expand: nil,
245
- invoice: nil,
246
- limit: nil,
247
- starting_after: nil
248
- ); end
249
- end
250
- class CreateParams < Stripe::RequestParams
251
- class Line < Stripe::RequestParams
252
- class TaxAmount < Stripe::RequestParams
253
- # The amount, in cents (or local equivalent), of the tax.
254
- sig { returns(Integer) }
255
- attr_accessor :amount
256
- # The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.
257
- sig { returns(String) }
258
- attr_accessor :tax_rate
259
- # The amount on which tax is calculated, in cents (or local equivalent).
260
- sig { returns(Integer) }
261
- attr_accessor :taxable_amount
262
- sig { params(amount: Integer, tax_rate: String, taxable_amount: Integer).void }
263
- def initialize(amount: nil, tax_rate: nil, taxable_amount: nil); end
264
- end
265
- # The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
266
- sig { returns(T.nilable(Integer)) }
267
- attr_accessor :amount
268
- # The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
269
- sig { returns(T.nilable(String)) }
270
- attr_accessor :description
271
- # The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
272
- sig { returns(T.nilable(String)) }
273
- attr_accessor :invoice_line_item
274
- # The line item quantity to credit.
275
- sig { returns(T.nilable(Integer)) }
276
- attr_accessor :quantity
277
- # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
278
- sig {
279
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::CreateParams::Line::TaxAmount]))))
280
- }
281
- attr_accessor :tax_amounts
282
- # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
283
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
284
- attr_accessor :tax_rates
285
- # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
286
- sig { returns(String) }
287
- attr_accessor :type
288
- # The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
289
- sig { returns(T.nilable(Integer)) }
290
- attr_accessor :unit_amount
291
- # 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.
292
- sig { returns(T.nilable(String)) }
293
- attr_accessor :unit_amount_decimal
294
- sig {
295
- params(amount: T.nilable(Integer), description: T.nilable(String), invoice_line_item: T.nilable(String), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::CreateParams::Line::TaxAmount]))), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), type: String, unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
296
- }
297
- def initialize(
298
- amount: nil,
299
- description: nil,
300
- invoice_line_item: nil,
301
- quantity: nil,
302
- tax_amounts: nil,
303
- tax_rates: nil,
304
- type: nil,
305
- unit_amount: nil,
306
- unit_amount_decimal: nil
307
- ); end
308
- end
309
- class Refund < Stripe::RequestParams
310
- # Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
311
- sig { returns(T.nilable(Integer)) }
312
- attr_accessor :amount_refunded
313
- # ID of an existing refund to link this credit note to.
314
- sig { returns(T.nilable(String)) }
315
- attr_accessor :refund
316
- sig { params(amount_refunded: T.nilable(Integer), refund: T.nilable(String)).void }
317
- def initialize(amount_refunded: nil, refund: nil); end
318
- end
319
- class ShippingCost < Stripe::RequestParams
320
- # The ID of the shipping rate to use for this order.
321
- sig { returns(T.nilable(String)) }
322
- attr_accessor :shipping_rate
323
- sig { params(shipping_rate: T.nilable(String)).void }
324
- def initialize(shipping_rate: nil); end
325
- end
326
- # The integer amount in cents (or local equivalent) representing the total amount of the credit note.
327
- sig { returns(T.nilable(Integer)) }
328
- attr_accessor :amount
329
- # The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
330
- sig { returns(T.nilable(Integer)) }
331
- attr_accessor :credit_amount
332
- # The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
333
- sig { returns(T.nilable(Integer)) }
334
- attr_accessor :effective_at
335
- # Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
336
- sig { returns(T.nilable(String)) }
337
- attr_accessor :email_type
338
- # Specifies which fields in the response should be expanded.
339
- sig { returns(T.nilable(T::Array[String])) }
340
- attr_accessor :expand
341
- # ID of the invoice.
342
- sig { returns(String) }
343
- attr_accessor :invoice
344
- # Line items that make up the credit note.
345
- sig { returns(T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Line])) }
346
- attr_accessor :lines
347
- # The credit note's memo appears on the credit note PDF.
348
- sig { returns(T.nilable(String)) }
349
- attr_accessor :memo
350
- # 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`.
351
- sig { returns(T.nilable(T::Hash[String, String])) }
352
- attr_accessor :metadata
353
- # The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
354
- sig { returns(T.nilable(Integer)) }
355
- attr_accessor :out_of_band_amount
356
- # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
357
- sig { returns(T.nilable(String)) }
358
- attr_accessor :reason
359
- # The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
360
- sig { returns(T.nilable(Integer)) }
361
- attr_accessor :refund_amount
362
- # Refunds to link to this credit note.
363
- sig { returns(T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Refund])) }
364
- attr_accessor :refunds
365
- # When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
366
- sig { returns(T.nilable(::Stripe::CreditNote::CreateParams::ShippingCost)) }
367
- attr_accessor :shipping_cost
368
- sig {
369
- params(amount: T.nilable(Integer), credit_amount: T.nilable(Integer), effective_at: T.nilable(Integer), email_type: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: String, lines: T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Line]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), out_of_band_amount: T.nilable(Integer), reason: T.nilable(String), refund_amount: T.nilable(Integer), refunds: T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Refund]), shipping_cost: T.nilable(::Stripe::CreditNote::CreateParams::ShippingCost)).void
370
- }
371
- def initialize(
372
- amount: nil,
373
- credit_amount: nil,
374
- effective_at: nil,
375
- email_type: nil,
376
- expand: nil,
377
- invoice: nil,
378
- lines: nil,
379
- memo: nil,
380
- metadata: nil,
381
- out_of_band_amount: nil,
382
- reason: nil,
383
- refund_amount: nil,
384
- refunds: nil,
385
- shipping_cost: nil
386
- ); end
387
- end
388
- class UpdateParams < Stripe::RequestParams
389
- # Specifies which fields in the response should be expanded.
390
- sig { returns(T.nilable(T::Array[String])) }
391
- attr_accessor :expand
392
- # Credit note memo.
393
- sig { returns(T.nilable(String)) }
394
- attr_accessor :memo
395
- # 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`.
396
- sig { returns(T.nilable(T::Hash[String, String])) }
397
- attr_accessor :metadata
398
- sig {
399
- params(expand: T.nilable(T::Array[String]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String])).void
400
- }
401
- def initialize(expand: nil, memo: nil, metadata: nil); end
402
- end
403
- class PreviewParams < Stripe::RequestParams
404
- class Line < Stripe::RequestParams
405
- class TaxAmount < Stripe::RequestParams
406
- # The amount, in cents (or local equivalent), of the tax.
407
- sig { returns(Integer) }
408
- attr_accessor :amount
409
- # The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.
410
- sig { returns(String) }
411
- attr_accessor :tax_rate
412
- # The amount on which tax is calculated, in cents (or local equivalent).
413
- sig { returns(Integer) }
414
- attr_accessor :taxable_amount
415
- sig { params(amount: Integer, tax_rate: String, taxable_amount: Integer).void }
416
- def initialize(amount: nil, tax_rate: nil, taxable_amount: nil); end
417
- end
418
- # The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
419
- sig { returns(T.nilable(Integer)) }
420
- attr_accessor :amount
421
- # The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
422
- sig { returns(T.nilable(String)) }
423
- attr_accessor :description
424
- # The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
425
- sig { returns(T.nilable(String)) }
426
- attr_accessor :invoice_line_item
427
- # The line item quantity to credit.
428
- sig { returns(T.nilable(Integer)) }
429
- attr_accessor :quantity
430
- # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
431
- sig {
432
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::PreviewParams::Line::TaxAmount]))))
433
- }
434
- attr_accessor :tax_amounts
435
- # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
436
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
437
- attr_accessor :tax_rates
438
- # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
439
- sig { returns(String) }
440
- attr_accessor :type
441
- # The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
442
- sig { returns(T.nilable(Integer)) }
443
- attr_accessor :unit_amount
444
- # 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.
445
- sig { returns(T.nilable(String)) }
446
- attr_accessor :unit_amount_decimal
447
- sig {
448
- params(amount: T.nilable(Integer), description: T.nilable(String), invoice_line_item: T.nilable(String), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::PreviewParams::Line::TaxAmount]))), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), type: String, unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
449
- }
450
- def initialize(
451
- amount: nil,
452
- description: nil,
453
- invoice_line_item: nil,
454
- quantity: nil,
455
- tax_amounts: nil,
456
- tax_rates: nil,
457
- type: nil,
458
- unit_amount: nil,
459
- unit_amount_decimal: nil
460
- ); end
461
- end
462
- class Refund < Stripe::RequestParams
463
- # Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
464
- sig { returns(T.nilable(Integer)) }
465
- attr_accessor :amount_refunded
466
- # ID of an existing refund to link this credit note to.
467
- sig { returns(T.nilable(String)) }
468
- attr_accessor :refund
469
- sig { params(amount_refunded: T.nilable(Integer), refund: T.nilable(String)).void }
470
- def initialize(amount_refunded: nil, refund: nil); end
471
- end
472
- class ShippingCost < Stripe::RequestParams
473
- # The ID of the shipping rate to use for this order.
474
- sig { returns(T.nilable(String)) }
475
- attr_accessor :shipping_rate
476
- sig { params(shipping_rate: T.nilable(String)).void }
477
- def initialize(shipping_rate: nil); end
478
- end
479
- # The integer amount in cents (or local equivalent) representing the total amount of the credit note.
480
- sig { returns(T.nilable(Integer)) }
481
- attr_accessor :amount
482
- # The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
483
- sig { returns(T.nilable(Integer)) }
484
- attr_accessor :credit_amount
485
- # The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
486
- sig { returns(T.nilable(Integer)) }
487
- attr_accessor :effective_at
488
- # Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
489
- sig { returns(T.nilable(String)) }
490
- attr_accessor :email_type
491
- # Specifies which fields in the response should be expanded.
492
- sig { returns(T.nilable(T::Array[String])) }
493
- attr_accessor :expand
494
- # ID of the invoice.
495
- sig { returns(String) }
496
- attr_accessor :invoice
497
- # Line items that make up the credit note.
498
- sig { returns(T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Line])) }
499
- attr_accessor :lines
500
- # The credit note's memo appears on the credit note PDF.
501
- sig { returns(T.nilable(String)) }
502
- attr_accessor :memo
503
- # 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`.
504
- sig { returns(T.nilable(T::Hash[String, String])) }
505
- attr_accessor :metadata
506
- # The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
507
- sig { returns(T.nilable(Integer)) }
508
- attr_accessor :out_of_band_amount
509
- # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
510
- sig { returns(T.nilable(String)) }
511
- attr_accessor :reason
512
- # The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
513
- sig { returns(T.nilable(Integer)) }
514
- attr_accessor :refund_amount
515
- # Refunds to link to this credit note.
516
- sig { returns(T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Refund])) }
517
- attr_accessor :refunds
518
- # When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
519
- sig { returns(T.nilable(::Stripe::CreditNote::PreviewParams::ShippingCost)) }
520
- attr_accessor :shipping_cost
521
- sig {
522
- params(amount: T.nilable(Integer), credit_amount: T.nilable(Integer), effective_at: T.nilable(Integer), email_type: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: String, lines: T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Line]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), out_of_band_amount: T.nilable(Integer), reason: T.nilable(String), refund_amount: T.nilable(Integer), refunds: T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Refund]), shipping_cost: T.nilable(::Stripe::CreditNote::PreviewParams::ShippingCost)).void
523
- }
524
- def initialize(
525
- amount: nil,
526
- credit_amount: nil,
527
- effective_at: nil,
528
- email_type: nil,
529
- expand: nil,
530
- invoice: nil,
531
- lines: nil,
532
- memo: nil,
533
- metadata: nil,
534
- out_of_band_amount: nil,
535
- reason: nil,
536
- refund_amount: nil,
537
- refunds: nil,
538
- shipping_cost: nil
539
- ); end
540
- end
541
- class ListPreviewLineItemsParams < Stripe::RequestParams
542
- class Line < Stripe::RequestParams
543
- class TaxAmount < Stripe::RequestParams
544
- # The amount, in cents (or local equivalent), of the tax.
545
- sig { returns(Integer) }
546
- attr_accessor :amount
547
- # The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.
548
- sig { returns(String) }
549
- attr_accessor :tax_rate
550
- # The amount on which tax is calculated, in cents (or local equivalent).
551
- sig { returns(Integer) }
552
- attr_accessor :taxable_amount
553
- sig { params(amount: Integer, tax_rate: String, taxable_amount: Integer).void }
554
- def initialize(amount: nil, tax_rate: nil, taxable_amount: nil); end
555
- end
556
- # The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
557
- sig { returns(T.nilable(Integer)) }
558
- attr_accessor :amount
559
- # The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
560
- sig { returns(T.nilable(String)) }
561
- attr_accessor :description
562
- # The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
563
- sig { returns(T.nilable(String)) }
564
- attr_accessor :invoice_line_item
565
- # The line item quantity to credit.
566
- sig { returns(T.nilable(Integer)) }
567
- attr_accessor :quantity
568
- # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
569
- sig {
570
- returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line::TaxAmount]))))
571
- }
572
- attr_accessor :tax_amounts
573
- # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
574
- sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
575
- attr_accessor :tax_rates
576
- # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
577
- sig { returns(String) }
578
- attr_accessor :type
579
- # The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
580
- sig { returns(T.nilable(Integer)) }
581
- attr_accessor :unit_amount
582
- # 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.
583
- sig { returns(T.nilable(String)) }
584
- attr_accessor :unit_amount_decimal
585
- sig {
586
- params(amount: T.nilable(Integer), description: T.nilable(String), invoice_line_item: T.nilable(String), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line::TaxAmount]))), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), type: String, unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
587
- }
588
- def initialize(
589
- amount: nil,
590
- description: nil,
591
- invoice_line_item: nil,
592
- quantity: nil,
593
- tax_amounts: nil,
594
- tax_rates: nil,
595
- type: nil,
596
- unit_amount: nil,
597
- unit_amount_decimal: nil
598
- ); end
599
- end
600
- class Refund < Stripe::RequestParams
601
- # Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
602
- sig { returns(T.nilable(Integer)) }
603
- attr_accessor :amount_refunded
604
- # ID of an existing refund to link this credit note to.
605
- sig { returns(T.nilable(String)) }
606
- attr_accessor :refund
607
- sig { params(amount_refunded: T.nilable(Integer), refund: T.nilable(String)).void }
608
- def initialize(amount_refunded: nil, refund: nil); end
609
- end
610
- class ShippingCost < Stripe::RequestParams
611
- # The ID of the shipping rate to use for this order.
612
- sig { returns(T.nilable(String)) }
613
- attr_accessor :shipping_rate
614
- sig { params(shipping_rate: T.nilable(String)).void }
615
- def initialize(shipping_rate: nil); end
616
- end
617
- # The integer amount in cents (or local equivalent) representing the total amount of the credit note.
618
- sig { returns(T.nilable(Integer)) }
619
- attr_accessor :amount
620
- # The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
621
- sig { returns(T.nilable(Integer)) }
622
- attr_accessor :credit_amount
623
- # The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
624
- sig { returns(T.nilable(Integer)) }
625
- attr_accessor :effective_at
626
- # Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
627
- sig { returns(T.nilable(String)) }
628
- attr_accessor :email_type
629
- # 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.
630
- sig { returns(T.nilable(String)) }
631
- attr_accessor :ending_before
632
- # Specifies which fields in the response should be expanded.
633
- sig { returns(T.nilable(T::Array[String])) }
634
- attr_accessor :expand
635
- # ID of the invoice.
636
- sig { returns(String) }
637
- attr_accessor :invoice
638
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
639
- sig { returns(T.nilable(Integer)) }
640
- attr_accessor :limit
641
- # Line items that make up the credit note.
642
- sig { returns(T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line])) }
643
- attr_accessor :lines
644
- # The credit note's memo appears on the credit note PDF.
645
- sig { returns(T.nilable(String)) }
646
- attr_accessor :memo
647
- # 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`.
648
- sig { returns(T.nilable(T::Hash[String, String])) }
649
- attr_accessor :metadata
650
- # The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
651
- sig { returns(T.nilable(Integer)) }
652
- attr_accessor :out_of_band_amount
653
- # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
654
- sig { returns(T.nilable(String)) }
655
- attr_accessor :reason
656
- # The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
657
- sig { returns(T.nilable(Integer)) }
658
- attr_accessor :refund_amount
659
- # Refunds to link to this credit note.
660
- sig { returns(T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Refund])) }
661
- attr_accessor :refunds
662
- # When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
663
- sig { returns(T.nilable(::Stripe::CreditNote::ListPreviewLineItemsParams::ShippingCost)) }
664
- attr_accessor :shipping_cost
665
- # 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.
666
- sig { returns(T.nilable(String)) }
667
- attr_accessor :starting_after
668
- sig {
669
- params(amount: T.nilable(Integer), credit_amount: T.nilable(Integer), effective_at: T.nilable(Integer), email_type: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), invoice: String, limit: T.nilable(Integer), lines: T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line]), memo: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), out_of_band_amount: T.nilable(Integer), reason: T.nilable(String), refund_amount: T.nilable(Integer), refunds: T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Refund]), shipping_cost: T.nilable(::Stripe::CreditNote::ListPreviewLineItemsParams::ShippingCost), starting_after: T.nilable(String)).void
670
- }
671
- def initialize(
672
- amount: nil,
673
- credit_amount: nil,
674
- effective_at: nil,
675
- email_type: nil,
676
- ending_before: nil,
677
- expand: nil,
678
- invoice: nil,
679
- limit: nil,
680
- lines: nil,
681
- memo: nil,
682
- metadata: nil,
683
- out_of_band_amount: nil,
684
- reason: nil,
685
- refund_amount: nil,
686
- refunds: nil,
687
- shipping_cost: nil,
688
- starting_after: nil
689
- ); end
690
- end
691
- class VoidCreditNoteParams < Stripe::RequestParams
692
- # Specifies which fields in the response should be expanded.
693
- sig { returns(T.nilable(T::Array[String])) }
694
- attr_accessor :expand
695
- sig { params(expand: T.nilable(T::Array[String])).void }
696
- def initialize(expand: nil); end
697
- end
698
- # Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
699
- # This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
700
- #
701
- #
702
- # Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
703
- # Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
704
- # Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
705
- #
706
- #
707
- # The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
708
- #
709
- # You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
710
- # post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
711
- sig {
712
- params(params: T.any(::Stripe::CreditNote::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
713
- }
714
- def self.create(params = {}, opts = {}); end
715
-
716
- # Returns a list of credit notes.
717
- sig {
718
- params(params: T.any(::Stripe::CreditNote::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
719
- }
720
- def self.list(params = {}, opts = {}); end
721
-
722
- # When retrieving a credit note preview, you'll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.
723
- sig {
724
- params(params: T.any(::Stripe::CreditNote::ListPreviewLineItemsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
725
- }
726
- def self.list_preview_line_items(params = {}, opts = {}); end
727
-
728
- # Get a preview of a credit note without creating it.
729
- sig {
730
- params(params: T.any(::Stripe::CreditNote::PreviewParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
731
- }
732
- def self.preview(params = {}, opts = {}); end
733
-
734
- # Updates an existing credit note.
735
- sig {
736
- params(id: String, params: T.any(::Stripe::CreditNote::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
737
- }
738
- def self.update(id, params = {}, opts = {}); end
739
-
740
- # Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
741
- sig {
742
- params(params: T.any(::Stripe::CreditNote::VoidCreditNoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
743
- }
744
- def void_credit_note(params = {}, opts = {}); end
745
-
746
- # Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
747
- sig {
748
- params(id: String, params: T.any(::Stripe::CreditNote::VoidCreditNoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
749
- }
750
- def self.void_credit_note(id, params = {}, opts = {}); end
751
- end
752
- end