Get Usage

Retrieve your account’s usage statistics and limits using the Docstron API. This endpoint provides information about your current usage of applications, templates, documents, and subscription details including rate limits and support level.

Endpoint

GET https://api.docstron.com/v1/usage

Authentication

This endpoint requires authentication using a Bearer token. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Parameters

This endpoint does not require any parameters.

Request Examples

curl --location 'https://api.docstron.com/v1/usage' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data ''

Response

---

200 - Success Response

{
  "success": true,
  "message": "Usage statistics retrieved successfully",
  "data": {
    "applications": {
      "total": 1,
      "limit": 1,
      "usage_percentage": 100.0
    },
    "templates": {
      "total": 2,
      "limit": 2,
      "usage_percentage": 100.0
    },
    "documents": {
      "total": 7,
      "monthly": 7,
      "usage": 9,
      "monthly_limit": 50,
      "usage_percentage": 14.0
    },
    "subscription": {
      "plan_name": "Trial",
      "api_rate_limit": 2,
      "processing_priority": "standard",
      "support_level": "email"
    }
  }
}

Response Fields

Field	Type	Description
success	boolean	Indicates if the request was successful
message	string	A message describing the response
data.applications.total	integer	Current number of applications created
data.applications.limit	integer	Maximum number of applications allowed
data.applications.usage_percentage	float	Percentage of application limit used
data.templates.total	integer	Current number of templates created
data.templates.limit	integer	Maximum number of templates allowed
data.templates.usage_percentage	float	Percentage of template limit used
data.documents.total	integer	Total number of documents created
data.documents.monthly	integer	Number of documents created this month
data.documents.usage	integer	Current document usage count
data.documents.monthly_limit	integer	Maximum number of documents allowed per month
data.documents.usage_percentage	float	Percentage of monthly document limit used
data.subscription.plan_name	string	Name of the current subscription plan
data.subscription.api_rate_limit	integer	API requests allowed per second
data.subscription.processing_priority	string	Processing priority level (e.g., “standard”, “priority”)
data.subscription.support_level	string	Type of support available (e.g., “email”, “priority”, “dedicated”)

Error Responses

---

500 - Internal Server Error

Returned when an unexpected server error occurs while retrieving usage statistics.

{
  "success": false,
  "message": "Failed to fetch usage statistics.",
  "data": []
}

Common causes:

• Temporary server issue
• Database connectivity problem
• Service maintenance

Solution: Wait a few moments and retry the request. If the problem persists, contact support@docstron.com.

Need Help?

If you have questions about applications or need assistance:

• 📧 Email: support@docstron.com
• 💬 Live Chat: Available in your dashboard
• 📚 Documentation: You’re reading it!