Class: Stripe::PromotionCode::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/promotion_code.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, code: nil, coupon: nil, customer: nil, expand: nil, expires_at: nil, max_redemptions: nil, metadata: nil, restrictions: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/stripe/resources/promotion_code.rb', line 147

def initialize(
  active: nil,
  code: nil,
  coupon: nil,
  customer: nil,
  expand: nil,
  expires_at: nil,
  max_redemptions: nil,
  metadata: nil,
  restrictions: nil
)
  @active = active
  @code = code
  @coupon = coupon
  @customer = customer
  @expand = expand
  @expires_at = expires_at
  @max_redemptions = max_redemptions
  @metadata = metadata
  @restrictions = restrictions
end

Instance Attribute Details

#active ⇒ Object

Whether the promotion code is currently active.



127
128
129
 
# File 'lib/stripe/resources/promotion_code.rb', line 127

def active
  @active
end

#code ⇒ Object

The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).

If left blank, we will generate one automatically.



131
132
133
 
# File 'lib/stripe/resources/promotion_code.rb', line 131

def code
  @code
end

#coupon ⇒ Object

The coupon for this promotion code.



133
134
135
 
# File 'lib/stripe/resources/promotion_code.rb', line 133

def coupon
  @coupon
end

#customer ⇒ Object

The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.



135
136
137
 
# File 'lib/stripe/resources/promotion_code.rb', line 135

def customer
  @customer
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



137
138
139
 
# File 'lib/stripe/resources/promotion_code.rb', line 137

def expand
  @expand
end

#expires_at ⇒ Object

The timestamp at which this promotion code will expire. If the coupon has specified a ‘redeems_by`, then this value cannot be after the coupon’s ‘redeems_by`.



139
140
141
 
# File 'lib/stripe/resources/promotion_code.rb', line 139

def expires_at
  @expires_at
end

#max_redemptions ⇒ Object

A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a ‘max_redemptions`, then this value cannot be greater than the coupon’s ‘max_redemptions`.



141
142
143
 
# File 'lib/stripe/resources/promotion_code.rb', line 141

def max_redemptions
  @max_redemptions
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`.



143
144
145
 
# File 'lib/stripe/resources/promotion_code.rb', line 143

def metadata
  @metadata
end

#restrictions ⇒ Object

Settings that restrict the redemption of the promotion code.



145
146
147
 
# File 'lib/stripe/resources/promotion_code.rb', line 145

def restrictions
  @restrictions
end