Class: Stripe::SubscriptionSchedule::UpdateParams::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.



1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1748

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.



1734
1735
1736
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1734

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



1736
1737
1738
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1736

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.



1738
1739
1740
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1738

def period
  @period
end

#price ⇒ Object

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



1740
1741
1742
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1740

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.



1742
1743
1744
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1742

def price_data
  @price_data
end

#quantity ⇒ Object

Quantity for this item. Defaults to 1.



1744
1745
1746
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1744

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.



1746
1747
1748
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1746

def tax_rates
  @tax_rates
end