HighLevel: List Subscriptions

← Payments operations · Get started

Operation gohighlevel.list_subscriptions

Provider route: GET /payments/subscriptions. 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["payments"]["listSubscriptions"]>[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.payments.listSubscriptions(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.payments.list_subscriptions(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.altId	string	Required within parent
query.altType	string	Required within parent	One of: location
query.entityId	string	Optional
query.paymentMode	string	Optional
query.startAt	string	Optional
query.endAt	string	Optional
query.entitySourceType	string	Optional
query.search	string	Optional
query.contactId	string	Optional
query.id	string	Optional
query.limit	number	Optional	Default: 10
query.offset	number	Optional	Default: 0
query.getPaymentsCollectedCount	boolean	Optional

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 List Subscriptions — response body

Referenced models: List Subscriptions — response body

Schemas

List Subscriptions — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent	An array of subscriptions
data[]	Model	Each item	Expand List Subscriptions — response body — data item
totalCount	JSON	Required within parent
totalCount (anyOf 1)	number	Alternative	total subscriptions count
totalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Subscriptions — response body — data item

List Subscriptions — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the subscription.
altId	string	Required within parent	AltId is the unique identifier eg: location id.
altType	string	Required within parent	AltType is the type of identifier. Known values: location
amount	JSON	Optional
amount (anyOf 1)	number	Alternative	Subscription value.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
contactEmail	string	Optional	Contact email corresponding to the subscription.
contactId	string	Optional	Contact id corresponding to the subscription.
contactName	string	Optional	Contact name corresponding to the subscription.
createdAt	string	Required within parent	The creation timestamp of the subscription. Format: date-time
createdBy	string	Optional	User ID who created the subscription.
currency	string	Optional	Currency in which subscription occurred.
entityId	string	Optional	Entity id for the subscription. e.g: order id
entitySourceId	string	Optional	Entity source id for the subscription.
entitySourceMeta	object	Optional	Meta content for the entity source of subscription.
entitySourceName	string	Optional	Entity source name for the subscription.
entitySourceType	string	Required within parent	Entity source type of subscription (eg: funnel).
entityType	string	Optional	Entity type of subscription (eg: order).
ipAddress	string	Optional	Ip address from where subscription was initiated.
liveMode	boolean	Optional	Subscription is in live / test mode.
paymentProviderConnectedAccount	string	Optional	Payment provider connected account id for subscription.
paymentProviderType	string	Optional	Payment provider for subscription.
status	object	Required within parent	The status of the subscription (e.g., succeeded).
subscriptionId	string	Optional	Subscription id for subscription.
subscriptionSnapshot	object	Optional	Snapshot of subscription.
updatedAt	string	Required within parent	The update timestamp of the subscription. Format: date-time

Policy, approvals and errors

SDK function policy ID: gohighlevel.list_subscriptions. Catalog operation: list-subscriptions. 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.

Required provider scopes: ["payments/subscriptions.readonly"]

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

Official provider source