Skip to main content
GET
/
organizations
/
{orgId}
/
plantemplates
List PlanTemplate
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/plantemplates \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "string",
      "version": 1,
      "customFields": {
        "example1": 123,
        "example2": "string"
      },
      "productId": "string",
      "name": "string",
      "currency": "USD",
      "standingCharge": 0,
      "standingChargeDescription": "string",
      "standingChargeInterval": 1,
      "standingChargeOffset": 364,
      "billFrequencyInterval": 1,
      "billFrequency": "DAILY",
      "ordinal": 0,
      "code": "string",
      "minimumSpend": 0,
      "minimumSpendDescription": "string",
      "standingChargeBillInAdvance": true,
      "minimumSpendBillInAdvance": false
    }
  ],
  "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>

Specifies the maximum number of PlanTemplates to retrieve per page.

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

The nextToken for multi-page retrievals. It is used to fetch the next page of PlanTemplates in a paginated list.

​
productId
string

The unique identifiers (UUIDs) of the Products to retrieve associated PlanTemplates.

​
ids
string[]

List of specific PlanTemplate UUIDs to retrieve.

Response

Returns the list of requested PlanTemplates

​
data
object[]
​
nextToken
string