Editing Weebly API (section)

= Upgrade website =
{{Warnbox|Please note that downgrading is not supported for Weebly website plans}}

== Upgrade via API ==
You can upgrade your website by using the following command

<pre>
COMMAND = UpgradeWebsite
ID = (Website ID)
CLASS = (Website class)
</pre>
<br> 

'''ID'''
<br>
The website ID

'''CLASS'''
<br>
Website plan. Valid plan are:
* WEEBLY_FREE
* WEEBLY_STARTER
* WEEBLY_PRO
* WEEBLY_BUSINESS
* WEEBLY_PERFORMANCE

Note that when you upgrade your website, we will automatically process a refund for the remaining term left in your original plan. For example, if you bought a Starter website in June and upgrade to Performance in August, we will refund the prorated Starter annual fee which is calculated from September to May. 

See [https://github.com/hexonet/hexonet-api-documentation/blob/master/API/WEEBLY/UPGRADEWEBSITE.md here] for more information on UpgradeWebsite command.

== Povisioning upgrade within Weebly Website Editor ==
Weebly displays several upgrade triggers in the Website Editor when the website's current plan does not include that feature. There's also an upgrade button at the top right corner of the Website Editor for easy upgrade. If a customer clicks on either the upgrade triggers or button, it will open a new modal to provision the upgrade process. As our reseller, you can customize the upgrade modal content so that you can have full control on the upgrading process.

[[Image:Weebly_upgrade.png|center|frame]]

To do so, you must provide us the URL that will handle the upgrading process. You can provide the URL via the CreateWebsite (for new website) or UpdateWebsite (for existing website) command. Note that you must specify the upgrade URL for each website you want to apply the changes to.
<br><br>
'''To add upgrade URL to new website'''

<pre>
COMMAND = CreateWebsite
CLASS = (Website class)
DOMAIN = (Domain name)
WEBSITEUSERID = (Website User ID)
PERIOD = 1Y
TITLE = (New website title) (optional)
REFERENCE = (Original website ID to copy from) (optional)
UPGRADEURL = (your custom link to the upgrade modal) 
</pre>
<br>
'''To add upgrade URL to existing website'''

<pre>
COMMAND = UpdateWebsite
ID = (Website ID)
UPGRADEURL = (your custom link to the upgrade modal)
</pre>


Whenever an upgrade trigger or button is clicked, Weebly will call your upgrade URL and adds the following parameters to the URL:

* user_id
* site
* plan
* upgrade_type
* upgrade_id
* plan_ids
* hash

<br>
Hereâs an example of an URL with the added parameters:

<pre>http://your-url.com/upgrade.html?user_id=1234567&site=1234567891011234&plan=starter&upgrade_type=feature&upgrade_id=edit_footer&plan_ids=40%2C14%2C41%2C10%2C35%2C39&hash=e71ca960fad7e87df447bb7879a27a8d14fa5a48&</pre>
<br>

'''To display your upgrade modal content'''

Before you load your modal content, you should verify the hash to make sure the call is coming directly from the Weebly Website Editor. You can use the following command to verify the hash

<pre>
COMMAND = VerifyWebsiteUpgradeHash
ID = Website ID
WEBSITEUSERID = (Website user ID)
HASH = (hash from the upgrade URL)
CLASS = Weebly
</pre>

See [https://github.com/hexonet/hexonet-api-documentation/blob/master/API/WEEBLY/VERIFYWEBSITEUPGRADEHASH.md here] for more information on VerifyWebsiteUpgradeHash command.

If VerifyWebsiteUpgradeHash returns code 200, you can then proceed with the modal load and execute the UpgradeWebsite command to upgrade the website plan.