Class: Stripe::SubscriptionService::UpdateParams::AddInvoiceItem

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/subscription_service.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.



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/stripe/services/subscription_service.rb', line 165

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.



151
152
153
 
# File 'lib/stripe/services/subscription_service.rb', line 151

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



153
154
155
 
# File 'lib/stripe/services/subscription_service.rb', line 153

def metadata
  @metadata
end

#period ⇒ Object

The period associated with this invoice item. Defaults to the current period of the subscription.



155
156
157
 
# File 'lib/stripe/services/subscription_service.rb', line 155

def period
  @period
end

#price ⇒ Object

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



157
158
159
 
# File 'lib/stripe/services/subscription_service.rb', line 157

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.



159
160
161
 
# File 'lib/stripe/services/subscription_service.rb', line 159

def price_data
  @price_data
end

#quantity ⇒ Object

Quantity for this item. Defaults to 1.



161
162
163
 
# File 'lib/stripe/services/subscription_service.rb', line 161

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.



163
164
165
 
# File 'lib/stripe/services/subscription_service.rb', line 163

def tax_rates
  @tax_rates
end