HighLevel: Get all wallet charges

← Marketplace operations · Get started

Operation gohighlevel.getcharges

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

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.meterId	string	Optional
query.eventId	string	Optional
query.userId	string	Optional
query.startDate	string	Optional
query.endDate	string	Optional
query.skip	number	Optional
query.limit	number	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
$	object	Root
charges	array	Optional	List of wallet charges
charges[]	Model	Each item	Expand Get all wallet charges — response body — charges item
count	JSON	Optional
count (anyOf 1)	number	Alternative	Total number of charges
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pagination	object	Optional	Pagination metadata for the charges list
pagination.limit	JSON	Optional
pagination.limit (anyOf 1)	number	Alternative	Maximum number of records to return
pagination.limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pagination.skip	JSON	Optional
pagination.skip (anyOf 1)	number	Alternative	Number of records to skip
pagination.skip (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pagination.total	JSON	Optional
pagination.total (anyOf 1)	number	Alternative	Total number of charges
pagination.total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get all wallet charges — response body — charges item

Schemas

Get all wallet charges — response body — charges item

Field	Type	Presence	Description and constraints
$	object	Root
amountCharged	JSON	Optional
amountCharged (anyOf 1)	number	Alternative	Total amount charged
amountCharged (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
appId	string	Optional	App ID
chargeId	string	Optional	Charge ID
createdAt	string	Optional	Timestamp when the charge was created in our system Format: date-time
currency	string	Optional	Currency of the transaction. We currently support USD only.
entityId	string	Optional	If the entityType is Location, entityld would be locationld.
entityType	string	Optional	Indicates who was charged? Currently, we support charges for 'location' only
meta	object	Optional	meta object contains details that were sent while creating the charge via the API - eventID, description, eventTime, userld
meterId	string	Optional	Billing Meter ID (you can find this on your app's pricing page)
pricePerUnit	JSON	Optional
pricePerUnit (anyOf 1)	number	Alternative	Price per unit for the charge
pricePerUnit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
refunded	boolean	Optional	Value is 'true' if the charge has subsequently been refunded.
transactionType	string	Optional	This can be one of two values - 'charge' or 'refund'
units	JSON	Optional
units (anyOf 1)	number	Alternative	Number of units that the sub-account was charged for
units (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Optional	Timestamp when the charge was last updated in our system Format: date-time

Policy, approvals and errors

SDK function policy ID: gohighlevel.getcharges. Catalog operation: getCharges. 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.readonly"]

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

Official provider source