---
title: "List PlanGroups"
method: GET
path: "/organizations/{orgId}/plangroups"
tags: ["PlanGroup"]
---

# List PlanGroups

`GET /organizations/{orgId}/plangroups`

Retrieve a list of PlanGroups.

Retrieves a list of PlanGroups within the specified organization. You can optionally filter by Account IDs or PlanGroup IDs, and also paginate the results for easier management.

## Path parameters

- `orgId` string, required

## Query parameters

- `pageSize` integer
- `nextToken` string
- `accountId` string[]
- `ids` string[]

## Response `200`

Returns the list of PlanGroups

- PaginatedPlanGroupResponseData
  - `data` PlanGroupResponse[]
    - `id` string, required — The UUID of the entity.
    - `version` integer — The version number: - **Create:** On initial Create to insert a new entity, the version is set at 1 in the response. - **Update:** On successful Update, the version is incremented by 1 in the response.
    - `customFields` object — User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number. If `customFields` can also be defined for this entity at the Organizational level,`customField` values defined at individual level override values of `customFields` with the same name defined at Organization level. See [Working with Custom Fields](https://www.m3ter.com/docs/guides/creating-and-managing-products/working-with-custom-fields) in the m3ter documentation for more information.
    - `name` string — The name of the PlanGroup.
    - `code` string — The short code representing the PlanGroup.
    - `standingCharge` number, double — Standing charge amount for the PlanGroup.
    - `standingChargeDescription` string — Description of the standing charge, displayed on the bill line item.
    - `minimumSpend` number, double — The minimum spend amount for the PlanGroup.
    - `minimumSpendDescription` string — Description of the minimum spend, displayed on the bill line item.
    - `currency` string — Currency code for the PlanGroup (For example, USD).
    - `standingChargeBillInAdvance` boolean — A boolean flag that determines when the standing charge is billed. This flag overrides the setting at Organizational level for standing charge billing in arrears/in advance. * **TRUE** - standing charge is billed at the start of each billing period. * **FALSE** - standing charge is billed at the end of each billing period.
    - `minimumSpendBillInAdvance` boolean — A boolean flag that determines when the minimum spend is billed. This flag overrides the setting at Organizational level for minimum spend billing in arrears/in advance. * **TRUE** - minimum spend is billed at the start of each billing period. * **FALSE** - minimum spend is billed at the end of each billing period.
    - `accountId` string — Optional. This PlanGroup was created as bespoke for the associated Account with this Account ID.
    - `minimumSpendAccountingProductId` string — Optional. Product ID to attribute the PlanGroup's minimum spend for accounting purposes.
    - `standingChargeAccountingProductId` string — Optional. Product ID to attribute the PlanGroup's standing charge for accounting purposes.
    - `dtCreated` string, date-time — The date and time *(in ISO 8601 format)* when the PlanGroup was first created.
    - `dtLastModified` string, date-time — The date and time *(in ISO 8601 format)* when the PlanGroup was last modified.
    - `createdBy` string — The unique identifier (UUID) for the user who created the PlanGroup.
    - `lastModifiedBy` string — The unique identifier (UUID) for the user who last modified the PlanGroup.
  - `nextToken` string

## Other responses

- `4XX` — Error message
- `5XX` — Error message

---

[API](https://skmtc.net/m3ter-com/apis/m3ter-api.md) · [All operations](https://skmtc.net/m3ter-com/apis/m3ter-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/m3ter-com/m3ter-api/revisions/ac93d1a9e6d9/schema)