Skip to main content
POST
/
protocol
/
plans
/
redeem
Redeem Credits
curl --request POST \
  --url https://api.sandbox.nevermined.app/api/v1/protocol/plans/redeem \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "planId": "did:nv:abc123...",
  "holderAddress": "0xUserAddress",
  "amount": 5,
  "proof": "0xSignatureProof..."
}
'
{
  "success": true,
  "creditsRedeemed": 123,
  "remainingBalance": 123
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Redeem request

​
planId
string
required
​
holderAddress
string
required
​
amount
integer
required
​
proof
string
required

Response

Credits redeemed

​
success
boolean
​
creditsRedeemed
integer
​
remainingBalance
integer