Class: Stripe::Checkout::SessionCreateParams::LineItem::PriceData

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

Defined Under Namespace

Classes: ProductData, Recurring

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, new, #to_h

Constructor Details

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

Returns a new instance of PriceData.



916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 916

def initialize(
  currency: nil,
  product: nil,
  product_data: nil,
  recurring: nil,
  tax_behavior: nil,
  unit_amount: nil,
  unit_amount_decimal: nil
)
  @currency = currency
  @product = product
  @product_data = product_data
  @recurring = recurring
  @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, in lowercase. Must be a supported currency.



902
903
904
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 902

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.



904
905
906
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 904

def product
  @product
end

#product_data ⇒ Object

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



906
907
908
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 906

def product_data
  @product_data
end

#recurring ⇒ Object

The recurring components of a price such as interval and interval_count.



908
909
910
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 908

def recurring
  @recurring
end

#tax_behavior ⇒ Object

Only required if a default tax behavior 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.



910
911
912
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 910

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.



912
913
914
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 912

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.



914
915
916
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 914

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



934
935
936
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 934

def self.field_encodings
  @field_encodings = { unit_amount_decimal: :decimal_string }
end