Partner Plan

Last updated on 2022-06-16 11:35:45

URI	/v1/partners/{username}/plans/{plan_id}
URI Parameters	username (string) plan_id (int)
Methods	GET, PUT, DELETE

GET /v1/partners/{username}/plans/{plan_id}

Gets a partner's branded plan

Scope	partners_read
Request Body Parameters	n/a
Response Attributes	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

Example JSON

Request:

GET /v1/partners/barracuda/plans/10 HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/json

Response:

HTTP/1.1 200 OK

Content-Type: application/json

{

"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

}

Example XML

Request:

GET /v1/partners/barracuda/plans/10 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>

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

</plan>

PUT /v1/partners/{username}/plans/{plan_id}

Edits a partner's branded plan.

Scope	partners_write
Request Body Parameters	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
Response Attributes	n/a

Example JSON

Request:

PUT /v1/partners/barracuda/plans/10 HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Content-Type: application/json

{

"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

}

Response:

HTTP/1.1 204 No Content

Example XML

Request:

PUT /v1/partners/barracuda/plans/10 HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Content-Type: application/xml

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

<plan>

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

</plan>

Response:

HTTP/1.1 204 No Content

DELETE /v1/partners/{username}/plans/{plan_id}

Deletes a partner's branded plan.

Scope	partners_write
Request Body Parameters	n/a
Response Attributes	n/a

Example

Request:

DELETE /v1/partners/barracuda/users/tech_user HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Response:

HTTP/1.1 204 No Content