Ledgers

Get Financial Report Breakdown

Changed on

Breaks one bucket of a financial report, such as payments received or card spend, into the customers, accounts, merchants, or campaigns that contributed most, with the rest summed as a remainder. Use it to explain a total from GET /financial_reports.

get/financial_reports/breakdown

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/financial_reports/breakdown
  • Auth: HTTP bearer

Query parameters

account_idstring required

The owning account ID (a biz_ identifier).

bucket'transfers' | 'payments' | 'refunds' | 'ads' | 'application_fees' | 'card_spend' | 'card_authorization_releases' | 'withdrawals' | 'withdrawal_markup' | 'platform_markup' | 'clawbacks' | 'disputes' | 'affiliate_earnings' | 'affiliate_payouts' | 'revenue_share' | 'swaps' | 'card_loads' required

The high-level report bucket to explain.

direction'money_in' | 'money_out' required

Whether to explain money received or money sent.

currencystring required

The report currency to explain.

fromstring date-time required

Start of the report window as an ISO 8601 timestamp.

tostring date-time required

Exclusive end of the report window as an ISO 8601 timestamp.

group_by'hour' | 'day' | 'week' | 'month'

Period grouping used by the parent report.

timezonestring

IANA timezone used by the parent report to bucket periods. Defaults to UTC.

Headers

Api-Version-Datestring
Example:2026-10-15

Pins the request to a dated API version.

Response

breakdown returned

bucket'transfers' | 'payments' | 'refunds' | 'ads' | 'application_fees' | 'card_spend' | 'card_authorization_releases' | 'withdrawals' | 'withdrawal_markup' | 'platform_markup' | 'clawbacks' | 'disputes' | 'affiliate_earnings' | 'affiliate_payouts' | 'revenue_share' | 'swaps' | 'card_loads' required
currencystring required
direction'money_in' | 'money_out' required
other_namestring required

Example response

{
  "activity_filters": {
    "direction": "money_out",
    "line_types": [
      "platform_balance_transfer_outgoing"
    ]
  },
  "bucket": "transfers",
  "currency": "usd",
  "direction": "money_out",
  "items": [
    {
      "amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "avatar": {
        "shape": "circle"
      },
      "object": "user"
    }
  ],
  "other_amount": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "other_name": "Other"
}

Changes

  • ef86d14ef691Revision changes
    • info

      added the new enum value hour to the query request parameter group_by

  • 918ff9d965e1Revision changes
    • warning

      added the new affiliate_earnings enum value to the response property for the response status

    • warning

      added the new affiliate_payouts enum value to the response property for the response status

    • warning

      added the new clawbacks enum value to the response property for the response status

    • warning

      added the new disputes enum value to the response property for the response status

    • warning

      added the new platform_markup enum value to the response property for the response status

    • warning

      added the new revenue_share enum value to the response property for the response status

    This list may be incomplete.