Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api.docs.onlydrams.app/llms.txt

Use this file to discover all available pages before exploring further.

Retrieves the current Stripe balance for a community, showing available, pending, and instant available funds.

URL Parameters

community_id
integer
required
The ID of the community

Returns

Returns the current Stripe balance object.
curl -X GET https://api.onlydrams.app/odis/v1/communities/1/balance \
     -H "Authorization: Bearer $ACCESS_TOKEN"
{
  "available": [
    {
      "amount": 25000,
      "currency": "usd"
    }
  ],
  "pending": [
    {
      "amount": 5000,
      "currency": "usd"
    }
  ],
  "instantAvailable": [
    {
      "amount": 0,
      "currency": "usd"
    }
  ]
}

Error Responses

{
  "message": "No Stripe account connected"
}

Response Fields

available
array
Funds available for payout (in cents)
pending
array
Funds pending and not yet available (in cents)
instantAvailable
array
Funds available for instant payout if enabled (in cents)

Notes

  • Authorization: Community owner or admin only
  • Amounts: All amounts in cents (divide by 100 for dollars)
  • Real-time: Fetches current balance from Stripe
  • Multiple Currencies: Can show balances in multiple currencies
  • Pending: Funds typically become available after 2-7 days