HighLevel: Get Location Subscription Details — saas get Location Subscription Deprecated

← Saas operations · Get started

Operation gohighlevel.get_location_subscription_deprecated

Provider route: GET /saas-api/public-api/get-saas-subscription/{locationId}. 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"]["getLocationSubscriptionDeprecated"]>[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.getLocationSubscriptionDeprecated(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_location_subscription_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.locationId	string	Required within parent
query	object	Required within parent	Additional keys: not allowed
query.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
$	Model	Root	Expand Get Location Subscription Details — saas get Location Subscription Deprecated — response body

Referenced models: Get Location Subscription Details — saas get Location Subscription Deprecated — response body

Schemas

Get Location Subscription Details — saas get Location Subscription Deprecated — response body

Field	Type	Presence	Description and constraints
$	object	Root
companyId	string	Required within parent	Company ID
customerId	string	Optional	Customer ID
isSaaSV2	boolean	Required within parent	Indicates if the SaaS is V2
locationId	string	Required within parent	Location ID
priceId	string	Optional	Price ID
productId	string	Optional	Product ID
saasMode	string	Optional	SaaS mode
saasPlanId	string	Optional	SaaS plan ID
subscriptionId	string	Optional	Subscription ID
subscriptionStatus	string	Optional	Subscription status

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_location_subscription_deprecated. Catalog operation: get-location-subscription-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