---
title: "Search usage plans"
method: GET
path: "/v1/UsagePlans"
tags: ["UsagePlans"]
---

# Search usage plans

`GET /v1/UsagePlans`

Search for one or more usage plans.

## Query parameters

- `search.plan_id` integer[]
- `search.description` string[]
- `search.active` boolean
- `search.created_date_start` string, date-time
- `search.created_date_end` string, date-time
- `search.page_size` integer
- `search.page` integer
- `search.sort` string

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsUsagePlan
  - `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` RevAppModelsUsagePlan[] — List of records returned.
    - `plan_id` integer — Primary identifier for this usage plan.
    - `description` string, required — Short description (i.e. the name).
    - `rate_method` 'STANDARD' | 'MARGIN' | 'MARKUP' — Rate calculation method for this plan.
    - `active` boolean — Indicates whether the plan can be assigned.
    - `created_date` string, date-time — Date and time this plan was created.
    - `created_by` integer — Foreign identifier indicating which user created it.
    - `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)