VPSBG's dev hub
HomePricingKnowledge BaseContact us
HomePricingKnowledge BaseContact us
  1. Affiliate
  • 👋 Hello
  • API Introduction
    • API Introduction
    • How to generate API key?
  • API Reference
    • User
      • 2FA
        • Get 2FA secret key
        • Enable 2FA
        • Disable 2FA
      • Update user
      • Get account information
    • Balance
      • Balance
      • Deposit funds
      • List balance transactions
    • Affiliate
      • Get affiliate information
        GET
      • List conversions
        GET
      • List payouts
        GET
      • Activate affiliate program
        POST
      • Update referral code
        PUT
    • Invoices
      • List invoices
      • Download an invoice
      • Download invoices
    • Support
      • Tickets
        • List tickets
        • List departments
        • List related services
        • Get a ticket
        • Create new ticket
        • Reply to ticket
        • Mark ticket as resolved
        • Download attachment
      • List plans
      • Purchase support plan
      • Renew support plan
      • Cancel support plan
      • Undo cancel request
    • SSH Keys
      • Get an SSH Key
      • Update SSH Key
      • Delete SSH Key
      • List SSH keys
      • Add SSH Key
    • Servers
      • Scale
        • List plans
        • Calculate scale cost
        • Scale a server
      • Addons
        • List available addons
        • Scale addons
        • Calculate scale cost
        • Purchase new addons
        • Cancel addon
        • Undo cancel request
      • Rescue
        • Enable rescue mode
        • Disable rescue mode
      • List plans
      • List servers
      • Server status
      • Get a server
      • Server metrics
      • Bandwidth
      • Deploy new server
      • Start a server
      • Restart a server
      • Stop a server
      • Power off
      • Cancel server
      • Undo cancel request
      • Change password
      • Update hostname
      • Update SSH Keys
      • Modify ISOs
      • Restore
      • Renew server
      • Reinstall Server
      • Change Primary IP
      • Calculate renew amount
    • Plans
      • Plan addon
      • Plan promo-codes
    • Snapshots
      • List snapshots
      • Delete snapshot
    • Backups
      • List backups
      • Delete backup
    • Server Images
      • List server images
    • Floating IPs
      • List Floating IPs
      • Plans
      • Purchase Floating IPs
      • Attach Floating IP
      • Detach Floating IP
      • Cancel Floating IP
      • Delete Floating IP Cancellation
    • IP Addresses
      • Update IP address
    • Network Protection
      • Geo filter
        • Get current geo filter
        • Set geo filter
        • Update geo filter
        • Delete geo filter
      • Whitelist
        • Get status and list of IPs
        • Whitelist IP addresses
        • Update IP addresses list
        • Delete all rules
      • Blacklist
        • Get status and list of IPs
        • Blacklist IP addresses
        • Update IP addresses list
        • Delete all rules
      • General information
      • Bandwidth
      • List blocked IPs
      • List attacks
      • Get an attack
      • Attack bandwidth
    • Orders
      • List orders
      • Get an order
      • Delete order
      • Pay orders
      • Update order
      • Change renewal period
    • ISOs
      • Get an ISO
      • Delete an ISO
      • List ISOs
      • Add ISO
  1. Affiliate

Update referral code

PUT
/affiliate
Affiliate
You can use this endpoint to update your affiliate referral code. You old referral links will continue to work properly.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
Accept
string 
required
Default:
application/json
Body Params application/json
referral_code
string 
required
>= 5 characters<= 20 characters
Example
{
  "referral_code": "myawesomewebsite"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.vpsbg.eu/v1/affiliate' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "referral_code": "myawesomewebsite"
}'

Responses

🟢200Updated referral code
application/json
Body
referral_code
string 
required
referral_url
string 
required
referrals_turnover
integer 
required
commission
integer 
required
estimated_earnings
number 
required
all_time_earnings
number 
required
next_payout_in_days
integer 
required
Example
{
  "referral_code": "myawesomewebsite2",
  "referral_url": "https://www.vpsbg.eu/aff/myawesomewebsite2",
  "referrals_turnover": 30,
  "commission": 5,
  "estimated_earnings": 1.5,
  "all_time_earnings": 1.5,
  "next_payout_in_days": 15
}
🔴500Server Error
Modified at 2024-09-18 10:09:22
Previous
Activate affiliate program
Next
List invoices
Built with