Get Plan

Retrieves details about a specific payment plan.

GET /protocol/plans/{planId}

Get Plan

cURL

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

200

{
  "planId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "priceConfig": {
    "tokenAddress": "<string>",
    "amounts": [
      123
    ],
    "receivers": [
      "<string>"
    ]
  },
  "creditsConfig": {
    "amount": 123,
    "minAmount": 123,
    "durationOfThePlan": 123
  },
  "isListed": true,
  "owner": "<string>"
}

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

Response

200

application/json

Plan details

planId · string

name · string

description · string

priceConfig · object

Show child attributes

creditsConfig · object

Show child attributes

isListed · boolean

owner · string