Skip to main content
GET
Read your 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, as a total and by kind and expiry.

total
string
required

Every unexpired credit, frozen ones included, as a whole-number digit string. "0" when there is none.

Example:

"2000"

spendable
string
required

The credits that can pay a call right now: the sum of the parts that are not frozen, as a whole-number digit string. What the Router spends — read it rather than adding up your calls.

Example:

"2000"

parts
object[]
required

The credits left, by kind, expiry and freeze, in the order they are spent: earliest expiry first, never-expiring last. Empty when there is none.

nextExpiry
object | null
required

The next credits to expire, or null when none of the credits left ever expires.

topups
object

Your credit top-up settings. Present when credit top-ups are available to you; absent when they are not, or when the settings could not be read this time. Top-ups are turned on and managed in the Nevermined App, not over the API.