Class: Recurly::Resources::ExternalSubscription

Inherits:
Recurly::Resource show all
Defined in:
lib/recurly/resources/external_subscription.rb

Instance Attribute Summary collapse

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 Account mini details.

Returns:



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

define_attribute :account, :AccountMini

#activated_at ⇒ DateTime

Returns When the external subscription was activated in the external platform.

Returns:

  • (DateTime) —

    When the external subscription was activated in the external platform.



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

define_attribute :activated_at, DateTime

#app_identifier ⇒ String

Returns Identifier of the app that generated the external subscription.

Returns:

  • (String) —

    Identifier of the app that generated the external subscription.



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

define_attribute :app_identifier, String

#auto_renew ⇒ Boolean

Returns An indication of whether or not the external subscription will auto-renew at the expiration date.

Returns:

  • (Boolean) —

    An indication of whether or not the external subscription will auto-renew at the expiration date.



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

define_attribute :auto_renew, :Boolean

#canceled_at ⇒ DateTime

Returns When the external subscription was canceled in the external platform.

Returns:

  • (DateTime) —

    When the external subscription was canceled in the external platform.



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

define_attribute :canceled_at, DateTime

#created_at ⇒ DateTime

Returns When the external subscription was created in Recurly.

Returns:

  • (DateTime) —

    When the external subscription was created in Recurly.



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

define_attribute :created_at, DateTime

#expires_at ⇒ DateTime

Returns When the external subscription expires in the external platform.

Returns:

  • (DateTime) —

    When the external subscription expires in the external platform.



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

define_attribute :expires_at, DateTime

#external_id ⇒ String

Returns The id of the subscription in the external systems., I.e. Apple App Store or Google Play Store.

Returns:

  • (String) —

    The id of the subscription in the external systems., I.e. Apple App Store or Google Play Store.



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

define_attribute :external_id, String

#external_payment_phases ⇒ Array[ExternalPaymentPhase]

Returns The phases of the external subscription payment lifecycle.

Returns:



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

define_attribute :external_payment_phases, Array, { :item_type => :ExternalPaymentPhase }

#external_product_reference ⇒ ExternalProductReferenceMini

Returns External Product Reference details.

Returns:



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

define_attribute :external_product_reference, :ExternalProductReferenceMini

#id ⇒ String

Returns System-generated unique identifier for an external subscription ID, e.g. `e28zov4fw0v2`.

Returns:

  • (String) —

    System-generated unique identifier for an external subscription ID, e.g. `e28zov4fw0v2`.



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

define_attribute :id, String

#imported ⇒ Boolean

Returns An indication of whether or not the external subscription was created by a historical data import.

Returns:

  • (Boolean) —

    An indication of whether or not the external subscription was created by a historical data import.



55
 
# File 'lib/recurly/resources/external_subscription.rb', line 55

define_attribute :imported, :Boolean

#in_grace_period ⇒ Boolean

Returns An indication of whether or not the external subscription is in a grace period.

Returns:

  • (Boolean) —

    An indication of whether or not the external subscription is in a grace period.



59
 
# File 'lib/recurly/resources/external_subscription.rb', line 59

define_attribute :in_grace_period, :Boolean

#last_purchased ⇒ DateTime

Returns When a new billing event occurred on the external subscription in conjunction with a recent billing period, reactivation or upgrade/downgrade.

Returns:

  • (DateTime) —

    When a new billing event occurred on the external subscription in conjunction with a recent billing period, reactivation or upgrade/downgrade.



63
 
# File 'lib/recurly/resources/external_subscription.rb', line 63

define_attribute :last_purchased, DateTime

#object ⇒ String

Returns Object type.

Returns:

  • (String) —

    Object type



67
 
# File 'lib/recurly/resources/external_subscription.rb', line 67

define_attribute :object, String

#quantity ⇒ Integer

Returns An indication of the quantity of a subscribed item's quantity.

Returns:

  • (Integer) —

    An indication of the quantity of a subscribed item's quantity.



71
 
# File 'lib/recurly/resources/external_subscription.rb', line 71

define_attribute :quantity, Integer

#state ⇒ String

Returns External subscriptions can be active, canceled, expired, past_due, voided, revoked, or paused.

Returns:

  • (String) —

    External subscriptions can be active, canceled, expired, past_due, voided, revoked, or paused.



75
 
# File 'lib/recurly/resources/external_subscription.rb', line 75

define_attribute :state, String

#test ⇒ Boolean

Returns An indication of whether or not the external subscription was purchased in a sandbox environment.

Returns:

  • (Boolean) —

    An indication of whether or not the external subscription was purchased in a sandbox environment.



79
 
# File 'lib/recurly/resources/external_subscription.rb', line 79

define_attribute :test, :Boolean

#trial_ends_at ⇒ DateTime

Returns When the external subscription trial period ends in the external platform.

Returns:

  • (DateTime) —

    When the external subscription trial period ends in the external platform.



83
 
# File 'lib/recurly/resources/external_subscription.rb', line 83

define_attribute :trial_ends_at, DateTime

#trial_started_at ⇒ DateTime

Returns When the external subscription trial period started in the external platform.

Returns:

  • (DateTime) —

    When the external subscription trial period started in the external platform.



87
 
# File 'lib/recurly/resources/external_subscription.rb', line 87

define_attribute :trial_started_at, DateTime

#updated_at ⇒ DateTime

Returns When the external subscription was updated in Recurly.

Returns:

  • (DateTime) —

    When the external subscription was updated in Recurly.



91
 
# File 'lib/recurly/resources/external_subscription.rb', line 91

define_attribute :updated_at, DateTime

#uuid ⇒ String

Returns Universally Unique Identifier created automatically.

Returns:

  • (String) —

    Universally Unique Identifier created automatically.



95
 
# File 'lib/recurly/resources/external_subscription.rb', line 95

define_attribute :uuid, String