Class: Stripe::SubscriptionCreateParams::Item::PriceData

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



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

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, in lowercase. Must be a supported currency.



362
363
364
 
# File 'lib/stripe/params/subscription_create_params.rb', line 362

def currency
  @currency
end

#product ⇒ Object

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



364
365
366
 
# File 'lib/stripe/params/subscription_create_params.rb', line 364

def product
  @product
end

#recurring ⇒ Object

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



366
367
368
 
# File 'lib/stripe/params/subscription_create_params.rb', line 366

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



368
369
370
 
# File 'lib/stripe/params/subscription_create_params.rb', line 368

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.



370
371
372
 
# File 'lib/stripe/params/subscription_create_params.rb', line 370

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.



372
373
374
 
# File 'lib/stripe/params/subscription_create_params.rb', line 372

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



390
391
392
 
# File 'lib/stripe/params/subscription_create_params.rb', line 390

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