Class: Stripe::ProductCreateParams::DefaultPriceData

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

Defined Under Namespace

Classes: CurrencyOptions, CustomUnitAmount, Recurring

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(currency: nil, currency_options: nil, custom_unit_amount: nil, metadata: nil, recurring: nil, tax_behavior: nil, unit_amount: nil, unit_amount_decimal: nil) ⇒ DefaultPriceData

Returns a new instance of DefaultPriceData.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/stripe/params/product_create_params.rb', line 124

def initialize(
  currency: nil,
  currency_options: nil,
  custom_unit_amount: nil,
  metadata: nil,
  recurring: nil,
  tax_behavior: nil,
  unit_amount: nil,
  unit_amount_decimal: nil
)
  @currency = currency
  @currency_options = currency_options
  @custom_unit_amount = custom_unit_amount
  @metadata = metadata
  @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](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



108
109
110
 
# File 'lib/stripe/params/product_create_params.rb', line 108

def currency
  @currency
end

#currency_options ⇒ Object

Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html) and a [supported currency](stripe.com/docs/currencies).



110
111
112
 
# File 'lib/stripe/params/product_create_params.rb', line 110

def currency_options
  @currency_options
end

#custom_unit_amount ⇒ Object

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



112
113
114
 
# File 'lib/stripe/params/product_create_params.rb', line 112

def custom_unit_amount
  @custom_unit_amount
end

#metadata ⇒ Object

Set of [key-value pairs](docs.stripe.com/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.



114
115
116
 
# File 'lib/stripe/params/product_create_params.rb', line 114

def metadata
  @metadata
end

#recurring ⇒ Object

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



116
117
118
 
# File 'lib/stripe/params/product_create_params.rb', line 116

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



118
119
120
 
# File 'lib/stripe/params/product_create_params.rb', line 118

def tax_behavior
  @tax_behavior
end

#unit_amount ⇒ Object

A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of unit_amount, unit_amount_decimal, or custom_unit_amount is required.



120
121
122
 
# File 'lib/stripe/params/product_create_params.rb', line 120

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.



122
123
124
 
# File 'lib/stripe/params/product_create_params.rb', line 122

def unit_amount_decimal
  @unit_amount_decimal
end