Skip to main content
SaaSVersion: v3

Get SaaS Plan

GET/saas/saas-plan/{planId}

Fetch a specific SaaS plan by plan ID

Authorizations

Authorizationstringheaderrequired

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

Scope:saas/company.read
Auth methods:OAuthPrivate Integration
Token type:Agency Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

planIdstringrequired

Query Parameters

companyIdstringrequired

Response

The requested SaaS plan.

planIdstringrequired

Unique identifier for the SaaS plan

Example:66c4d36534f21f900dc2a265
companyIdstringrequired

Company ID associated with the SaaS plan

Example:66c4d36534f21f900dc2a265
titlestringrequired

Title of the SaaS plan

Example:AED 1.5 changed
descriptionstringrequired

Description of the SaaS plan

Example:AED 1.5
saasProductsstring[]required

Array of SaaS products included in the plan

Example:["2-way-text-messaging","gmb-messaging","web-chat"]
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.

Example:["contacts-conversations","web-chat","workflows"]
addOnsstring[]

Array of add-ons included in the plan

Example:["YEXT_V2","WHATSAPP_V1","WORDPRESS_V1","AI_EMPLOYEE","Ad_Publishing_Connect_Your_BM"]
planLevelnumberrequired

Level of the plan (0-4)

Example:0
trialPeriodnumberrequired

Trial period in days

Example:16
setupFeenumber

Setup fee for the plan

Example:100
userLimitnumber

User limit for the plan

Example:50
contactLimitnumber

Contact limit for the plan

Example:50
pricesobject[]required

Prices for the plan

categoryIdstring

Category ID for the plan

Example:66911cdc98508ec2731979b9
snapshotIdstring

Snapshot ID for the plan

Example:G8KmpIeLnZc7ZMoJoxDx
providerLocationIdstring

Provider location ID

Example:r06mdj4OrrERzYDvsOdh
productIdstring

Product ID for the plan

Example:66a9edbfcc6c5090bedb7974
isSaaSV2booleanrequired

Indicates if this is a SaaS V2 plan

Example:true
createdAtstring<date-time>required

Creation timestamp

Example:2024-07-31T07:54:41.885Z
updatedAtstring<date-time>required

Last update timestamp

Example:2025-04-01T12:27:29.167Z