Suspend or resume a license

You can suspend a license transaction using the 10Duke Entitlement Management REST API. This suspends (deactivates) the licenses that were created based on that license transaction.

Similarly, you can resume a license transaction to reactivate the licenses.

If you want to deactivate or activate an individual license, you can do this by editing the license in 10Duke SysAdmin.

API operations

10Duke Entitlement Management REST API operations:

Operation URL (relative, prepend the environment base URL)
Suspend an organization license transaction PUT /organizations/{orgId}/license-transactions/{transactionId}/suspend-licenses
Suspend a personal license transaction PUT /users/{userId}/license-transactions/{transactionId}/suspend-licenses
Resume a suspended organization license transaction PUT /organizations/{orgId}/license-transactions/{transactionId}/resume-licenses
Resume a suspended personal license transaction PUT /users/{userId}/license-transactions/{transactionId}/resume-licenses

Suspend a license transaction for an organization

The following examples show how you suspend a license transaction for an organization. Suspending a transaction for personal licenses is done in a similar way.

Request example

To suspend a license transaction for an organization, send a PUT request to /organizations/{orgId}/license-transactions/{transactionId}/suspend-licenses. See the API reference for details on the API path parameters, request body, and response schemas.

This example request uses curl (line breaks added for display purposes):

curl --request PUT
   --url <API_base_path>/organizations/0697532b-c3fe-4915-82f5-e34bba8f8ae7/license-transactions/497f6eca-6276-4993-bfeb-53cbbbba6f08/suspend-licenses

Response example

This is a sample response for suspending an organization license transaction. It shows information that the response body can contain:

{
   "transaction": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "externalId": "0000005556577",
      "processed": "2022-11-19T14:12:22.010Z",
      "cancelled": "2023-02-22T16:10:10.025Z",
      "items": [{
         "id": "396e1e22-ce90-4fb6-af38-ddfc81f34966",
         "externalId": "000006",
         "productId": "644b511a-d914-4413-9658-25bf848d0ffd",
         "quantity": 10,
         "licenseValidFrom": "2022-11-19T14:12:22.010Z",
         "licenseValidUntil": "2023-11-19T14:12:22.012Z",
         "licenses": [{
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "validFrom": "2022-11-19T14:12:22.010Z",
            "validUntil": "2023-11-19T14:12:22.012Z",
            "active": false,
            "entitlementId": "d0da2989-2fa0-40a9-a5df-fe8d14d0a8ff",
            "licensedItem": {
               "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
               "name": "CutXPro"
            },
            "licenseModelId": "9188e9b9-12fc-4882-91eb-d433650e42dc",
            "licenseModelName": "License_Model_Seats_based",
            "seatsTaken": 0,
            "seatsReserved": 0,
            "seatsTotal": 10,
            "seatCountCredits": [{
               "id": "150d1a74-c5f2-4c17-80a4-9813218c10a1",
               "validFrom": "2022-11-19T14:12:22.010Z",
               "validUntil": "2023-11-19T14:12:22.012Z",
               "active": false,
               "licenseId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
               "licenseTransactionItemId": "396e1e22-ce90-4fb6-af38-ddfc81f34966"
            }]
         }]
      }]
   }
}

Resume a suspended license transaction for an organization

The following examples show how you resume a suspended license transaction for an organization. Resuming a suspended transaction for personal licenses is done in a similar way.

Request example

To resume a suspended license transaction for an organization, send a PUT request to /organizations/{orgId}/license-transactions/{transactionId}/resume-licenses. See the API reference for details on the API path parameters, request body, and response schemas.

This example request uses curl (line breaks added for display purposes):

curl --request PUT
   --url <API_base_path>/organizations/0697532b-c3fe-4915-82f5-e34bba8f8ae7/license-transactions/497f6eca-6276-4993-bfeb-53cbbbba6f08/resume-licenses

Response example

This is a sample response for resuming a suspended organization license transaction. It shows information that the response body can contain:

{
   "transaction": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "externalId": "0000005556577",
      "processed": "2022-11-19T14:12:22.010Z",
      "items": [{
         "id": "396e1e22-ce90-4fb6-af38-ddfc81f34966",
         "externalId": "000006",
         "productId": "644b511a-d914-4413-9658-25bf848d0ffd",
         "quantity": 10,
         "licenseValidFrom": "2022-11-19T14:12:22.010Z",
         "licenseValidUntil": "2023-11-19T14:12:22.012Z",
         "licenses": [{
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "validFrom": "2022-11-19T14:12:22.010Z",
            "validUntil": "2023-11-19T14:12:22.012Z",
            "active": true,
            "entitlementId": "d0da2989-2fa0-40a9-a5df-fe8d14d0a8ff",
            "licensedItem": {
               "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
               "name": "CutXPro"
            },
            "licenseModelId": "9188e9b9-12fc-4882-91eb-d433650e42dc",
            "licenseModelName": "License_Model_Seats_based",
            "seatsTaken": 0,
            "seatsReserved": 0,
            "seatsTotal": 10,
            "seatCountCredits": [{
               "id": "150d1a74-c5f2-4c17-80a4-9813218c10a1",
               "validFrom": "2022-11-19T14:12:22.010Z",
               "validUntil": "2023-11-19T14:12:22.012Z",
               "active": false,
               "licenseId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
               "licenseTransactionItemId": "396e1e22-ce90-4fb6-af38-ddfc81f34966"
            }]
         }]
      }]
   }
}

On this page