Get Plan Balance

Retrieves credit balance for a specific account on a plan.

GET /protocol/plans/{planId}/balance/{holderAddress}

Get Plan Balance

cURL

curl --request GET \
  --url https://api.sandbox.nevermined.app/api/v1/protocol/plans/{planId}/balance/{holderAddress} \
  --header 'Authorization: Bearer <token>'

200

{
  "isSubscriber": true,
  "total": 123,
  "used": 123,
  "remaining": 123,
  "expiresAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

planId · integer · required

The plan's unique identifier

holderAddress · string · required

Wallet address to check balance for

Response

200

application/json

Balance information

isSubscriber · boolean

total · integer

used · integer

remaining · integer

expiresAt · string<date-time>