Skip to main content
GET
/
organizations
/
{orgId}
/
balances
/
{balanceId}
/
balancechargeschedules
List BalanceChargeSchedule
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/balances/{balanceId}/balancechargeschedules \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "chargeDescription": "<string>",
      "version": 123,
      "customFields": {},
      "balanceId": "<string>",
      "name": "<string>",
      "code": "<string>",
      "amount": 123,
      "units": 123,
      "unitPrice": 123,
      "currency": "<string>",
      "servicePeriodStartDate": "2023-11-07T05:31:56Z",
      "servicePeriodEndDate": "2023-11-07T05:31:56Z",
      "billEpoch": "2023-12-25",
      "billFrequency": "DAILY",
      "billFrequencyInterval": 123,
      "billInAdvance": true,
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>",
      "nextRun": "2023-11-07T05:31:56Z",
      "previousRun": "2023-11-07T05:31:56Z"
    }
  ],
  "nextToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

UUID of the organization

​
balanceId
string
required

UUID of the balance

Query Parameters

​
pageSize
integer<int32>

Number of BalanceChargeSchedules to retrieve per page

Required range: 1 <= x <= 200
​
nextToken
string

nextToken for multi page retrievals

​
ids
string[] | null
Maximum array length: 200

Response

ListBalanceChargeSchedule 200 response

​
data
object[]
​
nextToken
string