HighLevel: Get Subscription by ID

← Payments operations · Get started

Operation gohighlevel.get_subscription_by_id

Provider route: GET /payments/subscriptions/{subscriptionId}. 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"]["getSubscriptionById"]>[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.getSubscriptionById(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.get_subscription_by_id(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.subscriptionId	string	Required within parent
query	object	Required within parent	Additional keys: not allowed
query.altId	string	Required within parent
query.altType	string	Required within parent	One of: location

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 Subscription by ID — response body

Referenced models: Get Subscription by ID — response body

Schemas

Get Subscription by ID — response body

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	object	Required within parent	AltType is the type of identifier.
amount	JSON	Optional
amount (anyOf 1)	number	Alternative	Subscription value.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
autoPayment	object	Optional	Auto payment details of the subscription.
canceledAt	string	Optional	Cancellation timestamp of the subscription. Format: date-time
canceledBy	string	Optional	User id who cancelled the subscription.
contactId	string	Optional	Contact id corresponding to the subscription.
contactSnapshot	object	Optional	Contact details of the subscriber.
coupon	object	Optional	Coupon details of 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 was made.
entityId	string	Optional	Entity id for the subscription. e.g: order id
entitySource	JSON	Optional	Entity source details for the subscription.
entitySource (allOf 1)	Model	All variants apply	Expand Get Order by ID — response body — source id, meta, name, sub Type, type
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.
markAsTest	boolean	Optional	Is test subscription.
meta	object	Optional	Meta details of the subscription.
paymentProvider	object	Optional	Payment provider details for the subscription.
recurringProduct	object	Optional	Recurring product details of the subscription.
schedule	JSON	Optional	Scedule details for the subscription.
schedule (allOf 1)	Model	All variants apply	Expand Get Subscription by ID — response body — schedule execute At, rrule
status	object	Optional	Subscription status.
subscriptionId	string	Optional	Subscription id for subscription.
subscriptionSnapshot	object	Optional	Snapshot of subscription.
traceId	string	Optional	Trace id of the subscription.
updatedAt	string	Required within parent	The last update timestamp of the subscription. Format: date-time

Referenced models: Get Order by ID — response body — source id, meta, name, sub Type, type, Get Subscription by ID — response body — schedule execute At, rrule

Get Order by ID — response body — source id, meta, name, sub Type, type

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent
meta	object	Optional
name	string	Optional
subType	string	Optional	Known values: one_step_order_form, two_step_order_form, upsell, tap_to_pay, card_payment, store, contact_view, email_campaign, payments_dashboard, shopify, subscription_view, store_upsell, woocommerce, service, meeting, imported_csv, qr_code, saas_one_time, saas_subscription
type	string	Required within parent	Known values: funnel, website, invoice, calendar, text2Pay, document_contracts, membership, mobile_app, communities, point_of_sale, manual, form, survey, payment_link, external

Get Subscription by ID — response body — schedule execute At, rrule

Field	Type	Presence	Description and constraints
$	object	Root
executeAt	string	Optional
rrule	Model	Optional	Expand Get Subscription by ID — response body — schedule execute At, rrule rrule

Referenced models: Get Subscription by ID — response body — schedule execute At, rrule rrule

Get Subscription by ID — response body — schedule execute At, rrule rrule

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Optional
count (anyOf 1)	number	Alternative	Max number of task executions
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dayOfMonth	JSON	Optional
dayOfMonth (anyOf 1)	number	Alternative	-1, 1, 2, 3, ..., 27, 28
dayOfMonth (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dayOfWeek	string	Optional	Known values: mo, tu, we, th, fr, sa, su
daysBefore	JSON	Optional
daysBefore (anyOf 1)	number	Alternative	Execute task number of days before
daysBefore (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
endDate	string	Optional	End date in YYYY-MM-DD format
endTime	string	Optional	End time in HH:mm:ss format
interval	JSON	Required within parent
interval (anyOf 1)	number	Alternative
interval (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
intervalType	string	Required within parent	Known values: yearly, monthly, weekly, daily, hourly, minutely, secondly
monthOfYear	string	Optional	Known values: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec
numOfWeek	JSON	Optional
numOfWeek (anyOf 1)	number	Alternative	-1, 1, 2, 3, 4
numOfWeek (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startDate	string	Required within parent	Start date in YYYY-MM-DD format
startTime	string	Optional	Start time in HH:mm:ss format

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_subscription_by_id. Catalog operation: get-subscription-by-id. 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