Back

GET api/v1/Users/UsageRemaining

Requires Authorization

To get information on the units remaining for the logged in user for RMAIL productline.

Request Information

URI Parameters

None.

Body Parameters

None.

Sample Request

Response Information

Resource Description

UserUsageRemainingViewModel
NameDescriptionTypeAdditional information
PlanName

User's current plan

 string

None.
OnTrialPlan

True if the user is on a trial plan, false otherwise

 boolean

None.
PlanType

Plan type - Individual/Shared

 string

None.
PlanRange

Plan range - Monthly/Yearly

 string

None.
UnitsRemaining

Units left on the plan. If the user is on a shared plan, units remaining would be null

 integer

None.
AllowedUnits

Units allowed on the plan

 integer

None.
UnitsSent

Units Sent

 integer

None.

Sample Response

application/json, text/json

Sample: 
{
  "PlanName": "RSign-Standard-USD-RP",
  "OnTrialPlan": false,
  "PlanType": "Individual",
  "PlanRange": "Monthly",
  "UnitsRemaining": 25,
  "AllowedUnits": 100,
  "UnitsSent": 75
}