---
title: "Search usage plan rates"
method: GET
path: "/v1/UsagePlanRates"
tags: ["UsagePlanRates"]
---

# Search usage plan rates

`GET /v1/UsagePlanRates`

Search for one or more usage plan rates.

## Query parameters

- `search.usage_plan_rate_id` integer[]
- `search.plan_id` integer[]
- `search.description` string[]
- `search.page_size` integer
- `search.page` integer
- `search.sort` string

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsUsagePlanRate
  - `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` RevAppModelsUsagePlanRate[] — List of records returned.
    - `usage_plan_rate_id` integer — Primary identifier for this usage plan rate.
    - `plan_id` integer, required — Identifier of the usage plan this rate belongs to.
    - `description` string, required — Short description of this rate.
    - `rate` number, double — The rate amount.
    - `surcharge` number, double — Additional surcharge applied on top of the rate.
    - `initial` integer — Number of seconds/units included before increment billing begins.
    - `increment` integer — Billing increment, in seconds/units, applied after the initial period.
    - `country` string — Country code this rate applies to.
    - `state` string — State/province this rate applies to.
    - `area` string — Area/NPA this rate applies to.
    - `lata` string — LATA this rate applies to.
    - `ocn` string — OCN this rate applies to.
    - `product_type_id` integer — Product type this rate applies to.
    - `line_type` string — Service/line type this rate applies to.
    - `direction` 'OUTBOUND' | 'INBOUND' | 'BOTH' — Call direction this rate applies to.
    - `carrier_code` string — Carrier code this rate applies to.
    - `source_type` string — Source/external type for this rate.
    - `start_date` string, date-time — Date this rate becomes effective.
    - `end_date` string, date-time — Date this rate is no longer effective.
    - `rounding_digits` integer — Number of digits to round the calculated charge to.
    - `minimum_charge` number, double — Minimum charge to apply regardless of calculated usage.
    - `zone` integer — Zone this rate applies to.
    - `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)