Class: Recurly::Resources::CouponRedemption

Inherits:

Recurly::Resource

• Object
• Recurly::Resource
• Recurly::Resources::CouponRedemption

Defined in:

lib/recurly/resources/coupon_redemption.rb

Instance Attribute Summary

• #account ⇒ AccountMini

  The Account on which the coupon was applied.

• #coupon ⇒ Coupon
• #created_at ⇒ DateTime

  Created at.

• #currency ⇒ String

  3-letter ISO 4217 currency code.

• #discounted ⇒ Float

  The amount that was discounted upon the application of the coupon, formatted with the currency.

• #id ⇒ String

  Coupon Redemption ID.

• #object ⇒ String

  Will always be coupon.

• #removed_at ⇒ DateTime

  The date and time the redemption was removed from the account (un-redeemed).

• #state ⇒ String

  Coupon Redemption state.

• #subscription_id ⇒ String

  Subscription ID.

• #updated_at ⇒ DateTime

  Last updated at.

Attributes inherited from Recurly::Resource

#attributes

Method Summary

Methods inherited from Recurly::Resource

#==, #get_response, #inspect, #requires_client?, #to_json, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::ResourceCaster

#cast

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#account ⇒ AccountMini

Returns The Account on which the coupon was applied.

Returns:

• (AccountMini) —

  The Account on which the coupon was applied.

# File 'lib/recurly/resources/coupon_redemption.rb', line 11

define_attribute :account, :AccountMini

#coupon ⇒ Coupon

Returns:

• (Coupon)

# File 'lib/recurly/resources/coupon_redemption.rb', line 15

define_attribute :coupon, :Coupon

#created_at ⇒ DateTime

Returns Created at.

Returns:

• (DateTime) —

  Created at

# File 'lib/recurly/resources/coupon_redemption.rb', line 19

define_attribute :created_at, DateTime

#currency ⇒ String

Returns 3-letter ISO 4217 currency code.

Returns:

• (String) —

  3-letter ISO 4217 currency code.

# File 'lib/recurly/resources/coupon_redemption.rb', line 23

define_attribute :currency, String

#discounted ⇒ Float

Returns The amount that was discounted upon the application of the coupon, formatted with the currency.

Returns:

• (Float) —

  The amount that was discounted upon the application of the coupon, formatted with the currency.

# File 'lib/recurly/resources/coupon_redemption.rb', line 27

define_attribute :discounted, Float

#id ⇒ String

Returns Coupon Redemption ID.

Returns:

• (String) —

  Coupon Redemption ID

# File 'lib/recurly/resources/coupon_redemption.rb', line 31

define_attribute :id, String

#object ⇒ String

Returns Will always be coupon.

Returns:

• (String) —

  Will always be coupon.

# File 'lib/recurly/resources/coupon_redemption.rb', line 35

define_attribute :object, String

#removed_at ⇒ DateTime

Returns The date and time the redemption was removed from the account (un-redeemed).

Returns:

• (DateTime) —

  The date and time the redemption was removed from the account (un-redeemed).

# File 'lib/recurly/resources/coupon_redemption.rb', line 39

define_attribute :removed_at, DateTime

#state ⇒ String

Returns Coupon Redemption state.

Returns:

• (String) —

  Coupon Redemption state

# File 'lib/recurly/resources/coupon_redemption.rb', line 43

define_attribute :state, String

#subscription_id ⇒ String

Returns Subscription ID.

Returns:

• (String) —

  Subscription ID

# File 'lib/recurly/resources/coupon_redemption.rb', line 47

define_attribute :subscription_id, String

#updated_at ⇒ DateTime

Returns Last updated at.

Returns:

• (DateTime) —

  Last updated at

# File 'lib/recurly/resources/coupon_redemption.rb', line 51

define_attribute :updated_at, DateTime