latestOpenAPI 3.1.02026-08-08243131.9 MB

c5ddcd5c7e72

Get earnings data for a creator

Returns cursor-paginated invoice data for the specified creator over a specified time period. Each transaction includes information about the fan who made the payment. Reversals are included as refund/chargeback rows with negative gross (matching /insights/spending); filter them with source.

get/creators/{creatorUserUuid}/insights/earnings

Path parameters

creatorUserUuidstring uuid required

Query parameters

startDatestring date-time

Start date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-20T00:00:00+01:00 or 2024-10-20T00:00:00Z).

Start date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-20T00:00:00+01:00 or 2024-10-20T00:00:00Z).

endDatestring date-time

End date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-25T00:00:00+01:00 or 2024-10-25T00:00:00Z). Non-inclusive - data before this date is included.

End date as ISO 8601 datetime string with optional timezone offset (e.g., 2024-10-25T00:00:00+01:00 or 2024-10-25T00:00:00Z). Non-inclusive - data before this date is included.

sourceEarningSource[]

Comma-separated list of earning sources

Comma-separated list of earning sources. Default: all

transactionOrderIdsstring[]

Comma-separated transaction order IDs (max 100)

Comma-separated transaction order IDs to fetch (max 100). Use to re-fetch specific transactions by ID and pick up status changes. Combines with the other filters; normal pagination still applies.

cursorstring

Cursor for pagination - If given, pass nextCursor to get the next page.

Cursor for pagination - If given, pass nextCursor to get the next page.

sizenumber

Number of items to return per page (1-50, default: 20). When omitted on a cursor request, the size from the previous page (carried in the cursor) is reused.

Number of items to return per page (1-50, default: 20). When omitted on a cursor request, the size from the previous page (carried in the cursor) is reused.

Headers

X-Fanvue-API-Versionstring required
Example:2025-06-26

API version to use for the request

Response

Creator earnings data with cursor pagination

nextCursorstring nullable required

Cursor for next page, null if no more data