List Plans

Get paginated list of payment plans for the current user.

GET /protocol/plans

List Plans

cURL

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

200

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

Authorizations

Authorization · string · header · required

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

Query Parameters

page · integer · default: 1

offset · integer · default: 10

sortBy · string · default: createdAt

sortOrder · enum<string> · default: desc

Available options: asc, desc

Response

200

application/json

List of plans

plans · object[]

Show child attributes

totalCount · integer

page · integer

offset · integer