> ## Documentation Index > Fetch the complete documentation index at: https://www.dropfans.io/developers/llms.txt > Use this file to discover all available pages before exploring further. # GET /api/external/v1/balance — The account’s payout balance > The account's payout balance buckets in USD dollars: the creator side at the top level, plus `total` and `sides` for everything the account owns. - Source: https://www.dropfans.io/developers/reference/get-balance - Section: API reference - OpenAPI: https://www.dropfans.io/developers/openapi.json Also served at `/api/external/balance` (the unversioned alias). The account's payout balance buckets in USD dollars: the creator side at the top level, plus `total` and `sides` for everything the account owns. The top-level buckets are the creator side (own sales), unchanged since this endpoint launched. `total` is the full payable balance — the same numbers the Payouts page shows and a payout request pays out: creator side + agency side (income from managed creators and AI personas) + referral commission + partner shares. `sides` breaks `total` down. > [!WARNING] Dollars, not cents > This endpoint returns USD **dollars**. The earnings, check-status and payouts endpoints return **cents**. Do not mix the units. For cents, eligibility and payout status use [GET /payouts/summary](https://www.dropfans.io/developers/reference/get-payout-summary.md). > [!NOTE] Added on 2026-10-30 > `total` and `sides` are new. The top-level fields did not change, so existing integrations keep working; read `total` for an agency, referral or partner account. Bucket semantics: `pending` is revenue still inside the chargeback hold window; `available` has cleared the hold and is what a payout request pays out; `processing` is inside a payout currently being executed; `paidOut` is the lifetime total already paid. `available` can be negative (a refund of money already paid out is netted against future earnings). ## Authentication `Authorization: Bearer dpfn_...` — an API key generated in the dashboard (Vault → API Connect). By default the key acts for the one account it belongs to. Missing or invalid keys return 401 `{"error":"Unauthorized","code":"unauthorized"}`. **For a creator you manage or onboarded:** `GET /api/external/v1/creators/{creatorId}/balance` — with a verified agency's own key for a creator or AI persona it manages, or your app owner's own key for an account your app onboarded (ids from GET /api/external/v1/creators); for a managed creator the agency needs `canViewStats`. The response echoes the account acted on in `X-Dropfans-Account`. Sending `X-Dropfans-Account: ` on the plain path still works but is deprecated. ## Responses ### 200 Balance buckets in USD dollars. | Field | Type | Required | Description | |---|---|---|---| | `currency` | `USD` | yes | Always "USD". | | `pending` | number | yes | USD **dollars** (not cents — unlike earnings and check-status). Creator side (own sales) still inside the chargeback hold window; not payable yet. For everything the account owns, read `total`. | | `available` | number | yes | USD dollars, creator side. Cleared the hold. Can be negative. | | `processing` | number | yes | USD dollars, creator side. Included in a payout that is currently being sent. | | `paidOut` | number | yes | USD dollars, creator side. Lifetime total of completed payouts. | | `total` | BalanceBuckets | yes | Added 2026-10-30. The full payable balance, USD dollars: the sum of all four `sides` — what the Payouts page shows and a payout request pays out (`total.available`). | | `sides` | object | yes | Added 2026-10-30. The four buckets per side, USD dollars; they sum to `total`. `sides.creator` equals the top-level buckets. | | `sides.creator` | BalanceBuckets | yes | Own sales (creatorPortion). | | `sides.agency` | BalanceBuckets | yes | Income from managed creators / AI personas (agencyPortion). | | `sides.affiliate` | BalanceBuckets | yes | Referral commission. | | `sides.share` | BalanceBuckets | yes | Partner shares of other accounts’ sales. | ```json { "currency": "USD", "pending": 120.5, "available": 300.1, "processing": 0, "paidOut": 1755, "total": { "pending": 120.5, "available": 342.1, "processing": 0, "paidOut": 1875 }, "sides": { "creator": { "pending": 120.5, "available": 300.1, "processing": 0, "paidOut": 1755 }, "agency": { "pending": 0, "available": 42, "processing": 0, "paidOut": 120 }, "affiliate": { "pending": 0, "available": 0, "processing": 0, "paidOut": 0 }, "share": { "pending": 0, "available": 0, "processing": 0, "paidOut": 0 } } } ``` ## Errors | Status | Body | When | |---|---|---| | 401 | `{"error":"Unauthorized","code":"unauthorized"}` | Missing or invalid API key. | | 500 | `{"error":"Failed to fetch balance"}` | Balance computation failed — retry later. | | 400 | `{"error":"X-Dropfans-Account must be an account id (from GET /api/external/agency/creators), not a username.","code":"invalid_account_header"}` | `X-Dropfans-Account` is not an account id. | | 400 | `{"error":"X-Dropfans-Account names a different account than the path — send one or the other.","code":"account_mismatch"}` | Called under /v1/creators/{creatorId}/ with an `X-Dropfans-Account` naming another account. | | 403 | `{"error":"This key cannot act for that account.","code":"account_not_managed"}` | The creator in the path (or `X-Dropfans-Account`) is one this key cannot act for: no ACCEPTED management by your agency and not an account your app onboarded (or it no longer holds a key bound to your app), a key minted for one creator, or someone is suspended, banned or deleted. An unknown id gets the same answer. | | 403 | `{"error":"The agency does not have permission for this on that account.","code":"permission_denied","permission":"canViewStats"}` | For a managed creator: the agency lacks `canViewStats` on that account. | | 403 | `{"error":"This app does not have the earnings API category enabled. Contact support to enable it.","code":"api_category_disabled","category":"earnings"}` | Your app has the Earnings & balance [API category](https://www.dropfans.io/developers/concepts/api-categories.md) switched off. | ## Rate limiting Per-key fixed windows by tier (Personal 60/min · 5,000/day; approved apps 300/min · 50,000/day; Dropfans-operated integrations exempt). Read the live values from X-RateLimit-Tier, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and their -Day variants; a 429 carries Retry-After and `{"error":"Rate limit exceeded","code":"rate_limited"}`. See [Rate limits](https://www.dropfans.io/developers/concepts/rate-limits.md). ## Code samples ### curl ```bash curl "https://www.dropfans.io/api/external/v1/balance" \ -H "Authorization: Bearer $DROPFANS_API_KEY" ``` ### Node ```javascript const res = await fetch(`https://www.dropfans.io/api/external/v1/balance`, { headers: { Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`, }, }); console.log(await res.json()); ``` ### Python ```python import os import requests res = requests.get( "https://www.dropfans.io/api/external/v1/balance", headers={"Authorization": f"Bearer {os.environ['DROPFANS_API_KEY']}"}, ) print(res.json()) ``` ## OpenAPI ```json { "method": "GET", "path": "/api/external/v1/balance", "operationId": "getBalance", "tags": [ "account" ], "summary": "The account’s payout balance", "description": "The account's payout balance buckets in USD dollars: the creator side at the top level, plus `total` and `sides` for everything the account owns.\n\nThe top-level buckets are the creator side (own sales), unchanged since this endpoint launched. `total` is the full payable balance — the same numbers the Payouts page shows and a payout request pays out: creator side + agency side (income from managed creators and AI personas) + referral commission + partner shares. `sides` breaks `total` down.\n\n> [!WARNING] Dollars, not cents\n> This endpoint returns USD **dollars**. The earnings, check-status and payouts endpoints return **cents**. Do not mix the units. For cents, eligibility and payout status use [GET /payouts/summary](https://www.dropfans.io/developers/reference/get-payout-summary.md).\n\n> [!NOTE] Added on 2026-10-30\n> `total` and `sides` are new. The top-level fields did not change, so existing integrations keep working; read `total` for an agency, referral or partner account.\n\nBucket semantics: `pending` is revenue still inside the chargeback hold window; `available` has cleared the hold and is what a payout request pays out; `processing` is inside a payout currently being executed; `paidOut` is the lifetime total already paid. `available` can be negative (a refund of money already paid out is netted against future earnings).", "parameters": [ { "name": "X-Dropfans-Account", "in": "header", "required": false, "deprecated": true, "description": "Deprecated: call the …ForCreator operation (/api/external/v1/creators/{creatorId}/…) instead; the header keeps working and such responses carry Deprecation and Link: rel=\"successor-version\". With a verified agency’s own key, the id of a creator or AI persona the agency manages (from GET /api/external/v1/agency/creators): the request then acts as that account, exactly as if it were sent with that account’s own key. Account ids only — usernames are refused (400 invalid_account_header). Checked on every request: the management must be ACCEPTED, nobody may be suspended, banned or deleted (else 403 account_not_managed), and the agency needs the endpoint’s permission on that account (else 403 permission_denied). Omit it to act as the key’s own account.", "schema": { "type": "string", "pattern": "^c[a-z0-9]{20,32}$" }, "example": "cmh4v2q8k0003xy9z7w6v5u4t" } ], "responses": { "200": { "description": "Balance buckets in USD dollars.", "headers": { "X-RateLimit-Tier": { "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).", "schema": { "type": "string", "enum": [ "personal", "app", "first_party" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed per minute for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requests left in the current minute window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Epoch seconds when the minute window resets.", "schema": { "type": "integer" } }, "X-RateLimit-Limit-Day": { "description": "Requests allowed per UTC day for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining-Day": { "description": "Requests left in the current UTC day window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset-Day": { "description": "Epoch seconds when the day window resets.", "schema": { "type": "integer" } }, "X-Dropfans-Account": { "description": "The id of the account this request acted on — the key’s own account, or the managed account named in the X-Dropfans-Account request header. Assert it when acting for several accounts.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency": { "type": "string", "description": "Always \"USD\".", "enum": [ "USD" ] }, "pending": { "type": "number", "description": "USD **dollars** (not cents — unlike earnings and check-status). Creator side (own sales) still inside the chargeback hold window; not payable yet. For everything the account owns, read `total`.", "example": 120.5 }, "available": { "type": "number", "description": "USD dollars, creator side. Cleared the hold. Can be negative.", "example": 300.1 }, "processing": { "type": "number", "description": "USD dollars, creator side. Included in a payout that is currently being sent.", "example": 0 }, "paidOut": { "type": "number", "description": "USD dollars, creator side. Lifetime total of completed payouts.", "example": 1755 }, "total": { "type": "object", "properties": { "pending": { "type": "number", "description": "USD **dollars**. Still inside the chargeback hold window.", "example": 120.5 }, "available": { "type": "number", "description": "USD dollars. Payable. Can be negative.", "example": 342.1 }, "processing": { "type": "number", "description": "USD dollars. Inside a payout being sent.", "example": 0 }, "paidOut": { "type": "number", "description": "USD dollars. Lifetime paid out.", "example": 1875 } }, "required": [ "pending", "available", "processing", "paidOut" ] }, "sides": { "type": "object", "properties": { "creator": { "type": "object", "properties": { "pending": { "type": "number", "description": "USD **dollars**. Still inside the chargeback hold window.", "example": 120.5 }, "available": { "type": "number", "description": "USD dollars. Payable. Can be negative.", "example": 342.1 }, "processing": { "type": "number", "description": "USD dollars. Inside a payout being sent.", "example": 0 }, "paidOut": { "type": "number", "description": "USD dollars. Lifetime paid out.", "example": 1875 } }, "required": [ "pending", "available", "processing", "paidOut" ] }, "agency": { "type": "object", "properties": { "pending": { "type": "number", "description": "USD **dollars**. Still inside the chargeback hold window.", "example": 120.5 }, "available": { "type": "number", "description": "USD dollars. Payable. Can be negative.", "example": 342.1 }, "processing": { "type": "number", "description": "USD dollars. Inside a payout being sent.", "example": 0 }, "paidOut": { "type": "number", "description": "USD dollars. Lifetime paid out.", "example": 1875 } }, "required": [ "pending", "available", "processing", "paidOut" ] }, "affiliate": { "type": "object", "properties": { "pending": { "type": "number", "description": "USD **dollars**. Still inside the chargeback hold window.", "example": 120.5 }, "available": { "type": "number", "description": "USD dollars. Payable. Can be negative.", "example": 342.1 }, "processing": { "type": "number", "description": "USD dollars. Inside a payout being sent.", "example": 0 }, "paidOut": { "type": "number", "description": "USD dollars. Lifetime paid out.", "example": 1875 } }, "required": [ "pending", "available", "processing", "paidOut" ] }, "share": { "type": "object", "properties": { "pending": { "type": "number", "description": "USD **dollars**. Still inside the chargeback hold window.", "example": 120.5 }, "available": { "type": "number", "description": "USD dollars. Payable. Can be negative.", "example": 342.1 }, "processing": { "type": "number", "description": "USD dollars. Inside a payout being sent.", "example": 0 }, "paidOut": { "type": "number", "description": "USD dollars. Lifetime paid out.", "example": 1875 } }, "required": [ "pending", "available", "processing", "paidOut" ] } }, "required": [ "creator", "agency", "affiliate", "share" ], "description": "Added 2026-10-30. The four buckets per side, USD dollars; they sum to `total`. `sides.creator` equals the top-level buckets." } }, "required": [ "currency", "pending", "available", "processing", "paidOut", "total", "sides" ] }, "example": { "currency": "USD", "pending": 120.5, "available": 300.1, "processing": 0, "paidOut": 1755, "total": { "pending": 120.5, "available": 342.1, "processing": 0, "paidOut": 1875 }, "sides": { "creator": { "pending": 120.5, "available": 300.1, "processing": 0, "paidOut": 1755 }, "agency": { "pending": 0, "available": 42, "processing": 0, "paidOut": 120 }, "affiliate": { "pending": 0, "available": 0, "processing": 0, "paidOut": 0 }, "share": { "pending": 0, "available": 0, "processing": 0, "paidOut": 0 } } } } } }, "400": { "description": "`X-Dropfans-Account` is not an account id. Also: Called under /v1/creators/{creatorId}/ with an `X-Dropfans-Account` naming another account.", "headers": { "X-RateLimit-Tier": { "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).", "schema": { "type": "string", "enum": [ "personal", "app", "first_party" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed per minute for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requests left in the current minute window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Epoch seconds when the minute window resets.", "schema": { "type": "integer" } }, "X-RateLimit-Limit-Day": { "description": "Requests allowed per UTC day for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining-Day": { "description": "Requests left in the current UTC day window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset-Day": { "description": "Epoch seconds when the day window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Human-readable message.", "example": "Rate limit exceeded" }, "code": { "type": "string", "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, api_category_disabled, rate_limited, username_required, invalid_account_header, account_not_managed, permission_denied, account_header_not_allowed, agency_key_required — plus endpoint-specific codes listed on each reference page.", "example": "rate_limited" } }, "required": [ "error", "code" ] }, "example": { "error": "X-Dropfans-Account must be an account id (from GET /api/external/agency/creators), not a username.", "code": "invalid_account_header" } } } }, "401": { "description": "Missing or invalid API key.", "headers": { "X-RateLimit-Tier": { "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).", "schema": { "type": "string", "enum": [ "personal", "app", "first_party" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed per minute for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requests left in the current minute window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Epoch seconds when the minute window resets.", "schema": { "type": "integer" } }, "X-RateLimit-Limit-Day": { "description": "Requests allowed per UTC day for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining-Day": { "description": "Requests left in the current UTC day window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset-Day": { "description": "Epoch seconds when the day window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Human-readable message.", "example": "Rate limit exceeded" }, "code": { "type": "string", "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, api_category_disabled, rate_limited, username_required, invalid_account_header, account_not_managed, permission_denied, account_header_not_allowed, agency_key_required — plus endpoint-specific codes listed on each reference page.", "example": "rate_limited" } }, "required": [ "error", "code" ] }, "example": { "error": "Unauthorized", "code": "unauthorized" } } } }, "403": { "description": "The creator in the path (or `X-Dropfans-Account`) is one this key cannot act for: no ACCEPTED management by your agency and not an account your app onboarded (or it no longer holds a key bound to your app), a key minted for one creator, or someone is suspended, banned or deleted. An unknown id gets the same answer. Also: For a managed creator: the agency lacks `canViewStats` on that account. Also: Your app has the Earnings & balance [API category](https://www.dropfans.io/developers/concepts/api-categories.md) switched off.", "headers": { "X-RateLimit-Tier": { "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).", "schema": { "type": "string", "enum": [ "personal", "app", "first_party" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed per minute for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requests left in the current minute window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Epoch seconds when the minute window resets.", "schema": { "type": "integer" } }, "X-RateLimit-Limit-Day": { "description": "Requests allowed per UTC day for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining-Day": { "description": "Requests left in the current UTC day window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset-Day": { "description": "Epoch seconds when the day window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Human-readable message.", "example": "Rate limit exceeded" }, "code": { "type": "string", "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, api_category_disabled, rate_limited, username_required, invalid_account_header, account_not_managed, permission_denied, account_header_not_allowed, agency_key_required — plus endpoint-specific codes listed on each reference page.", "example": "rate_limited" } }, "required": [ "error", "code" ] }, "example": { "error": "This key cannot act for that account.", "code": "account_not_managed" } } } }, "429": { "description": "Rate limit exceeded for the current minute or day window. Wait Retry-After seconds and retry.", "headers": { "X-RateLimit-Tier": { "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).", "schema": { "type": "string", "enum": [ "personal", "app", "first_party" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed per minute for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requests left in the current minute window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Epoch seconds when the minute window resets.", "schema": { "type": "integer" } }, "X-RateLimit-Limit-Day": { "description": "Requests allowed per UTC day for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining-Day": { "description": "Requests left in the current UTC day window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset-Day": { "description": "Epoch seconds when the day window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait before retrying (sent with 429s).", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Human-readable message.", "example": "Rate limit exceeded" }, "code": { "type": "string", "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, api_category_disabled, rate_limited, username_required, invalid_account_header, account_not_managed, permission_denied, account_header_not_allowed, agency_key_required — plus endpoint-specific codes listed on each reference page.", "example": "rate_limited" } }, "required": [ "error", "code" ] }, "example": { "error": "Rate limit exceeded", "code": "rate_limited" } } } }, "500": { "description": "Balance computation failed — retry later.", "headers": { "X-RateLimit-Tier": { "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).", "schema": { "type": "string", "enum": [ "personal", "app", "first_party" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed per minute for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requests left in the current minute window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Epoch seconds when the minute window resets.", "schema": { "type": "integer" } }, "X-RateLimit-Limit-Day": { "description": "Requests allowed per UTC day for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining-Day": { "description": "Requests left in the current UTC day window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset-Day": { "description": "Epoch seconds when the day window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Human-readable message describing what went wrong.", "example": "Vault item not found" } }, "required": [ "error" ] }, "example": { "error": "Failed to fetch balance" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "curl", "source": "curl \"https://www.dropfans.io/api/external/v1/balance\" \\\n -H \"Authorization: Bearer $DROPFANS_API_KEY\"" }, { "lang": "JavaScript", "label": "Node", "source": "const res = await fetch(`https://www.dropfans.io/api/external/v1/balance`, {\n headers: {\n Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,\n },\n});\nconsole.log(await res.json());" }, { "lang": "Python", "source": "import os\nimport requests\n\nres = requests.get(\n \"https://www.dropfans.io/api/external/v1/balance\",\n headers={\"Authorization\": f\"Bearer {os.environ['DROPFANS_API_KEY']}\"},\n)\nprint(res.json())" } ], "x-dropfans-docs": "https://www.dropfans.io/developers/reference/get-balance", "x-dropfans-category": "earnings", "x-dropfans-agency-permission": "canViewStats" } ``` --- Previous: [Set the creator’s subscription tier](https://www.dropfans.io/developers/reference/update-subscription.md) · Next: [List the creators and personas you manage](https://www.dropfans.io/developers/reference/list-agency-creators.md) · All pages: [llms.txt](https://www.dropfans.io/developers/llms.txt)