Sha256: bf74e282f5427f4e24ba38d17e5665221f8ce8c8e5ff9e79ba4a6a15fc0a169c

Contents?: true

Size: 1.35 KB

Versions: 20

Compression:

Stored size: 1.35 KB

Contents

# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  class InvoiceLineItemService < StripeService
    # When retrieving an invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
    def list(invoice, params = {}, opts = {})
      request(
        method: :get,
        path: format("/v1/invoices/%<invoice>s/lines", { invoice: CGI.escape(invoice) }),
        params: params,
        opts: opts,
        base_address: :api
      )
    end

    # Updates an invoice's line item. Some fields, such as tax_amounts, only live on the invoice line item,
    # so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice
    # item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.
    # Updating an invoice's line item is only possible before the invoice is finalized.
    def update(invoice, line_item_id, params = {}, opts = {})
      request(
        method: :post,
        path: format("/v1/invoices/%<invoice>s/lines/%<line_item_id>s", { invoice: CGI.escape(invoice), line_item_id: CGI.escape(line_item_id) }),
        params: params,
        opts: opts,
        base_address: :api
      )
    end
  end
end

Version data entries

20 entries across 20 versions & 1 rubygems

Version Path
stripe-13.5.0 lib/stripe/services/invoice_line_item_service.rb
stripe-13.4.1 lib/stripe/services/invoice_line_item_service.rb
stripe-13.4.0 lib/stripe/services/invoice_line_item_service.rb
stripe-13.3.1 lib/stripe/services/invoice_line_item_service.rb
stripe-13.3.0 lib/stripe/services/invoice_line_item_service.rb
stripe-13.3.0.pre.beta.3 lib/stripe/services/invoice_line_item_service.rb
stripe-13.3.0.pre.beta.2 lib/stripe/services/invoice_line_item_service.rb
stripe-13.3.0.pre.beta.1 lib/stripe/services/invoice_line_item_service.rb
stripe-13.2.0 lib/stripe/services/invoice_line_item_service.rb
stripe-13.1.2 lib/stripe/services/invoice_line_item_service.rb
stripe-13.2.0.pre.beta.3 lib/stripe/services/invoice_line_item_service.rb
stripe-13.2.0.pre.beta.2 lib/stripe/services/invoice_line_item_service.rb
stripe-13.1.1 lib/stripe/services/invoice_line_item_service.rb
stripe-13.2.0.pre.beta.1 lib/stripe/services/invoice_line_item_service.rb
stripe-13.1.0 lib/stripe/services/invoice_line_item_service.rb
stripe-13.0.2 lib/stripe/services/invoice_line_item_service.rb
stripe-13.1.0.pre.beta.3 lib/stripe/services/invoice_line_item_service.rb
stripe-13.0.1 lib/stripe/services/invoice_line_item_service.rb
stripe-13.1.0.pre.beta.2 lib/stripe/services/invoice_line_item_service.rb
stripe-13.0.0 lib/stripe/services/invoice_line_item_service.rb