HighLevel: Get rebilling config for an app subscription and usage plans

← Marketplace operations · Get started

Operation gohighlevel.get_rebilling_config_for_app

Provider route: GET /marketplace/app/{appId}/rebilling-config/location/{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["marketplace"]["getRebillingConfigForApp"]>[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.marketplace.getRebillingConfigForApp(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.marketplace.get_rebilling_config_for_app(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.appId	string	Required within parent
path.locationId	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 rebilling config for an app subscription and usage plans — response body

Referenced models: Get rebilling config for an app subscription and usage plans — response body

Schemas

Get rebilling config for an app subscription and usage plans — response body

Field	Type	Presence	Description and constraints
$	object	Root
plans	JSON	Required within parent	The rebilling plans configuration
plans (allOf 1)	Model	All variants apply	Expand Get rebilling config for an app subscription and usage plans — response body — plans subscription, usage

Referenced models: Get rebilling config for an app subscription and usage plans — response body — plans subscription, usage

Get rebilling config for an app subscription and usage plans — response body — plans subscription, usage

Field	Type	Presence	Description and constraints
$	object	Root
subscription	array	Required within parent	Subscription plans
subscription[]	Model	Each item	Expand Get rebilling config for an app subscription and usage plans — response body — plans subscription, usage subscription item
usage	array	Required within parent	Usage-based plans
usage[]	Model	Each item	Expand Get rebilling config for an app subscription and usage plans — response body — plans subscription, usage usage item

Referenced models: Get rebilling config for an app subscription and usage plans — response body — plans subscription, usage subscription item, Get rebilling config for an app subscription and usage plans — response body — plans subscription, usage usage item

Get rebilling config for an app subscription and usage plans — response body — plans subscription, usage subscription item

Field	Type	Presence	Description and constraints
$	object	Root
baseAmount	JSON	Required within parent
baseAmount (anyOf 1)	number	Alternative	The base amount
baseAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
features	array	Required within parent	The features
features[]	string	Each item
name	string	Required within parent	The plan name
paymentTime	string	Required within parent	The payment time
paymentType	string	Required within parent	The payment time
planId	string	Required within parent	The plan id
resellingAmount	JSON	Required within parent
resellingAmount (anyOf 1)	number	Alternative	The reselling amount
resellingAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get rebilling config for an app subscription and usage plans — response body — plans subscription, usage usage item

Field	Type	Presence	Description and constraints
$	object	Root
executionLimitPerCycle	JSON	Required within parent
executionLimitPerCycle (anyOf 1)	number	Alternative	The execution limit per cycle
executionLimitPerCycle (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fixedPricePerUnit	JSON	Required within parent
fixedPricePerUnit (anyOf 1)	number	Alternative	The fixed price per unit, applicable for fixed price type
fixedPricePerUnit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxPricePerUnit	string	Required within parent	The max price per unit, applicable for dynamic price type
meterId	string	Required within parent	The meter id
meterName	string	Required within parent	The meter name
minPricePerUnit	string	Required within parent	The min price per unit, applicable for dynamic price type
priceType	string	Required within parent	The price type Known values: fixed, dynamic
productName	string	Required within parent	The product name
productType	string	Required within parent	The product type
usageUnit	string	Required within parent	The usage unit for the meter

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_rebilling_config_for_app. Catalog operation: get-rebilling-config-for-app. 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: ["oauth.readonly"]

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

Official provider source