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

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/subscription_schedule_create_params.rb

Defined Under Namespace

Classes: BillingThresholds, Discount, PriceData

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(billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, price: nil, price_data: nil, quantity: nil, tax_rates: nil) ⇒ Item

Returns a new instance of Item.



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 442

def initialize(
  billing_thresholds: nil,
  discounts: nil,
  metadata: nil,
  plan: nil,
  price: nil,
  price_data: nil,
  quantity: nil,
  tax_rates: nil
)
  @billing_thresholds = billing_thresholds
  @discounts = discounts
  @metadata = metadata
  @plan = plan
  @price = price
  @price_data = price_data
  @quantity = quantity
  @tax_rates = tax_rates
end

Instance Attribute Details

#billing_thresholds ⇒ Object

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.



426
427
428
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 426

def billing_thresholds
  @billing_thresholds
end

#discounts ⇒ Object

The coupons to redeem into discounts for the subscription item.



428
429
430
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 428

def discounts
  @discounts
end

#metadata ⇒ Object

Set of key-value pairs that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's metadata when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's metadata can be unset by posting an empty value to them in the configuration item's metadata. To unset all keys in the subscription item's metadata, update the subscription item directly or unset every key individually from the configuration item's metadata.



430
431
432
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 430

def metadata
  @metadata
end

#plan ⇒ Object

The plan ID to subscribe to. You may specify the same ID in plan and price.



432
433
434
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 432

def plan
  @plan
end

#price ⇒ Object

The ID of the price object.



434
435
436
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 434

def price
  @price
end

#price_data ⇒ Object

Data used to generate a new Price object inline.



436
437
438
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 436

def price_data
  @price_data
end

#quantity ⇒ Object

Quantity for the given price. Can be set only if the price's usage_type is licensed and not metered.



438
439
440
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 438

def quantity
  @quantity
end

#tax_rates ⇒ Object

A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.



440
441
442
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 440

def tax_rates
  @tax_rates
end

Class Method Details

.field_encodings ⇒ Object 



462
463
464
465
466
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 462

def self.field_encodings
  @field_encodings = {
    price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } },
  }
end