Class: Stripe::QuoteUpdateParams::LineItem::PriceData

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/quote_update_params.rb

Defined Under Namespace

Classes: Recurring

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, new, #to_h

Constructor Details

#initialize(currency: nil, product: nil, recurring: nil, tax_behavior: nil, unit_amount: nil, unit_amount_decimal: nil) ⇒ PriceData

Returns a new instance of PriceData.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/stripe/params/quote_update_params.rb', line 135

def initialize(
  currency: nil,
  product: nil,
  recurring: nil,
  tax_behavior: nil,
  unit_amount: nil,
  unit_amount_decimal: nil
)
  @currency = currency
  @product = product
  @recurring = recurring
  @tax_behavior = tax_behavior
  @unit_amount = unit_amount
  @unit_amount_decimal = unit_amount_decimal
end

Instance Attribute Details

#currencyObject

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



123
124
125
# File 'lib/stripe/params/quote_update_params.rb', line 123

def currency
  @currency
end

#productObject

The ID of the Product that this Price will belong to.



125
126
127
# File 'lib/stripe/params/quote_update_params.rb', line 125

def product
  @product
end

#recurringObject

The recurring components of a price such as interval and interval_count.



127
128
129
# File 'lib/stripe/params/quote_update_params.rb', line 127

def recurring
  @recurring
end

#tax_behaviorObject

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.



129
130
131
# File 'lib/stripe/params/quote_update_params.rb', line 129

def tax_behavior
  @tax_behavior
end

#unit_amountObject

A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.



131
132
133
# File 'lib/stripe/params/quote_update_params.rb', line 131

def unit_amount
  @unit_amount
end

#unit_amount_decimalObject

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.



133
134
135
# File 'lib/stripe/params/quote_update_params.rb', line 133

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodingsObject



151
152
153
# File 'lib/stripe/params/quote_update_params.rb', line 151

def self.field_encodings
  @field_encodings = { unit_amount_decimal: :decimal_string }
end