Class: Stripe::SubscriptionService::UpdateParams::Item

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/subscription_service.rb

Defined Under Namespace

Classes: Discount, PriceData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(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.



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/stripe/services/subscription_service.rb', line 342

def initialize(
  clear_usage: nil,
  deleted: nil,
  discounts: nil,
  id: nil,
  metadata: nil,
  plan: nil,
  price: nil,
  price_data: nil,
  quantity: nil,
  tax_rates: nil
)
  @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

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



322
323
324
 
# File 'lib/stripe/services/subscription_service.rb', line 322

def clear_usage
  @clear_usage
end

#deleted ⇒ Object

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



324
325
326
 
# File 'lib/stripe/services/subscription_service.rb', line 324

def deleted
  @deleted
end

#discounts ⇒ Object

The coupons to redeem into discounts for the subscription item.



326
327
328
 
# File 'lib/stripe/services/subscription_service.rb', line 326

def discounts
  @discounts
end

#id ⇒ Object

Subscription item to update.



328
329
330
 
# File 'lib/stripe/services/subscription_service.rb', line 328

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



330
331
332
 
# File 'lib/stripe/services/subscription_service.rb', line 330

def metadata
  @metadata
end

#plan ⇒ Object

Plan ID for this item, as a string.



332
333
334
 
# File 'lib/stripe/services/subscription_service.rb', line 332

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.



334
335
336
 
# File 'lib/stripe/services/subscription_service.rb', line 334

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.



336
337
338
 
# File 'lib/stripe/services/subscription_service.rb', line 336

def price_data
  @price_data
end

#quantity ⇒ Object

Quantity for this item.



338
339
340
 
# File 'lib/stripe/services/subscription_service.rb', line 338

def quantity
  @quantity
end

#tax_rates ⇒ Object

A list of [Tax Rate](stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [‘default_tax_rates`](stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.



340
341
342
 
# File 'lib/stripe/services/subscription_service.rb', line 340

def tax_rates
  @tax_rates
end