---
title: "Reads the store's plan, with the day it ends when set to cancel and whether it can still be resumed, and the plan billed once its period ends (a scheduled change up or down, or the base plan a cancelled one lapses into), and every limit it sets each store, with what the store uses of it: storage, transcription minutes, customers (with where the countdown past the cap stands), pages, menu items and redirects (with how many are kept inactive past what the store applies), features, the add-on blocks of storage and AI media minutes the store holds, where the business stands against its plan, what keeps it from moving to Lite and the plan change last called off for it (over its limits, or a move to the plan it holds for good or under it), and the marketing emails it may send a month, whose use is not reported yet."
---

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

Path: Sherpo merchant API › site

`GET /v1/stores/{store}/plan_usage`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `site:read`

## Path parameters

- `store` (`getPlanUsage.path.store`; string, required) — The store's id.

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sherpo.io/merchant/v1/stores/<store>/plan_usage' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/plan_usage';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/merchant/v1/stores/<store>/plan_usage"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Reads the store's plan, with the day it ends when set to cancel and whether it can still be resumed, and the plan billed once its period ends (a scheduled change up or down, or the base plan a cancelled one lapses into), and every limit it sets each store, with what the store uses of it: storage, transcription minutes, customers (with where the countdown past the cap stands), pages, menu items and redirects (with how many are kept inactive past what the store applies), features, the add-on blocks of storage and AI media minutes the store holds, where the business stands against its plan, what keeps it from moving to Lite and the plan change last called off for it (over its limits, or a move to the plan it holds for good or under it), and the marketing emails it may send a month, whose use is not reported yet.

#### Example

```json
{
  "plan": {
    "key": "string",
    "tier": "string",
    "name": "string",
    "ends_at": "string",
    "resumable": true,
    "scheduled": {
      "key": "string",
      "tier": "string",
      "name": "string",
      "at": "string"
    }
  },
  "metered": {
    "storage": {
      "used_bytes": 0,
      "allowance_bytes": 0
    },
    "transcription": {
      "used_minutes": 0,
      "allowance_minutes": 0,
      "renews_at": "string"
    },
    "marketing_emails": {
      "used": 0,
      "allowance": 0
    }
  },
  "add_ons": {
    "storage": 0,
    "minutes": 0
  },
  "auto_upgrade": true,
  "within_lite": true,
  "over_lite": [
    "string"
  ],
  "change_refusal": {
    "at": "string",
    "over": [
      "string"
    ],
    "unsure": [
      "string"
    ],
    "base": {
      "key": "string",
      "tier": "string",
      "name": "string"
    }
  },
  "standing": {
    "phase": "string",
    "trigger": "string",
    "over": [
      "string"
    ],
    "near": [
      "string"
    ],
    "since": "string",
    "unlocks_pause_at": "string",
    "suspend_at": "string",
    "delete_at": "string",
    "hold_until": "string",
    "upgrade_at": "string"
  },
  "counts": {
    "customers": {
      "used": 0,
      "limit": 0,
      "standing": {
        "status": "string",
        "pause_at": null
      }
    },
    "pages": {
      "used": 0,
      "limit": 0,
      "inactive": 0
    },
    "menu": {
      "used": 0,
      "limit": 0,
      "inactive": 0
    },
    "internal_redirects": {
      "used": 0,
      "limit": 0,
      "inactive": 0
    },
    "external_redirects": {
      "used": 0,
      "limit": 0,
      "inactive": 0
    }
  },
  "features": {
    "domain": true,
    "unbranded": true,
    "stylesheet": true,
    "learning": true,
    "self_hosted": true,
    "ai": true
  }
}
```

- `plan` (`getPlanUsage.response.200.plan`; any of, required)
  - any of: `object`, `null`
