Router

Read your subscription credits

Your Nevermined Subscription credits left, when they reset, and your plan. Charges nothing. Called in an organization you are an active member of (X-Current-Org-Id, or that organization's API key), it reads that organization's subscription instead, never your personal one; organizations can no longer subscribe, so that is subscribed: false unless the organization still holds one bought earlier. subscribed: false carries no other field; every other field is present exactly when subscribed is true.

Personal API keys only: the Nevermined Subscription belongs to a personal account, so call with a key that carries no organization tag and without X-Current-Org-Id. An OAuth-minted credential is refused (BCK.OAUTH.0030). Where the subscription is not available — on this deployment or to this account — it answers 404 BCK.SUBSCRIPTION_ACCESS.0001.

get/router/subscription/balance

Request

  • Base URL: https://api.sandbox.nevermined.app/api/v1
  • URL: https://api.sandbox.nevermined.app/api/v1/router/subscription/balance
  • Auth: HTTP bearer

Response

The caller's credits, reset date and plan.

subscribedboolean required

Whether the caller has a current Nevermined Subscription.

creditsLeftstring

Credits left: the unexpired remainder, as a whole-number digit string. What the Router debits.

spendableboolean

Whether these credits can pay a call right now: the subscription is active or trialing and not suspended by a card dispute.

resetsAtstring nullable

When this period's credits expire and — unless cancelAtPeriodEnd — the next period's are granted, on payment of its invoice (ISO 8601). null until the billing period is recorded.

cancelAtPeriodEndboolean

The subscription ends at resetsAt instead of renewing.

status'incomplete' | 'trialing' | 'active' | 'past_due' | 'unpaid' | 'paused'

The subscription status. A past_due subscription keeps its credits but cannot spend them until its invoice is paid. An ended subscription answers subscribed: false.

suspendedboolean

True while a card dispute is open, or after one was decided in the cardholder's favour: the credits cannot be spent. A dispute decided in Nevermined's favour lifts it, once no other dispute is open or was decided in the cardholder's favour.

Example response

{
  "creditsLeft": "1240",
  "resetsAt": "2026-10-30T00:00:00.000Z",
  "status": "active",
  "plan": {
    "planKey": "standard",
    "creditsPerCycle": "20000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.