> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Referrals

Referrals track businesses referred to Whop and the earnings generated from their processing volume. They help you see which referred businesses are active, how much volume they have processed, and what payouts are pending or completed.

Use the Referrals API to list referred businesses, retrieve one referral, and review earnings across all referrals or for a single referred business.

## Endpoints

| Endpoint                                                                                                 | Request                                                                                |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| [List Business Referrals](/api-reference/beta/referrals/list-business-referrals)                         | <Badge color="blue" size="sm" stroke>GET</Badge> `/referrals/businesses`               |
| [Retrieve Business Referral](/api-reference/beta/referrals/retrieve-a-business-referral)                 | <Badge color="blue" size="sm" stroke>GET</Badge> `/referrals/businesses/{id}`          |
| [List Business Referral Earnings](/api-reference/beta/referrals/list-a-business-referrals-earnings)      | <Badge color="blue" size="sm" stroke>GET</Badge> `/referrals/businesses/{id}/earnings` |
| [List All Business Referral Earnings](/api-reference/beta/referrals/list-all-business-referral-earnings) | <Badge color="blue" size="sm" stroke>GET</Badge> `/referrals/businesses/earnings`      |

## Attributes

<Columns cols={2}>
  <Column>
    <ResponseField name="account" type="object | null" required>
      Referred account.

      <Accordion title="Properties" defaultOpen={true}>
        <ResponseField name="id" type="string" required>
          Referred account ID.
        </ResponseField>

        <ResponseField name="logo_url" type="string | null" required>
          Referred account logo URL.
        </ResponseField>

        <ResponseField name="route" type="string" required>
          Referred account route.
        </ResponseField>

        <ResponseField name="title" type="string" required>
          Referred account display name.
        </ResponseField>
      </Accordion>
    </ResponseField>

    <ResponseField name="created_at" type="string" required>
      When the business referral was created.
    </ResponseField>

    <ResponseField name="earnings_usd" type="object" required>
      <Accordion title="Properties" defaultOpen={true}>
        <ResponseField name="completed" type="string" required>
          Commission already paid out, in USD.
        </ResponseField>

        <ResponseField name="pending" type="string" required>
          Commission scheduled but not yet paid, in USD.
        </ResponseField>

        <ResponseField name="total" type="string" required>
          Pending + completed commission, in USD.
        </ResponseField>
      </Accordion>
    </ResponseField>

    <ResponseField name="id" type="string" required>
      Business referral ID.
    </ResponseField>

    <ResponseField name="object" type="string" required />

    <ResponseField name="payout_percentage" type="number" required>
      Referrer's share of Whop gross profit, as a fraction (0.3 = 30%).
    </ResponseField>

    <ResponseField name="referral_expires_at" type="string | null" required>
      When the referral expires.
    </ResponseField>

    <ResponseField name="referral_started_at" type="string | null" required>
      When the referral became active.
    </ResponseField>

    <ResponseField name="status" type="string" required>
      Current referral status.

      Available options: `active`, `removed`
    </ResponseField>

    <ResponseField name="volume_usd" type="object" required>
      <Accordion title="Properties" defaultOpen={true}>
        <ResponseField name="attributed" type="string" required>
          Credited GMV (awaiting\_settlement + settled); excludes canceled and reversed,
          in USD.
        </ResponseField>

        <ResponseField name="awaiting_settlement" type="string" required>
          GMV awaiting settlement (commission not yet computed), in USD.
        </ResponseField>

        <ResponseField name="settled" type="string" required>
          GMV of pending + completed payments, in USD.
        </ResponseField>
      </Accordion>
    </ResponseField>
  </Column>

  <Column>
    <div className="api-resource-sticky-example">
      ```json BusinessReferral theme={null}
      {
      	"account": {
      		"id": "biz_xxxxxxxxxxxxxx",
      		"logo_url": "https://cdn.whop.com/logo.png",
      		"route": "pickaxe",
      		"title": "Pickaxe"
      	},
      	"created_at": "2026-06-01T12:00:00Z",
      	"earnings_usd": {
      		"completed": "120.50",
      		"pending": "45.25",
      		"total": "165.75"
      	},
      	"id": "bref_xxxxxxxxxxxx",
      	"object": "business_referral",
      	"payout_percentage": 0.3,
      	"referral_expires_at": "2027-06-01T12:00:00Z",
      	"referral_started_at": "2026-06-01T12:00:00Z",
      	"status": "active",
      	"volume_usd": {
      		"attributed": "11050.00",
      		"awaiting_settlement": "250.00",
      		"settled": "10800.00"
      	}
      }
      ```
    </div>
  </Column>
</Columns>