exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.CreditNote (exoapi_stripe v0.1.4)

description: Issue a credit note to adjust an invoice's amount after the invoice is finalized.

Related guide: Credit Notes.

:amount :: :integer

The integer amount in %s representing the total amount of the credit note, including tax.

:created :: :integer

Time at which the object was created. Measured in seconds since the Unix epoch.

:currency :: :string

Three-letter ISO currency code, in lowercase. Must be a supported currency.

:customer :: ExOAPI.Stripe.Schemas.DeletedCustomer | ExOAPI.Stripe.Schemas.Customer | :string

ID of the customer.

:customer_balance_transaction :: ExOAPI.Stripe.Schemas.CustomerBalanceTransaction | :string

Customer balance transaction related to this credit note.

:discount_amount :: :integer

The integer amount in %s representing the total amount of discount that was credited.

::discount_amounts :: ExOAPI.Stripe.Schemas.DiscountsResourceDiscountAmount

:id :: :string

Unique identifier for the object.

:invoice :: ExOAPI.Stripe.Schemas.Invoice | :string

ID of the invoice.

::data :: ExOAPI.Stripe.Schemas.CreditNoteLineItem

:has_more :: :boolean

True if this list has another page of items after this one that can be fetched.

:object :: :string

String representing the object's type. Objects of the same type share the same value. Always has the value list.

:url :: :string

The URL where this list can be accessed.

:livemode :: :boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

:memo :: :string

Customer-facing text that appears on the credit note PDF.

:metadata :: :map

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

:number :: :string

A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:out_of_band_amount :: :integer

Amount that was credited outside of Stripe.

:pdf :: :string

The link to download the PDF of the credit note.

:reason :: :string

Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory

:refund :: ExOAPI.Stripe.Schemas.Refund | :string

Refund related to this credit note.

:status :: :string

Status of this credit note, one of issued or void. Learn more about voiding credit notes.

:subtotal :: :integer

The integer amount in %s representing the amount of the credit note, excluding tax and invoice level discounts.

::tax_amounts :: ExOAPI.Stripe.Schemas.CreditNoteTaxAmount

:total :: :integer

The integer amount in %s representing the total amount of the credit note, including tax and all discount.

:type :: :string

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.

:voided_at :: :integer

The time that the credit note was voided.

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.CreditNote{
  amount: integer() | nil,
  created: integer() | nil,
  currency: String.t() | nil,
  customer: ExOAPI.EctoTypes.AnyOf.t() | nil,
  customer_balance_transaction: ExOAPI.EctoTypes.AnyOf.t() | nil,
  discount_amount: integer() | nil,
  discount_amounts: [ExOAPI.Stripe.Schemas.DiscountsResourceDiscountAmount.t()],
  id: String.t() | nil,
  invoice: ExOAPI.EctoTypes.AnyOf.t() | nil,
  lines: map() | nil,
  livemode: boolean() | nil,
  memo: String.t() | nil,
  metadata: map() | nil,
  number: String.t() | nil,
  object: :credit_note | nil,
  out_of_band_amount: integer() | nil,
  pdf: String.t() | nil,
  reason:
    (:product_unsatisfactory | :order_change | :fraudulent | :duplicate) | nil,
  refund: ExOAPI.EctoTypes.AnyOf.t() | nil,
  status: (:void | :issued) | nil,
  subtotal: integer() | nil,
  tax_amounts: [ExOAPI.Stripe.Schemas.CreditNoteTaxAmount.t()],
  total: integer() | nil,
  type: (:pre_payment | :post_payment) | nil,
  voided_at: integer() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()