class

Stripe::InvoiceItemPreviewParams

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, unspecified]."
MAX_LENGTH_FOR_DESCRIPTION = 5000
MAX_LENGTH_FOR_INVOICEITEM = 5000
MAX_LENGTH_FOR_PRICE = 5000
VALID_VALUES_FOR_TAX_BEHAVIOR = String.static_array("exclusive", "inclusive", "unspecified")

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount : Int64 | Nil = nil, currency : String | Nil = nil, description : String | Nil = nil, discountable : Bool | Nil = nil, discounts : Stripe::InvoiceItemPreviewParamsDiscounts | Nil = nil, invoiceitem : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, period : Stripe::Period | Nil = nil, price : String | Nil = nil, price_data : Stripe::OneTimePriceData | Nil = nil, quantity : Int64 | Nil = nil, tax_behavior : String | Nil = nil, tax_code : Stripe::PostInvoiceitemsRequestTaxCode | Nil = nil, tax_rates : Stripe::InvoiceItemPreviewParamsTaxRates | Nil = nil, unit_amount : Int64 | Nil = nil, unit_amount_decimal : BigDecimal | 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

The integer amount in cents (or local equivalent) of previewed invoice item.

Source
amount=(new_value : Int64 | Nil)

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

Source
currency

Three-letter ISO currency code, in lowercase. Must be a supported currency. Only applicable to new invoice items.

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 which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.

Source
description=(new_value : String | Nil)

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

Source
discountable

Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.

Source
discountable=(new_value : Bool | Nil)

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

Source
discounts
Source
discounts=(new_value : Stripe::InvoiceItemPreviewParamsDiscounts | 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

invoiceitem

The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.

Source
invoiceitem=(new_value : String | Nil)

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

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

Source
period
Source
period=(new_value : Stripe::Period | Nil)

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

Source
price

The ID of the price object. One of price or price_data is required.

Source
price=(new_value : String | Nil)

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

Source
price_data
Source
price_data=(new_value : Stripe::OneTimePriceData | Nil)

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

Source
quantity

Non-negative integer. The quantity of units for the invoice item.

Source
quantity=(new_value : Int64 | Nil)

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

Source
tax_behavior

Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

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
Source
tax_code=(new_value : Stripe::PostInvoiceitemsRequestTaxCode | Nil)

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

Source
tax_rates
Source
tax_rates=(new_value : Stripe::InvoiceItemPreviewParamsTaxRates | Nil)

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

Source
unit_amount

The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.

Source
unit_amount=(new_value : Int64 | Nil)

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

Source
unit_amount_decimal

Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

Source
unit_amount_decimal=(new_value : BigDecimal | Nil)

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