Revoke License

curl -X POST "https://api.chariow.com/v1/licenses/ABC-123-XYZ-789/revoke" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "Customer requested refund"
  }'

const response = await fetch(
  'https://api.chariow.com/v1/licenses/ABC-123-XYZ-789/revoke',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      reason: 'Customer requested refund'
    })
  }
);
const data = await response.json();

$ch = curl_init('https://api.chariow.com/v1/licenses/ABC-123-XYZ-789/revoke');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_KEY',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'reason' => 'Customer requested refund'
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

{
  "message": "License revoked successfully",
  "data": {
    "id": "lic_abc123",
    "status": "revoked",
    "customer": {
      "id": "cus_xyz789",
      "name": "John Doe",
      "email": "john@example.com"
    },
    "product": {
      "id": "prd_abc456",
      "name": "Premium Software License",
      "slug": "premium-software-license"
    },
    "license": {
      "key": "ABC-123-XYZ-789",
      "masked_key": "ABC-***-***-789"
    },
    "is_active": false,
    "is_expired": false,
    "can_activate": false,
    "activations": {
      "count": 3,
      "max": 10,
      "remaining": 7
    },
    "certificate_url": null,
    "metadata": null,
    "activated_at": "2025-01-15T10:30:00.000000Z",
    "expires_at": "2026-01-15T10:30:00.000000Z",
    "expired_at": null,
    "revoked_at": "2025-01-20T14:22:00.000000Z",
    "created_at": "2025-01-15T09:00:00.000000Z",
    "updated_at": "2025-01-20T14:22:00.000000Z"
  },
  "errors": []
}

{
  "message": "License has already been revoked",
  "data": [],
  "errors": []
}

{
  "message": "The reason must not exceed 500 characters.",
  "data": [],
  "errors": {
    "reason": ["The reason must not exceed 500 characters."]
  }
}

{
  "message": "No query results for model [App\\Models\\IssuedLicense].",
  "data": [],
  "errors": []
}

curl -X POST "https://api.chariow.com/v1/licenses/ABC-123-XYZ-789/revoke" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "Customer requested refund"
  }'

const response = await fetch(
  'https://api.chariow.com/v1/licenses/ABC-123-XYZ-789/revoke',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      reason: 'Customer requested refund'
    })
  }
);
const data = await response.json();

$ch = curl_init('https://api.chariow.com/v1/licenses/ABC-123-XYZ-789/revoke');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_KEY',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'reason' => 'Customer requested refund'
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

{
  "message": "License revoked successfully",
  "data": {
    "id": "lic_abc123",
    "status": "revoked",
    "customer": {
      "id": "cus_xyz789",
      "name": "John Doe",
      "email": "john@example.com"
    },
    "product": {
      "id": "prd_abc456",
      "name": "Premium Software License",
      "slug": "premium-software-license"
    },
    "license": {
      "key": "ABC-123-XYZ-789",
      "masked_key": "ABC-***-***-789"
    },
    "is_active": false,
    "is_expired": false,
    "can_activate": false,
    "activations": {
      "count": 3,
      "max": 10,
      "remaining": 7
    },
    "certificate_url": null,
    "metadata": null,
    "activated_at": "2025-01-15T10:30:00.000000Z",
    "expires_at": "2026-01-15T10:30:00.000000Z",
    "expired_at": null,
    "revoked_at": "2025-01-20T14:22:00.000000Z",
    "created_at": "2025-01-15T09:00:00.000000Z",
    "updated_at": "2025-01-20T14:22:00.000000Z"
  },
  "errors": []
}

{
  "message": "License has already been revoked",
  "data": [],
  "errors": []
}

{
  "message": "The reason must not exceed 500 characters.",
  "data": [],
  "errors": {
    "reason": ["The reason must not exceed 500 characters."]
  }
}

{
  "message": "No query results for model [App\\Models\\IssuedLicense].",
  "data": [],
  "errors": []
}

Permanently revokes a license by changing its status to revoked and recording the revocation timestamp. Once revoked, the license cannot be activated on any device, and this action cannot be undone. The license will remain visible in reports and history for audit purposes. This endpoint is useful for handling customer refunds, policy violations, or when a license needs to be immediately terminated for any reason. An optional reason parameter allows you to document why the license was revoked.

Revoking a license is permanent and irreversible. The license cannot be reactivated after revocation.

Path Parameters

string

required

The license key to revoke (e.g., ABC-123-XYZ-789)

Request Body

string

Optional reason for revocation. Max 500 characters. Useful for audit trails and customer support.

Response

object

Show properties

string

Unique license identifier

string

The license key string

string

License status (will be revoked)

string

ISO 8601 timestamp when the license was revoked

integer

