Skip to main content
GET
/
organizations
/
{orgId}
/
accountplans
List AccountPlan
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/accountplans \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "customFields": {},
      "accountId": "<string>",
      "productId": "<string>",
      "planId": "<string>",
      "planGroupId": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "code": "<string>",
      "billEpoch": "2023-12-25",
      "contractId": "<string>",
      "childBillingMode": "PARENT_SUMMARY",
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>"
    }
  ],
  "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

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

Query Parameters

​
pageSize
integer<int32>

The maximum number of AccountPlans and AccountPlanGroups to return per page.

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

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

​
date
string

The specific date for which you want to retrieve AccountPlans and AccountPlanGroups.

NOTE: Returns both active and inactive AccountPlans and AccountPlanGroups for the specified date.

​
account
string

The unique identifier (UUID) for the Account whose AccountPlans and AccountPlanGroups you want to retrieve.

NOTE: Only returns the currently active AccountPlans and AccountPlanGroups for the specified Account. Use in combination with the includeall query parameter to return both active and inactive.

​
plan
string

The unique identifier (UUID) for the Plan whose associated AccountPlans you want to retrieve.

NOTE: Does not return AccountPlanGroups if you use a planGroupId.

​
product
string

The unique identifier (UUID) for the Product whose associated AccountPlans you want to retrieve.

NOTE: You cannot use the product query parameter as a single filter condition, but must always use it in combination with the account query parameter.

​
includeall
boolean

A Boolean flag that specifies whether to include both active and inactive AccountPlans and AccountPlanGroups in the list.

  • TRUE - both active and inactive AccountPlans and AccountPlanGroups are included in the list.
  • FALSE - only active AccountPlans and AccountPlanGroups are retrieved in the list.(Default)

NOTE: Only operative if you also have one of account, plan or contract as a query parameter.

​
ids
string[]

A list of unique identifiers (UUIDs) for specific AccountPlans and AccountPlanGroups you want to retrieve.

​
contract
string | null

The unique identifier (UUID) of the Contract which the AccountPlans you want to retrieve have been linked to.

NOTE: Does not return AccountPlanGroups that have been linked to the Contract.

Response

Returns the list of AccountPlans and AccountPlanGroups

​
data
object[]
​
nextToken
string