Skip to main content
POST
/
protocol
/
plans
Register Plan
curl --request POST \
  --url https://api.sandbox.nevermined.app/api/v1/protocol/plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Pro Plan",
  "description": "500 requests per month",
  "priceConfig": {
    "priceType": "FIXED_PRICE",
    "tokenAddress": "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
    "amounts": [
      50000000
    ],
    "receivers": [
      "0xYourWalletAddress"
    ]
  },
  "creditsConfig": {
    "creditsType": "FIXED",
    "amount": 500,
    "minAmount": 1
  }
}
'
{
  "success": true,
  "planId": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Plan configuration

​
name
string
required
​
priceConfig
object
required
​
creditsConfig
object
required
​
description
string

Response

Plan created

​
success
boolean
​
planId
string