Class: Recurly::Resources::SubscriptionChangePreview

Inherits:
Recurly::Resource show all
Defined in:
lib/recurly/resources/subscription_change_preview.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

#activate_at ⇒ DateTime

Returns Activated at.

Returns:

  • (DateTime) —

    Activated at



11
 
# File 'lib/recurly/resources/subscription_change_preview.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.



15
 
# File 'lib/recurly/resources/subscription_change_preview.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.



19
 
# File 'lib/recurly/resources/subscription_change_preview.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:



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

define_attribute :billing_info, :SubscriptionChangeBillingInfo

#created_at ⇒ DateTime

Returns Created at.

Returns:

  • (DateTime) —

    Created at



27
 
# File 'lib/recurly/resources/subscription_change_preview.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.



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

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

#deleted_at ⇒ DateTime

Returns Deleted at.

Returns:

  • (DateTime) —

    Deleted at



35
 
# File 'lib/recurly/resources/subscription_change_preview.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.



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

define_attribute :id, String

#invoice_collection ⇒ InvoiceCollection

Returns Invoice Collection.

Returns:



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

define_attribute :invoice_collection, :InvoiceCollection

#object ⇒ String

Returns Object type.

Returns:

  • (String) —

    Object type



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

define_attribute :object, String

#plan ⇒ PlanMini

Returns Just the important parts.

Returns:

  • (PlanMini) —

    Just the important parts.



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

define_attribute :plan, :PlanMini

#quantity ⇒ Integer

Returns Subscription quantity.

Returns:

  • (Integer) —

    Subscription quantity



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

define_attribute :quantity, Integer

#ramp_intervals ⇒ Array[SubscriptionRampIntervalResponse]

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

Returns:



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

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

#revenue_schedule_type ⇒ String

Returns Revenue schedule type.

Returns:

  • (String) —

    Revenue schedule type



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

define_attribute :revenue_schedule_type, String

#setup_fee_revenue_schedule_type ⇒ String

Returns Setup fee revenue schedule type.

Returns:

  • (String) —

    Setup fee revenue schedule type



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

define_attribute :setup_fee_revenue_schedule_type, String

#shipping ⇒ SubscriptionShipping

Returns Subscription shipping details.

Returns:



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

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.



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

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.



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

define_attribute :tax_inclusive, :Boolean

#unit_amount ⇒ Float

Returns Unit amount.

Returns:

  • (Float) —

    Unit amount



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

define_attribute :unit_amount, Float

#updated_at ⇒ DateTime

Returns Updated at.

Returns:

  • (DateTime) —

    Updated at



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

define_attribute :updated_at, DateTime