Class: Stripe::InvoiceCreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem

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

Defined Under Namespace

Classes: Discount, Period, PriceData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(discounts: nil, metadata: nil, period: nil, price: nil, price_data: nil, quantity: nil, tax_rates: nil) ⇒ AddInvoiceItem

Returns a new instance of AddInvoiceItem.



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 411

def initialize(
  discounts: nil,
  metadata: nil,
  period: nil,
  price: nil,
  price_data: nil,
  quantity: nil,
  tax_rates: nil
)
  @discounts = discounts
  @metadata = metadata
  @period = period
  @price = price
  @price_data = price_data
  @quantity = quantity
  @tax_rates = tax_rates
end

Instance Attribute Details

#discounts ⇒ Object

The coupons to redeem into discounts for the item.



397
398
399
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 397

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



399
400
401
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 399

def metadata
  @metadata
end

#period ⇒ Object

The period associated with this invoice item. If not set, ‘period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.



401
402
403
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 401

def period
  @period
end

#price ⇒ Object

The ID of the price object. One of ‘price` or `price_data` is required.



403
404
405
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 403

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.



405
406
407
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 405

def price_data
  @price_data
end

#quantity ⇒ Object

Quantity for this item. Defaults to 1.



407
408
409
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 407

def quantity
  @quantity
end

#tax_rates ⇒ Object

The tax rates which apply to the item. When set, the ‘default_tax_rates` do not apply to this item.



409
410
411
 
# File 'lib/stripe/params/invoice_create_preview_params.rb', line 409

def tax_rates
  @tax_rates
end