Class: Stripe::Billing::CreditBalanceSummary

Inherits:
SingletonAPIResource show all
Defined in:
lib/stripe/resources/billing/credit_balance_summary.rb

Overview

Indicates the billing credit balance for billing credits granted to a customer.

Defined Under Namespace

Classes: Balance

Constant Summary collapse

OBJECT_NAME = 
"billing.credit_balance_summary"

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 inherited from SingletonAPIResource

resource_url, #resource_url, retrieve

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

#balances ⇒ Object (readonly)

The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.



249
250
251
 
# File 'lib/stripe/resources/billing/credit_balance_summary.rb', line 249

def balances
  @balances
end

#customer ⇒ Object (readonly)

The customer the balance is for.



251
252
253
 
# File 'lib/stripe/resources/billing/credit_balance_summary.rb', line 251

def customer
  @customer
end

#customer_account ⇒ Object (readonly)

The account the balance is for.



253
254
255
 
# File 'lib/stripe/resources/billing/credit_balance_summary.rb', line 253

def 
  @customer_account
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.



255
256
257
 
# File 'lib/stripe/resources/billing/credit_balance_summary.rb', line 255

def livemode
  @livemode
end

#object ⇒ Object (readonly)

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



257
258
259
 
# File 'lib/stripe/resources/billing/credit_balance_summary.rb', line 257

def object
  @object
end

Class Method Details

.field_encodings ⇒ Object 



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/stripe/resources/billing/credit_balance_summary.rb', line 267

def self.field_encodings
  @field_encodings = {
    balances: {
      kind: :array,
      element: {
        kind: :object,
        fields: {
          available_balance: {
            kind: :object,
            fields: {
              custom_pricing_unit: {
                kind: :nullable,
                inner: { kind: :object, fields: { value: :decimal_string } },
              },
            },
          },
          ledger_balance: {
            kind: :object,
            fields: {
              custom_pricing_unit: {
                kind: :nullable,
                inner: { kind: :object, fields: { value: :decimal_string } },
              },
            },
          },
        },
      },
    },
  }
end

.field_remappings ⇒ Object 



263
264
265
 
# File 'lib/stripe/resources/billing/credit_balance_summary.rb', line 263

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



259
260
261
 
# File 'lib/stripe/resources/billing/credit_balance_summary.rb', line 259

def self.inner_class_types
  @inner_class_types = { balances: Balance }
end

.object_name ⇒ Object 



9
10
11
 
# File 'lib/stripe/resources/billing/credit_balance_summary.rb', line 9

def self.object_name
  "billing.credit_balance_summary"
end