Class: Stripe::SubscriptionScheduleUpdateParams::Phase::AddInvoiceItem

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/subscription_schedule_update_params.rb

Defined Under Namespace

Classes: Discount, Period, PriceData

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, new, #to_h

Constructor Details

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

Returns a new instance of AddInvoiceItem.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 280

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

Instance Attribute Details

#discountable ⇒ Object

Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.



264
265
266
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 264

def discountable
  @discountable
end

#discounts ⇒ Object

The coupons to redeem into discounts for the item.



266
267
268
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 266

def discounts
  @discounts
end

#metadata ⇒ Object

Set of key-value pairs 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.



268
269
270
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 268

def metadata
  @metadata
end

#period ⇒ Object

The period associated with this invoice item. If not set, period.start.type defaults to max_item_period_start and period.end.type defaults to min_item_period_end.



270
271
272
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 270

def period
  @period
end

#price ⇒ Object

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



272
273
274
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 272

def price
  @price
end

#price_data ⇒ Object

Data used to generate a new Price object inline. One of price or price_data is required.



274
275
276
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 274

def price_data
  @price_data
end

#quantity ⇒ Object

Quantity for this item. Defaults to 1.



276
277
278
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 276

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.



278
279
280
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 278

def tax_rates
  @tax_rates
end

Class Method Details

.field_encodings ⇒ Object 



300
301
302
303
304
 
# File 'lib/stripe/params/subscription_schedule_update_params.rb', line 300

def self.field_encodings
  @field_encodings = {
    price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } },
  }
end