action stripe_get_balance {
  label: "GetBalance"
  description: "<p>Retrieves the current account balance, based on the authentication that was used to make the request.\n For a sample request, see <a href=\"/docs/connect/account-balances#accounting-for-negative-balances\">Accounting for negative balances</a>.</p>"
  provider: stripe
  method: GET
  path: "/v1/balance"
  encoding: form
  input: {
    type: "object"
    properties: {
      expand: {
        type: "array"
        items: {
          type: "string"
        }
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    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)."
    required: ["available", "livemode", "object", "pending"]
    properties: {
      available: {
        type: "array"
        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: {
          type: "object"
          required: ["amount", "currency"]
          properties: {
            amount: {
              type: "integer"
              description: "Balance amount."
            }
            currency: {
              type: "string"
              description: "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
            }
            source_types: {
              type: "object"
              properties: {
                bank_account: {
                  type: "integer"
                  description: "Amount for bank account."
                }
                card: {
                  type: "integer"
                  description: "Amount for card."
                }
                fpx: {
                  type: "integer"
                  description: "Amount for FPX."
                }
              }
            }
          }
        }
      }
      connect_reserved: {
        type: "array"
        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: {
          type: "object"
          additionalProperties: true
        }
      }
      instant_available: {
        type: "array"
        description: "Funds that can be paid out using Instant Payouts."
        items: {
          type: "object"
          additionalProperties: true
        }
      }
      issuing: {
        type: "object"
        required: ["available"]
        properties: {
          available: {
            type: "array"
            description: "Funds that are available for use."
            items: {
              type: "object"
              additionalProperties: true
            }
          }
        }
      }
      livemode: {
        type: "boolean"
        description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
      }
      object: {
        type: "string"
        description: "String representing the object's type. Objects of the same type share the same value."
        enum: ["balance"]
      }
      pending: {
        type: "array"
        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: {
          type: "object"
          additionalProperties: true
        }
      }
    }
  }
}