Get user's referral bonus info

GET /v1/client/promotions/referral-bonus

Header api token & Header user Query api token & Query user Header bearer token

Allow a user to view information regarding it's referral from another user.

Responses

200 application/json

OK
Hide response attribute Show response attribute object
- data object
  
  Hide data attributes Show data attributes object
  
  active boolean Required
  
  If there is an active status or not. This also works for expired status.
  
  valid_until string(RFC3339)
  
  The end of the bonus period in RFC3339.
  
  commission_percentage number(double)
  
  The bonus multiplier of the user.

GET /v1/client/promotions/referral-bonus

curl \
 --request GET 'https://api.bitlabs.ai/v1/client/promotions/referral-bonus' \
 --header "X-Api-Token: $API_KEY" \
 --header "X-User-Id: $API_KEY"

Response examples (200)

{
  "data": {
    "active": true,
    "valid_until": "2020-05-04T17:01:30Z",
    "commission_percentage": 12.5
  },
  "status": "success",
  "trace_id": "2050914de1c94427"
}