Class: Stripe::SubscriptionUpdateParams::Item::PriceData

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
# File 'lib/stripe/params/subscription_update_params.rb', line 262

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

#currencyObject

Three-letter ISO currency code, in lowercase. Must be a supported currency.



250
251
252
# File 'lib/stripe/params/subscription_update_params.rb', line 250

def currency
  @currency
end

#productObject

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



252
253
254
# File 'lib/stripe/params/subscription_update_params.rb', line 252

def product
  @product
end

#recurringObject

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



254
255
256
# File 'lib/stripe/params/subscription_update_params.rb', line 254

def recurring
  @recurring
end

#tax_behaviorObject

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.



256
257
258
# File 'lib/stripe/params/subscription_update_params.rb', line 256

def tax_behavior
  @tax_behavior
end

#unit_amountObject

A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.



258
259
260
# File 'lib/stripe/params/subscription_update_params.rb', line 258

def unit_amount
  @unit_amount
end

#unit_amount_decimalObject

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.



260
261
262
# File 'lib/stripe/params/subscription_update_params.rb', line 260

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodingsObject



278
279
280
# File 'lib/stripe/params/subscription_update_params.rb', line 278

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