Class: Dodopayments::Models::CreditEntitlements::CreditLedgerEntry

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb

Overview

See Also:

Direct Known Subclasses

WebhookPayload::Data::CreditLedgerEntry

Defined Under Namespace

Modules: TransactionType

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, amount:, balance_after:, balance_before:, brand_id:, business_id:, created_at:, credit_entitlement_id:, customer_id:, is_credit:, metadata:, overage_after:, overage_before:, transaction_type:, description: nil, grant_id: nil, reference_id: nil, reference_type: nil) ⇒ Object

Some parameter documentations has been truncated, see Dodopayments::Models::CreditEntitlements::CreditLedgerEntry for more details.

Response for a ledger entry

Parameters:

  • id (String)
  • amount (String)
  • balance_after (String)
  • balance_before (String)
  • brand_id (String) —

    Brand id this credit ledger entry belongs to

  • business_id (String)
  • created_at (Time)
  • credit_entitlement_id (String)
  • customer_id (String)
  • is_credit (Boolean)
  • metadata (Hash{Symbol=>String}) —

    Metadata associated with the credit grant’s source (the subscription or

  • overage_after (String)
  • overage_before (String)
  • transaction_type (Symbol, Dodopayments::Models::CreditEntitlements::CreditLedgerEntry::TransactionType)
  • description (String, nil) (defaults to: nil)
  • grant_id (String, nil) (defaults to: nil)
  • reference_id (String, nil) (defaults to: nil)
  • reference_type (String, nil) (defaults to: nil) 



# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 103

Instance Attribute Details

#amount ⇒ String

Returns:

  • (String) 


16
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 16

required :amount, String

#balance_after ⇒ String

Returns:

  • (String) 


21
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 21

required :balance_after, String

#balance_before ⇒ String

Returns:

  • (String) 


26
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 26

required :balance_before, String

#brand_id ⇒ String

Brand id this credit ledger entry belongs to

Returns:

  • (String) 


32
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 32

required :brand_id, String

#business_id ⇒ String

Returns:

  • (String) 


37
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 37

required :business_id, String

#created_at ⇒ Time

Returns:

  • (Time) 


42
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 42

required :created_at, Time

#credit_entitlement_id ⇒ String

Returns:

  • (String) 


47
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 47

required :credit_entitlement_id, String

#customer_id ⇒ String

Returns:

  • (String) 


52
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 52

required :customer_id, String

#description ⇒ String?

Returns:

  • (String, nil) 


86
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 86

optional :description, String, nil?: true

#grant_id ⇒ String?

Returns:

  • (String, nil) 


91
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 91

optional :grant_id, String, nil?: true

#id ⇒ String

Returns:

  • (String) 


11
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 11

required :id, String

#is_credit ⇒ Boolean

Returns:

  • (Boolean) 


57
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 57

required :is_credit, Dodopayments::Internal::Type::Boolean

#metadata ⇒ Hash{Symbol=>String}

Metadata associated with the credit grant’s source (the subscription or payment created at checkout). Empty when the grant has no resolvable source (e.g. credits granted directly via the API).

Returns:

  • (Hash{Symbol=>String}) 


65
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 65

required :metadata, Dodopayments::Internal::Type::HashOf[String]

#overage_after ⇒ String

Returns:

  • (String) 


70
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 70

required :overage_after, String

#overage_before ⇒ String

Returns:

  • (String) 


75
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 75

required :overage_before, String

#reference_id ⇒ String?

Returns:

  • (String, nil) 


96
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 96

optional :reference_id, String, nil?: true

#reference_type ⇒ String?

Returns:

  • (String, nil) 


101
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 101

optional :reference_type, String, nil?: true

#transaction_type ⇒ Symbol, Dodopayments::Models::CreditEntitlements::CreditLedgerEntry::TransactionType

Returns:



80
81
 
# File 'lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb', line 80

required :transaction_type,
enum: -> { Dodopayments::CreditEntitlements::CreditLedgerEntry::TransactionType }