---
title: "Get Calling Plans for a given reference"
method: GET
path: "/v2/partition/{partitionId}/account/{accountId}/callingplan"
tags: ["Calling Plan"]
---

# Get Calling Plans for a given reference

`GET /v2/partition/{partitionId}/account/{accountId}/callingplan`

## Request

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

will get a callingplan

## Path parameters

- `accountId` string, required
- `partitionId` string, required

## Query parameters

- `referenceId` string
- `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'ACCOUNT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER'

## Response `200`

Successful operation

- CallingPlanX[]
  - `id` string
  - `referenceId` string
  - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'ACCOUNT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER'
  - `callingPlanProductId` string
  - `endDate` string, date-time
  - `startDate` string, date-time
  - `planMinutes` integer
  - `secondsRemaining` integer

## 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)
