Class: Recurly::Requests::DunningCycleCreate

Inherits:
Recurly::Request show all
Defined in:
lib/recurly/requests/dunning_cycle_create.rb

Instance Attribute Summary collapse

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

#active ⇒ Boolean

Returns Only meaningful on the trial cycle, where sending false removes it. Other cycle types cannot be deactivated.

Returns:

  • (Boolean) —

    Only meaningful on the trial cycle, where sending false removes it. Other cycle types cannot be deactivated.



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

define_attribute :active, :Boolean

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



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

define_attribute :applies_to_manual_trial, :Boolean

#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/requests/dunning_cycle_create.rb', line 19

define_attribute :expire_subscription, :Boolean

#external_payment_recovery_extension_days ⇒ Integer

Returns Number of days to extend external payment recovery. Only available when the site has external payment retries enabled.

Returns:

  • (Integer) —

    Number of days to extend external payment recovery. Only available when the site has external payment retries enabled.



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

define_attribute :external_payment_recovery_extension_days, Integer

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



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

define_attribute :fail_invoice, :Boolean

#intervals ⇒ Array[DunningIntervalCreate]

Returns Dunning intervals. Required unless active is false.

Returns:



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

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

#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/requests/dunning_cycle_create.rb', line 35

define_attribute :send_immediately_on_hard_decline, :Boolean

#type ⇒ String

Returns The type of invoice this cycle applies to.

Returns:

  • (String) —

    The type of invoice this cycle applies to.



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

define_attribute :type, String