Class: Stripe::PromotionCodeService::UpdateParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/promotion_code_service.rb

Defined Under Namespace

Classes: Restrictions

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(active: nil, expand: nil, metadata: nil, restrictions: nil) ⇒ UpdateParams

Returns a new instance of UpdateParams.



176
177
178
179
180
181
 
# File 'lib/stripe/services/promotion_code_service.rb', line 176

def initialize(active: nil, expand: nil, metadata: nil, restrictions: nil)
  @active = active
  @expand = expand
  @metadata = metadata
  @restrictions = restrictions
end

Instance Attribute Details

#active ⇒ Object

Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable.



168
169
170
 
# File 'lib/stripe/services/promotion_code_service.rb', line 168

def active
  @active
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



170
171
172
 
# File 'lib/stripe/services/promotion_code_service.rb', line 170

def expand
  @expand
end

#metadata ⇒ Object

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



172
173
174
 
# File 'lib/stripe/services/promotion_code_service.rb', line 172

def metadata
  @metadata
end

#restrictions ⇒ Object

Settings that restrict the redemption of the promotion code.



174
175
176
 
# File 'lib/stripe/services/promotion_code_service.rb', line 174

def restrictions
  @restrictions
end