Class: Stripe::SubscriptionScheduleCreateParams::Phase::AddInvoiceItem::PriceData

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/subscription_schedule_create_params.rb

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, tax_behavior: nil, unit_amount: nil, unit_amount_decimal: nil) ⇒ PriceData

Returns a new instance of PriceData.



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 265

def initialize(
  currency: nil,
  product: nil,
  tax_behavior: nil,
  unit_amount: nil,
  unit_amount_decimal: nil
)
  @currency = currency
  @product = product
  @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.



255
256
257
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 255

def currency
  @currency
end

#product ⇒ Object

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



257
258
259
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 257

def product
  @product
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.



259
260
261
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 259

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 or a negative integer representing the amount to credit to the customer.



261
262
263
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 261

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.



263
264
265
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 263

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



279
280
281
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 279

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