---
title: "Reads the store's storage use against its plan's allowance, and the time zone its files' deliveries are dated in."
---

> 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 › file

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

## Authentication

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

## Path parameters

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

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/quota';
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>/quota"

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

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

print(response.text)
```

## Responses

### 200

Reads the store's storage use against its plan's allowance, and the time zone its files' deliveries are dated in.

#### Example

```json
{
  "used_bytes": 0,
  "assets": 0,
  "allowance_bytes": 0,
  "available_bytes": 0,
  "by_type": {
    "video": {
      "bytes": 0,
      "assets": 0
    },
    "audio": {
      "bytes": 0,
      "assets": 0
    },
    "image": {
      "bytes": 0,
      "assets": 0
    },
    "document": {
      "bytes": 0,
      "assets": 0
    },
    "other": {
      "bytes": 0,
      "assets": 0
    }
  },
  "by_enforcement": {
    "public": {
      "bytes": 0,
      "assets": 0
    },
    "external": {
      "bytes": 0,
      "assets": 0
    },
    "signed": {
      "bytes": 0,
      "assets": 0
    }
  },
  "by_destination": {
    "product": {
      "bytes": 0,
      "assets": 0
    },
    "entry": {
      "bytes": 0,
      "assets": 0
    },
    "store": {
      "bytes": 0,
      "assets": 0
    },
    "quiz": {
      "bytes": 0,
      "assets": 0
    },
    "certificate": {
      "bytes": 0,
      "assets": 0
    },
    "holding": {
      "bytes": 0,
      "assets": 0
    },
    "page": {
      "bytes": 0,
      "assets": 0
    }
  },
  "unused": {
    "bytes": 0,
    "assets": 0
  },
  "time_zone": "string"
}
```

- `used_bytes` (`getQuota.response.200.used_bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
- `assets` (`getQuota.response.200.assets`; number, required)
- `allowance_bytes` (`getQuota.response.200.allowance_bytes`; number, required)
- `available_bytes` (`getQuota.response.200.available_bytes`; number, required)
- `by_type` (`getQuota.response.200.by_type`; object, required)
  - `video` (`getQuota.response.200.by_type.video`; object, required)
    - `bytes` (`getQuota.response.200.by_type.video.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `assets` (`getQuota.response.200.by_type.video.assets`; number, required)
  - `audio` (`getQuota.response.200.by_type.audio`; object, required)
    - `bytes` (`getQuota.response.200.by_type.audio.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `assets` (`getQuota.response.200.by_type.audio.assets`; number, required)
  - `image` (`getQuota.response.200.by_type.image`; object, required)
    - `bytes` (`getQuota.response.200.by_type.image.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `assets` (`getQuota.response.200.by_type.image.assets`; number, required)
  - `document` (`getQuota.response.200.by_type.document`; object, required)
    - `bytes` (`getQuota.response.200.by_type.document.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `assets` (`getQuota.response.200.by_type.document.assets`; number, required)
  - `other` (`getQuota.response.200.by_type.other`; object, required)
    - `bytes` (`getQuota.response.200.by_type.other.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `assets` (`getQuota.response.200.by_type.other.assets`; number, required)
- `by_enforcement` (`getQuota.response.200.by_enforcement`; object, required)
  - `public` (`getQuota.response.200.by_enforcement.public`; object, required)
    - `bytes` (`getQuota.response.200.by_enforcement.public.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `assets` (`getQuota.response.200.by_enforcement.public.assets`; number, required)
  - `external` (`getQuota.response.200.by_enforcement.external`; object, required)
    - `bytes` (`getQuota.response.200.by_enforcement.external.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `assets` (`getQuota.response.200.by_enforcement.external.assets`; number, required)
  - `signed` (`getQuota.response.200.by_enforcement.signed`; object, required)
    - `bytes` (`getQuota.response.200.by_enforcement.signed.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `assets` (`getQuota.response.200.by_enforcement.signed.assets`; number, required)
- `by_destination` (`getQuota.response.200.by_destination`; object, required)
  - `product` (`getQuota.response.200.by_destination.product`; object, required)
    - `bytes` (`getQuota.response.200.by_destination.product.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `assets` (`getQuota.response.200.by_destination.product.assets`; number, required)
  - `entry` (`getQuota.response.200.by_destination.entry`; object, required)
    - `bytes` (`getQuota.response.200.by_destination.entry.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `assets` (`getQuota.response.200.by_destination.entry.assets`; number, required)
  - `store` (`getQuota.response.200.by_destination.store`; object, required)
    - `bytes` (`getQuota.response.200.by_destination.store.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `assets` (`getQuota.response.200.by_destination.store.assets`; number, required)
  - `quiz` (`getQuota.response.200.by_destination.quiz`; object, required)
    - `bytes` (`getQuota.response.200.by_destination.quiz.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `assets` (`getQuota.response.200.by_destination.quiz.assets`; number, required)
  - `certificate` (`getQuota.response.200.by_destination.certificate`; object, required)
    - `bytes` (`getQuota.response.200.by_destination.certificate.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `assets` (`getQuota.response.200.by_destination.certificate.assets`; number, required)
  - `holding` (`getQuota.response.200.by_destination.holding`; object, required)
    - `bytes` (`getQuota.response.200.by_destination.holding.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `assets` (`getQuota.response.200.by_destination.holding.assets`; number, required)
  - `page` (`getQuota.response.200.by_destination.page`; object, required)
    - `bytes` (`getQuota.response.200.by_destination.page.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
    - `assets` (`getQuota.response.200.by_destination.page.assets`; number, required)
- `unused` (`getQuota.response.200.unused`; object, required)
  - `bytes` (`getQuota.response.200.unused.bytes`; number, required) — The files' size in bytes, as they count against the store's storage.
  - `assets` (`getQuota.response.200.unused.assets`; number, required)
- `time_zone` (`getQuota.response.200.time_zone`; string, 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` (`getQuota.response.default.type`; string, required)
  - format `uri`
- `title` (`getQuota.response.default.title`; string, required)
- `status` (`getQuota.response.default.status`; integer, required)
- `detail` (`getQuota.response.default.detail`; string, required)
- `code` (`getQuota.response.default.code`; string, optional)
- `context` (`getQuota.response.default.context`; object, optional)
- `reached_core` (`getQuota.response.default.reached_core`; boolean, optional)
- `core_answer` (`getQuota.response.default.core_answer`; string, optional)


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