Check referral reward eligibility

Check if a specific account or service is eligible for a referral reward. May suggest a suitable account if none is specified.

Headers

Accept Example

Content-Type Example

Responses

200

success boolean

timestamp string

requestId string

data object

GET https://cloud.hostup.se/api/referral/reward-target

For AI assistants

cURL

curl -X GET "https://cloud.hostup.se/api/referral/reward-target" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "success": true,
  "timestamp": "string",
  "requestId": "string",
  "data": {
    "targetAccountId": "string",
    "targetValid": true,
    "suggestedAccountId": "string",
    "accounts": [
      {
        "accountId": "string",
        "name": "string",
        "status": "string",
        "nextDue": "string",
        "expires": "string"
      }
    ]
  }
}

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "timestamp": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "targetAccountId": {
          "type": "string",
          "nullable": true
        },
        "targetValid": {
          "type": "boolean"
        },
        "suggestedAccountId": {
          "type": "string"
        },
        "accounts": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "accountId": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "nextDue": {
                "type": "string"
              },
              "expires": {
                "type": "string",
                "nullable": true
              }
            }
          }
        }
      }
    }
  }
}