Skip to main content
Version: v3

Get Agency Plans

GET 

/saas/agency-plans/:companyId

Fetch all agency subscription plans for a given company ID

Request

Version stringrequired

API Version

Available optionsv3
companyId stringrequired
application/json

List of agency subscription plans for the company.

Schema
  • Array [
  • planIdstringrequired

    Unique identifier for the plan

    titlestringrequired

    Title of the plan

    descriptionstringrequired

    Description of the 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

    userLimitnumber

    User limit for the plan

    contactLimitnumber

    Contact limit for the plan

    pricesobject[]required

    Pricing information for the plan

    categoryIdstring

    Category ID for the plan

    snapshotIdstring

    Snapshot ID for the plan

    productIdstring

    Product ID for the plan

    isSaaSV2booleanrequired

    Indicates if this is a SaaS V2 plan

    providerLocationIdstring

    Provider location ID

    createdAtstringrequired

    Creation timestamp

    updatedAtstringrequired

    Last update timestamp

  • ]