---
title: "Retrieve calling plan product list"
method: GET
path: "/v2/partition/{partitionId}/callingplanproduct"
tags: ["Calling Plan Product"]
---

# Retrieve calling plan product list

`GET /v2/partition/{partitionId}/callingplanproduct`

## Request

- Base URL: `https://api.alianza.com`
- URL: `https://api.alianza.com/v2/partition/{partitionId}/callingplanproduct`
- Auth: API key in header `X-AUTH-TOKEN`
- TypeScript: <https://skmtc.dev/alianza/apis/alianza-public-api/docs/v2/partition/:partitionId/callingplanproduct/get.ts> (a function with typed inputs; its response is checked against the schema)

Use to retrieve a list of calling plan products

## Path parameters

- `partitionId` string, required

## Query parameters

- `includeArchived` boolean

## Response `200`

Successful operation

- CallingPlanProduct[]
  - `id` string: Not required for POST operation
  - `name` string
  - `planMinutes` integer
  - `unlimitedDisplay` boolean
  - `allowOverage` boolean
  - `preventForwarding` boolean
  - `defaultPlan` boolean
  - `callRateFor411` number, double
  - `allow411` boolean
  - `rateTypeFor411` 'PER_CALL' | 'PER_MINUTE'
  - `callRateForOperator` number, double
  - `allowOperator` boolean
  - `rateTypeForOperator` 'PER_CALL' | 'PER_MINUTE'
  - `partitionId` string
  - `allowUnlimitedLocal` boolean
  - `rateIntraPartitionAsFree` boolean

## Other responses

- `400`: Invalid request parameters
- `401`: Unauthorized
- `404`: Not found

---

[API](https://skmtc.dev/alianza/apis/alianza-public-api.md) - [All operations](https://skmtc.dev/alianza/apis/alianza-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alianza/apis/alianza-public-api/revisions/7223246c352c?raw)
