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

Instance Method Summary collapse

Methods inherited from RequestParams

#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.



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/stripe/params/subscription_update_params.rb', line 252

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](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



240
241
242
 
# File 'lib/stripe/params/subscription_update_params.rb', line 240

def currency
  @currency
end

#product ⇒ Object

The ID of the [Product](docs.stripe.com/api/products) that this [Price](docs.stripe.com/api/prices) will belong to.



242
243
244
 
# File 'lib/stripe/params/subscription_update_params.rb', line 242

def product
  @product
end

#recurring ⇒ Object

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



244
245
246
 
# File 'lib/stripe/params/subscription_update_params.rb', line 244

def recurring
  @recurring
end

#tax_behavior ⇒ Object

Only required if a [default tax behavior](docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) 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.



246
247
248
 
# File 'lib/stripe/params/subscription_update_params.rb', line 246

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.



248
249
250
 
# File 'lib/stripe/params/subscription_update_params.rb', line 248

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.



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

def unit_amount_decimal
  @unit_amount_decimal
end