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.



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/stripe/params/subscription_update_params.rb', line 361

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.



339
340
341
 
# File 'lib/stripe/params/subscription_update_params.rb', line 339

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.



341
342
343
 
# File 'lib/stripe/params/subscription_update_params.rb', line 341

def clear_usage
  @clear_usage
end

#deleted ⇒ Object

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



343
344
345
 
# File 'lib/stripe/params/subscription_update_params.rb', line 343

def deleted
  @deleted
end

#discounts ⇒ Object

The coupons to redeem into discounts for the subscription item.



345
346
347
 
# File 'lib/stripe/params/subscription_update_params.rb', line 345

def discounts
  @discounts
end

#id ⇒ Object

Subscription item to update.



347
348
349
 
# File 'lib/stripe/params/subscription_update_params.rb', line 347

def id
  @id
end

#metadata ⇒ Object

Set of [key-value pairs](docs.stripe.com/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`.



349
350
351
 
# File 'lib/stripe/params/subscription_update_params.rb', line 349

def metadata
  @metadata
end

#plan ⇒ Object

Plan ID for this item, as a string.



351
352
353
 
# File 'lib/stripe/params/subscription_update_params.rb', line 351

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.



353
354
355
 
# File 'lib/stripe/params/subscription_update_params.rb', line 353

def price
  @price
end

#price_data ⇒ Object

Data used to generate a new [Price](docs.stripe.com/api/prices) object inline. One of ‘price` or `price_data` is required.



355
356
357
 
# File 'lib/stripe/params/subscription_update_params.rb', line 355

def price_data
  @price_data
end

#quantity ⇒ Object

Quantity for this item.



357
358
359
 
# File 'lib/stripe/params/subscription_update_params.rb', line 357

def quantity
  @quantity
end

#tax_rates ⇒ Object

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



359
360
361
 
# File 'lib/stripe/params/subscription_update_params.rb', line 359

def tax_rates
  @tax_rates
end

Class Method Details

.field_encodings ⇒ Object 



387
388
389
390
391
 
# File 'lib/stripe/params/subscription_update_params.rb', line 387

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