Stripe.CreditNoteLineItem (stripity_stripe v2.17.3) View Source

Work with Stripe (credit note) line item objects.

Note that these are distinct from invoice line item objects.

Stripe API reference: https://stripe.com/docs/api/credit_notes/line_item

Link to this section Summary

Types

discount()

t()

tax_amount()

Functions

retrieve(credit_note, params \\ %{}, opts \\ [])

Retrieve line items for a given credit note.

Link to this section Types

discount()

Specs

discount() :: %{amount: integer(), discount: String.t()}

t()

Specs

t() :: %Stripe.CreditNoteLineItem{
  amount: integer(),
  description: String.t(),
  discount_amount: integer(),
  discount_amounts: [discount()],
  id: Stripe.id(),
  invoice_line_item: Stripe.id() | nil,
  livemode: boolean(),
  object: String.t(),
  quantity: integer(),
  tax_amounts: [tax_amount()],
  tax_rates: [Stripe.TaxRate.t()],
  type: String.t(),
  unit_amount: integer() | nil,
  unit_amount_decimal: String.t() | nil
}

tax_amount()

Specs

tax_amount() :: %{
  amount: integer(),
  inclusive: boolean(),
  tax_rate: Stripe.id() | Stripe.TaxRate.t()
}

Link to this section Functions

retrieve(credit_note, params \\ %{}, opts \\ [])

Specs

retrieve(Stripe.id() | Stripe.CreditNote.t(), params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params:
       %{
         optional(:ending_before) => t() | Stripe.id(),
         optional(:limit) => 1..100,
         optional(:starting_after) => t() | Stripe.id()
       }
       | %{}

Retrieve line items for a given credit note.