Class: Stripe::Billing::CreditBalanceTransaction

Inherits:
APIResource show all
Extended by:
APIOperations::List
Defined in:
lib/stripe/resources/billing/credit_balance_transaction.rb

Overview

A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.

Defined Under Namespace

Classes: Credit, Debit, ListParams

Constant Summary collapse

OBJECT_NAME = 
"billing.credit_balance_transaction"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods included from APIOperations::List

list

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



102
103
104
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 102

def created
  @created
end

#credit ⇒ Object (readonly)

Credit details for this credit balance transaction. Only present if type is ‘credit`.



104
105
106
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 104

def credit
  @credit
end

#credit_grant ⇒ Object (readonly)

The credit grant associated with this credit balance transaction.



106
107
108
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 106

def credit_grant
  @credit_grant
end

#debit ⇒ Object (readonly)

Debit details for this credit balance transaction. Only present if type is ‘debit`.



108
109
110
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 108

def debit
  @debit
end

#effective_at ⇒ Object (readonly)

The effective time of this credit balance transaction.



110
111
112
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 110

def effective_at
  @effective_at
end

#id ⇒ Object (readonly)

Unique identifier for the object.



112
113
114
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 112

def id
  @id
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



114
115
116
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 114

def livemode
  @livemode
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



116
117
118
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 116

def object
  @object
end

#test_clock ⇒ Object (readonly)

ID of the test clock this credit balance transaction belongs to.



118
119
120
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 118

def test_clock
  @test_clock
end

#type ⇒ Object (readonly)

The type of credit balance transaction (credit or debit).



120
121
122
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 120

def type
  @type
end

Class Method Details

.list(params = {}, opts = {}) ⇒ Object

Retrieve a list of credit balance transactions.



123
124
125
126
127
128
129
130
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 123

def self.list(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: "/v1/billing/credit_balance_transactions",
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



11
12
13
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 11

def self.object_name
  "billing.credit_balance_transaction"
end