class

Stripe::CalculationLineItem

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

Constants

ERROR_MESSAGE_FOR_TAX_BEHAVIOR = "invalid value for \"tax_behavior\", must be one of [exclusive, inclusive]."
MAX_LENGTH_FOR_PRODUCT = 5000
MAX_LENGTH_FOR_REFERENCE = 500
VALID_VALUES_FOR_TAX_BEHAVIOR = String.static_array("exclusive", "inclusive")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount : Int64 | Nil = nil, product : String | Nil = nil, quantity : Int64 | Nil = nil, reference : String | Nil = nil, tax_behavior : String | Nil = nil, tax_code : 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

amount

A positive integer representing the line item's total price in the smallest currency unit. If tax_behavior=inclusive, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.

Source
amount=(new_value : Int64 | Nil)

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

list_invalid_properties

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

Source
product

If provided, the product's tax_code will be used as the line item's tax_code.

Source
product=(new_value : String | Nil)

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

Source
quantity

The number of units of the item being purchased. Used to calculate the per-unit price from the total amount for the line. For example, if amount=100 and quantity=4, the calculated unit price is 25.

Source
quantity=(new_value : Int64 | Nil)

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

Source
reference

A custom identifier for this line item, which must be unique across the line items in the calculation. The reference helps identify each line item in exported tax reports.

Source
reference=(new_value : String | Nil)

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

Source
tax_behavior

Specifies whether the amount includes taxes. Defaults to exclusive.

Source
tax_behavior=(new_value : String | Nil)

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

Source
tax_code

A tax code ID to use for this line item. If not provided, we will use the tax code from the provided product param. If neither tax_code nor product is provided, we will use the default tax code from your Tax Settings.

Source
tax_code=(new_value : String | Nil)

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