---
title: "List data plans"
method: GET
path: "/plans"
tags: ["Organizations"]
---

# List data plans

`GET /plans`

## Request

- Base URL: `https://dashboard.hologram.io/api/1`
- URL: `https://dashboard.hologram.io/api/1/plans`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/hologram/apis/hologram-rest-api-v1/docs/plans/get.ts> (a function with typed inputs; its response is checked against the schema)

List all data plans.
Returns all data plans matching the specified parameters.

## Query parameters

- `orgid` integer
- `id` integer
- `ids` string
- `name` string
- `carrierid` integer
- `display_category` string
- `startafter` integer
- `include_rate_card_range` boolean
- `rate_card_effective_date` string
- `limit` integer
- `cellular_coverage_region_id` integer
- `network` integer
- `includezdr` boolean
- `includepid` boolean

## Response `200`

OK

- ListPlansResponse
  - `success` boolean: Indicates whether the request was successful.
  - `limit` integer
  - `size` integer
  - `continues` boolean
  - `lastid` integer: ID of the last record returned, for cursor-based pagination
  - `links` PaginationLinks
    - `path` string: The API endpoint path
    - `base` string: The API base URL
    - `next` string: URL to retrieve the next page of results
  - `data` DataPlanDetailsObject[]
    - `id` integer: Unique plan ID
    - `name` string: Plan name
    - `description` string: Plan description
    - `data` integer: Included data in bytes
    - `billingperiod` integer: Billing period in days
    - `recurring` 0 | 1: 1 if the plan auto-renews
    - `enabled` 0 | 1: 1 if the plan is currently available
    - `developerplan` 0 | 1: 1 if this is a developer plan
    - `groupid` integer: Plan group ID
    - `partnerid` integer: Partner this plan belongs to
    - `display_category` string, nullable: Display category for this plan
    - `cellular_coverage_region_id` integer, nullable: Cellular coverage region ID
    - `use_variable_rates` boolean: Whether this plan uses variable rates
    - `is_dynamic_pool` boolean: Whether this plan uses a dynamic pool
    - `cellular_coverage_region` PlanCoverageRegion
      - `id` integer: Region ID
      - `display_name` string: Region display name
      - `description` string: Region description
    - `tiers` DataPlanTiersMap
    - `current_tier` string, nullable: Current pricing tier for the requesting organization
    - `zones` DataPlanZonesMap
    - `amountglobal` string, nullable: Legacy flattened amount for the global zone (key name matches zone name casing)
    - `smsglobal` string, nullable: Legacy flattened SMS amount for the global zone (key name matches zone name casing)
    - `overageglobal` string, nullable: Legacy flattened overage amount for the global zone (key name matches zone name casing)
    - `variable_rates_range` PlanVariableRatesRange
      - `min` number, nullable: Minimum price per megabyte
      - `max` number, nullable: Maximum price per megabyte
    - `profiles` DataPlanProfile[], nullable: Carrier profiles (present on single-plan responses only)
      - `carrierId` integer: Carrier ID
      - `name` string: Profile name
      - `offerId` integer: Carrier offer ID

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/hologram/apis/hologram-rest-api-v1.md) - [All operations](https://skmtc.dev/hologram/apis/hologram-rest-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/hologram/apis/hologram-rest-api-v1/revisions/1bc07dcd1631?raw)