Class: Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem

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

Defined Under Namespace

Classes: Discount, Period, PriceData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(discounts: nil, metadata: nil, period: nil, price: nil, price_data: nil, quantity: nil, tax_rates: nil) ⇒ AddInvoiceItem

Returns a new instance of AddInvoiceItem.



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1016

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

Instance Attribute Details

#discounts ⇒ Object

The coupons to redeem into discounts for the item.



1002
1003
1004
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1002

def discounts
  @discounts
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



1004
1005
1006
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1004

def metadata
  @metadata
end

#period ⇒ Object

The period associated with this invoice item. Defaults to the period of the underlying subscription that surrounds the start of the phase.



1006
1007
1008
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1006

def period
  @period
end

#price ⇒ Object

The ID of the price object. One of ‘price` or `price_data` is required.



1008
1009
1010
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1008

def price
  @price
end

#price_data ⇒ Object

Data used to generate a new [Price](stripe.com/docs/api/prices) object inline. One of ‘price` or `price_data` is required.



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

def price_data
  @price_data
end

#quantity ⇒ Object

Quantity for this item. Defaults to 1.



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

def quantity
  @quantity
end

#tax_rates ⇒ Object

The tax rates which apply to the item. When set, the ‘default_tax_rates` do not apply to this item.



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

def tax_rates
  @tax_rates
end