Skip to content
nsin nsin nsin Docs

Get one of the domain's subscriptions

GET
/domains/{domain}/subscriptions/{id}
 
curl --request GET \
  --url https://api.nsin.ir/domains/example.com/subscriptions/1 \
  --header 'Authorization: Bearer <token>'

Owner only.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
domain
required
string

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

Example 
example.com
id
required
integer

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Subscription.

Media type application/json

A plan attached to one domain. Entitlements are not read from the plan directly — use GET /domains/{domain}/features, which resolves any per-subscription overrides.

object
id
integer
user_id
integer
domain_id
integer
domain_name
string
plan_id
integer
plan

The plan this subscription is on.

object
key
additional properties
any
plan_term_id
integer
plan_term

The billing term purchased.

object
key
additional properties
any
status

For example active, expired, grace or cancelled.

string
started_at
string format: date-time
expires_at
string format: date-time
grace_until
string format: date-time
auto_renew
boolean
quota_reset_days

Traffic-allowance reset cadence, frozen at purchase time so later plan changes cannot shift an existing subscriber’s quota window.

integer
is_trial

The free trial granted at signup. Downgrades to the free plan on expiry rather than entering grace.

boolean
Example generated
{
  "id": 1,
  "user_id": 1,
  "domain_id": 1,
  "domain_name": "example",
  "plan_id": 1,
  "plan": {},
  "plan_term_id": 1,
  "plan_term": {},
  "status": "example",
  "started_at": "2026-04-15T12:00:00Z",
  "expires_at": "2026-04-15T12:00:00Z",
  "grace_until": "2026-04-15T12:00:00Z",
  "auto_renew": true,
  "quota_reset_days": 1,
  "is_trial": true
}

401

Section titled “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"
}

403

Section titled “403 ”

The key is read-only, your role on the domain lacks the required permission, or the domain’s plan does not include the feature.

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"
}

404

Section titled “404 ”

Domain or subscription not found.

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

Section titled “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"
}