Deactivate a license

curl -X POST https://yourstore.keyplar.com/api/v1/licenses/deactivate \
  -H "Authorization: Bearer ak_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "licenseKey": "ACME-4F3A-9C21-BE77",
    "instanceId": "9b3e7d15-2c48-4f6a-8e01-7a5c3b9d2e64"
  }'

const res = await fetch(
  "https://yourstore.keyplar.com/api/v1/licenses/deactivate",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.KEYPLAR_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      licenseKey: storedKey,
      instanceId: storedInstanceId,
    }),
  },
);

const data = await res.json();

if (data.deactivated) {
  clearStoredLicense();
}

import os
import requests

res = requests.post(
    "https://yourstore.keyplar.com/api/v1/licenses/deactivate",
    headers={"Authorization": f"Bearer {os.environ['KEYPLAR_API_KEY']}"},
    json={"licenseKey": stored_key, "instanceId": stored_instance_id},
    timeout=10,
)
res.raise_for_status()

if res.json()["deactivated"]:
    clear_stored_license()

{
  "deactivated": true,
  "error": null,
  "license": {
    "key": "ACME-4F3A-9C21-BE77",
    "status": "active",
    "activationLimit": 3,
    "activationUsage": 1,
    "expiresAt": null,
    "createdAt": "2026-02-11T09:14:22.481Z"
  },
  "instance": null,
  "order": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d0195c1", "status": "paid" },
  "product": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d019500", "name": "Acme Editor Pro" },
  "customer": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d0194aa", "email": "sam@example.com" },
  "benefit": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d0193bb", "name": "Pro license", "type": "license" }
}

{
  "deactivated": false,
  "error": "License instance not found",
  "license": {
    "key": "ACME-4F3A-9C21-BE77",
    "status": "active",
    "activationLimit": 3,
    "activationUsage": 2,
    "expiresAt": null,
    "createdAt": "2026-02-11T09:14:22.481Z"
  },
  "instance": null,
  "order": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d0195c1", "status": "paid" },
  "product": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d019500", "name": "Acme Editor Pro" },
  "customer": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d0194aa", "email": "sam@example.com" },
  "benefit": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d0193bb", "name": "Pro license", "type": "license" }
}

string

required

Bearer ak_… — see Authentication.

POST /api/v1/licenses/deactivate

Releases one activation, freeing a seat against the license’s activation limit. Call it when your software is uninstalled, signed out of, or moved to another machine.

Body

string

required

The customer’s license key.

string

required

The activation to release — the instance.id you stored when you activated. Must be a UUID.

Response

Always 200 OK when the request itself is well-formed. Read deactivated.

boolean

Whether the seat was released.

string | null

Why not, when deactivated is false.

null

Always null here — the activation no longer exists.

Plus the standard context block, with license.activationUsage already reduced.

Why a deactivation can fail

`error`	What happened
`Invalid license key`	No such key in this store
`License instance not found`	The activation doesn’t belong to this key, or it was already deactivated

Deactivation works even when the license itself is expired, disabled or revoked. Someone uninstalling after their subscription lapsed still gets their seat cleaned up.

Idempotency

Deactivating an activation that’s already gone returns deactivated: false with License instance not found. That’s usually fine to ignore — the seat is free either way, which is what you wanted.

curl -X POST https://yourstore.keyplar.com/api/v1/licenses/deactivate \
  -H "Authorization: Bearer ak_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "licenseKey": "ACME-4F3A-9C21-BE77",
    "instanceId": "9b3e7d15-2c48-4f6a-8e01-7a5c3b9d2e64"
  }'

const res = await fetch(
  "https://yourstore.keyplar.com/api/v1/licenses/deactivate",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.KEYPLAR_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      licenseKey: storedKey,
      instanceId: storedInstanceId,
    }),
  },
);

const data = await res.json();

if (data.deactivated) {
  clearStoredLicense();
}

import os
import requests

res = requests.post(
    "https://yourstore.keyplar.com/api/v1/licenses/deactivate",
    headers={"Authorization": f"Bearer {os.environ['KEYPLAR_API_KEY']}"},
    json={"licenseKey": stored_key, "instanceId": stored_instance_id},
    timeout=10,
)
res.raise_for_status()

if res.json()["deactivated"]:
    clear_stored_license()

{
  "deactivated": true,
  "error": null,
  "license": {
    "key": "ACME-4F3A-9C21-BE77",
    "status": "active",
    "activationLimit": 3,
    "activationUsage": 1,
    "expiresAt": null,
    "createdAt": "2026-02-11T09:14:22.481Z"
  },
  "instance": null,
  "order": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d0195c1", "status": "paid" },
  "product": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d019500", "name": "Acme Editor Pro" },
  "customer": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d0194aa", "email": "sam@example.com" },
  "benefit": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d0193bb", "name": "Pro license", "type": "license" }
}

{
  "deactivated": false,
  "error": "License instance not found",
  "license": {
    "key": "ACME-4F3A-9C21-BE77",
    "status": "active",
    "activationLimit": 3,
    "activationUsage": 2,
    "expiresAt": null,
    "createdAt": "2026-02-11T09:14:22.481Z"
  },
  "instance": null,
  "order": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d0195c1", "status": "paid" },
  "product": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d019500", "name": "Acme Editor Pro" },
  "customer": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d0194aa", "email": "sam@example.com" },
  "benefit": { "id": "0195c1f4-8a2d-7c31-b6e9-4f8a2d0193bb", "name": "Pro license", "type": "license" }
}

⌘I

Introduction

Licenses

Deactivate a license

Body

Response

Why a deactivation can fail

Idempotency

​Body

​Response

​Why a deactivation can fail

​Idempotency

Body

Response

Why a deactivation can fail

Idempotency