Skip to main content
GET
/
api
/
v1
/
plans
/
{id}
JavaScript
import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const plan = await client.v1.plans.retrieve('x');

console.log(plan.data);
{
  "data": {
    "id": "plan-professional",
    "displayName": "Professional",
    "description": "Professional plan with advanced features",
    "productId": "product-starter",
    "status": "PUBLISHED",
    "pricingType": "PAID",
    "billingId": "price_1234567890",
    "versionNumber": 1,
    "isLatest": true,
    "entitlements": [
      {
        "type": "FEATURE",
        "id": "feature-advanced-analytics"
      },
      {
        "type": "CREDIT",
        "id": "api-calls"
      }
    ],
    "metadata": {},
    "createdAt": "2025-10-28T10:46:14.391Z",
    "updatedAt": "2025-05-29T12:47:07.275Z",
    "parentPlanId": null,
    "defaultTrialConfig": {
      "duration": 14,
      "units": "DAY",
      "budget": null,
      "trialEndBehavior": null
    },
    "compatibleAddonIds": [
      "suus necessitatibus aro cilicium creator vociferor ancilla ipsam talio delego appello depulso patruus vado ratione victus quam adipiscor suscipio corpus caries ulterius arbustum subito quibusdam cubitum vestrum calculus quidem vapulus adicio sulum vehemen"
    ]
  }
}

Authorizations

X-API-KEY
string
header
required

Server API Key

Path Parameters

id
string
required

The unique identifier of the entity

Required string length: 1 - 255

Response

The plan object with full details.

Response object

data
Plan · object
required

Plan configuration object