Cancel a license transaction

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

If you want to deactivate a specific license, you can do this in 10Duke SysAdmin.

API endpoints

10Duke Entitlement Management REST API endpoints:

Item	URL (relative, prepend the environment base URL)
Cancel an organization license transaction	`/organizations/{orgId}/license-transactions/{transactionId}/cancel`
Cancel a personal license transaction	`/users/{userId}/license-transactions/{transactionId}/cancel`

Request example

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

This example request uses curl:

curl --request PUT \
  --url https://<your 10Duke Enterprise instance>/organizations/0697532b-c3fe-4915-82f5-e34bba8f8ae7/license-transactions/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel \

Response example

This sample response 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"
				}]
			}]
		}]
	}
}