> ## Documentation Index > Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt > Use this file to discover all available pages before exploring further. # Get the tenant's referral program state > The tenant's referral code, the MSP that referred it, and every MSP it referred, trials included: each one's stage and, once it moved to a paid plan, the monthly credits it adds and the date they stop. Also the rewards the tenant holds and the program terms. Credits only, never dollar amounts. ## OpenAPI ````yaml https://api.neoagent.io/public-api/openapi.json get /public-api/billing/referrals openapi: 3.1.0 info: description: >- Neo's public contract for the dashboard ChatAgent, partner integrations, and MSP automation. Every response is wrapped in a `{data, meta}` envelope; errors use `{error: {code, message, details?}, meta: {request_id}}`. Authenticate with a `Bearer neo_sk__` API key (service account) or a Microsoft Entra ID JWT (dashboard user). Signed-URL endpoints (end-user feedback links) take a `signature` query parameter instead. title: Neo Public API version: 1.0.0 servers: - url: https://api.neoagent.io security: [] tags: - description: Service metadata — health, OpenAPI. name: Meta - description: Agents and workflows — read, version history, delete, stats. name: Agents - description: Agent/workflow execution history, sub-resources, retry/cancel. name: Executions - description: >- Every tool call the tenant's agents made in the last 30 days, within the caller's workflow access. name: Audit Log - description: PSA webhook events and their workflow-match results. name: Callbacks - description: Technician-in-the-loop approval requests. name: TIL requests - description: RMM script executions triggered by agents. name: RMM scripts - description: Dispatch-agent field-update decisions. name: Dispatch - description: The authenticated tenant. name: Tenant - description: Agent-builder schema catalogs (raw JSON payloads). name: Schemas - description: Escalate to the Neo team (HubSpot ticket). name: Escalation - description: Tenant settings. name: Settings - description: Tenant API-key management (dashboard JWT only). name: API keys - description: End-user feedback links (signed-URL auth). name: Feedback - description: End-client companies (CRUD + bulk-update). name: End companies - description: Channels — bind a CONVERSATIONAL agent to a transport (Teams). name: Channels - description: PSA/RMM/M365 integration status and connection management. name: Integrations - description: Technician roster (controls TIL routing and paging). name: Technicians - description: Future runs queued for TRIGGERED agents. name: Scheduled work - description: Subscription state and customer-facing credit usage (no provider $). name: Billing - description: Inbox messages and announcements. name: Inbox & Comms - description: Tenant-authored agent skills (CRUD) and the built-in skill catalog. name: Skills paths: /public-api/billing/referrals: get: tags: - Billing summary: Get the tenant's referral program state description: >- The tenant's referral code, the MSP that referred it, and every MSP it referred, trials included: each one's stage and, once it moved to a paid plan, the monthly credits it adds and the date they stop. Also the rewards the tenant holds and the program terms. Credits only, never dollar amounts. operationId: public_api.billing_referrals_get parameters: [] responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/Referrals' meta: $ref: '#/components/schemas/SuccessMeta' required: - data - meta type: object description: Success. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Bad request — malformed input. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Unauthenticated — missing or invalid credentials. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Forbidden — authenticated but not allowed. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Not found. '409': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Conflict — the resource is in a state that blocks this operation. '422': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Request validation failed. '429': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Rate limited — see Retry-After. '500': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Internal server error. security: - bearerAuth: [] components: schemas: Referrals: description: >- The calling tenant's referral program state: its code, who referred it, the MSPs it referred, the rewards it holds, and the program terms. properties: monthly_referral_credits: title: Monthly Referral Credits type: integer program_monthly_credits: title: Program Monthly Credits type: integer program_term_months: title: Program Term Months type: integer program_welcome_credits: title: Program Welcome Credits type: integer referral_code: anyOf: - type: string - type: 'null' title: Referral Code referred_by: anyOf: - type: string - type: 'null' title: Referred By referred_msps: items: $ref: '#/components/schemas/ReferredMsp' title: Referred Msps type: array rewards: items: $ref: '#/components/schemas/ReferralReward' title: Rewards type: array required: - referral_code - referred_by - monthly_referral_credits - referred_msps - rewards - program_monthly_credits - program_term_months - program_welcome_credits title: Referrals type: object SuccessMeta: properties: pagination: $ref: '#/components/schemas/Pagination' request_id: format: uuid type: string timings_ms: additionalProperties: type: number type: object warnings: description: >- Non-fatal warnings about the created/updated resource (e.g. an unhealthy PSA callback). items: type: string type: array required: - request_id - timings_ms type: object ErrorEnvelope: properties: error: properties: code: description: Stable machine-readable error code. type: string details: additionalProperties: true type: object message: type: string required: - code - message type: object meta: properties: request_id: format: uuid type: - string - 'null' type: object required: - error - meta type: object ReferredMsp: description: >- An MSP the calling tenant referred. `stage` is `CONVERTED` once the MSP moved to a paid plan, and stays so if it later cancels. The `reward_*` fields are null while no reward is on record. properties: name: title: Name type: string reward_expires_at: anyOf: - format: date-time type: string - type: 'null' title: Reward Expires At reward_monthly_credits: anyOf: - type: integer - type: 'null' title: Reward Monthly Credits reward_started_at: anyOf: - format: date-time type: string - type: 'null' title: Reward Started At reward_status: anyOf: - $ref: '#/components/schemas/ReferralRewardStatus' - type: 'null' signed_up_at: anyOf: - format: date-time type: string - type: 'null' title: Signed Up At stage: $ref: '#/components/schemas/ReferredMspStage' trial_end_date: anyOf: - format: date-time type: string - type: 'null' title: Trial End Date required: - name - signed_up_at - stage - trial_end_date - reward_monthly_credits - reward_started_at - reward_expires_at - reward_status title: ReferredMsp type: object ReferralReward: description: >- A referral reward the calling tenant holds: monthly credits for an MSP it referred (`REFERRER`), or its own one-time welcome bonus (`REFERRED`). properties: cadence: $ref: '#/components/schemas/ReferralCadence' counterparty_name: title: Counterparty Name type: string credits: title: Credits type: integer expires_at: format: date-time title: Expires At type: string role: $ref: '#/components/schemas/ReferralRole' status: $ref: '#/components/schemas/ReferralRewardStatus' required: - role - cadence - counterparty_name - credits - expires_at - status title: ReferralReward type: object Pagination: properties: has_more: type: boolean next_cursor: type: - string - 'null' required: - next_cursor - has_more type: object ReferralRewardStatus: description: >- Soft lifecycle — no hard deletes. ACTIVE rewards contribute credits; the hourly job sweeps expired rewards to COMPLETED; an admin un-marking a referral CANCELs. enum: - ACTIVE - COMPLETED - CANCELLED title: ReferralRewardStatus type: string ReferredMspStage: description: >- Where an MSP this client referred stands. The referrer's reward starts at CONVERTED, so a TRIAL row is a reward still to come and a TRIAL_ENDED row is one that did not come. CONVERTED records the move to a paid plan and stays after a later cancellation: it is no billing status. enum: - TRIAL - TRIAL_ENDED - CONVERTED title: ReferredMspStage type: string ReferralCadence: description: >- How the reward pays out. MONTHLY refreshes a credit ceiling each calendar month; ONE_TIME is a single finite pool that depletes as it is spent. enum: - MONTHLY - ONE_TIME title: ReferralCadence type: string ReferralRole: description: Which side of a referral a reward beneficiary is on. enum: - REFERRER - REFERRED title: ReferralRole type: string securitySchemes: bearerAuth: description: >- `Authorization: Bearer ` where `` is either a `neo_sk__` API key (service account) or a Microsoft Entra ID access token (dashboard user). scheme: bearer type: http ````