Class: Stripe::SubscriptionScheduleUpdateParams::Phase::Item::PriceData

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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 375

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



363
364
365
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 363

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.



365
366
367
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 365

def product
  @product
end

#recurring ⇒ Object

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



367
368
369
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 367

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.



369
370
371
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 369

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.



371
372
373
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 371

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.



373
374
375
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 373

def unit_amount_decimal
  @unit_amount_decimal
end