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 payout history for a community, showing transfers from the platform to the community owner’s account.

​
URL Parameters

​
community_id
integer
required
The ID of the community

​
Query Parameters

​
page
number
Page number (default: 1)
​
per_page
number
Results per page (default: 25)

​
Returns

Returns a paginated list of payout records. 
curl -X GET https://api.onlydrams.app/odis/v1/communities/1/payouts \
     -H "Authorization: Bearer $ACCESS_TOKEN" \
     -G \
     -d "page=1" \
     -d "per_page=25"

{
  "payouts": [
    {
      "id": 1,
      "grossAmount": 9990,
      "platformFee": 999,
      "netAmount": 8991,
      "currency": "usd",
      "status": "paid",
      "periodStart": "2024-11-01T00:00:00Z",
      "periodEnd": "2024-11-30T23:59:59Z",
      "arrivalDate": "2024-12-02T00:00:00Z",
      "processedAt": "2024-12-01T10:00:00Z",
      "stripeTransferId": "tr_1234567890",
      "errorMessage": null,
      "createdAt": "2024-12-01T09:30:00Z"
    },
    {
      "id": 2,
      "grossAmount": 15985,
      "platformFee": 1599,
      "netAmount": 14386,
      "currency": "usd",
      "status": "paid",
      "periodStart": "2024-10-01T00:00:00Z",
      "periodEnd": "2024-10-31T23:59:59Z",
      "arrivalDate": "2024-11-02T00:00:00Z",
      "processedAt": "2024-11-01T10:00:00Z",
      "stripeTransferId": "tr_0987654321",
      "errorMessage": null,
      "createdAt": "2024-11-01T09:30:00Z"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 5,
    "totalCount": 120,
    "perPage": 25
  }
}

​
Response Fields

​
grossAmount
integer
Total subscription revenue in cents before platform fees
​
platformFee
integer
Platform fee amount in cents
​
netAmount
integer
Amount paid to community owner in cents (gross - platform fee)
​
status
string
Payout status: paid, pending, failed, canceled
​
periodStart
string
Start of the payout period
​
periodEnd
string
End of the payout period
​
arrivalDate
string
Expected arrival date in bank account
​
stripeTransferId
string
Stripe transfer ID for tracking

​
Notes

  • Authorization: Community owner or admin only
  • Amounts: All amounts in cents (divide by 100 for dollars)
  • Currency: Defaults to USD
  • Arrival: Typically 2-3 business days after processedAt