# Quota

## Get Custom Hostname Quota

`client.customHostnames.quota.get(QuotaGetParamsparams, RequestOptionsoptions?): QuotaGetResponse`

**get** `/zones/{zone_id}/custom_hostnames/quota`

Returns custom hostname quota usage for a zone. The allocated quota is a soft limit; creating custom hostnames after usage exceeds this limit can still succeed until the hard cap is reached. Use the exceeded and hard_cap fields to track when usage is above the soft limit and when new custom hostname creation will be rejected.

### Parameters

- `params: QuotaGetParams`

  - `zone_id: string`

    Identifier.

### Returns

- `QuotaGetResponse`

  - `allocated: number`

    The allocated custom hostname quota.

  - `exceeded: boolean`

    Whether the current usage has exceeded the allocated quota.

  - `hard_cap: number`

    The maximum number of custom hostnames allowed before create requests are rejected.

  - `used: number`

    The number of custom hostnames currently in use.

### Example

```typescript
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const quota = await client.customHostnames.quota.get({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(quota.allocated);
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "success": true,
  "result": {
    "allocated": 100,
    "exceeded": false,
    "hard_cap": 200,
    "used": 50
  }
}
```

## Domain Types

### Quota Get Response

- `QuotaGetResponse`

  - `allocated: number`

    The allocated custom hostname quota.

  - `exceeded: boolean`

    Whether the current usage has exceeded the allocated quota.

  - `hard_cap: number`

    The maximum number of custom hostnames allowed before create requests are rejected.

  - `used: number`

    The number of custom hostnames currently in use.