Get the domain's effective plan entitlements

GET

/domains/{domain}/features

curl --request GET \
  --url https://api.nsin.ir/domains/example.com/features \
  --header 'Authorization: Bearer <token>'

• Production

What this domain’s plan actually allows — the resolved values after any per-subscription overrides, so this is the authority on whether a feature is available.

A limit of null means unlimited. Use this before calling a gated endpoint rather than inferring capability from the plan name. Readable by shared members.

Authorizations

• bearerAuth
• apiKeyAuth

Parameters

Path Parameters

domain

required

string

The domain name (for example example.com) — not a numeric id.

Example

example.com

Responses

200

Effective entitlements.

Media type application/json

The domain’s effective entitlements, after per-subscription overrides. A null limit means unlimited.

object

plan_id

integer

plan_name

string

plan_slug

string

has_active_plan

boolean

max_records

Null means unlimited.

integer

max_traffic_gb

Null means unlimited.

integer

max_rules_per_set

Rules allowed per rule type. Null means unlimited.

integer

max_gateway_requests_30d

Requests this domain’s gateway records may serve in a rolling 30-day window. Null means unlimited. See the gateway list endpoint for usage against it.

integer

nullable

max_cache_cap_mb

Ceiling for the domain’s cache_cap_mb — the largest response body cached.

integer

max_cache_disk_gb

Ceiling for the domain’s cache_l2_max_gb — the size of its cache pool.

integer

max_cache_ttl_days

Ceiling for the domain’s cache_l2_ttl_days — how long a cached entry may live.

integer

disabled_rule_types

Rule types this plan may NOT create, by rule type string (for example origin_pool, origin_route, optimize). A DENY list: any type not listed is available. Rules of a blocked type that already exist keep working.

Array<string>

gateways_enabled

Gates the Gateways feature.

boolean

logs_enabled

Gates the raw-log and top-N analytics endpoints.

boolean

monitoring_enabled

Gates most analytics sections.

boolean

rules_enabled

boolean

cache_purge_enabled

Gates the cache purge endpoints.

boolean

custom_ssl_enabled

Gates custom certificate upload.

boolean

ws_enabled

WebSocket support.

boolean

host_header_edit_enabled

boolean

uptime_sms_enabled

Whether uptime outage/recovery alerts may be delivered by SMS. When false they still go out by email and to the panel — uptime monitoring itself is not gated.

boolean

dedicated_support_enabled

Direct support when true; ticket support when false.

boolean

domain_usage

Current usage against the limits above.

Array<object>

object

key

additional properties

any

plan_term_id

integer

billing_duration_days

integer

quota_reset_days

integer

quota_period_start

string format: date-time

quota_period_end

string format: date-time

Example ^generated

{
  "plan_id": 1,
  "plan_name": "example",
  "plan_slug": "example",
  "has_active_plan": true,
  "max_records": 1,
  "max_traffic_gb": 1,
  "max_rules_per_set": 1,
  "max_gateway_requests_30d": 1,
  "max_cache_cap_mb": 1,
  "max_cache_disk_gb": 1,
  "max_cache_ttl_days": 1,
  "disabled_rule_types": [
    "example"
  ],
  "gateways_enabled": true,
  "logs_enabled": true,
  "monitoring_enabled": true,
  "rules_enabled": true,
  "cache_purge_enabled": true,
  "custom_ssl_enabled": true,
  "ws_enabled": true,
  "host_header_edit_enabled": true,
  "uptime_sms_enabled": true,
  "dedicated_support_enabled": true,
  "domain_usage": [
    {}
  ],
  "plan_term_id": 1,
  "billing_duration_days": 1,
  "quota_reset_days": 1,
  "quota_period_start": "2026-04-15T12:00:00Z",
  "quota_period_end": "2026-04-15T12:00:00Z"
}

400

Missing domain.

Media type application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}

401

Missing, malformed, revoked or expired API key — or the owning account is inactive.

Media type application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

Example invalidKey

{
  "error": "invalid API key"
}

404

No such domain, or it is not visible to this account. Domains you cannot access are reported as not found rather than forbidden.

Media type application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}

429

The key exceeded its request budget (300 requests per minute by default).

Media type application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

Example limited

{
  "error": "rate limit exceeded"
}