Class: Recurly::Resources::SubscriptionChange

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

Returns Activated at.

Returns:

  • (DateTime)

    Activated at



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

define_attribute :activate_at, DateTime

#activatedBoolean

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.rb', line 15

define_attribute :activated, :Boolean

#add_onsArray[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.rb', line 19

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

#created_atDateTime

Returns Created at.

Returns:

  • (DateTime)

    Created at



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

define_attribute :created_at, DateTime

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



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

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

#deleted_atDateTime

Returns Deleted at.

Returns:

  • (DateTime)

    Deleted at



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

define_attribute :deleted_at, DateTime

#idString

Returns The ID of the Subscription Change.

Returns:

  • (String)

    The ID of the Subscription Change.



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

define_attribute :id, String

#invoice_collectionInvoiceCollection

Returns Invoice Collection.

Returns:



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

define_attribute :invoice_collection, :InvoiceCollection

#objectString

Returns Object type.

Returns:

  • (String)

    Object type



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

define_attribute :object, String

#planPlanMini

Returns Just the important parts.

Returns:

  • (PlanMini)

    Just the important parts.



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

define_attribute :plan, :PlanMini

#quantityInteger

Returns Subscription quantity.

Returns:

  • (Integer)

    Subscription quantity



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

define_attribute :quantity, Integer

#revenue_schedule_typeString

Returns Revenue schedule type.

Returns:

  • (String)

    Revenue schedule type



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

define_attribute :revenue_schedule_type, String

#shippingSubscriptionShipping

Returns Subscription shipping details.

Returns:



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

define_attribute :shipping, :SubscriptionShipping

#subscription_idString

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.



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

define_attribute :subscription_id, String

#unit_amountFloat

Returns Unit amount.

Returns:

  • (Float)

    Unit amount



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

define_attribute :unit_amount, Float

#updated_atDateTime

Returns Updated at.

Returns:

  • (DateTime)

    Updated at



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

define_attribute :updated_at, DateTime