Class: Recurly::Resources::CreditPayment

Inherits:

Recurly::Resource

• Object
• Recurly::Resource
• Recurly::Resources::CreditPayment

Defined in:

lib/recurly/resources/credit_payment.rb

Instance Attribute Summary

• #account ⇒ AccountMini

  Account mini details.

• #action ⇒ String

  The action for which the credit was created.

• #amount ⇒ Float

  Total credit payment amount applied to the charge invoice.

• #applied_to_invoice ⇒ InvoiceMini

  Invoice mini details.

• #created_at ⇒ DateTime

  Created at.

• #currency ⇒ String

  3-letter ISO 4217 currency code.

• #id ⇒ String

  Credit Payment ID.

• #object ⇒ String

  Object type.

• #original_credit_payment_id ⇒ String

  For credit payments with action refund, this is the credit payment that was refunded.

• #original_invoice ⇒ InvoiceMini

  Invoice mini details.

• #refund_transaction ⇒ Transaction
• #updated_at ⇒ DateTime

  Last updated at.

• #uuid ⇒ String

  The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.

• #voided_at ⇒ DateTime

  Voided at.

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

#account ⇒ AccountMini

Returns Account mini details.

Returns:

• (AccountMini) —

  Account mini details

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

define_attribute :account, :AccountMini

#action ⇒ String

Returns The action for which the credit was created.

Returns:

• (String) —

  The action for which the credit was created.

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

define_attribute :action, String

#amount ⇒ Float

Returns Total credit payment amount applied to the charge invoice.

Returns:

• (Float) —

  Total credit payment amount applied to the charge invoice.

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

define_attribute :amount, Float

#applied_to_invoice ⇒ InvoiceMini

Returns Invoice mini details.

Returns:

• (InvoiceMini) —

  Invoice mini details

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

define_attribute :applied_to_invoice, :InvoiceMini

#created_at ⇒ DateTime

Returns Created at.

Returns:

• (DateTime) —

  Created at

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

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/credit_payment.rb', line 31

define_attribute :currency, String

#id ⇒ String

Returns Credit Payment ID.

Returns:

• (String) —

  Credit Payment ID

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

define_attribute :id, String

#object ⇒ String

Returns Object type.

Returns:

• (String) —

  Object type

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

define_attribute :object, String

#original_credit_payment_id ⇒ String

Returns For credit payments with action refund, this is the credit payment that was refunded.

Returns:

• (String) —

  For credit payments with action refund, this is the credit payment that was refunded.

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

define_attribute :original_credit_payment_id, String

#original_invoice ⇒ InvoiceMini

Returns Invoice mini details.

Returns:

• (InvoiceMini) —

  Invoice mini details

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

define_attribute :original_invoice, :InvoiceMini

#refund_transaction ⇒ Transaction

Returns:

• (Transaction)

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

define_attribute :refund_transaction, :Transaction

#updated_at ⇒ DateTime

Returns Last updated at.

Returns:

• (DateTime) —

  Last updated at

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

define_attribute :updated_at, DateTime

#uuid ⇒ String

Returns The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.

Returns:

• (String) —

  The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.

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

define_attribute :uuid, String

#voided_at ⇒ DateTime

Returns Voided at.

Returns:

• (DateTime) —

  Voided at

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

define_attribute :voided_at, DateTime