Skip to article
Documentation menu

Manage your programme

Deactivate and reactivate

Stop new participation without removing earned rewards.

Stop new participation, keep existing obligations

Use Customer access to deactivate an enrolled customer. This stops new promotion-code redemptions, attribution, referral access and asks for that customer.

Their old links still lead to your destination. Already applied credits and discounts remain. Previously attributed referrals and earned obligations continue, even while deactivated, under the usual payment, hold, refund and billing rules.

Signing in, requesting a widget, sending a moment or receiving a Stripe event never reactivates them. An explicit owner or server API action is required.

Change participation from your server

Call PATCH /api/v1/referrers with the same server API key. The customer must already be enrolled in the connected account and mode. active must be a JSON boolean.

Server · cURL (deactivate)
curl -X PATCH https://refersprout.com/api/v1/referrers \
  -H "Authorization: Bearer $REFERSPROUT_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"customer_id":"cus_example","active":false}'
200 · JSON
{
  "referrer": {
    "referrer_id": "00000000-0000-4000-8000-000000000001",
    "active": false
  }
}

To reactivate, send the same request with active: true. New participation resumes only after provider synchronisation succeeds; it uses the existing code and preserves history.

If lifecycle_sync_failed or lifecycle_busy occurs, finish the same change before requesting its opposite. Do not assume the provider promotion code changed until confirmed. Error handling →

Reactivation does not reset usage or ask limits

Reactivation restores new participation, not a clean slate. Shown, copy and negative-feedback windows are retained. A percentage reward still waits for an active subscription if needed.

Deactivation does not subtract this month's usage. Reactivation can add usage if the customer has not already counted this month. If it is refused, check Billing or contact support. Repeated toggles never multiply a customer's count in the same period.