Class: Stripe::SubscriptionScheduleCreateParams::Phase::Item::PriceData

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



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 395

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



383
384
385
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 383

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.



385
386
387
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 385

def product
  @product
end

#recurring ⇒ Object

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



387
388
389
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 387

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.



389
390
391
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 389

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.



391
392
393
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 391

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.



393
394
395
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 393

def unit_amount_decimal
  @unit_amount_decimal
end