Class: Recurly::Resources::SubscriptionChange

Inherits:

Recurly::Resource

• Object
• Recurly::Resource
• Recurly::Resources::SubscriptionChange

Defined in:

lib/recurly/resources/subscription_change.rb

Instance Attribute Summary

• #activate_at ⇒ DateTime

  Activated at.

• #activated ⇒ Boolean

  Returns `true` if the subscription change is activated.

• #add_ons ⇒ Array[SubscriptionAddOn]

  These add-ons will be used when the subscription renews.

• #billing_info ⇒ SubscriptionChangeBillingInfo

  Accept nested attributes for three_d_secure_action_result_token_id.

• #created_at ⇒ DateTime

  Created at.

• #custom_fields ⇒ Array[CustomField]

  The custom fields will only be altered when they are included in a request.

• #deleted_at ⇒ DateTime

  Deleted at.

• #id ⇒ String

  The ID of the Subscription Change.

• #invoice_collection ⇒ InvoiceCollection

  Invoice Collection.

• #object ⇒ String

  Object type.

• #plan ⇒ PlanMini

  Just the important parts.

• #quantity ⇒ Integer

  Subscription quantity.

• #ramp_intervals ⇒ Array[SubscriptionRampIntervalResponse]

  The ramp intervals representing the pricing schedule for the subscription.

• #revenue_schedule_type ⇒ String

  Revenue schedule type.

• #shipping ⇒ SubscriptionShipping

  Subscription shipping details.

• #subscription_id ⇒ String

  The ID of the subscription that is going to be changed.

• #tax_inclusive ⇒ Boolean

  This field is deprecated.

• #unit_amount ⇒ Float

  Unit amount.

• #updated_at ⇒ DateTime

  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

#activate_at ⇒ DateTime

Returns Activated at.

Returns:

• (DateTime) —

  Activated at

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

define_attribute :activate_at, DateTime

#activated ⇒ Boolean

Returns `true` if the subscription change is activated.

Returns:

• (Boolean) —

  Returns `true` if the subscription change is activated.

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

define_attribute :activated, :Boolean

#add_ons ⇒ Array[SubscriptionAddOn]

Returns These add-ons will be used when the subscription renews.

Returns:

• (Array[SubscriptionAddOn]) —

  These add-ons will be used when the subscription renews.

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

define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }

#billing_info ⇒ SubscriptionChangeBillingInfo

Returns Accept nested attributes for three_d_secure_action_result_token_id.

Returns:

• (SubscriptionChangeBillingInfo) —

  Accept nested attributes for three_d_secure_action_result_token_id

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

define_attribute :billing_info, :SubscriptionChangeBillingInfo

#created_at ⇒ DateTime

Returns Created at.

Returns:

• (DateTime) —

  Created at

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

define_attribute :created_at, DateTime

#custom_fields ⇒ Array[CustomField]

Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.

Returns:

• (Array[CustomField]) —

  The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.

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

define_attribute :custom_fields, Array, { :item_type => :CustomField }

#deleted_at ⇒ DateTime

Returns Deleted at.

Returns:

• (DateTime) —

  Deleted at

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

define_attribute :deleted_at, DateTime

#id ⇒ String

Returns The ID of the Subscription Change.

Returns:

• (String) —

  The ID of the Subscription Change.

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

define_attribute :id, String

#invoice_collection ⇒ InvoiceCollection

Returns Invoice Collection.

Returns:

• (InvoiceCollection) —

  Invoice Collection

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

define_attribute :invoice_collection, :InvoiceCollection

#object ⇒ String

Returns Object type.

Returns:

• (String) —

  Object type

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

define_attribute :object, String

#plan ⇒ PlanMini

Returns Just the important parts.

Returns:

• (PlanMini) —

  Just the important parts.

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

define_attribute :plan, :PlanMini

#quantity ⇒ Integer

Returns Subscription quantity.

Returns:

• (Integer) —

  Subscription quantity

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

define_attribute :quantity, Integer

#ramp_intervals ⇒ Array[SubscriptionRampIntervalResponse]

Returns The ramp intervals representing the pricing schedule for the subscription.

Returns:

• (Array[SubscriptionRampIntervalResponse]) —

  The ramp intervals representing the pricing schedule for the subscription.

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

define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampIntervalResponse }

#revenue_schedule_type ⇒ String

Returns Revenue schedule type.

Returns:

• (String) —

  Revenue schedule type

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

define_attribute :revenue_schedule_type, String

#shipping ⇒ SubscriptionShipping

Returns Subscription shipping details.

Returns:

• (SubscriptionShipping) —

  Subscription shipping details

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

define_attribute :shipping, :SubscriptionShipping

#subscription_id ⇒ String

Returns The ID of the subscription that is going to be changed.

Returns:

• (String) —

  The ID of the subscription that is going to be changed.

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

define_attribute :subscription_id, String

#tax_inclusive ⇒ Boolean

Returns This field is deprecated. Please do not use it.

Returns:

• (Boolean) —

  This field is deprecated. Please do not use it.

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

define_attribute :tax_inclusive, :Boolean

#unit_amount ⇒ Float

Returns Unit amount.

Returns:

• (Float) —

  Unit amount

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

define_attribute :unit_amount, Float

#updated_at ⇒ DateTime

Returns Updated at.

Returns:

• (DateTime) —

  Updated at

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

define_attribute :updated_at, DateTime