Struct Balance

pub struct Balance {
    pub available: Vec<BalanceAmount>,
    pub connect_reserved: Option<Vec<BalanceAmount>>,
    pub instant_available: Option<Vec<BalanceAmountNet>>,
    pub issuing: Option<BalanceDetail>,
    pub livemode: bool,
    pub pending: Vec<BalanceAmount>,
}

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.

For more details see <https://stripe.com/docs/api/balance/balance_object>.

Fields

available: Vec<BalanceAmount>

Available funds that you can transfer or pay out automatically by Stripe or explicitly through the Transfers API or Payouts API. You can find the available balance for each currency and payment type in the source_types property.

connect_reserved: Option<Vec<BalanceAmount>>

Funds held due to negative balances on connected accounts where account.controller.requirement_collection is application, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the source_types property.

instant_available: Option<Vec<BalanceAmountNet>>

Funds that you can pay out using Instant Payouts.

issuing: Option<BalanceDetail>

livemode: bool

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

pending: Vec<BalanceAmount>

Funds that aren’t available in the balance yet. You can find the pending balance for each currency and each payment type in the source_types property.

Trait Implementations

impl Clone for Balance

fn clone(&self) -> Balance

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Balance

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deserialize for Balance

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl FromValueOpt for Balance

fn from_value(v: Value) -> Option<Self>

impl ObjectDeser for Balance

type Builder = BalanceBuilder