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.



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 465

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.



453
454
455
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 453

def currency
  @currency
end

#product ⇒ Object

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



455
456
457
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 455

def product
  @product
end

#recurring ⇒ Object

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



457
458
459
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 457

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.



459
460
461
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 459

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.



461
462
463
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 461

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.



463
464
465
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 463

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



481
482
483
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 481

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