1. Cookbook
TunnelSats Public Wireguard API
  • Announcements
    • 👋 About our team
    • 💫 What is TunnelSats?
    • 🚀 Introducing the TunnelSats Public API v1
    • 🧩 How the TunnelSats StartOS Package Uses the Public API
    • How TunnelSats Leverages Public APIs for Confined VPN Management
  • 📡 Discovery
    • List Available WireGuard Servers & Regions
      GET
  • ⚡ Purchase
    • Create a New WireGuard Subscription (Invoice Generation)
      POST
    • Check Invoice Status & Polling by Payment Hash
      GET
    • Claim WireGuard Configuration After Payment Settlement
      POST
  • 🔄 Lifecycle
    • Get Subscription & Bandwidth Status by WireGuard Public Key
      POST
    • Sync Subscription (Real-Time Server Refresh)
      POST
    • Renew an Existing VPN Subscription (Anonymous)
      POST
    • Request Bandwidth Top-Up ($1 for +100GB)
      POST
  • 🔑 Account
    • List Account Subscriptions (Authenticated)
      GET
    • Create Referral Code
      POST
    • Get Referral Code
      GET
    • Referral History
      GET
  • 🔧 Tools
    • Lightning Node Network Address Discovery
    • Universal Connectivity & Latency Probe
  • Cookbook
    • 🛠️ Automation & Code Examples
    • 🐚 Bash One-Liners
    • 🚑 Node Health & Upkeep
    • ⚡ Bandwidth Top-Up ($1 for +100GB)
    • 🛡️ Security & Authentication
    • 🎁 Referral Program: Earn Bonus Months
    • 🛑 Error Codes & Troubleshooting
  • Schemas
    • Server
    • InvoiceOrder
    • SubscriptionStatus
    • NodeLookup
    • ConnectivityResult
    • ApiError
    • ClaimResult
    • BandwidthResetResponse
    • PublicKeyStatusResponse
    • ReferralCode
    • ReferralHistory
    • BandwidthResetPaymentStatus
    • RenewalOrder
    • SubscriptionListItem
    • SyncResult
Tunnelsats Github
Tunnelsats Telegram
  1. Cookbook

🎁 Referral Program: Earn Bonus Months

The TunnelSats Referral Program allows developers and partners to earn bonus VPN months by onboarding new users. Whether you are building a node management dashboard or sharing your code with the community, you can automate your rewards.

📈 How It Works#

Partners earn bonus time based on the subscription duration purchased by the referred user.
Plan PurchasedBonus Earned by Partner
3-Month Plan+1 Month Free
6-Month Plan+2 Months Free
12-Month Plan+3 Months Free

🛠️ Developer Integration#

You can integrate your referral code directly into the programmatic purchase flow to ensure every new subscription is linked to your account.
Linking a Referral
Managing Codes
[Referral during Creation]
Include your referralCode in the initial POST /api/public/v1/subscription/create request to track the conversion from the start.
Request Example:
Create Subscription API Reference

💡 Partner Best Practices#

[Plan Restrictions]
Referral bonuses are applied only to 3, 6, and 12-month plans. Standard 1-month subscriptions do not trigger referral bonuses.
[Automatic Application]
Bonus months are automatically added to your primary active subscription linked to your authenticated account.
Modified at 2026-09-27 20:28:55
Previous
🛡️ Security & Authentication
Next
🛑 Error Codes & Troubleshooting
Built with