Class: Recurly::Resources::DunningCycle

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

#applies_to_manual_trial ⇒ Boolean

Returns Whether the dunning settings will be applied to manual trials. Only applies to trial cycles.

Returns:

  • (Boolean) —

    Whether the dunning settings will be applied to manual trials. Only applies to trial cycles.



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

define_attribute :applies_to_manual_trial, :Boolean

#created_at ⇒ DateTime

Returns When the current settings were created in Recurly.

Returns:

  • (DateTime) —

    When the current settings were created in Recurly.



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

define_attribute :created_at, DateTime

#expire_subscription ⇒ Boolean

Returns Whether the subscription(s) should be cancelled at the end of the dunning cycle.

Returns:

  • (Boolean) —

    Whether the subscription(s) should be cancelled at the end of the dunning cycle.



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

define_attribute :expire_subscription, :Boolean

#fail_invoice ⇒ Boolean

Returns Whether the invoice should be failed at the end of the dunning cycle.

Returns:

  • (Boolean) —

    Whether the invoice should be failed at the end of the dunning cycle.



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

define_attribute :fail_invoice, :Boolean

#first_communication_interval ⇒ Integer

Returns The number of days after a transaction failure before the first dunning email is sent.

Returns:

  • (Integer) —

    The number of days after a transaction failure before the first dunning email is sent.



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

define_attribute :first_communication_interval, Integer

#intervals ⇒ Array[DunningInterval]

Returns Dunning intervals.

Returns:



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

define_attribute :intervals, Array, { :item_type => :DunningInterval }

#send_immediately_on_hard_decline ⇒ Boolean

Returns Whether or not to send an extra email immediately to customers whose initial payment attempt fails with either a hard decline or invalid billing info.

Returns:

  • (Boolean) —

    Whether or not to send an extra email immediately to customers whose initial payment attempt fails with either a hard decline or invalid billing info.



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

define_attribute :send_immediately_on_hard_decline, :Boolean

#total_dunning_days ⇒ Integer

Returns The number of days between the first dunning email being sent and the end of the dunning cycle.

Returns:

  • (Integer) —

    The number of days between the first dunning email being sent and the end of the dunning cycle.



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

define_attribute :total_dunning_days, Integer

#total_recycling_days ⇒ Integer

Returns The number of days between a transaction failure and the end of the dunning cycle.

Returns:

  • (Integer) —

    The number of days between a transaction failure and the end of the dunning cycle.



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

define_attribute :total_recycling_days, Integer

#type ⇒ String

Returns The type of invoice this cycle applies to.

Returns:

  • (String) —

    The type of invoice this cycle applies to.



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

define_attribute :type, String

#updated_at ⇒ DateTime

Returns When the current settings were updated in Recurly.

Returns:

  • (DateTime) —

    When the current settings were updated in Recurly.



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

define_attribute :updated_at, DateTime

#version ⇒ Integer

Returns Current campaign version.

Returns:

  • (Integer) —

    Current campaign version.



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

define_attribute :version, Integer