Class: Stripe::SubscriptionScheduleUpdateParams::Phase::Item::PriceData

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



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 529

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.



517
518
519
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 517

def currency
  @currency
end

#product ⇒ Object

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



519
520
521
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 519

def product
  @product
end

#recurring ⇒ Object

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



521
522
523
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 521

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.



523
524
525
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 523

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.



525
526
527
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 525

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.



527
528
529
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 527

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



545
546
547
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 545

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