# Get a Plan

Retrieves the details of an existing plan by its ID.

Endpoint: GET /v3/plans/{planId}
Version: 1.0.0
Security: ApiKeyAuth

## Path parameters:

  - `planId` (string, required)

## Response 200 fields (application/json):

  - `error` (boolean, required)
    Indicates whether an error occurred during the request

  - `data` (object, required)
    Contains the details of the requested plan

  - `data.plan_name` (string, required)
    Name of the plan
    Example: "USA Plan"

  - `data.plan_id` (string, required)
    The unique identifier of the plan
    Example: "0a3ee1d6-fe5e-4561-91a0-d4649aaf0754"

  - `data.coverage_id` (string, required)
    The ID associated with the plan's coverage
    Example: "819b05c4-f154-4df9-8fd1-16be3e82f5c6"

  - `data.archived_at` (string,null, required)
    Timestamp indicating when the plan was archived, if applicable
    Example: "2025-01-01T00:00:00Z"

  - `data.region_code` (string, required)
    The code representing the region for the plan
    Example: "US"

  - `data.label` (string, required)
    A human-readable label for the plan
    Example: "blue"

  - `data.throttling` (boolean, required)
    Indicates if throttling is applied to the plan
    Example: true

  - `data.recurring` (boolean, required)
    Indicates if the plan has a recurring billing cycle
    Example: true

  - `data.archive` (boolean, required)
    Indicates if the plan is archived
    Example: true

  - `data.data_mega_bytes` (integer, required)
    The amount of data in megabytes included in the plan
    Example: 1024

  - `data.period_days` (integer, required)
    The duration of the plan in days
    Example: 1

  - `data.throttling_threshold1_perc` (integer)
    The percentage threshold for first throttling
    Example: 10

  - `data.throttling_threshold1_limit` (string)
    The limit associated with the first throttling threshold
    Enum: "32", "64", "128", "256", "384", "512", "1024", "3072", "5120", "7680", "10240", "20480"

  - `data.throttling_threshold2_perc` (integer)
    The percentage threshold for second throttling
    Example: 10

  - `data.throttling_threshold2_limit` (string)
    The limit associated with the second throttling threshold
    Enum: "32", "64", "128", "256", "384", "512", "1024", "3072", "5120", "7680", "10240", "20480"

  - `data.throttling_threshold3_perc` (integer)
    The percentage threshold for third throttling
    Example: 10

  - `data.throttling_threshold3_limit` (string)
    The limit associated with the third throttling threshold
    Enum: "32", "64", "128", "256", "384", "512", "1024", "3072", "5120", "7680", "10240", "20480"

  - `data.nb_occurrence` (integer)
    The number of occurrences for the plan
    Example: 2

  - `data.recurring_periodicity_type` (string)
    The type of periodicity for the recurring plan. Possible values are 0=Daily, 1=Weekly, 2=Monthly.
    Example: "2"

  - `data.recurring_periodicity_frequency` (integer)
    The frequency of the recurring billing cycle

## Response 401 fields (application/json):

  - `error` (boolean, required)
    Indicates whether an error occurred during the request
    Example: true

  - `message` (string, required)
    Error message describing the unauthorized access
    Example: "Unauthorized: API key is missing"