Referral Program

Switch the programme off

curl -X POST https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/referral-program/deactivate \
  -H "Authorization: Bearer sbt_..." \
  -H "Idempotency-Key: $(uuidgen)"

The safe way to stop: links stop attributing and payments stop earning at once, while the ledger and the payouts stay readable and every affiliate is told their link no longer counts new friends. Emits referral.program_updated. Answers 200 with the programme.

post/v1/projects/{project}/referral-program/deactivate

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/referral-program/deactivate
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

Headers

Idempotency-Keystring uuid required

A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.

Response

The programme after the change.

Example response

{
  "data": {
    "id": "6e2a7a4f-3b8c-4c21-9f6d-2a3b4c5d6e7f",
    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
    "active": true,
    "reward_kind": "cash",
    "commission_type": "percentage",
    "commission_value": "20.0000",
    "commission_period_months": 6,
    "hold_days": 14,
    "minimum_payout": "50.0000",
    "friend_reward_kind": "free_days",
    "friend_reward_days": 3,
    "payout_details_label": "PayPal email",
    "terms": "One referral per household.",
    "created_at": "2026-10-01T09:14:02+00:00",
    "updated_at": "2026-10-08T16:41:11+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.