Class: Stripe::QuoteCreateParams::Line::Action::SetItem

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

Defined Under Namespace

Classes: Discount, Trial

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(discounts: nil, metadata: nil, price: nil, quantity: nil, tax_rates: nil, trial: nil, trial_offer: nil) ⇒ SetItem

Returns a new instance of SetItem.



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/stripe/params/quote_create_params.rb', line 369

def initialize(
  discounts: nil,
  metadata: nil,
  price: nil,
  quantity: nil,
  tax_rates: nil,
  trial: nil,
  trial_offer: nil
)
  @discounts = discounts
  @metadata = metadata
  @price = price
  @quantity = quantity
  @tax_rates = tax_rates
  @trial = trial
  @trial_offer = trial_offer
end

Instance Attribute Details

#discounts ⇒ Object

If an item with the price already exists, passing this will override the discounts array on the subscription item that matches that price. Otherwise, the items array is cleared and a single new item is added with the supplied discounts.



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

def discounts
  @discounts
end

#metadata ⇒ Object

If an item with the price already exists, passing this will override the metadata on the subscription item that matches that price. Otherwise, the items array is cleared and a single new item is added with the supplied metadata.



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

def metadata
  @metadata
end

#price ⇒ Object

The ID of the price object.



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

def price
  @price
end

#quantity ⇒ Object

If an item with the price already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the items array is cleared and a single new item is added with the supplied quantity.



361
362
363
 
# File 'lib/stripe/params/quote_create_params.rb', line 361

def quantity
  @quantity
end

#tax_rates ⇒ Object

If an item with the price already exists, passing this will override the tax_rates array on the subscription item that matches that price. Otherwise, the items array is cleared and a single new item is added with the supplied tax_rates.



363
364
365
 
# File 'lib/stripe/params/quote_create_params.rb', line 363

def tax_rates
  @tax_rates
end

#trial ⇒ Object

If an item with the price already exists, passing this will override the trial configuration on the subscription item that matches that price. Otherwise, the items array is cleared and a single new item is added with the supplied trial.



365
366
367
 
# File 'lib/stripe/params/quote_create_params.rb', line 365

def trial
  @trial
end

#trial_offer ⇒ Object

The ID of the trial offer to apply to the configuration item.



367
368
369
 
# File 'lib/stripe/params/quote_create_params.rb', line 367

def trial_offer
  @trial_offer
end