Class: Stripe::Invoice::UpdateLinesParams::Line::PriceData

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/invoice.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.



6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
 
# File 'lib/stripe/resources/invoice.rb', line 6982

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



6965
6966
6967
 
# File 'lib/stripe/resources/invoice.rb', line 6965

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.



6968
6969
6970
 
# File 'lib/stripe/resources/invoice.rb', line 6968

def product
  @product
end

#product_data ⇒ Object

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



6971
6972
6973
 
# File 'lib/stripe/resources/invoice.rb', line 6971

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.



6974
6975
6976
 
# File 'lib/stripe/resources/invoice.rb', line 6974

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.



6977
6978
6979
 
# File 'lib/stripe/resources/invoice.rb', line 6977

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.



6980
6981
6982
 
# File 'lib/stripe/resources/invoice.rb', line 6980

def unit_amount_decimal
  @unit_amount_decimal
end