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

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

Returns a new instance of Item.



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 428

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.



412
413
414
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 412

def billing_thresholds
  @billing_thresholds
end

#discounts ⇒ Object

The coupons to redeem into discounts for the subscription item.



414
415
416
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 414

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.



416
417
418
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 416

def metadata
  @metadata
end

#plan ⇒ Object

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



418
419
420
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 418

def plan
  @plan
end

#price ⇒ Object

The ID of the price object.



420
421
422
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 420

def price
  @price
end

#price_data ⇒ Object

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



422
423
424
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 422

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.



424
425
426
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 424

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.



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

def tax_rates
  @tax_rates
end