UnmarkdownDocs

Usage

Check your current plan tier, API call consumption, and remaining quota for the current billing period.

The usage endpoint provides a snapshot of your current account status, including your plan tier, API call consumption for the current month, and when the quota resets.

Note
This endpoint does not count toward your monthly API quota.
GET/v1/usage

Retrieve your current plan usage and limits.

Request

bash
curl https://api.unmarkdown.com/v1/usage \
  -H "Authorization: Bearer um_your_api_key"

Response

json
{
  "used": 247,
  "limit": 1000,
  "remaining": 753,
  "month": "2026-02",
  "reset_date": "2026-03-01T00:00:00Z",
  "tier": "free"
}

Error Response

json
{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key"
  }
}

Status Codes

StatusDescription
200Success
401Missing or invalid API key
429Rate limit exceeded
500Internal server error

Understanding the Response

  • used: Number of API calls made in the current billing period
  • limit: Maximum API calls allowed per month (1,000 for Free, 10,000 for Pro)
  • remaining: Calls remaining before quota is exhausted
  • month: Current billing period in YYYY-MM format (UTC)
  • reset_date: ISO 8601 timestamp when the quota resets (first day of next month)
  • tier: Your current plan, either free or pro
TemplatesAuthentication