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

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



482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 482

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.



466
467
468
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 466

def billing_thresholds
  @billing_thresholds
end

#discounts ⇒ Object

The coupons to redeem into discounts for the subscription item.



468
469
470
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 468

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.



470
471
472
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 470

def metadata
  @metadata
end

#plan ⇒ Object

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



472
473
474
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 472

def plan
  @plan
end

#price ⇒ Object

The ID of the price object.



474
475
476
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 474

def price
  @price
end

#price_data ⇒ Object

Data used to generate a new Price object inline.



476
477
478
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 476

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.



478
479
480
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 478

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.



480
481
482
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 480

def tax_rates
  @tax_rates
end

Class Method Details

.field_encodings ⇒ Object 



502
503
504
505
506
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 502

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