# Create Plans

Creates a plan with the given configuration.

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

## Request fields (application/json):

  - `coverage_id` (string, required)
    coverage id of the region.
    Example: "819b05c4-f154-4df9-8fd1-16be3e82f5c6"

  - `data_MBs` (number, required)
    The amount of MBs you want in the plan
    Example: 1024

  - `name` (string, required)
    Name of the plan which can be any thing you like.
    Example: "test1 recurring and throttling package"

  - `period_days` (number, required)
    plan validity in days
    Example: 1

  - `recurring` (boolean, required)
    Set to true if you want the plan to be recurring
    Example: true

  - `throttling` (boolean, required)
    Set to true if you want the plan to be throttled
    Example: true

  - `nb_occurrence` (number)
    The number of occurrences for the plan. Required if recurring is true.
    Example: 2

  - `recurring_periodicity_type` (string)
    Recurring periodicity type. Possible values are 0=Daily, 1=Weekly, 2=Monthly. Required if recurring is true.
    Enum: "0", "1", "2"

  - `recurring_periodicity_frequency` (number)
    Along with recurring_periodicity_type will determine the frequency at which the subscriber will receive its packages. For example recurring_periodicity_frequency=0 and recurring_periodicity_frequency=2, the subscriber is going to receive a package every 2 days. Required if recurring is true.
    Example: 2

  - `throttling_threshold1_perc` (number)
    First threshold for throttling, in percentage of the total volume of the package. Required if throttling is true.
    Example: 50

  - `throttling_threshold1_limit` (string)
    Limit to apply when the subscriber is crossing the first threshold. It's units is Kbit/sec. Required if throttling is true.
    Enum: "128", "256", "384", "512", "1024", "3072", "5120", "7680", "10240", "20480"

  - `throttling_threshold2_perc` (number)
    Second threshold for throttling, in percentage of the total volume of the package. Required if throttling is true.
    Example: 90

  - `throttling_threshold2_limit` (string)
    Limit to apply when the subscriber is crossing the second threshold. It's units is Kbit/sec. Required if throttling_threshold2_perc is present in request.
    Enum: "128", "256", "384", "512", "1024", "3072", "5120", "7680", "10240", "20480"

  - `throttling_threshold3_perc` (number)
    Third threshold for throttling, in percentage of the total volume of the package. Required if throttling is true.
    Example: 100

  - `throttling_threshold3_limit` (string)
    Limit to apply when the subscriber is crossing the third threshold. It's units is Kbit/sec. Required if throttling_threshold3_perc is present in request.
    Enum: "128", "256", "384", "512", "1024", "3072", "5120", "7680", "10240", "20480"

## Response 201 fields (application/json):

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

  - `message` (string, required)
    A message providing additional information about the error (if any)
    Example: "plan created successfully"

  - `plan_id` (string, required)
    The unique identifier for the newly created plan (if successful)
    Example: "39c3ae26-22a5-49cb-93ca-2fe65b3a5c69"

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