Account8

AccountPlan6

Aggregation5

Auth1

BalanceChargeSchedule6

Balances8

BalanceTransactionSchedule6

Bill20

BillConfig2

BillGroupingKey5

BillJob5

Charge5

Commitments6

CompoundAggregation5

Contract6

Counter5

CounterAdjustments5

CounterPricing5

CreditReason5

Credits5

Currency5

CustomField2

DataExplorer20

DataExplorerV26

DebitReason5

Debits5

Events4

ExportAdHoc1

ExportDestination6

ExportJob2

ExportSchedule5

External Mapping8

ExternalMappings2

IntegrationConfigs12

IntegrationCredentials5

IntegrationDestinations22

IntegrationRuns7

IntegrationTransformations7

Invitations3

Line Item1

LookupTable5

LookupTableRevision6

LookupTableRevisionData13

Marketplace Integrations1

Measurements6

Meter5

MeterGroup5

Notifications6

OrganizationConfig2

OrgUsers6

PermissionPolicy13

Plan5

PlanGroup5

PlanGroupLink5

PlanTemplate5

Pricing5

Product5

ResourceGroup9

ScheduledEventConfigurations5

ServiceUser6

ServiceUserCredentials6

StatementDefinition5

StatementJob5

Support3

TransactionType5

User1

Balances

List Balances

Changed on Oct 16, 2026

Retrieve a list of all Balances for your Organization.

This endpoint returns a list of all Balances associated with your organization. You can filter the Balances by the end customer's Account UUID and end dates, and paginate through them using the pageSize and nextToken parameters.

NOTE: If a Balance has a rollover amount configured and you want to use the endDateStart or endDateEnd query parameters, the rolloverEndDate is used as the end date/time for the Balance.

get/organizations/{orgId}/balances

Request

Base URL
https://api.m3ter.com
Auth
OAuth 2
Authorization codehttps://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize, token URL https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token
Client credentialsToken URL /oauth/token
TypeScript
https://skmtc.dev/m3ter-com/apis/m3ter-api/docs/organizations/:orgId/balances/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

orgIdstring required

The unique identifier (UUID) for your organization. The Organization represents your company as a direct customer of our service.

Query parameters

pageSizeinteger

The maximum number of Balances to return per page.

nextTokenstring

The nextToken for retrieving the next page of Balances. It is used to fetch the next page of Balances in a paginated list.

accountIdstring

The unique identifier (UUID) for the end customer's account.

endDateStartstring

Only include Balances with end date/times equal to or later than this date/time (in ISO-8601 format). If a Balance has a rollover amount configured, then the rolloverEndDate will be used as the end date/time.

endDateEndstring

Only include Balances with end date/times earlier than this date/time (in ISO-8601 format). If a Balance has a rollover amount configured, then the rolloverEndDate will be used as the end date/time.

contractstring

contractIdstring

Filter Balances by contract id. Use '' with accountId to fetch unlinked balances.

idsstring[]

A list of unique identifiers (UUIDs) for specific Balances to retrieve.

Response

Returns list of Balances