class Stripe::LineItem

Overview

Included Modules

Defined in:

stripe/models/line_item.cr

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

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, 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

def self.new(pull : JSON::PullParser) #

[View source]
def self.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::Plan | Nil = nil, price : Stripe::Price | Nil = nil, proration : Bool | Nil = nil, proration_details : Stripe::InvoicesResourceLineItemsProrationDetails | 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


[View source]

Instance Method Detail

def ==(other : self) #

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


def _type : String | Nil #

[View source]
def _type=(new_value : String | Nil) #

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


[View source]
def amount : Int64 | Nil #

[View source]
def amount=(new_value : Int64 | Nil) #

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


[View source]
def amount_excluding_tax : Int64 | Nil #

[View source]
def amount_excluding_tax=(new_value : Int64 | Nil) #

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


[View source]
def currency : String | Nil #

[View source]
def currency=(new_value : String | Nil) #

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


[View source]
def description : String | Nil #

[View source]
def description=(new_value : String | Nil) #

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


[View source]
def discount_amounts : Array(Stripe::DiscountsResourceDiscountAmount) | Nil #

[View source]
def discount_amounts=(new_value : Array(Stripe::DiscountsResourceDiscountAmount) | Nil) #

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


[View source]
def discountable : Bool | Nil #

[View source]
def discountable=(new_value : Bool | Nil) #

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


[View source]
def discounts : Array(Stripe::InvoiceitemDiscountsInner) | Nil #

[View source]
def discounts=(new_value : Array(Stripe::InvoiceitemDiscountsInner) | Nil) #

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


[View source]
def hash(hasher) #

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


def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

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


[View source]
def invoice : String | Nil #

[View source]
def invoice=(new_value : String | Nil) #

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


[View source]
def invoice_item : Stripe::LineItemInvoiceItem | Nil #

[View source]
def invoice_item=(new_value : Stripe::LineItemInvoiceItem | Nil) #

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


[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def livemode : Bool | Nil #

[View source]
def livemode=(new_value : Bool | Nil) #

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


[View source]
def metadata : Hash(String, String) | Nil #

[View source]
def metadata=(new_value : Hash(String, String) | Nil) #

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


[View source]
def object : String | Nil #

[View source]
def object=(new_value : String | Nil) #

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


[View source]
def period : Stripe::InvoiceLineItemPeriod | Nil #

[View source]
def period=(new_value : Stripe::InvoiceLineItemPeriod | Nil) #

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


[View source]
def plan : Stripe::Plan | Nil #

[View source]
def plan=(new_value : Stripe::Plan | Nil) #

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


[View source]
def price : Stripe::Price | Nil #

[View source]
def price=(new_value : Stripe::Price | Nil) #

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


[View source]
def proration : Bool | Nil #

[View source]
def proration=(new_value : Bool | Nil) #

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


[View source]

[View source]
def proration_details=(new_value : Stripe::InvoicesResourceLineItemsProrationDetails | Nil) #

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


[View source]
def quantity : Int64 | Nil #

[View source]
def quantity=(new_value : Int64 | Nil) #

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


[View source]
def subscription : Stripe::LineItemSubscription | Nil #

[View source]
def subscription=(new_value : Stripe::LineItemSubscription | Nil) #

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


[View source]
def subscription_item : Stripe::LineItemSubscriptionItem | Nil #

[View source]
def subscription_item=(new_value : Stripe::LineItemSubscriptionItem | Nil) #

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


[View source]
def tax_amounts : Array(Stripe::InvoiceTaxAmount) | Nil #

[View source]
def tax_amounts=(new_value : Array(Stripe::InvoiceTaxAmount) | Nil) #

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


[View source]
def tax_rates : Array(Stripe::TaxRate) | Nil #

[View source]
def tax_rates=(new_value : Array(Stripe::TaxRate) | Nil) #

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


[View source]
def unit_amount_excluding_tax : BigDecimal | Nil #

[View source]
def 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


[View source]
def valid? : Bool #

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


[View source]