Class: Stripe::SubscriptionUpdateParams::Item::PriceData

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/subscription_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.



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/stripe/params/subscription_update_params.rb', line 345

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

#currency ⇒ Object

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



333
334
335
 
# File 'lib/stripe/params/subscription_update_params.rb', line 333

def currency
  @currency
end

#product ⇒ Object

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



335
336
337
 
# File 'lib/stripe/params/subscription_update_params.rb', line 335

def product
  @product
end

#recurring ⇒ Object

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



337
338
339
 
# File 'lib/stripe/params/subscription_update_params.rb', line 337

def recurring
  @recurring
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.



339
340
341
 
# File 'lib/stripe/params/subscription_update_params.rb', line 339

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.



341
342
343
 
# File 'lib/stripe/params/subscription_update_params.rb', line 341

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.



343
344
345
 
# File 'lib/stripe/params/subscription_update_params.rb', line 343

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



361
362
363
 
# File 'lib/stripe/params/subscription_update_params.rb', line 361

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