Website Builder Plan¶
/website-builder-plan¶
GET¶
Get a list of the Website Builder Plans available for reseller. These include the plans a reseller can buy from his parent as well as his own plans (in case a reseller is a provisioner of Website Builder products himself).
Request parameters
All values are optional.
+———————————+———-+————————————————————————-+
| id
| string | The UUID or coma-separated UUIDs of Website Builder plan(s) |
+———————————+———-+————————————————————————-+
| provisioner
| string | The UUID or coma-separated UUIDs of provisioner(s) |
+———————————+———-+————————————————————————-+
| updated__gt
| datetime | The plans where the last updated date/time is after the given date/time.|
+———————————+———-+————————————————————————-+
JSON response
array: Product Plan
Possible errors
Sample
curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/website-builder-plan" | python -m json.tool
POST¶
Create a Website Builder plan. Only product provisioner can create plans.
JSON request
|
string |
The name of the Website Builder Plan. |
|
integer |
The renew interval for the Website Builder Plan (in months). |
|
string |
The description of the Website Builder Plan. |
JSON response
object: SSL Certificate Plan
Possible errors
Sample
curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
{
"name": "Test Website Builder Plan",
"interval": "1",
"description": "Test description"
}
' \
"{{api_base_url}}/website-builder-plan" | python -m json.tool
/website-builder-plan/{id}¶
GET¶
Get the detailed information about a certain Website Builder Plan.
Request parameters
N/A
JSON response
object: Product Plan
Possible errors
Sample
curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/website-builder-plan/{id}" | python -m json.tool
PUT¶
Update the Website Builder Plan. A provisioner can change the original name and description of his Plan. However, this action is also available for non-provisioning resellers. If a non-provisioning reseller invokes this API end-point, a custom Plan name and description will be assigned for this reseller without changing the original Plan’s name and description. In this case all of reseller’s customers will see this Website Builder Plan with the name and description a reseller has assigned. In that way a reseller can control the appearance of the Website Builder Plan for his customers.
JSON request
|
string |
The name of the Website Builder Plan. |
|
string |
The description of the Website Builder Plan. |
JSON response
object: Product Plan
Possible errors
Sample
curl \
--request PUT \
--user "{{api_username}}:{{api_key}}" \
--data '
{
"name": "Test Website Builder Plan",
"description": "Test description"
}
' \
"{{api_base_url}}/website-builder-plan/{id}" | python -m json.tool
DELETE¶
Delete the Website Builder Plan. The Website Builder Plan can be deleted only by provisioning reseller who owns this plan.
Request parameters
N/A
JSON response
object: Product Plan
Possible errors
Sample
curl \
--request DELETE \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/website-builder-plan/{id}" | python -m json.tool