class Stripe::Balance

Overview

This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account. You can also retrieve the balance history, which contains a list of transactions that contributed to the balance (charges, payouts, and so forth). The available and pending amounts for each currency are broken down further by payment source types. Related guide: Understanding Connect account balances

Included Modules

Defined in:

stripe/models/balance.cr

Constant Summary

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [balance]."
VALID_VALUES_FOR_OBJECT = String.static_array("balance")

Constructors

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, available : Array(Stripe::BalanceAmount) | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, pending : Array(Stripe::BalanceAmount) | Nil = nil, connect_reserved : Array(Stripe::BalanceAmount) | Nil = nil, instant_available : Array(Stripe::BalanceAmountNet) | Nil = nil, issuing : Stripe::BalanceDetail | Nil = nil) #

Initializes the object @param [Hash] attributes Model attributes in the form of hash


[View source]

Instance Method Detail

def ==(other : self) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def available : Array(Stripe::BalanceAmount) | Nil #

[View source]
def available=(new_value : Array(Stripe::BalanceAmount) | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] available Object to be assigned


[View source]
def connect_reserved : Array(Stripe::BalanceAmount) | Nil #

[View source]
def connect_reserved=(new_value : Array(Stripe::BalanceAmount) | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] connect_reserved Object to be assigned


[View source]
def hash(hasher) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def instant_available : Array(Stripe::BalanceAmountNet) | Nil #

[View source]
def instant_available=(new_value : Array(Stripe::BalanceAmountNet) | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] instant_available Object to be assigned


[View source]
def issuing : Stripe::BalanceDetail | Nil #

[View source]
def issuing=(new_value : Stripe::BalanceDetail | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] issuing Object to be assigned


[View source]
def list_invalid_properties : Array(String) #

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons


[View source]
def livemode : Bool | Nil #

[View source]
def livemode=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned


[View source]
def object : String | Nil #

[View source]
def object=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned


[View source]
def pending : Array(Stripe::BalanceAmount) | Nil #

[View source]
def pending=(new_value : Array(Stripe::BalanceAmount) | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] pending Object to be assigned


[View source]
def valid? : Bool #

Check to see if the all the properties in the model are valid @return true if the model is valid


[View source]