mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-10-08 00:02:46 -04:00
56 lines
1.8 KiB
Ruby
56 lines
1.8 KiB
Ruby
# File generated from our OpenAPI spec
|
|
# frozen_string_literal: true
|
|
|
|
module Stripe
|
|
# Issue a credit note to adjust an invoice's amount after the invoice is finalized.
|
|
#
|
|
# Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)
|
|
class CreditNote < APIResource
|
|
extend Stripe::APIOperations::Create
|
|
extend Stripe::APIOperations::List
|
|
include Stripe::APIOperations::Save
|
|
|
|
OBJECT_NAME = "credit_note"
|
|
|
|
# Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
|
|
def void_credit_note(params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/credit_notes/%<id>s/void", { id: CGI.escape(self["id"]) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# 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.
|
|
def self.list_preview_line_items(params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :get,
|
|
path: "/v1/credit_notes/preview/lines",
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Get a preview of a credit note without creating it.
|
|
def self.preview(params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :get,
|
|
path: "/v1/credit_notes/preview",
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
|
|
def self.void_credit_note(id, params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/credit_notes/%<id>s/void", { id: CGI.escape(id) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
end
|
|
end
|