- `metered` (`getPlanUsage.response.200.metered`; object, required)
  - `storage` (`getPlanUsage.response.200.metered.storage`; object, required)
    - `used_bytes` (`getPlanUsage.response.200.metered.storage.used_bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `allowance_bytes` (`getPlanUsage.response.200.metered.storage.allowance_bytes`; number, required)
  - `transcription` (`getPlanUsage.response.200.metered.transcription`; object, required)
    - `used_minutes` (`getPlanUsage.response.200.metered.transcription.used_minutes`; number, required)
    - `allowance_minutes` (`getPlanUsage.response.200.metered.transcription.allowance_minutes`; number, required)
    - `renews_at` (`getPlanUsage.response.200.metered.transcription.renews_at`; any of, required)
      - any of: `string`, `null`
  - `marketing_emails` (`getPlanUsage.response.200.metered.marketing_emails`; object, required)
    - `used` (`getPlanUsage.response.200.metered.marketing_emails.used`; any of, required)
      - any of: `number`, `null`
    - `allowance` (`getPlanUsage.response.200.metered.marketing_emails.allowance`; any of, required)
      - any of: `number`, `null`
- `add_ons` (`getPlanUsage.response.200.add_ons`; object, required)
  - `storage` (`getPlanUsage.response.200.add_ons.storage`; number, required)
  - `minutes` (`getPlanUsage.response.200.add_ons.minutes`; number, required)
- `auto_upgrade` (`getPlanUsage.response.200.auto_upgrade`; boolean, required)
- `within_lite` (`getPlanUsage.response.200.within_lite`; boolean, required)
- `over_lite` (`getPlanUsage.response.200.over_lite`; array<string>, required)
- `change_refusal` (`getPlanUsage.response.200.change_refusal`; any of, required)
  - any of: `object`, `null`
- `standing` (`getPlanUsage.response.200.standing`; any of, required)
  - any of: `object`, `null`
- `counts` (`getPlanUsage.response.200.counts`; object, required)
  - `customers` (`getPlanUsage.response.200.counts.customers`; object, required)
    - `used` (`getPlanUsage.response.200.counts.customers.used`; number, required)
    - `limit` (`getPlanUsage.response.200.counts.customers.limit`; any of, required)
      - any of: `number`, `null`
    - `standing` (`getPlanUsage.response.200.counts.customers.standing`; any of, required)
      - any of: `object`, `object`, `null`
  - `pages` (`getPlanUsage.response.200.counts.pages`; object, required)
    - `used` (`getPlanUsage.response.200.counts.pages.used`; number, required)
    - `limit` (`getPlanUsage.response.200.counts.pages.limit`; number, required)
    - `inactive` (`getPlanUsage.response.200.counts.pages.inactive`; number, required)
  - `menu` (`getPlanUsage.response.200.counts.menu`; object, required)
    - `used` (`getPlanUsage.response.200.counts.menu.used`; number, required)
    - `limit` (`getPlanUsage.response.200.counts.menu.limit`; number, required)
    - `inactive` (`getPlanUsage.response.200.counts.menu.inactive`; number, required)
  - `internal_redirects` (`getPlanUsage.response.200.counts.internal_redirects`; object, required)
    - `used` (`getPlanUsage.response.200.counts.internal_redirects.used`; number, required)
    - `limit` (`getPlanUsage.response.200.counts.internal_redirects.limit`; number, required)
    - `inactive` (`getPlanUsage.response.200.counts.internal_redirects.inactive`; number, required)
  - `external_redirects` (`getPlanUsage.response.200.counts.external_redirects`; object, required)
    - `used` (`getPlanUsage.response.200.counts.external_redirects.used`; number, required)
    - `limit` (`getPlanUsage.response.200.counts.external_redirects.limit`; number, required)
    - `inactive` (`getPlanUsage.response.200.counts.external_redirects.inactive`; number, required)
- `features` (`getPlanUsage.response.200.features`; object, required)
  - `domain` (`getPlanUsage.response.200.features.domain`; boolean, required)
  - `unbranded` (`getPlanUsage.response.200.features.unbranded`; boolean, required)
  - `stylesheet` (`getPlanUsage.response.200.features.stylesheet`; boolean, required)
  - `learning` (`getPlanUsage.response.200.features.learning`; boolean, required)
  - `self_hosted` (`getPlanUsage.response.200.features.self_hosted`; boolean, required)
  - `ai` (`getPlanUsage.response.200.features.ai`; boolean, required)

### default

A problem; see https://api.sherpo.io/merchant/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`getPlanUsage.response.default.type`; string, required)
  - format `uri`
- `title` (`getPlanUsage.response.default.title`; string, required)
- `status` (`getPlanUsage.response.default.status`; integer, required)
- `detail` (`getPlanUsage.response.default.detail`; string, required)
- `code` (`getPlanUsage.response.default.code`; string, optional)
- `context` (`getPlanUsage.response.default.context`; object, optional)
- `reached_core` (`getPlanUsage.response.default.reached_core`; boolean, optional)
- `core_answer` (`getPlanUsage.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/get-plan-usage/index.md
