Class: Stripe::SubscriptionUpdateParams::Item

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

Defined Under Namespace

Classes: BillingThresholds, CurrentTrial, Discount, PriceData

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, discriminator, discriminator_fields, new, #to_h

Constructor Details

#initialize(billing_thresholds: nil, clear_usage: nil, current_trial: 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.



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/stripe/params/subscription_update_params.rb', line 489

def initialize(
  billing_thresholds: nil,
  clear_usage: nil,
  current_trial: 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
  @current_trial = current_trial
  @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.



465
466
467
 
# File 'lib/stripe/params/subscription_update_params.rb', line 465

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.



467
468
469
 
# File 'lib/stripe/params/subscription_update_params.rb', line 467

def clear_usage
  @clear_usage
end

#current_trial ⇒ Object

The trial offer to apply to this subscription item.



469
470
471
 
# File 'lib/stripe/params/subscription_update_params.rb', line 469

def current_trial
  @current_trial
end

#deleted ⇒ Object

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



471
472
473
 
# File 'lib/stripe/params/subscription_update_params.rb', line 471

def deleted
  @deleted
end

#discounts ⇒ Object

The coupons to redeem into discounts for the subscription item.



473
474
475
 
# File 'lib/stripe/params/subscription_update_params.rb', line 473

def discounts
  @discounts
end

#id ⇒ Object

Subscription item to update. If you omit id, the API adds a new subscription item rather than updating the existing one. See Changing a subscription's price.



475
476
477
 
# File 'lib/stripe/params/subscription_update_params.rb', line 475

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.



477
478
479
 
# File 'lib/stripe/params/subscription_update_params.rb', line 477

def metadata
  @metadata
end

#plan ⇒ Object

Plan ID for this item, as a string.



479
480
481
 
# File 'lib/stripe/params/subscription_update_params.rb', line 479

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.



481
482
483
 
# File 'lib/stripe/params/subscription_update_params.rb', line 481

def price
  @price
end

#price_data ⇒ Object

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



483
484
485
 
# File 'lib/stripe/params/subscription_update_params.rb', line 483

def price_data
  @price_data
end

#quantity ⇒ Object

Quantity for this item.



485
486
487
 
# File 'lib/stripe/params/subscription_update_params.rb', line 485

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.



487
488
489
 
# File 'lib/stripe/params/subscription_update_params.rb', line 487

def tax_rates
  @tax_rates
end

Class Method Details

.field_encodings ⇒ Object 



517
518
519
520
521
 
# File 'lib/stripe/params/subscription_update_params.rb', line 517

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