---
title: "Suspend an affiliate"
method: POST
path: "/v1/projects/{project}/referral-affiliates/{affiliate}/suspend"
tags: ["Referral Program"]
---

# Suspend an affiliate

`POST /v1/projects/{project}/referral-affiliates/{affiliate}/suspend`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/projects/{project}/referral-affiliates/{affiliate}/suspend`
- Auth: HTTP bearer

Their code stops counting new friends and nothing new is earned; what they already earned stays and can still be paid. Emits `referral.affiliate_suspended`. Answers `200` with the affiliate.

## Path parameters

- `project` string, uuid, required
- `affiliate` string, uuid, required

## Headers

- `Idempotency-Key` string, uuid, required

## Response `200`

The affiliate after the change.

- object
  - `data` ReferralAffiliateResource, required: A member enrolled in the Referral Program: their code, whether they are approved, the membership days they hold on balance and, on a single read, what they are owed per currency. Never their payout details.
    - `id` string, required: The affiliate's id.
    - `project_id` string, required: The project the programme belongs to.
    - `program_id` string, required: The programme they joined.
    - `member_id` string, required: The member, as the members endpoints list them.
    - `code` string, required: The code their friends type at checkout and their links carry; unique within the project.
    - `status` string, required: `pending` (awaiting the creator's approval), `approved` (their code counts) or `suspended` (their code no longer counts; what they earned stays).
    - `days_balance` integer, required: Membership days earned while they held no live membership, banked onto their next purchase.
    - `balances` unknown[]: What they are owed per currency, present on a single read and on every write, not on a list row. Each entry carries `currency_id` and four decimal strings with four places: `pending` (commissions still inside the hold), `earned` (every commission earned in the currency, held, payable or paid), `payable` (past the hold and not yet paid out: what a payout may record) and `paid_out` (recorded as paid).
      - unknown
    - `joined_at` string, nullable, required: When they joined, ISO 8601.
    - `approved_at` string, nullable, required: When the creator approved them, ISO 8601; null while pending.
    - `created_at` string, nullable, required: When the row was written, ISO 8601.
    - `updated_at` string, nullable, required: When it last changed, ISO 8601.

## Other responses

- `400`: `IDEMPOTENCY_KEY_MISSING`: every write needs an `Idempotency-Key` header. Send a fresh UUID per distinct operation.
- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `409`: `IDEMPOTENCY_KEY_REUSED`: the key was already used in the last 24 hours with a different request body.
- `425`: `IDEMPOTENCY_REPLAY_IN_PROGRESS`: the first request with this key is still running; retry in a few seconds and the original response is replayed.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)