Class: Stripe::InvoiceCreatePreviewParams::SubscriptionDetails::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.



960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 960

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.



948
949
950
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 948

def currency
  @currency
end

#product ⇒ Object

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



950
951
952
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 950

def product
  @product
end

#recurring ⇒ Object

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



952
953
954
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 952

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.



954
955
956
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 954

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.



956
957
958
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 956

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.



958
959
960
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 958

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



976
977
978
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 976

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