logoshorty

GET /v1/usage

Get plan, limits, and usage — Shorty API

Returns the authenticated account’s plan (Free / Premium / Pro), tier limits (upload sizes, real-time minutes, conversion caps), and current cloud-conversion usage against the daily quota.

Open in ClaudeOpen in ChatGPT
GET /v1/usage

Returns the authenticated account’s plan (Free / Premium / Pro), tier limits (upload sizes, real-time minutes, conversion caps), and current cloud-conversion usage against the daily quota.

Authentication

Requires a Bearer credential — a shk_live_ API key or an OAuth 2.1 access token with the scope for this resource. See Authentication.

Example request

curl -X GET https://aishorty.com/v1/v1/usage \
  -H "Authorization: Bearer shk_live_your_key"

Response · 200

FieldTypeRequiredDescription
planUsagePlanYes—
subscriptionUsageSubscriptionYes—
limitsUsageLimitsYes—
usageUsageCountersYes—

Errors

On failure this endpoint returns an RFC 9457 problem body. Possible statuses:

  • 401
  • 403
  • 429
  • 500

Switch on the problem code, not the status. See the error reference for every code and how to fix it.