Skip to content

Get user earnings

GET
/payouts/earnings

Returns the authenticated creator's earnings summary in dollars. The target is always derived from the authenticated principal — any ?userId query param is ignored (#1072). total and fees are lifetime aggregates from the canonical ledger. For creators with an active Stripe Connect account, available, pending and withdrawn come from Stripe directly (pending additionally includes platform-held net funds that haven't transferred yet). Creators without a Connect account see available and withdrawn as 0 and pending equal to total (everything sits on FundlyHub's platform balance awaiting onboarding). Rate limited per authenticated user.

Authorizations

BearerAuth

Authentication is handled automatically via httpOnly session cookies after signing in at /cognito/signin or via Google SSO at /cognito/oauth/google. For Swagger UI testing, paste a JWT token from the /cognito/signin response.

Type
HTTP (bearer)

Responses

Earnings summary (all values in dollars)

application/json
JSON
{
"total": 0,
"pending": 0,
"available": 0,
"withdrawn": 0,
"fees": 0
}

Playground

Server
Authorization

Samples

Powered by VitePress OpenAPI

Built with VitePress