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:

Constant 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

Constructor Detail

Instance Method Detail