Class: Stripe::SubscriptionScheduleUpdateParams::Phase::AddInvoiceItem::PriceData

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

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, tax_behavior: nil, unit_amount: nil, unit_amount_decimal: nil) ⇒ PriceData

Returns a new instance of PriceData.



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 217

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

Instance Attribute Details

#currency ⇒ Object

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



207
208
209
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 207

def currency
  @currency
end

#product ⇒ Object

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



209
210
211
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 209

def product
  @product
end

#tax_behavior ⇒ Object

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.



211
212
213
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 211

def tax_behavior
  @tax_behavior
end

#unit_amount ⇒ Object

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



213
214
215
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 213

def unit_amount
  @unit_amount
end

#unit_amount_decimal ⇒ Object

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.



215
216
217
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 215

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



231
232
233
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 231

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