class Stripe::LineItem
- Stripe::LineItem
- Reference
- Object
Overview
Invoice Line Items represent the individual lines within an invoice and only exist within the context of an invoice. Each line item is backed by either an invoice item or a subscription item.
Included Modules
- JSON::Serializable
- JSON::Serializable::Unmapped
- OpenApi::Json
- OpenApi::Validatable
Defined in:
stripe/models/line_item.crConstant Summary
-
ERROR_MESSAGE_FOR__TYPE =
"invalid value for \"_type\", must be one of [invoiceitem, subscription]."
-
ERROR_MESSAGE_FOR_OBJECT =
"invalid value for \"object\", must be one of [line_item]."
-
MAX_LENGTH_FOR_DESCRIPTION =
5000
-
MAX_LENGTH_FOR_ID =
5000
-
MAX_LENGTH_FOR_INVOICE =
5000
-
VALID_VALUES_FOR__TYPE =
String.static_array("invoiceitem", "subscription")
-
VALID_VALUES_FOR_OBJECT =
String.static_array("line_item")
Constructors
- .new(pull : JSON::PullParser)
-
.new(*, amount : Int64 | Nil = nil, amount_excluding_tax : Int64 | Nil = nil, currency : String | Nil = nil, description : String | Nil = nil, discount_amounts : Array(Stripe::DiscountsResourceDiscountAmount) | Nil = nil, discountable : Bool | Nil = nil, discounts : Array(Stripe::InvoiceitemDiscountsInner) | Nil = nil, id : String | Nil = nil, invoice : String | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, period : Stripe::InvoiceLineItemPeriod | Nil = nil, plan : Stripe::LineItemPlan | Nil = nil, price : Stripe::LineItemPrice | Nil = nil, proration : Bool | Nil = nil, proration_details : Stripe::LineItemProrationDetails | Nil = nil, quantity : Int64 | Nil = nil, subscription : Stripe::LineItemSubscription | Nil = nil, _type : String | Nil = nil, unit_amount_excluding_tax : BigDecimal | Nil = nil, invoice_item : Stripe::LineItemInvoiceItem | Nil = nil, subscription_item : Stripe::LineItemSubscriptionItem | Nil = nil, tax_amounts : Array(Stripe::InvoiceTaxAmount) | Nil = nil, tax_rates : Array(Stripe::TaxRate) | Nil = nil)
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Summary
-
#==(other : self)
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
- #_type : String | Nil
-
#_type=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #amount : Int64 | Nil
-
#amount=(new_value : Int64 | Nil)
Custom attribute writer method checking allowed values (enum).
- #amount_excluding_tax : Int64 | Nil
-
#amount_excluding_tax=(new_value : Int64 | Nil)
Custom attribute writer method checking allowed values (enum).
- #currency : String | Nil
-
#currency=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #description : String | Nil
-
#description=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #discount_amounts : Array(Stripe::DiscountsResourceDiscountAmount) | Nil
-
#discount_amounts=(new_value : Array(Stripe::DiscountsResourceDiscountAmount) | Nil)
Custom attribute writer method checking allowed values (enum).
- #discountable : Bool | Nil
-
#discountable=(new_value : Bool | Nil)
Custom attribute writer method checking allowed values (enum).
- #discounts : Array(Stripe::InvoiceitemDiscountsInner) | Nil
-
#discounts=(new_value : Array(Stripe::InvoiceitemDiscountsInner) | Nil)
Custom attribute writer method checking allowed values (enum).
-
#hash(hasher)
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
- #id : String | Nil
-
#id=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #invoice : String | Nil
-
#invoice=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #invoice_item : Stripe::LineItemInvoiceItem | Nil
-
#invoice_item=(new_value : Stripe::LineItemInvoiceItem | Nil)
Custom attribute writer method checking allowed values (enum).
-
#list_invalid_properties : Array(String)
Show invalid properties with the reasons.
- #livemode : Bool | Nil
-
#livemode=(new_value : Bool | Nil)
Custom attribute writer method checking allowed values (enum).
- #metadata : Hash(String, String) | Nil
-
#metadata=(new_value : Hash(String, String) | Nil)
Custom attribute writer method checking allowed values (enum).
- #object : String | Nil
-
#object=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #period : Stripe::InvoiceLineItemPeriod | Nil
-
#period=(new_value : Stripe::InvoiceLineItemPeriod | Nil)
Custom attribute writer method checking allowed values (enum).
- #plan : Stripe::LineItemPlan | Nil
-
#plan=(new_value : Stripe::LineItemPlan | Nil)
Custom attribute writer method checking allowed values (enum).
- #price : Stripe::LineItemPrice | Nil
-
#price=(new_value : Stripe::LineItemPrice | Nil)
Custom attribute writer method checking allowed values (enum).
- #proration : Bool | Nil
-
#proration=(new_value : Bool | Nil)
Custom attribute writer method checking allowed values (enum).
- #proration_details : Stripe::LineItemProrationDetails | Nil
-
#proration_details=(new_value : Stripe::LineItemProrationDetails | Nil)
Custom attribute writer method checking allowed values (enum).
- #quantity : Int64 | Nil
-
#quantity=(new_value : Int64 | Nil)
Custom attribute writer method checking allowed values (enum).
- #subscription : Stripe::LineItemSubscription | Nil
-
#subscription=(new_value : Stripe::LineItemSubscription | Nil)
Custom attribute writer method checking allowed values (enum).
- #subscription_item : Stripe::LineItemSubscriptionItem | Nil
-
#subscription_item=(new_value : Stripe::LineItemSubscriptionItem | Nil)
Custom attribute writer method checking allowed values (enum).
- #tax_amounts : Array(Stripe::InvoiceTaxAmount) | Nil
-
#tax_amounts=(new_value : Array(Stripe::InvoiceTaxAmount) | Nil)
Custom attribute writer method checking allowed values (enum).
- #tax_rates : Array(Stripe::TaxRate) | Nil
-
#tax_rates=(new_value : Array(Stripe::TaxRate) | Nil)
Custom attribute writer method checking allowed values (enum).
- #unit_amount_excluding_tax : BigDecimal | Nil
-
#unit_amount_excluding_tax=(new_value : BigDecimal | Nil)
Custom attribute writer method checking allowed values (enum).
-
#valid? : Bool
Check to see if the all the properties in the model are valid @return true if the model is valid
Instance methods inherited from module OpenApi::Json
after_initialize
after_initialize,
clone
clone,
eql?(o : self)
eql?,
to_hash : Hash(String, JSON::Any)
to_hash,
to_json_any : JSON::Any
to_json_any
Class methods inherited from module OpenApi::Json
build_from_hash(hash : Hash)
build_from_hash,
build_from_json_any(json_any : JSON::Any)
build_from_json_any
Instance methods inherited from module OpenApi::Validatable
list_invalid_properties : Array(String)
list_invalid_properties,
list_invalid_properties_for(key : String) : Array(String)
list_invalid_properties_for,
valid? : Bool
valid?,
validate : Nil
validate
Constructor Detail
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Detail
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] amount Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] amount_excluding_tax Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] discount_amounts Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] discountable Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] discounts Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] invoice Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] invoice_item Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] period Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] plan Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] price Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] proration Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] proration_details Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] quantity Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] subscription Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] subscription_item Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] tax_amounts Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] tax_rates Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] unit_amount_excluding_tax Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid