---
title: "Retrieve the plan usage"
description: "The shop's current STOQ plan, the limits it includes, and a calendar month's usage against them (back-in-stock email and SMS alerts, SMS segments, preorders)."
url: https://docs.stoqapp.com/v2-reference/account-plan-usage/retrieve-the-plan-usage/
api: "API v2 reference"
method: GET
path: "/account/plan_usage"
---

# Retrieve the plan usage

`GET https://app.stoqapp.com/api/v2/external/account/plan_usage`

The shop's current STOQ plan, the limits it includes, and a calendar month's usage against them (back-in-stock email and SMS alerts, SMS segments, preorders).

**Note:** usage.by_template splits the month's back-in-stock email and SMS alerts by notification template, as the usage card's breakdown does: template_position 0 is the back-in-stock alert, 1 the first reminder.

## Query parameters

- `period` (string)

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Example request

```sh
curl "https://app.stoqapp.com/api/v2/external/account/plan_usage" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check `Retry-After`.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```