class

Stripe::LineItem

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

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.

Constants

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)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
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

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

A string identifying the type of the source of this line item, either an invoiceitem or a subscription.

Source
_type=(new_value : String | Nil)

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

Source
amount

The amount, in cents (or local equivalent).

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 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
currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Source
currency=(new_value : String | Nil)

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

Source
description

An arbitrary string attached to the object. Often useful for displaying to users.

Source
description=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] description 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
discountable

If true, discounts will apply to this line item. Always false for prorations.

Source
discountable=(new_value : Bool | Nil)

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

Source
discounts

The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.

Source
discounts=(new_value : Array(Stripe::InvoiceitemDiscountsInner) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] discounts 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

The ID of the invoice that contains this line item.

Source
invoice=(new_value : String | Nil)

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

Source
invoice_item
Source
invoice_item=(new_value : Stripe::LineItemInvoiceItem | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] invoice_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
metadata
Source
metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata 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
period
Source
period=(new_value : Stripe::InvoiceLineItemPeriod | Nil)

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

Source
plan
Source
plan=(new_value : Stripe::LineItemPlan | Nil)

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

Source
price
Source
price=(new_value : Stripe::LineItemPrice | Nil)

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

Source
proration

Whether this is a proration.

Source
proration=(new_value : Bool | Nil)

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

Source
proration_details
Source
proration_details=(new_value : Stripe::LineItemProrationDetails | Nil)

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

Source
quantity

The quantity of the subscription, if the line item is a subscription or a proration.

Source
quantity=(new_value : Int64 | Nil)

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

Source
subscription
Source
subscription=(new_value : Stripe::LineItemSubscription | Nil)

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

Source
subscription_item
Source
subscription_item=(new_value : Stripe::LineItemSubscriptionItem | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] subscription_item 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::InvoiceTaxAmount) | 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_excluding_tax

The amount in cents (or local equivalent) representing the unit amount 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