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>'

import requests

url = "https://api.sandbox.nevermined.app/api/v1/protocol/plans/{planId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.nevermined.app/api/v1/protocol/plans/{planId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.nevermined.app/api/v1/protocol/plans/{planId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.nevermined.app/api/v1/protocol/plans/{planId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.nevermined.app/api/v1/protocol/plans/{planId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.nevermined.app/api/v1/protocol/plans/{planId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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