Number of activations before revocation

integer

Maximum number of activations (for reference)

integer

Will show remaining count, but license cannot be activated

boolean

Will be false after revocation

boolean

Will be false after revocation

object

Product information

Error Responses

object

Returned when the license has already been revoked

object

Returned when the license key doesn’t exist or doesn’t belong to your store

object

Returned when validation fails (e.g., reason exceeds 500 characters)

curl -X POST "https://api.chariow.com/v1/licenses/ABC-123-XYZ-789/revoke" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "Customer requested refund"
  }'

const response = await fetch(
  'https://api.chariow.com/v1/licenses/ABC-123-XYZ-789/revoke',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      reason: 'Customer requested refund'
    })
  }
);
const data = await response.json();

$ch = curl_init('https://api.chariow.com/v1/licenses/ABC-123-XYZ-789/revoke');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_KEY',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'reason' => 'Customer requested refund'
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

{
  "message": "License revoked successfully",
  "data": {
    "id": "lic_abc123",
    "status": "revoked",
    "customer": {
      "id": "cus_xyz789",
      "name": "John Doe",
      "email": "john@example.com"
    },
    "product": {
      "id": "prd_abc456",
      "name": "Premium Software License",
      "slug": "premium-software-license"
    },
    "license": {
      "key": "ABC-123-XYZ-789",
      "masked_key": "ABC-***-***-789"
    },
    "is_active": false,
    "is_expired": false,
    "can_activate": false,
    "activations": {
      "count": 3,
      "max": 10,
      "remaining": 7
    },
    "certificate_url": null,
    "metadata": null,
    "activated_at": "2025-01-15T10:30:00.000000Z",
    "expires_at": "2026-01-15T10:30:00.000000Z",
    "expired_at": null,
    "revoked_at": "2025-01-20T14:22:00.000000Z",
    "created_at": "2025-01-15T09:00:00.000000Z",
    "updated_at": "2025-01-20T14:22:00.000000Z"
  },
  "errors": []
}

{
  "message": "License has already been revoked",
  "data": [],
  "errors": []
}

{
  "message": "The reason must not exceed 500 characters.",
  "data": [],
  "errors": {
    "reason": ["The reason must not exceed 500 characters."]
  }
}

{
  "message": "No query results for model [App\\Models\\IssuedLicense].",
  "data": [],
  "errors": []
}

Common Use Cases

Refund Processing

When processing a refund, revoke the license to prevent further use:

async function processRefund(licenseKey) {
  await fetch(`https://api.chariow.com/v1/licenses/${licenseKey}/revoke`, {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      reason: 'Full refund processed via payment gateway'
    })
  });
}

Terms of Service Violation

Revoke licenses that violate your terms:

async function revokeViolation(licenseKey, violationType) {
  await fetch(`https://api.chariow.com/v1/licenses/${licenseKey}/revoke`, {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      reason: `Terms of service violation: ${violationType}`
    })
  });
}

Fraudulent Purchase

Immediately revoke licenses from suspected fraudulent purchases:

async function revokeFraudulent(licenseKey) {
  await fetch(`https://api.chariow.com/v1/licenses/${licenseKey}/revoke`, {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      reason: 'Suspected fraudulent purchase - payment flagged by gateway'
    })
  });
}

What Happens After Revocation

Once a license is revoked:

Status Change: The license status becomes revoked
Timestamp: The revoked_at field is set to the current timestamp
No Future Activations: The license cannot be activated on any device
Existing Activations: Any existing activations remain in the system for audit purposes
Permanent: The revocation cannot be undone - you must issue a new license if needed
Visible in Reports: The license remains visible in your dashboard and API responses for historical tracking

Alternative: Deactivating Individual Devices

If you want to free up an activation slot without permanently revoking the entire license, you should instead remove specific activations. This can be done through your store dashboard, allowing the license to be activated on a different device.

There is currently no Public API endpoint for deactivating individual device activations. This must be done through the store dashboard or Core API.

Overview

Store

Products

Checkout

Sales

Customers

Licenses

Discounts

Pulses

Affiliates

Path Parameters

Request Body

Response

Error Responses

Common Use Cases

Refund Processing

Terms of Service Violation

Fraudulent Purchase

What Happens After Revocation

Alternative: Deactivating Individual Devices

​Path Parameters

​Request Body

​Response

​Error Responses

​Common Use Cases

​Refund Processing

​Terms of Service Violation

​Fraudulent Purchase

​What Happens After Revocation

​Alternative: Deactivating Individual Devices

Path Parameters

Request Body

Response

Error Responses

Common Use Cases

Refund Processing

Terms of Service Violation

Fraudulent Purchase

What Happens After Revocation

Alternative: Deactivating Individual Devices