# List plans

This endpoint retrieves a list of available plans. It allows users to specify pagination and filter out archived plans.

Endpoint: GET /v3/plans
Version: 1.0.0
Security: ApiKeyAuth

## Query parameters:

  - `archived` (boolean)
    When true, only archived plans are returned. When false, only non archived plans are returned. When absent all are returned.

  - `page_size` (string)
    Number of items to be returned in a single page

  - `page` (string)
    A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call.

  - `label` (string)
    Filter plans by label. Allowed values are Green, Aqua, Blue, Voilet, Red, Grey, Orange
    Enum: "Green", "Aqua", "Blue", "Voilet", "Red", "Grey", "Orange"

  - `search_query` (string)
    Query to search the plans by name

  - `country_iso_2` (string)
    Comma separated list of countryIso2 e.g. countryIso2=FR,IN

## Response 200 fields (application/json):

  - `error` (boolean, required)
    Indicates if there was an error in the request

  - `data` (array, required)
    An array of plan objects returned by the request

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

  - `data.plan_id` (string, required)
    Unique identifier for the plan
    Example: "39c3ae26-22a5-49cb-93ca-2fe65b3a5c69"

  - `data.coverage_id` (string, required)
    Identifier for the coverage area of the plan
    Example: "819b05c4-f154-4df9-8fd1-16be3e82f5c6"

  - `data.archived_at` (string,null, required)
    Timestamp of when the plan was archived (if applicable)

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

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

  - `data.created_at` (string, required)
    Timestamp of when the plan was created
    Example: "2025-01-01T00:00:00Z"

  - `data.throttling` (boolean, required)
    Indicates if the plan has throttling enabled
    Example: true

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

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

  - `data.period_days` (integer, required)
    Duration of the plan in days
    Example: 30

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

  - `data.period_iterations` (integer)
    Number of iterations for the plan period
    Example: 12

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

  - `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: 80

  - `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: 90

  - `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: 12

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

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

  - `next_page` (string,null, required)
    Token for the next page of results, if available

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