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.



2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
 
# File 'lib/stripe/resources/invoice.rb', line 2914

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.



2882
2883
2884
 
# File 'lib/stripe/resources/invoice.rb', line 2882

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.



2884
2885
2886
 
# File 'lib/stripe/resources/invoice.rb', line 2884

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.



2886
2887
2888
 
# File 'lib/stripe/resources/invoice.rb', line 2886

def description
  @description
end

#discountable ⇒ Object

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



2888
2889
2890
 
# File 'lib/stripe/resources/invoice.rb', line 2888

def discountable
  @discountable
end

#discounts ⇒ Object

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



2890
2891
2892
 
# File 'lib/stripe/resources/invoice.rb', line 2890

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.



2892
2893
2894
 
# File 'lib/stripe/resources/invoice.rb', line 2892

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`.



2894
2895
2896
 
# File 'lib/stripe/resources/invoice.rb', line 2894

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.



2896
2897
2898
 
# File 'lib/stripe/resources/invoice.rb', line 2896

def period
  @period
end

#price ⇒ Object

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



2898
2899
2900
 
# File 'lib/stripe/resources/invoice.rb', line 2898

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.



2900
2901
2902
 
# File 'lib/stripe/resources/invoice.rb', line 2900

def price_data
  @price_data
end

#quantity ⇒ Object

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



2902
2903
2904
 
# File 'lib/stripe/resources/invoice.rb', line 2902

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.



2904
2905
2906
 
# File 'lib/stripe/resources/invoice.rb', line 2904

def tax_behavior
  @tax_behavior
end

#tax_code ⇒ Object

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



2906
2907
2908
 
# File 'lib/stripe/resources/invoice.rb', line 2906

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.



2908
2909
2910
 
# File 'lib/stripe/resources/invoice.rb', line 2908

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.



2910
2911
2912
 
# File 'lib/stripe/resources/invoice.rb', line 2910

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.



2912
2913
2914
 
# File 'lib/stripe/resources/invoice.rb', line 2912

def unit_amount_decimal
  @unit_amount_decimal
end