Mayson Monorepo Documentation
    Preparing search index...

    This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account.

    The top-level available and pending comprise your "payments balance."

    Related guide: Balances and settlement time, Understanding Connect account balances

    Index

    Properties

    object: "balance"

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

    available: Stripe.Balance.Available[]

    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?: Stripe.Balance.ConnectReserved[]

    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?: Stripe.Balance.InstantAvailable[]

    Funds that you can pay out using Instant Payouts.

    livemode: boolean

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

    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.

    refund_and_dispute_prefunding?: Stripe.Balance.RefundAndDisputePrefunding