Class: Stripe::InvoiceCreatePreviewParams::ScheduleDetails::Phase::Item::PriceData

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



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 594

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.



582
583
584
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 582

def currency
  @currency
end

#product ⇒ Object

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



584
585
586
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 584

def product
  @product
end

#recurring ⇒ Object

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



586
587
588
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 586

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.



588
589
590
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 588

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.



590
591
592
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 590

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.



592
593
594
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 592

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



610
611
612
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 610

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