class

Stripe::CreditNoteLineItem

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

The credit note line item object

Constants

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [custom_line_item, invoice_line_item]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [credit_note_line_item]."
MAX_LENGTH_FOR_DESCRIPTION = 5000
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_INVOICE_LINE_ITEM = 5000
VALID_VALUES_FOR__TYPE = String.static_array("custom_line_item", "invoice_line_item")
VALID_VALUES_FOR_OBJECT = String.static_array("credit_note_line_item")

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount : Int64 | Nil = nil, amount_excluding_tax : Int64 | Nil = nil, description : String | Nil = nil, discount_amount : Int64 | Nil = nil, discount_amounts : Array(Stripe::DiscountsResourceDiscountAmount) | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, quantity : Int64 | Nil = nil, tax_amounts : Array(Stripe::CreditNoteTaxAmount) | Nil = nil, tax_rates : Array(Stripe::TaxRate) | Nil = nil, _type : String | Nil = nil, unit_amount : Int64 | Nil = nil, unit_amount_decimal : BigDecimal | Nil = nil, unit_amount_excluding_tax : BigDecimal | Nil = nil, invoice_line_item : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

_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.

Source
_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned

Source
amount

The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.

Source
amount=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] amount Object to be assigned

Source
amount_excluding_tax

The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts.

Source
amount_excluding_tax=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] amount_excluding_tax Object to be assigned

Source
description

Description of the item being credited.

Source
description=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned

Source
discount_amount

The integer amount in cents (or local equivalent) representing the discount being credited for this line item.

Source
discount_amount=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] discount_amount Object to be assigned

Source
discount_amounts

The amount of discount calculated per discount for this line item

Source
discount_amounts=(new_value : Array(Stripe::DiscountsResourceDiscountAmount) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] discount_amounts Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
invoice_line_item

ID of the invoice line item being credited

Source
invoice_line_item=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] invoice_line_item Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
livemode

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

Source
livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

Source
object

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

Source
object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source
quantity

The number of units of product being credited.

Source
quantity=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] quantity Object to be assigned

Source
tax_amounts

The amount of tax calculated per tax rate for this line item

Source
tax_amounts=(new_value : Array(Stripe::CreditNoteTaxAmount) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] tax_amounts Object to be assigned

Source
tax_rates

The tax rates which apply to the line item.

Source
tax_rates=(new_value : Array(Stripe::TaxRate) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] tax_rates Object to be assigned

Source
unit_amount

The cost of each unit of product being credited.

Source
unit_amount=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] unit_amount Object to be assigned

Source
unit_amount_decimal

Same as unit_amount, but contains a decimal value with at most 12 decimal places.

Source
unit_amount_decimal=(new_value : BigDecimal | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] unit_amount_decimal Object to be assigned

Source
unit_amount_excluding_tax

The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts.

Source
unit_amount_excluding_tax=(new_value : BigDecimal | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] unit_amount_excluding_tax Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source