Schema2020-08-27object

balance

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](https://stripe.com/docs/reporting/balance-transaction-types) 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](https://stripe.com/docs/connect/account-balances).

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

BalanceDetail

object

available array

required

Funds that are available for use.

Root JSON Schema

{"description":"This is an object representing your Stripe balance. You can retrieve it to see\nthe balance currently on your Stripe account.\n\nYou can also retrieve the balance history, which contains a list of\n[transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance\n(charges, payouts, and so forth).\n\nThe available and pending amounts for each currency are broken down further by\npayment source types.\n\nRelated guide: [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances).","properties":{"available":{"description":"Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). The available balance for each currency and payment type can be found in the `source_types` property.","items":{"$ref":"#/components/schemas/balance_amount"},"type":"array"},"connect_reserved":{"description":"Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property.","items":{"$ref":"#/components/schemas/balance_amount"},"type":"array"},"instant_available":{"description":"Funds that can be paid out using Instant Payouts.","items":{"$ref":"#/components/schemas/balance_amount"},"type":"array"},"issuing":{"$ref":"#/components/schemas/balance_detail"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["balance"],"type":"string"},"pending":{"description":"Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the `source_types` property.","items":{"$ref":"#/components/schemas/balance_amount"},"type":"array"}},"required":["available","livemode","object","pending"],"title":"Balance","type":"object","x-expandableFields":["available","connect_reserved","instant_available","issuing","pending"],"x-resourceId":"balance"}