Class: Stripe::CouponCreateParams

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

Defined Under Namespace

Classes: AppliesTo, CurrencyOptions, Script, ServicePeriod

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, service_period: nil) ⇒ CouponCreateParams

Returns a new instance of CouponCreateParams.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/stripe/params/coupon_create_params.rb', line 92

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,
  service_period: 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
  @service_period = service_period
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).



62
63
64
 
# File 'lib/stripe/params/coupon_create_params.rb', line 62

def amount_off
  @amount_off
end

#applies_to ⇒ Object

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



64
65
66
 
# File 'lib/stripe/params/coupon_create_params.rb', line 64

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



66
67
68
 
# File 'lib/stripe/params/coupon_create_params.rb', line 66

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



68
69
70
 
# File 'lib/stripe/params/coupon_create_params.rb', line 68

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



70
71
72
 
# File 'lib/stripe/params/coupon_create_params.rb', line 70

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.



72
73
74
 
# File 'lib/stripe/params/coupon_create_params.rb', line 72

def duration_in_months
  @duration_in_months
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



74
75
76
 
# File 'lib/stripe/params/coupon_create_params.rb', line 74

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.



76
77
78
 
# File 'lib/stripe/params/coupon_create_params.rb', line 76

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.



78
79
80
 
# File 'lib/stripe/params/coupon_create_params.rb', line 78

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



80
81
82
 
# File 'lib/stripe/params/coupon_create_params.rb', line 80

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.



82
83
84
 
# File 'lib/stripe/params/coupon_create_params.rb', line 82

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



84
85
86
 
# File 'lib/stripe/params/coupon_create_params.rb', line 84

def percent_off
  @percent_off
end

#redeem_by ⇒ Object

Unix timestamp specifying the last time at which the coupon can be redeemed (cannot be set to more than 5 years in the future). After the redeem_by date, the coupon can no longer be applied to new customers.



86
87
88
 
# File 'lib/stripe/params/coupon_create_params.rb', line 86

def redeem_by
  @redeem_by
end

#script ⇒ Object

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



88
89
90
 
# File 'lib/stripe/params/coupon_create_params.rb', line 88

def script
  @script
end

#service_period ⇒ Object

A hash specifying the service period for the coupon.



90
91
92
 
# File 'lib/stripe/params/coupon_create_params.rb', line 90

def service_period
  @service_period
end