Configuring the “Buy URL” option

The Buy URL option is used only for upselling. Refer to “Managing upsell” for more details.

Important

If the Buy URL option value is empty, the buy links will not be shown to the user.

Editions upsell data

When the user clicks the buy link in the message with a proposal to buy one of the editions, the user will be taken to the URL specified in the Buy URL option without any additional data.

Quota upsell data

When the quota is exceeded and the user clicks the buy link, the user will be taken to the URL specified in the Buy URL option with the following query string parameters:

Value	Description
`origin`	Place where the user clicks the buy link: alert in backup console, email notification or menu header in management portal. Contains one of the followings: * Alert_on_Storage – user clicks buy link in the alert with “Storage quota has been exceeded” or “Storage quota will be exceeded soon”. * alert_on_physical_machines – user clicks buy link in the alert with “Physical machine quota has been exceeded”. * alert_on_physical_servers – user clicks buy link in the alert with “Physical servers quota has been exceeded”. * alert_on_virtual_machines – user clicks buy link in the alert with “Virtual machines quota has been exceeded”. * alert_on_mobile_devices – user clicks buy link in the alert with “Mobile Devices quota has been exceeded”. * email_notification – user clicks buy link in the email notification. * mc_usage_info – user clicks buy link in the management portal.
`user_quotas`	All items for which user’s quota has been exceeded. May contain multiple values from the following list: * storage_size – Storage quota has been exceeded or storage quota will be exceeded soon. * physical_machines – Physical machine quota has been exceeded. * physical_servers – Physical servers quota has been exceeded. * virtual_machines – Virtual machines quota has been exceeded. * mobile_devices – Mobile Devices quota has been exceeded.
`tenant_quotas`	The same as `user_quota`, but for the tenant’s quotas. May contain multiple values.
`user_account_id`	API v1 ID of the user account that followed the link.
`tenant_id`	API v1 ID of the tenant where the quota has been exceeded.
`redirect_url`	The page from where the buy link was followed.

Step-by-step procedure

Authenticate to the cloud platform via the Python shell.

The following variables should be available now:

>>> base_url  # the base URL of the API
'https://eu2-cloud.acronis.com/api/2'
>>> auth  # the 'Authorization' header value with the access token
{'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImMwMD...'}
>>> tenant_id  # the UUID of the tenant to which the token provides access
'ede9f834-70b3-476c-83d9-736f9f8c7dae'

Assign either of the following values to the tenant_id variable – the UUID of a sub-tenant created via the API or a sub-tenant found by its name:
```
>>> tenant_id = created_tenant_id
>>> tenant_id
'0fcd4a69-8a40-4de8-b711-d9c83dc000f7'
```
Obtain the number of the latest tenant revision. You will have to specify this number in a subsequent request to the tenant. This is required to manage concurrent tenant modifications.
1. Fetch the tenant information as described in steps 3-5 of “Fetching information about an individual tenant”. As the result, you should have a tenant variable with the tenant object.
2. Define a variable named tenant_version, and then assign the value of the version key from the tenant object to this variable:
```
>>> tenant_version = tenant['version']
>>> tenant_version
3
```
Define a variable named params, and then assign an object with the version key containing version of the tenant to this variable:
```
>>> params = {
...     'version': tenant_version
... }
```
Define a variable named branding_options, and then assign an object with the upsell_url key containing the buy URL to this variable:
```
>>> branding_options = {
...     'upsell_url': 'https://www.johndoe.com/store'
... }
```
Important

If upsell_url is set to an empty string – no buttons or links will be shown to a user.

Convert the branding_options object to a JSON text:

>>> branding_options = json.dumps(branding_options, indent=4)
>>> print(branding_options)
{
    "upsell_url": "https://www.johndoe.com/store",
}

Send a PUT request to the /tenants/{tenant_id}/brand endpoint:

>>> response = requests.put(
...     f'{base_url}/tenants/{tenant_id}/brand',
...     headers={'Content-Type': 'application/json', **auth},
...     data=branding_options,
...     params=params,
... )

Check the status code of the response:

>>> response.status_code
200

Status code 200 means that the “Buy URL” option has been updated. Version number of the tenant will be also increased by 1.

A different status code means that an error has occurred. For the details, refer to “Status and error codes”.

Also, the response body contains an object with branding options formatted as a JSON text. When converted to an object, it will look as follows:

>>> pprint.pprint(response.json())
{'account_server_url': 'mc-cloud.acronis.com',
 'backup_console_url': 'mc-cloud.acronis.com/bc',
 'color': '000000',
 'color_scheme': 'default',
 'company_name': 'FooBar',
 'help_url': 'api/ams/links/help',
 'hide_predefined': 1,
 'home_url': 'www.acronis.com',
 'knowledgebase_url': 'kb.acronis.com/errorcode/',
 'logotype': '2f8ad2e2-28f2-11e7-aad1-5ffe2ad47151',
 'mobile_app_android_download_url': 'www.mobile.com/download',
 'mobile_app_ios_download_url': 'www.mobile.com/download',
 'owns_custom_legal_docs': True,
 'platform_terms_url': 'terms.acronis.com',
 'privacy_policy_url': 'https://www.acronis.com/company/privacy.html',
 'router_url': 'cloud.acronis.com',
 'service_name': 'myservice',
 'smtp_encryption': 'TLS',
 'smtp_override': 1,
 'smtp_password': '',
 'smtp_port': 465,
 'smtp_reply_address': 'noreply@mycompany.com',
 'smtp_server': 'smtp.mycompany.com',
 'smtp_user': 'smtpuser',
 'support_phone': '+1 1111 1111111',
 'support_url': 'support.acronis.com',
 'terms_url': 'terms.acronis.com',
 'upsell_url': 'https://www.johndoe.com/store',
 'user_guide_url': 'guide.acronis.com'}

[Optional] Increase the of the the tenant_version variable by 1:
```
>>> tenant_version = tenant_version + 1
```