Payment Operations
Get Plan
Retrieves details about a specific payment plan by its ID.
GET
/
plan
/
{planId}
Get Plan
curl --request GET \
--url http://sandbox.mintlify.com/plan/{planId} \
--header 'Authorization: Bearer <token>'import requests
url = "http://sandbox.mintlify.com/plan/{planId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://sandbox.mintlify.com/plan/{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 => "http://sandbox.mintlify.com/plan/{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 := "http://sandbox.mintlify.com/plan/{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("http://sandbox.mintlify.com/plan/{planId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://sandbox.mintlify.com/plan/{planId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"planId": "<string>",
"metadata": {
"name": "<string>",
"description": "<string>"
},
"price": {
"priceType": "<string>",
"tokenAddress": "<string>",
"amounts": [
123
],
"receivers": [
"<string>"
]
},
"credits": {
"creditsType": "<string>",
"amount": 123,
"durationOfThePlan": 123
},
"nftAddress": "<string>"
}Retrieves details about a specific payment plan by its ID.
Example Usage
const plan = await payments.getPlan(planId)
Response
{
"planId": "string",
"metadata": {
"name": "string",
"description": "string"
},
"price": {
"priceType": "FIXED_PRICE",
"tokenAddress": "string",
"amounts": ["number"],
"receivers": ["string"]
},
"credits": {
"creditsType": "FIXED",
"amount": "number",
"minAmount": "number",
"maxAmount": "number",
"durationOfThePlan": "number"
},
"nftAddress": "string?"
}
Notes
- This endpoint is used to display details to a subscriber before they purchase
- Returns pricing structure, credit limits, and metadata
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the plan to retrieve
⌘I
Get Plan
curl --request GET \
--url http://sandbox.mintlify.com/plan/{planId} \
--header 'Authorization: Bearer <token>'import requests
url = "http://sandbox.mintlify.com/plan/{planId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://sandbox.mintlify.com/plan/{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 => "http://sandbox.mintlify.com/plan/{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 := "http://sandbox.mintlify.com/plan/{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("http://sandbox.mintlify.com/plan/{planId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://sandbox.mintlify.com/plan/{planId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"planId": "<string>",
"metadata": {
"name": "<string>",
"description": "<string>"
},
"price": {
"priceType": "<string>",
"tokenAddress": "<string>",
"amounts": [
123
],
"receivers": [
"<string>"
]
},
"credits": {
"creditsType": "<string>",
"amount": 123,
"durationOfThePlan": 123
},
"nftAddress": "<string>"
}