Documentation IndexFetch the complete documentation index at: /docs/llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Contact support
cURL
curl --request GET \ --url http://localhost:3001/portal-api/plans/{plan_id} \ --header 'Authorization: <api-key>'
import requests url = "http://localhost:3001/portal-api/plans/{plan_id}" headers = {"Authorization": "<api-key>"} response = requests.get(url, headers=headers) print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}}; fetch('http://localhost:3001/portal-api/plans/{plan_id}', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));
<?php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_PORT => "3001", CURLOPT_URL => "http://localhost:3001/portal-api/plans/{plan_id}", 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: <api-key>" ], ]); $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 := "http://localhost:3001/portal-api/plans/{plan_id}" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "<api-key>") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) }
HttpResponse<String> response = Unirest.get("http://localhost:3001/portal-api/plans/{plan_id}") .header("Authorization", "<api-key>") .asString();
require 'uri' require 'net/http' url = URI("http://localhost:3001/portal-api/plans/{plan_id}") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Get.new(url) request["Authorization"] = '<api-key>' response = http.request(request) puts response.read_body
{ "Name": "free_plan_2", "ProviderID": 1, "CID": "2r7p8aUnkzby17hCJk8w2XvK3K6", "AutoApproveAccessRequests": true, "Catalogues": [ 1 ], "DisplayName": "Free plan", "Description": "Free plan offers only basic functionality", "JWTScope": "free-plan", "KeyExpiresIn": 3600, "MetaData": { "data1": "1", "data2": "2" }, "Per": 10, "PlanQuota": 2, "PlanQuotaRenewalRate": 3600, "Quota": 0, "QuotaRenewalRate": -1, "RateLimit": 5, "UnlimitedQuota": true, "UnlimitedRateLimit": false, "ID": 1, "ReferenceID": "6490fd451ba6a6000108864e" }
{ "errors": [ "<string>" ] }
Get a plan’s details
ID of the plan
OK
Name of the plan
"free_plan_2"
ID of the provider
1
Client ID for the plan
"2r7p8aUnkzby17hCJk8w2XvK3K6"
Whether access requests are automatically approved
true
List of catalogue IDs this plan belongs to
[1]
Display name of the plan
"Free plan"
Description of the plan
"Free plan offers only basic functionality"
JWT scope for the plan
"free-plan"
Key expiration time in seconds
3600
Additional metadata for the plan
{ "data1": "1", "data2": "2" }
Time period for rate limiting in seconds
10
Plan quota value
2
Plan quota renewal rate in seconds
Quota value
0
Quota renewal rate in seconds
-1
Rate limit for the plan
5
Whether the plan has unlimited quota
Whether the plan has unlimited rate limit
false
Unique identifier of the plan
Reference ID of the plan in the provider system
"6490fd451ba6a6000108864e"
Was this page helpful?