Class: Stripe::SubscriptionUpdateParams::Item

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/subscription_update_params.rb

Defined Under Namespace

Classes: BillingThresholds, Discount, 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(billing_thresholds: nil, clear_usage: nil, deleted: nil, discounts: nil, id: nil, metadata: nil, plan: nil, price: nil, price_data: nil, quantity: nil, tax_rates: nil) ⇒ Item

Returns a new instance of Item.



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/stripe/params/subscription_update_params.rb', line 305

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



283
284
285
 
# File 'lib/stripe/params/subscription_update_params.rb', line 283

def billing_thresholds
  @billing_thresholds
end

#clear_usage ⇒ Object

Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. clear_usage has no effect if the plan has a billing meter attached.



285
286
287
 
# File 'lib/stripe/params/subscription_update_params.rb', line 285

def clear_usage
  @clear_usage
end

#deleted ⇒ Object

A flag that, if set to true, will delete the specified item.



287
288
289
 
# File 'lib/stripe/params/subscription_update_params.rb', line 287

def deleted
  @deleted
end

#discounts ⇒ Object

The coupons to redeem into discounts for the subscription item.



289
290
291
 
# File 'lib/stripe/params/subscription_update_params.rb', line 289

def discounts
  @discounts
end

#id ⇒ Object

Subscription item to update.



291
292
293
 
# File 'lib/stripe/params/subscription_update_params.rb', line 291

def id
  @id
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.



293
294
295
 
# File 'lib/stripe/params/subscription_update_params.rb', line 293

def metadata
  @metadata
end

#plan ⇒ Object

Plan ID for this item, as a string.



295
296
297
 
# File 'lib/stripe/params/subscription_update_params.rb', line 295

def plan
  @plan
end

#price ⇒ Object

The ID of the price object. One of price or price_data is required. When changing a subscription item's price, quantity is set to 1 unless a quantity parameter is provided.



297
298
299
 
# File 'lib/stripe/params/subscription_update_params.rb', line 297

def price
  @price
end

#price_data ⇒ Object

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



299
300
301
 
# File 'lib/stripe/params/subscription_update_params.rb', line 299

def price_data
  @price_data
end

#quantity ⇒ Object

Quantity for this item.



301
302
303
 
# File 'lib/stripe/params/subscription_update_params.rb', line 301

def quantity
  @quantity
end

#tax_rates ⇒ Object

A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.



303
304
305
 
# File 'lib/stripe/params/subscription_update_params.rb', line 303

def tax_rates
  @tax_rates
end

Class Method Details

.field_encodings ⇒ Object 



331
332
333
334
335
 
# File 'lib/stripe/params/subscription_update_params.rb', line 331

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