Skip to main content
GET
/
organizations
/
{orgId}
/
plans
List Plans
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/plans \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "customFields": {},
      "planTemplateId": "<string>",
      "productId": "<string>",
      "name": "<string>",
      "code": "<string>",
      "standingCharge": 123,
      "standingChargeDescription": "<string>",
      "ordinal": 123,
      "bespoke": true,
      "minimumSpend": 123,
      "minimumSpendDescription": "<string>",
      "standingChargeBillInAdvance": true,
      "minimumSpendBillInAdvance": true,
      "minimumSpendAccountingProductId": "<string>",
      "standingChargeAccountingProductId": "<string>",
      "accountId": "<string>",
      "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

UUID of the organization. The Organization represents your company as a direct customer of the m3ter service.

Query Parameters

​
pageSize
integer<int32>

Number of Plans to retrieve per page.

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

nextToken for multi-page retrievals.

​
productId
string

UUID of the Product to retrieve Plans for.

​
accountId
string[]

List of Account IDs the Plan belongs to.

​
ids
string[]

List of Plan IDs to retrieve.

Response

Returns the list of requested Plans

​
data
object[]
​
nextToken
string