Plesk Price Selling

/plesk-price-selling

GET

Return selling prices

Request parameters

All parameters are optional.

price_list

string

UUID of the price list to return the selling prices for.

plan

string

UUID of the plan to return the selling prices for.

JSON response

Possible errors

N/A

Sample

curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/plesk-price-selling" | python -m json.tool

POST

Create a selling price

JSON request

price_list

string

UUID of the price list to define a price for.

plan

string

UUID of the plan to define a price for.

currency

string

3 character ISO 4217 currency code

name

string

Name of the price list.

start

datetime

Date/Time indicating when the price get active (there is always one price active).

actions

list

For each action available for the selected plan an amount should be defined.

action

string

Slug of the action.

amount

integer

Amount in cents

JSON response

Possible errors

Sample

curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
    {
        "name": "Action price for April",
        "currency": "EUR",
        "plan": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "start": "2016-04-04 00:00:00",
        "actions": [
            {
                "action": "create",
                "amount": 1000
            },
            {
                "action": "renew",
                "amount": 1500
            }
        ]
    }
' \
"{{api_base_url}}/plesk-price-selling" | python -m json.tool

/plesk-price-selling/{id}

GET

Get detailed information about selling price.

JSON response

Possible errors

Sample

curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/plesk-price-selling/{id}" | python -m json.tool

PUT

Update a selling price.

JSON request

currency

string

3 character ISO 4217 currency code

name

string

Name of the price list.

start

datetime

Date/Time indicating when the price get active (there is always one price active).

actions

list

For each action available for the selected plan an amount should be defined.

action

string

Slug of the action.

amount

integer

Amount in cents

JSON response

Possible errors

Sample

curl \
--request PUT \
--user "{{api_username}}:{{api_key}}" \
--data '
    {
        "name": "Action price for April",
        "currency": "EUR",
        "start": "2016-04-04 00:00:00",
        "actions": [
            {
                "action": "create",
                "amount": 1000
            },
            {
                "action": "renew",
                "amount": 1500
            }
        ]
    }
' \
"{{api_base_url}}/plesk-price-selling/{id}" | python -m json.tool