Back

GET api/v1/Users/TrialStatus?username={username}

Requires Authorization

To get information on the trial units left for an user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
username

Username/emailaddress

 string

Required

Body Parameters

None.

Sample Request

Response Information

Resource Description

UserTrialStatusViewModel
NameDescriptionTypeAdditional information
Username

Username/Emailaddress of the user.

 string

None.
OnTrial

States if the User is on trial or not.True if on trial, false otherwise.

 boolean

None.
TrialUnitsLeft

The number of trial units left if the User is on trial. For an user not on trial, it is always zero.

 integer

None.
UpgradeLink

Upgrade link for trial user

 string

None.
AccountMsg

If new user , appropriate message will be displayed

 string

None.

Sample Response

application/json, text/json

Sample: 
{
  "Username": "name@example.com",
  "OnTrial": true,
  "TrialUnitsLeft": 4,
  "UpgradeLink": null,
  "AccountMsg": null
}