Class: Stripe::Coupon::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/coupon.rb

Defined Under Namespace

Classes: AppliesTo, CurrencyOptions, Script

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount_off: nil, applies_to: nil, currency: nil, currency_options: nil, duration: nil, duration_in_months: nil, expand: nil, id: nil, max_redemptions: nil, metadata: nil, name: nil, percent_off: nil, redeem_by: nil, script: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/stripe/resources/coupon.rb', line 164

def initialize(
  amount_off: nil,
  applies_to: nil,
  currency: nil,
  currency_options: nil,
  duration: nil,
  duration_in_months: nil,
  expand: nil,
  id: nil,
  max_redemptions: nil,
  metadata: nil,
  name: nil,
  percent_off: nil,
  redeem_by: nil,
  script: nil
)
  @amount_off = amount_off
  @applies_to = applies_to
  @currency = currency
  @currency_options = currency_options
  @duration = duration
  @duration_in_months = duration_in_months
  @expand = expand
  @id = id
  @max_redemptions = max_redemptions
  @metadata = metadata
  @name = name
  @percent_off = percent_off
  @redeem_by = redeem_by
  @script = script
end

Instance Attribute Details

#amount_off ⇒ Object

A positive integer representing the amount to subtract from an invoice total (required if ‘percent_off` is not passed).



136
137
138
 
# File 'lib/stripe/resources/coupon.rb', line 136

def amount_off
  @amount_off
end

#applies_to ⇒ Object

A hash containing directions for what this Coupon will apply discounts to.



138
139
140
 
# File 'lib/stripe/resources/coupon.rb', line 138

def applies_to
  @applies_to
end

#currency ⇒ Object

Three-letter [ISO code for the currency](stripe.com/docs/currencies) of the ‘amount_off` parameter (required if `amount_off` is passed).



140
141
142
 
# File 'lib/stripe/resources/coupon.rb', line 140

def currency
  @currency
end

#currency_options ⇒ Object

Coupons defined in each available currency option (only supported if ‘amount_off` is passed). 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).



142
143
144
 
# File 'lib/stripe/resources/coupon.rb', line 142

def currency_options
  @currency_options
end

#duration ⇒ Object

Specifies how long the discount will be in effect if used on a subscription. Defaults to ‘once`.



144
145
146
 
# File 'lib/stripe/resources/coupon.rb', line 144

def duration
  @duration
end

#duration_in_months ⇒ Object

Required only if ‘duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.



146
147
148
 
# File 'lib/stripe/resources/coupon.rb', line 146

def duration_in_months
  @duration_in_months
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



148
149
150
 
# File 'lib/stripe/resources/coupon.rb', line 148

def expand
  @expand
end

#id ⇒ Object

Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don’t want to specify a particular code, you can leave the ID blank and we’ll generate a random code for you.



150
151
152
 
# File 'lib/stripe/resources/coupon.rb', line 150

def id
  @id
end

#max_redemptions ⇒ Object

A positive integer specifying the number of times the coupon can be redeemed before it’s no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.



152
153
154
 
# File 'lib/stripe/resources/coupon.rb', line 152

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`.



154
155
156
 
# File 'lib/stripe/resources/coupon.rb', line 154

def metadata
  @metadata
end

#name ⇒ Object

Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the ‘id` is shown if `name` is not set.



156
157
158
 
# File 'lib/stripe/resources/coupon.rb', line 156

def name
  @name
end

#percent_off ⇒ Object

A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if ‘amount_off` is not passed).



158
159
160
 
# File 'lib/stripe/resources/coupon.rb', line 158

def percent_off
  @percent_off
end

#redeem_by ⇒ Object

Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.



160
161
162
 
# File 'lib/stripe/resources/coupon.rb', line 160

def redeem_by
  @redeem_by
end

#script ⇒ Object

Configuration of the [script](docs.stripe.com/billing/subscriptions/script-coupons) used to calculate the discount.



162
163
164
 
# File 'lib/stripe/resources/coupon.rb', line 162

def script
  @script
end