CloudDocs
Plan
Weebly Cloud plan are based off of the four subscription levels that Weebly offers: Free, Starter, Pro, and Business. Weebly Cloud Plans can be created in Weebly Cloud Admin. This API allows packages to be managed for a given site.
Fields
- name (string)
The name of the plan as found in Weebly Cloud Admin (ex: "Amazing Plan")
- retail_price (float)
The price of the plan as found in Weebly Cloud Admin. This price is what your customers pay you for a package. If you handle your own billing, then this field does not do anything. (ex: "9.99")
- weebly_plan (int)
Numeric representation of the Weebly plans. The plans are Free - "0", Starter - "5", Pro - "10" and Business - "15". (ex: "15")
- page_limit (int)
The number of published pages permitted for a site with a given package. If a package allows for unlimited pages, then this value is set to "0". (ex: "6")
GET /plan
Returns all available packages for a Weebly Cloud account.
Example CURL Request
curl https://api.weeblycloud.com/hosts/plan \ -H "X-Public-Key: YOURAPIKEY" \ -H "X-Signed-Request-Hash: YOURSECRETHASH"
Example Response
{ "plans":{ "1":{ "name":"Basic", "page_limit":6, "terms":{ "0":{ "term":"1", "retail_price":0, "period_name":"month" }, "plans":null }, "plan_id":"1", "weebly_plan":0 }, "2":{ "name":"Pro", "page_limit":0, "terms":{ "0":{ "term":"1", "retail_price":8.99, "period_name":"month" }, "plans":null }, "plan_id":"2", "weebly_plan":10 }, "3":{ "name":"Biz", "page_limit":0, "terms":{ "0":{ "term":"1", "retail_price":29, "period_name":"month" }, "plans":null }, "plan_id":"3", "weebly_plan":15 } } }
GET /plan/PLAN_ID
Returns the settings for a given plan
Example CURL Request
curl https://api.weeblycloud.com/hosts/plan/PLAN_ID \ -H "X-Public-Key: YOURAPIKEY" \ -H "X-Signed-Request-Hash: YOURSECRETHASH"
Example Response
{ "plans":{ "1":{ "name":"Basic", "page_limit":6, "terms":{ "0":{ "term":"1", "retail_price":0 }, }, "plan_id":"1", "weebly_plan":0 } } }
GET /user/USER_ID/site/SITE_ID/plan
Get all packages assigned to a given site.
Example CURL Request
curl https://api.weeblycloud.com/hosts/user/USER_ID/site/SITE_ID/plan \ -H "X-Public-Key: YOURAPIKEY" \ -H "X-Signed-Request-Hash: YOURSECRETHASH"
Example Response
{ "plans":{ "1":{ "name":"Basic", "page_limit":6, "term":1, "period_name":"month", "retail_price":0, "plan_id":"1", "weebly_plan":0 }, "2":{ "name":"Pro", "page_limit":0, "term":1, "period_name":"month", "retail_price":8.99, "plan_id":"2", "weebly_plan":10 } } }
Assign a plan to a given site.
Example CURL Request
curl https://api.weeblycloud.com/hosts/user/USER_ID/site/SITE_ID/plan \ -X POST \ -d '{ "plan_id": "5" }' \ -H "Content-type: application/json" \ -H "X-Public-Key: YOURAPIKEY" \ -H "X-Signed-Request-Hash: YOURSECRETHASH"
Example Response
{ "success": true }
Removes a plan from a given site. An error will be thrown if removing the last plan from a site. A site must have at least one plan.
Example CURL Request
curl https://api.weeblycloud.com/hosts/user/USER_ID/site/SITE_ID/plan/PLAN_ID \ -X DELETE \ -H "Content-type: application/json" \ -H "X-Public-Key: YOURAPIKEY" \ -H "X-Signed-Request-Hash: YOURSECRETHASH"
Example Response
{ "success": true }
Site Info
|
More
|
|