HighLevel: Get Agency Plans — saas get Agency Plans Deprecated

← Saas operations · Get started

Operation gohighlevel.get_agency_plans_deprecated

Provider route: GET /saas-api/public-api/agency-plans/{companyId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["saas"]["getAgencyPlansDeprecated"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.saas.getAgencyPlansDeprecated(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.saas.get_agency_plans_deprecated(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.companyId	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	array	Root
$[]	Model	Each item	Expand Get Agency Plans — saas get Agency Plans Deprecated — response body — item

Referenced models: Get Agency Plans — saas get Agency Plans Deprecated — response body — item

Schemas

Get Agency Plans — saas get Agency Plans Deprecated — response body — item

Field	Type	Presence	Description and constraints
$	object	Root
addOns	array	Optional	Array of add-ons included in the plan
addOns[]	string	Each item
categoryId	string	Optional	Category ID for the plan
contactLimit	JSON	Optional
contactLimit (anyOf 1)	number	Alternative	Contact limit for the plan
contactLimit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	string	Required within parent	Creation timestamp
description	string	Required within parent	Description of the plan
isSaaSV2	boolean	Required within parent	Indicates if this is a SaaS V2 plan
planId	string	Required within parent	Unique identifier for the plan
planLevel	JSON	Required within parent
planLevel (anyOf 1)	number	Alternative	Level of the plan (0-4)
planLevel (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
prices	array	Required within parent	Pricing information for the plan
prices[]	object	Each item
prices[].active	boolean	Optional	Indicates if the price is active
prices[].amount	JSON	Optional
prices[].amount (anyOf 1)	number	Alternative	Amount of the price
prices[].amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
prices[].billingInterval	string	Optional	Billing interval for the plan Known values: month, year
prices[].currency	string	Optional	Currency of the price
prices[].id	string	Optional	ID of the price
prices[].symbol	string	Optional	Symbol of the price
productId	string	Optional	Product ID for the plan
providerLocationId	string	Optional	Provider location ID
saasProducts	array	Required within parent	Array of SaaS products included in the plan
saasProducts[]	string	Each item
snapshotId	string	Optional	Snapshot ID for the plan
title	string	Required within parent	Title of the plan
trialPeriod	JSON	Required within parent
trialPeriod (anyOf 1)	number	Alternative	Trial period in days
trialPeriod (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	Last update timestamp
userLimit	JSON	Optional
userLimit (anyOf 1)	number	Alternative	User limit for the plan
userLimit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_agency_plans_deprecated. Catalog operation: get-agency-plans-deprecated. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Version": "v3"}

Official provider source