Class: Stripe::SubscriptionScheduleCreateParams::Phase::Item::PriceData

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



841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 841

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.



829
830
831
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 829

def currency
  @currency
end

#product ⇒ Object

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



831
832
833
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 831

def product
  @product
end

#recurring ⇒ Object

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



833
834
835
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 833

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.



835
836
837
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 835

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.



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

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.



839
840
841
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 839

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



857
858
859
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 857

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