Stripe.Resources.CreditNoteLineItem (tiger_stripe v0.4.0)

Copy Markdown View Source

CreditNoteLineItem

The credit note line item object

Summary

Types

t()

Functions

expandable_fields()
object_name()

Types

t()

@type t() :: %Stripe.Resources.CreditNoteLineItem{
  amount: term(),
  description: term(),
  discount_amount: term(),
  discount_amounts: term(),
  id: term(),
  invoice_line_item: term(),
  livemode: term(),
  metadata: term(),
  object: term(),
  pretax_credit_amounts: term(),
  quantity: term(),
  tax_rates: term(),
  taxes: term(),
  type: term(),
  unit_amount: term(),
  unit_amount_decimal: term()
}
  • amount - The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
  • description - Description of the item being credited. Max length: 5000. Nullable.
  • discount_amount - The integer amount in cents (or local equivalent) representing the discount being credited for this line item.
  • discount_amounts - The amount of discount calculated per discount for this line item Expandable.
  • id - Unique identifier for the object. Max length: 5000.
  • invoice_line_item - ID of the invoice line item being credited Max length: 5000.
  • livemode - If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
  • metadata - 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. Nullable.
  • object - String representing the object's type. Objects of the same type share the same value. Possible values: credit_note_line_item.
  • pretax_credit_amounts - The pretax credit amounts (ex: discount, credit grants, etc) for this line item. Expandable.
  • quantity - The number of units of product being credited. Nullable.
  • tax_rates - The tax rates which apply to the line item. Expandable.
  • taxes - The tax information of the line item. Nullable. Expandable.
  • type - The type of the credit note line item, one of invoice_line_item or custom_line_item. When the type is invoice_line_item there is an additional invoice_line_item property on the resource the value of which is the id of the credited line item on the invoice. Possible values: custom_line_item, invoice_line_item.
  • unit_amount - The cost of each unit of product being credited. Nullable.
  • unit_amount_decimal - Same as unit_amount, but contains a decimal value with at most 12 decimal places. Format: decimal string. Nullable.

Functions

expandable_fields()

object_name()