Get SaaS Plan

GET 
/saas/saas-plan/:planId

Fetch a specific SaaS plan by plan ID

Request

Version stringrequired

API Version

Available optionsv3

planId stringrequired

companyId stringrequired

application/json

The requested SaaS plan.

application/json

Schema

Schema

planIdstringrequired

Unique identifier for the SaaS plan

companyIdstringrequired

Company ID associated with the SaaS plan

titlestringrequired

Title of the SaaS plan

descriptionstringrequired

Description of the SaaS plan

saasProductsstring[]required

Array of SaaS products included in the plan

featuresstring[]

Array of v2 feature-permission feature IDs included in the plan. This is the v2-native representation of the plan entitlements (the successor to saasProducts); the two are kept in sync via the plan create/update dual-write.

addOnsstring[]

Array of add-ons included in the plan

planLevelnumberrequired

Level of the plan (0-4)

trialPeriodnumberrequired

Trial period in days

setupFeenumber

Setup fee for the plan

userLimitnumber

User limit for the plan

contactLimitnumber

Contact limit for the plan

pricesobject[]required

Prices for the plan

categoryIdstring

Category ID for the plan

snapshotIdstring

Snapshot ID for the plan

providerLocationIdstring

Provider location ID

productIdstring

Product ID for the plan

isSaaSV2booleanrequired

Indicates if this is a SaaS V2 plan

createdAtstring<date-time>required

Creation timestamp

updatedAtstring<date-time>required

Last update timestamp

Example (auto)

{
  "planId": "66c4d36534f21f900dc2a265",
  "companyId": "66c4d36534f21f900dc2a265",
  "title": "AED 1.5 changed",
  "description": "AED 1.5",
  "saasProducts": [
    "2-way-text-messaging",
    "gmb-messaging",
    "web-chat"
  ],
  "features": [
    "contacts-conversations",
    "web-chat",
    "workflows"
  ],
  "addOns": [
    "YEXT_V2",
    "WHATSAPP_V1",
    "WORDPRESS_V1",
    "AI_EMPLOYEE",
    "Ad_Publishing_Connect_Your_BM"
  ],
  "planLevel": 0,
  "trialPeriod": 16,
  "setupFee": 100,
  "userLimit": 50,
  "contactLimit": 50,
  "prices": [
    {
      "id": "66a9edbfcc6c505a22db7976",
      "billingInterval": "month",
      "active": true,
      "amount": 150,
      "currency": "AED",
      "symbol": "$"
    }
  ],
  "categoryId": "66911cdc98508ec2731979b9",
  "snapshotId": "G8KmpIeLnZc7ZMoJoxDx",
  "providerLocationId": "r06mdj4OrrERzYDvsOdh",
  "productId": "66a9edbfcc6c5090bedb7974",
  "isSaaSV2": true,
  "createdAt": "2024-07-31T07:54:41.885Z",
  "updatedAt": "2025-04-01T12:27:29.167Z"
}