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

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

#==, #[], #[]=, #_get_inner_class_type, 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.



258
259
260
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 258

def created
  @created
end

#credit ⇒ Object (readonly)

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



260
261
262
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 260

def credit
  @credit
end

#credit_grant ⇒ Object (readonly)

The credit grant associated with this credit balance transaction.



262
263
264
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 262

def credit_grant
  @credit_grant
end

#debit ⇒ Object (readonly)

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



264
265
266
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 264

def debit
  @debit
end

#effective_at ⇒ Object (readonly)

The effective time of this credit balance transaction.



266
267
268
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 266

def effective_at
  @effective_at
end

#id ⇒ Object (readonly)

Unique identifier for the object.



268
269
270
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 268

def id
  @id
end

#livemode ⇒ Object (readonly)

If the object exists in live mode, the value is ‘true`. If the object exists in test mode, the value is `false`.



270
271
272
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 270

def livemode
  @livemode
end

#object ⇒ Object (readonly)

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



272
273
274
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 272

def object
  @object
end

#test_clock ⇒ Object (readonly)

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



274
275
276
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 274

def test_clock
  @test_clock
end

#type ⇒ Object (readonly)

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



276
277
278
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 276

def type
  @type
end

Class Method Details

.field_encodings ⇒ Object 



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 296

def self.field_encodings
  @field_encodings = {
    credit: {
      kind: :object,
      fields: {
        amount: {
          kind: :object,
          fields: { custom_pricing_unit: { kind: :object, fields: { value: :decimal_string } } },
        },
      },
    },
    debit: {
      kind: :object,
      fields: {
        amount: {
          kind: :object,
          fields: { custom_pricing_unit: { kind: :object, fields: { value: :decimal_string } } },
        },
      },
    },
  }
end

.field_remappings ⇒ Object 



292
293
294
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 292

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



288
289
290
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 288

def self.inner_class_types
  @inner_class_types = { credit: Credit, debit: Debit }
end

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

Retrieve a list of credit balance transactions.



279
280
281
282
283
284
285
286
 
# File 'lib/stripe/resources/billing/credit_balance_transaction.rb', line 279

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