HighLevel: Create a new wallet charge

← Marketplace operations · Get started

Operation gohighlevel.charge

Provider route: POST /marketplace/billing/charges. 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"]["charge"]>[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.charge(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.charge(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Create a new wallet charge — request body — body

Referenced models: Create a new wallet charge — request body — body

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
$	object	Root
chargeId	string	Optional	Unique identifier of the created charge
success	boolean	Optional	Indicates whether the charge was created successfully

Schemas

Create a new wallet charge — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
appId	string	Required within parent	App ID of the App
companyId	string	Required within parent	ID of the Agency the Sub-account belongs to
description	string	Required within parent	Description of the charge
eventId	string	Required within parent	Event ID / Transaction ID on your server's side. This will help you maintain the reference of the event/transaction on your end that you charged the customer for.
eventTime	string	Optional	The timestamp when the event/transaction was performed. If blank, the billing timestamp will be set as the event time. ISO8601 Format.
locationId	string	Required within parent	ID of the Sub-Account to be charged
meterId	string	Required within parent	Billing Meter ID (you can find this on your app's pricing page)
price	number	Optional	Price per unit to charge
units	number	Required within parent	Number of units to charge
userId	string	Optional	User ID

Policy, approvals and errors

SDK function policy ID: gohighlevel.charge. Catalog operation: charge. 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: ["charges.write"]

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

Official provider source