Skip to content

Create Plans

Request

Creates a plan with the given configuration.

Security
ApiKeyAuth
Bodyapplication/json
coverage_idstringrequired

coverage id of the region.

Example:"819b05c4-f154-4df9-8fd1-16be3e82f5c6"
data_MBsnumber, >= 1required

The amount of MBs you want in the plan

Example:1024
namestringrequired

Name of the plan which can be any thing you like.

Example:"test1 recurring and throttling package"
period_daysnumber, [ 1 .. 1825 ]required

plan validity in days

Example:1
recurringbooleanrequired

Set to true if you want the plan to be recurring

Example:true
throttlingbooleanrequired

Set to true if you want the plan to be throttled

Example:true
nb_occurrencenumber, [ 2 .. 550 ]

The number of occurrences for the plan. Required if recurring is true.

Example:2
recurring_periodicity_typestring

Recurring periodicity type. Possible values are 0=Daily, 1=Weekly, 2=Monthly. Required if recurring is true.

Enum:"0""1""2"
Example:"0"
recurring_periodicity_frequencynumber

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_percnumber, [ 0 .. 100 ]

First threshold for throttling, in percentage of the total volume of the package. Required if throttling is true.

Example:50
throttling_threshold1_limitstring(ThrottlingThresholdLimit)

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"
Example:"3072"
throttling_threshold2_percnumber, [ 0 .. 100 ]

Second threshold for throttling, in percentage of the total volume of the package. Required if throttling is true.

Example:90
throttling_threshold2_limitstring(ThrottlingThresholdSecondLimit)

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"
Example:"3072"
throttling_threshold3_percnumber, [ 0 .. 100 ]

Third threshold for throttling, in percentage of the total volume of the package. Required if throttling is true.

Example:100
throttling_threshold3_limitstring(ThrottlingThresholdThirdLimit)

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"
Example:"3072"
POST
/v3/plans
curl -i -X POST \
  'https://api.tellisim.com/v3/plans?key=YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "coverage_id": "819b05c4-f154-4df9-8fd1-16be3e82f5c6",
    "data_MBs": 1024,
    "name": "test1 recurring and throttling package",
    "period_days": 1,
    "recurring": true,
    "throttling": true,
    "nb_occurrence": 2,
    "recurring_periodicity_type": "0",
    "recurring_periodicity_frequency": 2,
    "throttling_threshold1_perc": 50,
    "throttling_threshold1_limit": "10240",
    "throttling_threshold2_perc": 75,
    "throttling_threshold2_limit": "5120",
    "throttling_threshold3_perc": 90,
    "throttling_threshold3_limit": "1024"
  }'

Responses

Plan created successfully

Bodyapplication/json
errorbooleanrequired

Indicates if there was an error processing the request

Example:false
messagestringrequired

A message providing additional information about the error (if any)

Example:"plan created successfully"
plan_idstringrequired

The unique identifier for the newly created plan (if successful)

Example:"39c3ae26-22a5-49cb-93ca-2fe65b3a5c69"
Response
{
  "error": false,
  "message": "plan created successfully",
  "plan_id": "39c3ae26-22a5-49cb-93ca-2fe65b3a5c69"
}