> ## Documentation Index
> Fetch the complete documentation index at: https://docs.screenshotly.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get usage

> GET /v1/screenshots/usage — check your current screenshot usage and remaining credits.

## Endpoint

```
GET https://api.screenshotly.dev/v1/screenshots/usage
```

## Headers

| Header      | Required | Description  |
| ----------- | -------- | ------------ |
| `X-API-Key` | Yes      | Your API key |

## Response

### 200 OK

```json theme={null}
{
  "success": true,
  "data": {
    "subscription": {
      "status": "active",
      "plan": "STARTER"
    },
    "plan": {
      "id": "starter",
      "name": "Starter",
      "limits": {
        "monthly": {
          "screenshots": 5000,
          "storage": "5 GB"
        }
      }
    },
    "limit": 5000,
    "usage": 1234,
    "remaining": 3766,
    "percentUsed": 25
  }
}
```

### Response fields

<ResponseField name="data.subscription" type="object">
  Your current subscription status and plan name.
</ResponseField>

<ResponseField name="data.plan" type="object">
  Details of your plan including limits and features.
</ResponseField>

<ResponseField name="data.limit" type="number">
  Total monthly screenshot allowance.
</ResponseField>

<ResponseField name="data.usage" type="number">
  Screenshots captured this month.
</ResponseField>

<ResponseField name="data.remaining" type="number">
  Remaining screenshots available this month.
</ResponseField>

<ResponseField name="data.percentUsed" type="number">
  Percentage of monthly limit used (0–100).
</ResponseField>

## Example

```bash theme={null}
curl https://api.screenshotly.dev/v1/screenshots/usage \
  -H "X-API-Key: $SCREENSHOTLY_API_KEY"
```