Struct stripe::generated::core::balance::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>,
}

The resource representing a Stripe “Balance”.

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 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.

Implementations

impl Balance

pub fn retrieve( client: &Client, account_id: Option<AccountId> ) -> Response<Balance>

Retrieves balance object by AccountId. Does not change stripe_account of the client.

For more details see https://stripe.com/docs/api/balance/balance_retrieve.

Trait Implementations

impl Clone for Balance

fn clone(&self) -> Balance

Returns a copy 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 Default for Balance

fn default() -> Balance

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Balance

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Object for Balance

type Id = ()

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object’s type, typically represented in wire format as the object property.

impl Serialize for Balance

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.