Class: Recurly::Resources::ExternalPaymentPhase

Inherits:

Recurly::Resource

• Object
• Recurly::Resource
• Recurly::Resources::ExternalPaymentPhase

Defined in:

lib/recurly/resources/external_payment_phase.rb

Instance Attribute Summary

• #amount ⇒ String

  Allows up to 9 decimal places.

• #created_at ⇒ DateTime

  When the external subscription was created in Recurly.

• #currency ⇒ String

  3-letter ISO 4217 currency code.

• #ending_billing_period_index ⇒ Integer

  Ending Billing Period Index.

• #ends_at ⇒ DateTime

  Ends At.

• #id ⇒ String

  System-generated unique identifier for an external payment phase ID, e.g.

• #object ⇒ String

  Object type.

• #offer_name ⇒ String

  Name of the discount offer given, e.g.

• #offer_type ⇒ String

  Type of discount offer given, e.g.

• #period_count ⇒ Integer

  Number of billing periods.

• #period_length ⇒ String

  Billing cycle length.

• #started_at ⇒ DateTime

  Started At.

• #starting_billing_period_index ⇒ Integer

  Starting Billing Period Index.

• #updated_at ⇒ DateTime

  When the external subscription was updated in Recurly.

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

#amount ⇒ String

Returns Allows up to 9 decimal places.

Returns:

• (String) —

  Allows up to 9 decimal places

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

define_attribute :amount, String

#created_at ⇒ DateTime

Returns When the external subscription was created in Recurly.

Returns:

• (DateTime) —

  When the external subscription was created in Recurly.

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

define_attribute :created_at, DateTime

#currency ⇒ String

Returns 3-letter ISO 4217 currency code.

Returns:

• (String) —

  3-letter ISO 4217 currency code.

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

define_attribute :currency, String

#ending_billing_period_index ⇒ Integer

Returns Ending Billing Period Index.

Returns:

• (Integer) —

  Ending Billing Period Index

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

define_attribute :ending_billing_period_index, Integer

#ends_at ⇒ DateTime

Returns Ends At.

Returns:

• (DateTime) —

  Ends At

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

define_attribute :ends_at, DateTime

#id ⇒ String

Returns System-generated unique identifier for an external payment phase ID, e.g. `e28zov4fw0v2`.

Returns:

• (String) —

  System-generated unique identifier for an external payment phase ID, e.g. `e28zov4fw0v2`.

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

define_attribute :id, String

#object ⇒ String

Returns Object type.

Returns:

• (String) —

  Object type

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

define_attribute :object, String

#offer_name ⇒ String

Returns Name of the discount offer given, e.g. “introductory”.

Returns:

• (String) —

  Name of the discount offer given, e.g. “introductory”

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

define_attribute :offer_name, String

#offer_type ⇒ String

Returns Type of discount offer given, e.g. “FREE_TRIAL”.

Returns:

• (String) —

  Type of discount offer given, e.g. “FREE_TRIAL”

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

define_attribute :offer_type, String

#period_count ⇒ Integer

Returns Number of billing periods.

Returns:

• (Integer) —

  Number of billing periods

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

define_attribute :period_count, Integer

#period_length ⇒ String

Returns Billing cycle length.

Returns:

• (String) —

  Billing cycle length

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

define_attribute :period_length, String

#started_at ⇒ DateTime

Returns Started At.

Returns:

• (DateTime) —

  Started At

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

define_attribute :started_at, DateTime

#starting_billing_period_index ⇒ Integer

Returns Starting Billing Period Index.

Returns:

• (Integer) —

  Starting Billing Period Index

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

define_attribute :starting_billing_period_index, Integer

#updated_at ⇒ DateTime

Returns When the external subscription was updated in Recurly.

Returns:

• (DateTime) —

  When the external subscription was updated in Recurly.

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

define_attribute :updated_at, DateTime