Class: Stripe::PriceUpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/price_update_params.rb

Defined Under Namespace

Classes: CurrencyOptions

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(active: nil, currency_options: nil, expand: nil, lookup_key: nil, metadata: nil, nickname: nil, tax_behavior: nil, transfer_lookup_key: nil) ⇒ PriceUpdateParams

Returns a new instance of PriceUpdateParams.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/stripe/params/price_update_params.rb', line 113

def initialize(
  active: nil,
  currency_options: nil,
  expand: nil,
  lookup_key: nil,
  metadata: nil,
  nickname: nil,
  tax_behavior: nil,
  transfer_lookup_key: nil
)
  @active = active
  @currency_options = currency_options
  @expand = expand
  @lookup_key = lookup_key
  @metadata = metadata
  @nickname = nickname
  @tax_behavior = tax_behavior
  @transfer_lookup_key = transfer_lookup_key
end

Instance Attribute Details

#active ⇒ Object

Whether the price can be used for new purchases. Defaults to true.



97
98
99
 
# File 'lib/stripe/params/price_update_params.rb', line 97

def active
  @active
end

#currency_options ⇒ Object

Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.



99
100
101
 
# File 'lib/stripe/params/price_update_params.rb', line 99

def currency_options
  @currency_options
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



101
102
103
 
# File 'lib/stripe/params/price_update_params.rb', line 101

def expand
  @expand
end

#lookup_key ⇒ Object

A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.



103
104
105
 
# File 'lib/stripe/params/price_update_params.rb', line 103

def lookup_key
  @lookup_key
end

#metadata ⇒ Object

Set of key-value pairs 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.



105
106
107
 
# File 'lib/stripe/params/price_update_params.rb', line 105

def metadata
  @metadata
end

#nickname ⇒ Object

A brief description of the price, hidden from customers.



107
108
109
 
# File 'lib/stripe/params/price_update_params.rb', line 107

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



109
110
111
 
# File 'lib/stripe/params/price_update_params.rb', line 109

def tax_behavior
  @tax_behavior
end

#transfer_lookup_key ⇒ Object

If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.



111
112
113
 
# File 'lib/stripe/params/price_update_params.rb', line 111

def transfer_lookup_key
  @transfer_lookup_key
end