Back

GET api/v1/Users/ProductlineUsageRemaining

Requires Authorization

To get information on the units remaining for the logged in user for RMAIL/RSign/RDocs productlines.

Request Information

URI Parameters

None.

Body Parameters

None.

Sample Request

Response Information

Resource Description

UserProductLIneUsageRemainingViewModel

Name	Description	Type	Additional information
UserName	User email address	string	None.
RMailUsage	RMail Usage	UserProductLineUsageModel	None.
RSignUsage	RSign Usage	UserProductLineUsageModel	None.
RDocsUsage	RDocs Usage	UserProductLineUsageModel	None.

Sample Response

application/json, text/json

Sample:

{
  "UserName": "sample string 1",
  "RMailUsage": {
    "PlanName": "sample string 2",
    "PlanType": "sample string 3",
    "PlanRange": "sample string 4",
    "AllowedUnits": 1,
    "UnitsSent": 1,
    "OnTrialPlan": true,
    "UnitsRemaining": 1
  },
  "RSignUsage": {
    "PlanName": "sample string 2",
    "PlanType": "sample string 3",
    "PlanRange": "sample string 4",
    "AllowedUnits": 1,
    "UnitsSent": 1,
    "OnTrialPlan": true,
    "UnitsRemaining": 1
  },
  "RDocsUsage": {
    "PlanName": "sample string 2",
    "PlanType": "sample string 3",
    "PlanRange": "sample string 4",
    "AllowedUnits": 1,
    "UnitsSent": 1,
    "OnTrialPlan": true,
    "UnitsRemaining": 1
  }
}