Skip to main content
GET
Read your subscription credits

Authorizations

Authorization
string
header
required

Your Nevermined API Key (starts with 'nvm:'). Get one at nevermined.app under Settings > API Keys.

Response

The caller's credits, reset date and plan.

subscribed
boolean
required

Whether the caller has a current Nevermined Subscription.

creditsLeft
string

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

Example:

"1240"

spendable
boolean

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

resetsAt
string | null

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.

Example:

"2026-10-30T00:00:00.000Z"

cancelAtPeriodEnd
boolean

The subscription ends at resetsAt instead of renewing.

status
enum<string>

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.

Available options:
incomplete,
trialing,
active,
past_due,
unpaid,
paused
Example:

"active"

suspended
boolean

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.

plan
object