Website Builder Purchase¶
/website-builder¶
GET¶
Get all purchases
Request parameters
All values are optional.
+———————————+———-+————————————————————————-+
| plan
| string | The UUID of a Website Builder plan. |
+———————————+———-+————————————————————————-+
| is_auto_renew_enabled
| boolean | Is auto renew enabled on the purchase. |
+———————————+———-+————————————————————————-+
| client_reference
| string | The client reference of the purchase. |
+———————————+———-+————————————————————————-+
| provisioning_reference
| string | The reference to the provisioner. |
+———————————+———-+————————————————————————-+
JSON response
array: Product Purchase
Possible errors
Sample
curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/website-builder" | python -m json.tool
POST¶
Create a new purchase.
Request parameters
All values are required.
+———————————+———-+————————————————————————-+
| plan
| string | The UUID of a Website Builder plan. |
+———————————+———-+————————————————————————-+
| is_auto_renew_enabled
| boolean | Is auto renew enabled on the purchase. |
+———————————+———-+————————————————————————-+
| client_reference
| string | The client reference of the purchase. |
+———————————+———-+————————————————————————-+
| provisioning_reference
| string | The reference to the provisioner. |
+———————————+———-+————————————————————————-+
| display_name
| string | The display name for the purchase. |
+———————————+———-+————————————————————————-+
JSON response
array: Product Purchase
Possible errors
Sample
curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
{
"plan": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"is_auto_renew_enabled": True,
"client_reference": "sample reference",
"provisioning_reference": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"display_name": "New website builder purchase"
}
' \
"{{api_base_url}}/website-builder" | python -m json.tool
/website-builder/{id}¶
GET¶
Get detailed information about a purchase.
JSON response
object: Product Purchase
Possible errors
Sample
curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/website-builder/{id}" | python -m json.tool
PUT¶
Update a existing purchase.
Request parameters
All values are optional.
+———————————+———-+————————————————————————-+
| is_auto_renew_enabled
| boolean | Is auto renew enabled on the purchase. |
+———————————+———-+————————————————————————-+
| client_reference
| string | The client reference of the purchase. |
+———————————+———-+————————————————————————-+
| provisioning_reference
| string | The reference to the provisioner. |
+———————————+———-+————————————————————————-+
| display_name
| string | The display name for the purchase. |
+———————————+———-+————————————————————————-+
JSON response
array: Product Purchase
Possible errors
Sample
curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
{
"is_auto_renew_enabled": True,
"client_reference": "sample reference",
"provisioning_reference": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"display_name": "New website builder purchase"
}
' \
"{{api_base_url}}/website-builder/{id}" | python -m json.tool