Home/HighLevel/Features/Developer Resources/How to configure HighLevel wallet public APIs

Agency, Settings and Integrations

How to configure HighLevel wallet public APIs

In short

HighLevel wallet public APIs let developers retrieve balances, transactions, usage analytics and billing details through nine secure endpoints. The APIs support read only and write scopes, enable agency wide reporting, provide idempotent complimentary credit actions, and allow agencies to view subaccount spending.

AreaDeveloper Resources · Developer Resources
Used forMarketing agency, SaaS product company, Financial analyst
Setup steps6 steps in 1 task
Last updatedNovember 17, 2026

01Who this is for

  • Agency owners Need agency level spending visibility across subaccounts.
  • Developers building billing dashboards Require programmatic access to wallet balances and usage data.
  • Finance teams managing credits Use the write scope to add complimentary credits safely.

02Wallet public APIs, explained

The wallet public APIs expose nine HTTP endpoints that return financial information for an agency or its subaccounts. Four existing endpoints were migrated to the Blade Platform and five new endpoints add reporting capabilities such as top product usage and location based spending.

Requests must include a token that carries either the wallet.readonly or wallet.write scope. Agency tokens can optionally include a locationId query parameter to retrieve data for a specific subaccount. Subaccount tokens are limited to data belonging to their own wallet.

All endpoints are accessed via the /wallet path in the HighLevel API base URL. Responses follow the same structure as the previous SaaS wallet APIs for the migrated endpoints, while the new endpoints provide additional fields for usage records and billing summaries.

03How businesses use wallet public APIs

  • Marketing agency. The agency creates an integration that calls GET /wallet/usage summary to pull a monthly usage report for all client subaccounts. The data is displayed in a custom dashboard inside the agency’s own portal.
  • SaaS product company. The company uses POST /wallet/balance/complimentary credits with the wallet.write scope to credit a new customer’s subaccount wallet after a promotional offer. The request includes an idempotency key to avoid duplicate credits.
  • Financial analyst. The analyst configures an API client to call GET /wallet/billing summary with a subaccount token, extracting billing totals for a specific location. The analyst then exports the data for internal reconciliation.

04Before you start

  • Obtain a HighLevel access token that includes the required wallet.readonly or wallet.write scope.
  • Identify the specific /wallet endpoint you plan to call and note any required query parameters.

05How to set up and use wallet public APIs in HighLevel

Set up and use wallet public APIs

  1. Open the HighLevel Wallet API Documentation and choose the endpoint you need.
  2. Create or open an integration and retrieve an access token that has the appropriate wallet scope.
  3. Select the wallet.readonly scope for data retrieval or wallet.write for credit operations.
  4. Enter the endpoint URL and HTTP method in your API client, adding the Authorization header and required parameters.
  5. Send the request and check the response to ensure the expected wallet information is returned.
  6. Verify that the token you are using has the correct scope for the chosen endpoint, because token compatibility depends on the specific endpoint.

06What it looks like in HighLevel

07Settings that matter

  • wallet.readonly. Grants permission to read wallet balances, transactions, usage records and billing summaries.
  • wallet.write. Grants permission to perform write actions such as adding complimentary credits to a wallet.

08Things to know before you rely on it

  • All nine wallet API endpoints are live in production.
  • Four existing endpoints retain their original response structures after migration.
  • Complimentary credit requests must specify a positive amount; negative values are rejected.
  • The complimentary credits endpoint supports idempotency to avoid duplicate processing.
  • Agency tokens can use the locationId query parameter only on endpoints that support subaccount data.

09How it connects to the rest of HighLevel

Michael's take

Michael Reimer
Michael ReimerFounder of CRM Pros, HighLevel Commander and Certified Admin

Most people think the new /wallet endpoints are a completely different set of data, but the migrated ones keep the same response format. Treat them as a drop in replacement and focus on updating the base URL and scopes.

If I were adding wallet data to a dashboard, I would first pull the usage summary and billing summary endpoints to get a high level view, then layer in the top products and by location reports for deeper insight.

Get More InformationOpens on HighLevelPublished November 11, 2026 · Updated November 17, 2026

Common questions

Common questions about wallet public APIs.

Are all wallet public API endpoints available in production?

Yes. All nine wallet public API endpoints are live and can be called.

Can I keep using the existing SaaS wallet APIs during migration?

Yes. The older SaaS endpoints remain functional throughout the migration period but are marked as deprecated.

Do I need to change how I handle API responses after migrating?

The four migrated endpoints keep their original response structures, so response handling does not need to change for them.

Can an agency token retrieve data for multiple subaccounts?

An agency token can access subaccount wallet data when the endpoint supports the locationId query parameter and the token has the proper scope.

How does the API prevent duplicate complimentary credit requests?

The complimentary credits endpoint supports an idempotency key, which helps avoid processing the same credit twice if a request is retried.

Next step

Pick the features that matter. Then get the plan that unlocks them.

Explore the features you want, start with the five at the top, and upgrade through my link when you are ready. The bonuses and the team come with it.

The features directory explains every HighLevel feature in plain English. Browse it to see what the platform can do.

Back to the FeaturesSee the full details
⌃

Site preview

Explore the next page

This destination is reserved in the page inventory and is not built yet.