Skip to content

Get a Plan

Request

Retrieves the details of an existing plan by its ID.

Security
ApiKeyAuth
Path
planIdstringrequired
GET
/v3/plans/{planId}
curl -i -X GET \
  'https://api.tellisim.com/v3/plans/{planId}?key=YOUR_API_KEY_HERE'

Responses

Successful response containing plan details

Bodyapplication/json
errorbooleanrequired

Indicates whether an error occurred during the request

Example:false
dataobjectrequired

Contains the details of the requested plan

Response
{
  "error": false,
  "data": {
    "plan_name": "USA Plan",
    "plan_id": "0a3ee1d6-fe5e-4561-91a0-d4649aaf0754",
    "coverage_id": "819b05c4-f154-4df9-8fd1-16be3e82f5c6",
    "archived_at": "2025-01-01T00:00:00Z",
    "region_code": "US",
    "label": "blue",
    "throttling": true,
    "recurring": true,
    "archive": true,
    "data_mega_bytes": 1024,
    "period_days": 1,
    "throttling_threshold1_perc": 10,
    "throttling_threshold1_limit": "3072",
    "throttling_threshold2_perc": 10,
    "throttling_threshold2_limit": "3072",
    "throttling_threshold3_perc": 10,
    "throttling_threshold3_limit": "3072",
    "nb_occurrence": 2,
    "recurring_periodicity_type": "2",
    "recurring_periodicity_frequency": 0
  }
}