Class: Stripe::SubscriptionSchedule::CreateParams::Phase::Item

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/subscription_schedule.rb

Defined Under Namespace

Classes: BillingThresholds, Discount, PriceData, Trial

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, trial: nil) ⇒ Item

Returns a new instance of Item.



1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1036

def initialize(
  billing_thresholds: nil,
  discounts: nil,
  metadata: nil,
  plan: nil,
  price: nil,
  price_data: nil,
  quantity: nil,
  tax_rates: nil,
  trial: nil
)
  @billing_thresholds = billing_thresholds
  @discounts = discounts
  @metadata = metadata
  @plan = plan
  @price = price
  @price_data = price_data
  @quantity = quantity
  @tax_rates = tax_rates
  @trial = trial
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. When updating, pass an empty string to remove previously-defined thresholds.



1010
1011
1012
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1010

def billing_thresholds
  @billing_thresholds
end

#discounts ⇒ Object

The coupons to redeem into discounts for the subscription item.



1013
1014
1015
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1013

def discounts
  @discounts
end

#metadata ⇒ Object

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



1016
1017
1018
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1016

def metadata
  @metadata
end

#plan ⇒ Object

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



1019
1020
1021
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1019

def plan
  @plan
end

#price ⇒ Object

The ID of the price object.



1022
1023
1024
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1022

def price
  @price
end

#price_data ⇒ Object

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



1025
1026
1027
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1025

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`.



1028
1029
1030
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1028

def quantity
  @quantity
end

#tax_rates ⇒ Object

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



1031
1032
1033
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1031

def tax_rates
  @tax_rates
end

#trial ⇒ Object

Options that configure the trial on the subscription item.



1034
1035
1036
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1034

def trial
  @trial
end