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.



821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 821

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.



809
810
811
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 809

def currency
  @currency
end

#product ⇒ Object

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



811
812
813
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 811

def product
  @product
end

#recurring ⇒ Object

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



813
814
815
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 813

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.



815
816
817
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 815

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.



817
818
819
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 817

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.



819
820
821
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 819

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



837
838
839
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 837

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