Class: Stripe::InvoiceLineItem::UpdateParams::PriceData

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/invoice_line_item.rb

Defined Under Namespace

Classes: ProductData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(currency: nil, product: nil, product_data: nil, tax_behavior: nil, unit_amount: nil, unit_amount_decimal: nil) ⇒ PriceData

Returns a new instance of PriceData.



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 164

def initialize(
  currency: nil,
  product: nil,
  product_data: nil,
  tax_behavior: nil,
  unit_amount: nil,
  unit_amount_decimal: nil
)
  @currency = currency
  @product = product
  @product_data = product_data
  @tax_behavior = tax_behavior
  @unit_amount = unit_amount
  @unit_amount_decimal = unit_amount_decimal
end

Instance Attribute Details

#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).



152
153
154
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 152

def currency
  @currency
end

#product ⇒ Object

The ID of the product that this price will belong to. One of ‘product` or `product_data` is required.



154
155
156
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 154

def product
  @product
end

#product_data ⇒ Object

Data used to generate a new product object inline. One of ‘product` or `product_data` is required.



156
157
158
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 156

def product_data
  @product_data
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.



158
159
160
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 158

def tax_behavior
  @tax_behavior
end

#unit_amount ⇒ Object

A non-negative integer in cents (or local equivalent) representing how much to charge. One of ‘unit_amount` or `unit_amount_decimal` is required.



160
161
162
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 160

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.



162
163
164
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 162

def unit_amount_decimal
  @unit_amount_decimal
end