Class: Stripe::PriceCreateParams::CurrencyOptions

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

Defined Under Namespace

Classes: CustomUnitAmount, Tier

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(custom_unit_amount: nil, tax_behavior: nil, tiers: nil, unit_amount: nil, unit_amount_decimal: nil) ⇒ CurrencyOptions

Returns a new instance of CurrencyOptions.



62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/stripe/params/price_create_params.rb', line 62

def initialize(
  custom_unit_amount: nil,
  tax_behavior: nil,
  tiers: nil,
  unit_amount: nil,
  unit_amount_decimal: nil
)
  @custom_unit_amount = custom_unit_amount
  @tax_behavior = tax_behavior
  @tiers = tiers
  @unit_amount = unit_amount
  @unit_amount_decimal = unit_amount_decimal
end

Instance Attribute Details

#custom_unit_amount ⇒ Object

When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.



52
53
54
 
# File 'lib/stripe/params/price_create_params.rb', line 52

def custom_unit_amount
  @custom_unit_amount
end

#tax_behavior ⇒ Object

Only required if a [default tax behavior](docs.stripe.com/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.



54
55
56
 
# File 'lib/stripe/params/price_create_params.rb', line 54

def tax_behavior
  @tax_behavior
end

#tiers ⇒ Object

Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.



56
57
58
 
# File 'lib/stripe/params/price_create_params.rb', line 56

def tiers
  @tiers
end

#unit_amount ⇒ Object

A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.



58
59
60
 
# File 'lib/stripe/params/price_create_params.rb', line 58

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.



60
61
62
 
# File 'lib/stripe/params/price_create_params.rb', line 60

def unit_amount_decimal
  @unit_amount_decimal
end