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

Instance Method Summary collapse

Methods inherited from RequestParams

#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 



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 408

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.



392
393
394
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 392

def billing_thresholds
  @billing_thresholds
end

#discounts ⇒ Object

The coupons to redeem into discounts for the subscription item.



394
395
396
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 394

def discounts
  @discounts
end

#metadata ⇒ Object

Set of [key-value pairs](docs.stripe.com/api/metadata) 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.



396
397
398
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 396

def metadata
  @metadata
end

#plan ⇒ Object

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



398
399
400
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 398

def plan
  @plan
end

#price ⇒ Object

The ID of the price object.



400
401
402
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 400

def price
  @price
end

#price_data ⇒ Object

Data used to generate a new [Price](docs.stripe.com/api/prices) object inline.



402
403
404
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 402

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.



404
405
406
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 404

def quantity
  @quantity
end

#tax_rates ⇒ Object

A list of [Tax Rate](docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [default_tax_rates](docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.



406
407
408
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 406

def tax_rates
  @tax_rates
end