Stripe.Resources.CreditNoteLineItem (tiger_stripe v0.3.0)

Copy Markdown View Source

CreditNoteLineItem

The credit note line item object

Summary

Types

discount_amounts()
pretax_credit_amounts()
t()
taxes()
taxes_tax_rate_details()

Functions

expandable_fields()
object_name()

Types

discount_amounts()

@type discount_amounts() :: %{
  optional(:amount) => integer() | nil,
  optional(:discount) => String.t() | Stripe.Resources.Discount.t() | nil,
  optional(String.t()) => term()
}
  • amount - The amount, in cents (or local equivalent), of the discount.
  • discount - The discount that was applied to get this discount amount.

pretax_credit_amounts()

@type pretax_credit_amounts() :: %{
  optional(:amount) => integer() | nil,
  optional(:credit_balance_transaction) =>
    String.t() | Stripe.Resources.Billing.CreditBalanceTransaction.t() | nil,
  optional(:discount) => String.t() | Stripe.Resources.Discount.t() | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}
  • amount - The amount, in cents (or local equivalent), of the pretax credit amount.
  • credit_balance_transaction - The credit balance transaction that was applied to get this pretax credit amount.
  • discount - The discount that was applied to get this pretax credit amount.
  • type - Type of the pretax credit amount referenced. Possible values: credit_balance_transaction, discount.

t()

@type t() :: %Stripe.Resources.CreditNoteLineItem{
  amount: integer(),
  description: String.t(),
  discount_amount: integer(),
  discount_amounts: [discount_amounts()],
  id: String.t(),
  invoice_line_item: String.t() | nil,
  livemode: boolean(),
  object: String.t(),
  pretax_credit_amounts: [pretax_credit_amounts()],
  quantity: integer(),
  tax_rates: [Stripe.Resources.TaxRate.t()],
  taxes: [taxes()],
  type: String.t(),
  unit_amount: integer(),
  unit_amount_decimal: String.t()
}
  • 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 - Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • 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.

taxes()

@type taxes() :: %{
  optional(:amount) => integer() | nil,
  optional(:tax_behavior) => String.t() | nil,
  optional(:tax_rate_details) => taxes_tax_rate_details() | nil,
  optional(:taxability_reason) => String.t() | nil,
  optional(:taxable_amount) => integer() | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}
  • amount - The amount of the tax, in cents (or local equivalent).
  • tax_behavior - Whether this tax is inclusive or exclusive. Possible values: exclusive, inclusive.
  • tax_rate_details - Additional details about the tax rate. Only present when type is tax_rate_details. Nullable.
  • taxability_reason - The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible values: customer_exempt, not_available, not_collecting, not_subject_to_tax, not_supported, portion_product_exempt, portion_reduced_rated, portion_standard_rated, product_exempt, product_exempt_holiday, proportionally_rated, reduced_rated, reverse_charge, standard_rated, taxable_basis_reduced, zero_rated.
  • taxable_amount - The amount on which tax is calculated, in cents (or local equivalent). Nullable.
  • type - The type of tax information. Possible values: tax_rate_details.

taxes_tax_rate_details()

@type taxes_tax_rate_details() :: %{
  optional(:tax_rate) => String.t() | nil,
  optional(String.t()) => term()
}
  • tax_rate - ID of the tax rate Max length: 5000.

Functions

expandable_fields()

object_name()