Skip to content
nsin nsin nsin Docs

Get the current billing-period statement

GET
/wallet/period-statement
 
curl --request GET \
  --url https://api.nsin.cloud/wallet/period-statement \
  --header 'Authorization: Bearer <token>'

A live estimate for the billing period in progress: plan price plus traffic accrued so far, per domain.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
subscription_id
integer

Which subscription’s period to report. Defaults to the current one.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Period statement.

Media type application/json

One billing period’s cost. For the period in progress the traffic figures are a running estimate.

object
id
integer
subscription_id
integer
plan_id
integer
plan_name
string
plan_term_id
integer
billing_duration_days
integer
quota_reset_days
integer
period_start
string
period_end
string
plan_price_rials
integer
traffic_cached_bytes
integer
traffic_proxied_bytes
integer
traffic_direct_bytes
integer
traffic_bypass_bytes

Legacy two-tier column, on historical periods only.

integer
traffic_charged_rials
integer
by_domain
Array<object>
object
domain
string
cached_bytes
integer
proxied_bytes
integer
direct_bytes
integer
estimated_charged_rials
integer
Example generated
{
  "id": 1,
  "subscription_id": 1,
  "plan_id": 1,
  "plan_name": "example",
  "plan_term_id": 1,
  "billing_duration_days": 1,
  "quota_reset_days": 1,
  "period_start": "example",
  "period_end": "example",
  "plan_price_rials": 1,
  "traffic_cached_bytes": 1,
  "traffic_proxied_bytes": 1,
  "traffic_direct_bytes": 1,
  "traffic_bypass_bytes": 1,
  "traffic_charged_rials": 1,
  "by_domain": [
    {
      "domain": "example",
      "cached_bytes": 1,
      "proxied_bytes": 1,
      "direct_bytes": 1,
      "estimated_charged_rials": 1
    }
  ]
}

401

Section titled “401 ”

Missing, malformed, revoked or expired API key, or a key whose owning user row is gone. A key whose owning account has merely been deactivated is not this: that is 403 with code: account_suspended, because the credential itself is intact and re-issuing it changes nothing.

Media type application/json

The error shape used by every endpoint. error is always present. code is present only on the failures that have one — do not require it, and do not parse error to recover it.

object
error
required

Human-readable description of what went wrong.

string
code

Stable machine-readable reason. Present on some failures only; the wording of error may change, this will not.

  • account_suspended — 403. The account behind the credential has been switched off, by an admin or by its provider. Every authenticated route answers this, so treat it as terminal rather than retrying.
  • domain_disabled — 409, not 403. You have every right to the operation; the domain is simply switched off and is not being served, so its configuration cannot change. It stays readable, and writes work again once it is enabled.
  • managed_by_reseller — 403. The account is a reseller’s client and this surface belongs to its provider. See If your account is managed by a reseller.
  • invite_email_mismatch — 403 from POST /invites/{token}/accept. The invitation was addressed to a different email; the body also carries invited_email, masked.

A panel session — not an API key — can additionally see session_check_failed on a 503, which means the session could not be verified, not that it is invalid. Retry it; do not discard the token.

string
Examples
Example invalidKey 
{
  "error": "invalid API key"
}

429

Section titled “429 ”

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

Media type application/json

The error shape used by every endpoint. error is always present. code is present only on the failures that have one — do not require it, and do not parse error to recover it.

object
error
required

Human-readable description of what went wrong.

string
code

Stable machine-readable reason. Present on some failures only; the wording of error may change, this will not.

  • account_suspended — 403. The account behind the credential has been switched off, by an admin or by its provider. Every authenticated route answers this, so treat it as terminal rather than retrying.
  • domain_disabled — 409, not 403. You have every right to the operation; the domain is simply switched off and is not being served, so its configuration cannot change. It stays readable, and writes work again once it is enabled.
  • managed_by_reseller — 403. The account is a reseller’s client and this surface belongs to its provider. See If your account is managed by a reseller.
  • invite_email_mismatch — 403 from POST /invites/{token}/accept. The invitation was addressed to a different email; the body also carries invited_email, masked.

A panel session — not an API key — can additionally see session_check_failed on a 503, which means the session could not be verified, not that it is invalid. Retry it; do not discard the token.

string
Examples
Example limited 
{
  "error": "rate limit exceeded"
}