Class: Recurly::Requests::CouponUpdate

Inherits:

Recurly::Request

• Object
• Recurly::Request
• Recurly::Requests::CouponUpdate

Defined in:

lib/recurly/requests/coupon_update.rb

Instance Attribute Summary

• #hosted_description ⇒ String

  This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.

• #invoice_description ⇒ String

  Description of the coupon on the invoice.

• #max_redemptions ⇒ Integer

  A maximum number of redemptions for the coupon.

• #max_redemptions_per_account ⇒ Integer

  Redemptions per account is the number of times a specific account can redeem the coupon.

• #name ⇒ String

  The internal name for the coupon.

• #redeem_by_date ⇒ String

  The date and time the coupon will expire and can no longer be redeemed.

Attributes inherited from Recurly::Request

#attributes

Method Summary

Methods inherited from Recurly::Request

#==, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::RequestCaster

#cast_request

Methods included from Schema::ResourceCaster

#cast

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#hosted_description ⇒ String

Returns This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.

Returns:

• (String) —

  This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.

# File 'lib/recurly/requests/coupon_update.rb', line 11

define_attribute :hosted_description, String

#invoice_description ⇒ String

Returns Description of the coupon on the invoice.

Returns:

• (String) —

  Description of the coupon on the invoice.

# File 'lib/recurly/requests/coupon_update.rb', line 15

define_attribute :invoice_description, String

#max_redemptions ⇒ Integer

Returns A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.

Returns:

• (Integer) —

  A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.

# File 'lib/recurly/requests/coupon_update.rb', line 19

define_attribute :max_redemptions, Integer

#max_redemptions_per_account ⇒ Integer

Returns Redemptions per account is the number of times a specific account can redeem the coupon. Set redemptions per account to `1` if you want to keep customers from gaming the system and getting more than one discount from the coupon campaign.

Returns:

• (Integer) —

  Redemptions per account is the number of times a specific account can redeem the coupon. Set redemptions per account to `1` if you want to keep customers from gaming the system and getting more than one discount from the coupon campaign.

# File 'lib/recurly/requests/coupon_update.rb', line 23

define_attribute :max_redemptions_per_account, Integer

#name ⇒ String

Returns The internal name for the coupon.

Returns:

• (String) —

  The internal name for the coupon.

# File 'lib/recurly/requests/coupon_update.rb', line 27

define_attribute :name, String

#redeem_by_date ⇒ String

Returns The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.

Returns:

• (String) —

  The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.

# File 'lib/recurly/requests/coupon_update.rb', line 31

define_attribute :redeem_by_date, String