Class: Recurly::Requests::ExternalSubscriptionUpdate

Inherits:

Recurly::Request

• Object
• Recurly::Request
• Recurly::Requests::ExternalSubscriptionUpdate

Defined in:

lib/recurly/requests/external_subscription_update.rb

Instance Attribute Summary

• #activated_at ⇒ DateTime

  When the external subscription was activated in the external platform.

• #app_identifier ⇒ String

  Identifier of the app that generated the external subscription.

• #auto_renew ⇒ Boolean

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

• #expires_at ⇒ DateTime

  When the external subscription expires in the external platform.

• #external_id ⇒ String

  Id of the subscription in the external system, i.e.

• #external_product_reference ⇒ ExternalProductReferenceUpdate
• #imported ⇒ Boolean

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

• #last_purchased ⇒ DateTime

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

• #quantity ⇒ Integer

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

• #state ⇒ String

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

• #trial_ends_at ⇒ DateTime

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

• #trial_started_at ⇒ DateTime

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

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

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

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

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.

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

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.

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

define_attribute :auto_renew, :Boolean

#expires_at ⇒ DateTime

Returns When the external subscription expires in the external platform.

Returns:

• (DateTime) —

  When the external subscription expires in the external platform.

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

define_attribute :expires_at, DateTime

#external_id ⇒ String

Returns Id of the subscription in the external system, i.e. Apple App Store or Google Play Store.

Returns:

• (String) —

  Id of the subscription in the external system, i.e. Apple App Store or Google Play Store.

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

define_attribute :external_id, String

#external_product_reference ⇒ ExternalProductReferenceUpdate

Returns:

• (ExternalProductReferenceUpdate)

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

define_attribute :external_product_reference, :ExternalProductReferenceUpdate

#imported ⇒ Boolean

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

Returns:

• (Boolean) —

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

# File 'lib/recurly/requests/external_subscription_update.rb', line 35

define_attribute :imported, :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.

# File 'lib/recurly/requests/external_subscription_update.rb', line 39

define_attribute :last_purchased, DateTime

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

# File 'lib/recurly/requests/external_subscription_update.rb', line 43

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.

# File 'lib/recurly/requests/external_subscription_update.rb', line 47

define_attribute :state, String

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

# File 'lib/recurly/requests/external_subscription_update.rb', line 51

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.

# File 'lib/recurly/requests/external_subscription_update.rb', line 55

define_attribute :trial_started_at, DateTime