Class: Stripe::Invoice::CreatePreviewParams::InvoiceItem

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/invoice.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(amount: nil, currency: nil, description: nil, discountable: nil, discounts: nil, invoiceitem: nil, metadata: nil, period: nil, price: nil, price_data: nil, quantity: nil, tax_behavior: nil, tax_code: nil, tax_rates: nil, unit_amount: nil, unit_amount_decimal: nil) ⇒ InvoiceItem

Returns a new instance of InvoiceItem.



2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
 
# File 'lib/stripe/resources/invoice.rb', line 2848

def initialize(
  amount: nil,
  currency: nil,
  description: nil,
  discountable: nil,
  discounts: nil,
  invoiceitem: nil,
  metadata: nil,
  period: nil,
  price: nil,
  price_data: nil,
  quantity: nil,
  tax_behavior: nil,
  tax_code: nil,
  tax_rates: nil,
  unit_amount: nil,
  unit_amount_decimal: nil
)
  @amount = amount
  @currency = currency
  @description = description
  @discountable = discountable
  @discounts = discounts
  @invoiceitem = invoiceitem
  @metadata = metadata
  @period = period
  @price = price
  @price_data = price_data
  @quantity = quantity
  @tax_behavior = tax_behavior
  @tax_code = tax_code
  @tax_rates = tax_rates
  @unit_amount = unit_amount
  @unit_amount_decimal = unit_amount_decimal
end

Instance Attribute Details

#amount ⇒ Object

The integer amount in cents (or local equivalent) of previewed invoice item.



2816
2817
2818
 
# File 'lib/stripe/resources/invoice.rb', line 2816

def amount
  @amount
end

#currency ⇒ Object

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies). Only applicable to new invoice items.



2818
2819
2820
 
# File 'lib/stripe/resources/invoice.rb', line 2818

def currency
  @currency
end

#description ⇒ Object

An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.



2820
2821
2822
 
# File 'lib/stripe/resources/invoice.rb', line 2820

def description
  @description
end

#discountable ⇒ Object

Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.



2822
2823
2824
 
# File 'lib/stripe/resources/invoice.rb', line 2822

def discountable
  @discountable
end

#discounts ⇒ Object

The coupons to redeem into discounts for the invoice item in the preview.



2824
2825
2826
 
# File 'lib/stripe/resources/invoice.rb', line 2824

def discounts
  @discounts
end

#invoiceitem ⇒ Object

The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.



2826
2827
2828
 
# File 'lib/stripe/resources/invoice.rb', line 2826

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



2828
2829
2830
 
# File 'lib/stripe/resources/invoice.rb', line 2828

def metadata
  @metadata
end

#period ⇒ Object

The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.



2830
2831
2832
 
# File 'lib/stripe/resources/invoice.rb', line 2830

def period
  @period
end

#price ⇒ Object

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



2832
2833
2834
 
# File 'lib/stripe/resources/invoice.rb', line 2832

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.



2834
2835
2836
 
# File 'lib/stripe/resources/invoice.rb', line 2834

def price_data
  @price_data
end

#quantity ⇒ Object

Non-negative integer. The quantity of units for the invoice item.



2836
2837
2838
 
# File 'lib/stripe/resources/invoice.rb', line 2836

def quantity
  @quantity
end

#tax_behavior ⇒ Object

Only required if a [default tax behavior](stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of ‘inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.



2838
2839
2840
 
# File 'lib/stripe/resources/invoice.rb', line 2838

def tax_behavior
  @tax_behavior
end

#tax_code ⇒ Object

A [tax code](stripe.com/docs/tax/tax-categories) ID.



2840
2841
2842
 
# File 'lib/stripe/resources/invoice.rb', line 2840

def tax_code
  @tax_code
end

#tax_rates ⇒ Object

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



2842
2843
2844
 
# File 'lib/stripe/resources/invoice.rb', line 2842

def tax_rates
  @tax_rates
end

#unit_amount ⇒ Object

The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer’s account, pass a negative unit_amount.



2844
2845
2846
 
# File 'lib/stripe/resources/invoice.rb', line 2844

def unit_amount
  @unit_amount
end

#unit_amount_decimal ⇒ Object

Same as ‘unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.



2846
2847
2848
 
# File 'lib/stripe/resources/invoice.rb', line 2846

def unit_amount_decimal
  @unit_amount_decimal
end