---
title: "Search usage plan group plans"
method: GET
path: "/v1/UsagePlanGroupPlans"
tags: ["UsagePlanGroupPlans"]
---

# Search usage plan group plans

`GET /v1/UsagePlanGroupPlans`

Search for one or more usage plan group plans.

## Query parameters

- `search.usage_plan_group_plan_id` integer[]
- `search.usage_plan_group_id` integer[]
- `search.plan_id` integer[]
- `search.page_size` integer
- `search.page` integer
- `search.sort` string

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsUsagePlanGroupPlan
  - `ok` boolean
  - `has_more` boolean — Helper for pagination. Indicates there are more records returned.
  - `record_count` integer — Total number of records found by the search.
  - `records` RevAppModelsUsagePlanGroupPlan[] — List of records returned.
    - `usage_plan_group_plan_id` integer — Primary identifier for this usage plan group / usage plan association.
    - `usage_plan_group_id` integer, required — Identifier of the usage plan group.
    - `plan_id` integer, required — Identifier of the usage plan being associated to the group.
    - `retail` boolean — Indicates whether this plan is available for retail assignment within the group.
    - `wholesale` boolean — Indicates whether this plan is available for wholesale assignment within the group.
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string

## Other responses

- `500` — InternalServerError

---

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