Skip to main content
POST
/
api
/
v1
/
plans
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.create({
  id: 'id',
  displayName: 'displayName',
  productId: 'productId',
});

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-26T10:00:00.000Z",
    "updatedAt": "2025-10-26T10:00:00.000Z",
    "parentPlanId": null,
    "defaultTrialConfig": {
      "duration": 14,
      "units": "DAY",
      "budget": null,
      "trialEndBehavior": null
    },
    "compatibleAddonIds": []
  }
}

Authorizations

​
X-API-KEY
string
header
required

Server API Key

Headers

​
X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

​
X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Body

application/json

Request to create a new plan

​
id
string
required

The unique identifier for the entity

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$
​
displayName
string
required

The display name of the package

Maximum string length: 255
​
productId
string
required

The product ID to associate the plan with

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$
​
description
string | null

The description of the package

Maximum string length: 255
​
parentPlanId
string | null

The ID of the parent plan, if applicable

Maximum string length: 255
​
pricingType
enum<string> | null

The pricing type of the package

Available options:
FREE,
PAID,
CUSTOM
​
billingId
string | null

The unique identifier for the entity in the billing provider

Maximum string length: 255
​
status
enum<string>

The status of the package

Available options:
DRAFT,
PUBLISHED,
ARCHIVED
​
metadata
object

Metadata associated with the entity

​
defaultTrialConfig
DefaultTrialConfig · object

Default trial configuration for the plan

Response

The newly created plan object.

Response object

​
data
Plan · object
required

Plan configuration object