Account Available Plan List

Last updated on 2022-06-10 13:25:24

URI	/v1/accounts/{username}/available_plans
URI Parameters	username (string)
Methods	GET, POST

GET /v1/accounts/{username}/available_plans

Gets an account's available plans and current plan.

Scope	accounts_read
Query Selector Parameters	n/a
Query Pagination Parameters	page (int) – the page to show (min 1, default 1) page_size (int) – the number of plans per page (min 1, max 50, default 10)
Query Sorting Parameters	order_by (string const) – PLAN_ID\|PLAN_NAME\|PRICE order_dir (string const) – ASC\|DESC
Request Body Parameters	n/a
Response Attributes	plan_id (int) name (string) setup_price (decimal) – price of setup to be added during the first month of billing base_usage (int) – bytes of base usage base_price (decimal) – base price of the plan extra_usage (int) – bytes of overusage blocks extra_price (decimal) – price of each overusage block computers (int) – number of computers included before charging for extra computers computers_usage (int) – bytes of available usage added for each extra computer computers_price (decimal) – price for each extra computer local_backup_price (decimal) – price of a local backup subscription vm_host_price (decimal) – price of a QuickSpin host license disk_image_price (decimal) – price of a DiskImage license es_seat_price(decimal) – price of each ECHOShare seat es_connection_price(decimal)-price of each ECHOShare connection es_cost_extra_block(decimal) – cost of each ECHOShare extra block total_cost (decimal) – Cost if this was the account was to be billed on this plan now is_current (bool) – If true, this is the account’s current plan is_optimal (bool) – If true, this is the account’s optimal plan

Example JSON

Request:

GET /v1/accounts/barracuda/available_plans HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/json

Response:

HTTP/1.1 200 OK

Content-Type: application/json

{

"page": 1,

"page_size": 10,

"count": 10,

"links": [

{

"rel": "first",

"href": "https://api.intronis.com/v1/accounts/barracuda/available_plans?page=1"

}

"list": [

{

"plan_id": 10,

"name": "20g Monthly",

"setup_price": 0.00,

"base_usage": 21474836480,

"base_price": 19.95,

"extra_usage": 1073741824,

"extra_price": 0.95,

"computers": 10,

"computers_usage": 5368709120,

"computers_price": 4.95,

"local_backup_price": 4.95,

"vm_host_price": 60,

"disk_image_price": 60,

"es_seat_price": 30,

"es_connection_price": 25,

"es_cost_extra_block": 50,

"total_cost": 19.95,

"is_current": true,

"is_optimal": false

{

"plan_id": 11,

"name": "10g Monthly",

"setup_price": 5.00,

"base_usage": 10737418240,

"base_price": 9.95,

"extra_usage": 1073741824,

"extra_price": 0.95,

"computers": 10,

"computers_usage": 5368709120,

"computers_price": 4.95,

"local_backup_price": 4.95,

"vm_host_price": 60,

"disk_image_price": 60,

"es_seat_price": 30,

"es_connection_price": 25,

"es_cost_extra_block": 50,

"total_cost": 14.70,

"is_current": false,

"is_optimal": true

}

]

}

Example XML

Request:

GET /v1/accounts/barracuda/available_plans HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/xml

Response:

HTTP/1.1 200 OK

Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>

<plan>

<plan_id>10</plan_id>

<name>20g Monthly</name>

<setup_price>0.00</setup_price>

<base_usage>21474836480</base_usage>

<base_price>19.95</base_price>

<extra_usage>1073741824</extra_usage>

<extra_price>0.95</extra_price>

<computers_usage>5368709120</computers_usage>

<computers_price>4.95</computers_price>

<local_backup_price>4.95</local_backup_price>

<vm_host_price>60</vm_host_price>

<disk_image_price>60</disk_image_price>

<es_seat_price>30</es_seat_price>

<es_connection_price>25</es_connection_price>

<es_cost_extra_block>50</es_cost_extra_block>

<total_cost>19.95</total_cost>

<is_current>true</is_current>

<is_optimal>false</is_optimal>

</plan>

<plan>

<plan_id>11</plan_id>

<name>10g Monthly</name>

<setup_price>5.00</setup_price>

<base_usage>10737418240</base_usage>

<base_price>9.95</base_price>

<extra_usage>1073741824</extra_usage>

<extra_price>0.95</extra_price>

<computers_usage>5368709120</computers_usage>

<computers_price>4.95</computers_price>

<local_backup_price>4.95</local_backup_price>

<vm_host_price>60</vm_host_price>

<disk_image_price>60</disk_image_price>

<es_seat_price>30</es_seat_price>

<es_connection_price>25</es_connection_price>

<es_cost_extra_block>50</es_cost_extra_block>

<total_cost>14.70</total_cost>

<is_current>false</is_current>

<is_optimal>true</is_optimal>

</plan>

</list>

POST /v1/accounts/{username}/available_plans

Sets an account to an available plan.

Scope	accounts_write
Request Body Parameters	plan_id (int) – the plan id from the Account Available Plan List resource
Response Attributes	n/a

Example JSON

Request:

POST /v1/accounts/barracuda/available_plans HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Content-Type: application/json

{

"plan_id": 1

}

Response:

HTTP/1.1 204 No Content

Example XML

Request:

POST /v1/accounts/barracuda/available_plans HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>

<plan>

<plan_id>1</plan_id>

</plan>

Response:

HTTP/1.1 204 No Content