Update License

Updates a single license, if requesting manager has access permissions to it.

• When updating valid_duration, validity_period and trial_days you should also send the is_trial field.

• When updating maintenance_duration or maintenance_period you should send the enable_maintenance_period field.

valid_duration and validity_period can't be sent in the same update license request.

URL: /api/v1/licenses/{id}/

Method: PATCH

Parameters

• max_activations - Integer

• max_consumptions - Integer

• allow_overages - Boolean

• max_overages - Integer

• reset_consumption - Boolean

• consumption_period - String

  • Choices: daily, weekly, monthly, annualy

• is_trial - Boolean

• trial_days - Integer

• enable_maintenance_period - Boolean

• maintenance_duration - String

  • Choices examples: 35d (35 days), 4m (4 months), 2y (2 years)

• is_floating - Boolean

• is_floating_cloud - Boolean

• floating_users - Integer

• valid_duration - String

  • Choices examples: 35d (35 days), 4m (4 months), 2y (2 years)

• validity_period - Date

  • Format: yyyy-mm-dd (2020-09-30)

• prevent_vm - Boolean

• note - String

• max_license_users - Integer

  • Default: 0 (unlimited)

• floating_timeout - Integer

• max_transfers - Integer

  • Default: 0 (unlimited)

• allow_unlimited_activation - Boolean

• order - Integer

• metadata - JSON object

• allow_grace_period - Boolean

• grace_period - Integer

• installation_file - Integer

Data example

payload.json

{
    "max_activations": 5
}

Success Response

Code : 200 OK

Content example :

response.json

{
    "id": 1593781720493289,
    "status": "Inactive",
    "floating_in_use_devices": 0,
    "customer": {
        "id": 620,
        "total_orders": 14,
        "total_licenses": 45,
        "labels": [
            {
                "id": 3,
                "label_id": 8,
                "label": "Customer",
                "color": "#ff9f43"
            },
            {
                "id": 53,
                "label_id": 34,
                "label": "Loyal",
                "color": "#3a0cd4"
            }
        ],
        "email": "[email protected]",
        "first_name": "",
        "last_name": "",
        "company_name": "",
        "phone": "",
        "reference": "",
        "address": "",
        "postcode": "",
        "city": "",
        "country": "",
        "state": "",
        "cognito_user_pool_id": "",
        "metadata": {},
        "clabels_all": "customerloyal",
        "company": 277,
        "license_user": null,
        "clabels": [
            8,
            34
        ]
    },
    "product_features": [
        {
            "id": 1596179495925542,
            "product_feature": {
                "id": 173,
                "created_at": "2020-09-14T11:17:43Z",
                "updated_at": "2020-09-14T11:17:43Z",
                "name": "Feature 3",
                "code": "f3",
                "is_deleted": false,
                "feature_type": "consumption",
                "max_consumption": 2,
                "allow_overages": false,
                "max_overages": 0,
                "reset_consumption": false,
                "consumption_period": null
            },
            "max_consumption": 30,
            "total_consumptions": 0,
            "expiry_date": null,
            "allow_overages": false,
            "max_overages": 99,
            "reset_consumption": false,
            "consumption_period": null,
            "metadata": {}
        }
    ],
    "product_custom_fields": [],
    "license_users": [
        {
            "id": 1240,
            "last_login": null,
            "email": "[email protected]|uss1",
            "true_email": "[email protected]",
            "created_at": "2020-08-12T08:52:32Z",
            "updated_at": "2020-08-12T09:01:24Z",
            "is_admin": {},
            "is_active": true,
            "is_staff": false,
            "first_name": "John",
            "last_name": "Doe",
            "phone_number": "00385913109161",
            "subscribed_to_email": false,
            "acquired_consent": null,
            "is_manager": false,
            "initial_password": "4q3dg7!_",
            "is_initial_password": true
        }
    ],
    "order_store_id": "d2d2dce02c844d4492c9d48758aa143a",
    "active_up_to_date_devices": 0,
    "total_active_devices": 0,
    "product": {
        "id": 1584723961091234,
        "product_name": "mch"
    },
    "created_at": "2020-07-03T13:08:40Z",
    "updated_at": "2020-11-13T07:38:16.788576Z",
    "license_key": null,
    "active": false,
    "enabled": true,
    "time_activated": "2020-10-10T14:42:16Z",
    "time_disabled": "2020-08-14T07:26:27Z",
    "max_activations": 5,
    "times_activated": 0,
    "valid_duration": null,
    "validity_period": "2020-09-30",
    "license_type": "perpetual",
    "enable_maintenance_period": true,
    "maintenance_duration": "3m",
    "maintenance_period": "2021-01-10",
    "is_trial": true,
    "max_consumptions": 0,
    "total_consumptions": 0,
    "subscription_id": null,
    "last_check": null,
    "prevent_vm": true,
    "allow_overages": false,
    "max_overages": 0,
    "reset_consumption": false,
    "consumption_period": null,
    "trial_days": 0,
    "is_floating": false,
    "is_floating_cloud": true,
    "floating_users": 1,
    "note": null,
    "max_license_users": 0,
    "transfer_count": 0,
    "floating_timeout": null,
    "max_transfers": 0,
    "is_air_gapped": false,
    "can_borrow": false,
    "max_borrow_time": 0,
    "is_bundle": false,
    "metadata": {},
    "order": 1593781720493279,
    "order_item": 1593781720493299,
    "disabled_user": null,
    "last_activation_device": null
}