Skip to main content
GET
/
plan
/
{planId}
Get Plan
curl --request GET \
  --url http://sandbox.mintlify.com/plan/{planId} \
  --header 'Authorization: Bearer <token>'
{
  "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

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
planId
string
required

The unique identifier of the plan to retrieve

Response

200 - application/json

Plan information

​
planId
string
​
metadata
object
​
price
object
​
credits
object
​
nftAddress
string