curl -X GET "https://api.chariow.com/v1/licenses/ABC-123-XYZ-789" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch('https://api.chariow.com/v1/licenses/ABC-123-XYZ-789', {
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
});
const { data } = await response.json();
$ch = curl_init('https://api.chariow.com/v1/licenses/ABC-123-XYZ-789');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer YOUR_API_KEY'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
{
"data": {
"id": "license_abc123",
"status": "active",
"customer": {
"id": "cus_xyz789",
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com",
"phone": {
"number": "+1 202-555-0123",
"country": {
"name": "United States",
"code": "US",
"alpha_3_code": "USA",
"dial_code": "+1",
"currency": "USD",
"flag": "https://cdn.axazara.com/flags/svg/US.svg"
}
},
"avatar_url": null
},
"product": {
"id": "prd_abc456",
"name": "Premium Software License",
"type": "license",
"pictures": {
"thumbnail": null,
"cover": null
},
"category": {
"value": "technology",
"label": "Technology"
},
"pricing": {
"type": "one_time",
"price": {
"value": 49,
"formatted": "$49.00",
"short": "49",
"currency": "USD"
},
"effective": {
"value": 49,
"formatted": "$49.00",
"short": "49",
"currency": "USD"
}
},
"bundle": null,
"metadata": null
},
"license": {
"key": "ABC-123-XYZ-789",
"masked_key": "ABC-***-***-789"
},
"is_active": true,
"is_expired": false,
"can_activate": true,
"activations": {
"count": 3,
"max": 10,
"remaining": 7
},
"certificate_url": "https://download.chariow.com/licenses/license_abc123?expires=1736937000&signature=4f1c...",
"metadata": null,
"activated_at": "2025-01-15T10:30:00.000000Z",
"expires_at": "2026-01-15T10:30:00.000000Z",
"expired_at": null,
"revoked_at": null,
"created_at": "2025-01-15T09:00:00.000000Z",
"updated_at": "2025-01-15T10:30:00.000000Z"
}
}
{
"message": "License key not found.",
"errors": []
}
Licenses
Get License
Retrieve details of a specific license
curl -X GET "https://api.chariow.com/v1/licenses/ABC-123-XYZ-789" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch('https://api.chariow.com/v1/licenses/ABC-123-XYZ-789', {
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
});
const { data } = await response.json();
$ch = curl_init('https://api.chariow.com/v1/licenses/ABC-123-XYZ-789');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer YOUR_API_KEY'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
{
"data": {
"id": "license_abc123",
"status": "active",
"customer": {
"id": "cus_xyz789",
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com",
"phone": {
"number": "+1 202-555-0123",
"country": {
"name": "United States",
"code": "US",
"alpha_3_code": "USA",
"dial_code": "+1",
"currency": "USD",
"flag": "https://cdn.axazara.com/flags/svg/US.svg"
}
},
"avatar_url": null
},
"product": {
"id": "prd_abc456",
"name": "Premium Software License",
"type": "license",
"pictures": {
"thumbnail": null,
"cover": null
},
"category": {
"value": "technology",
"label": "Technology"
},
"pricing": {
"type": "one_time",
"price": {
"value": 49,
"formatted": "$49.00",
"short": "49",
"currency": "USD"
},
"effective": {
"value": 49,
"formatted": "$49.00",
"short": "49",
"currency": "USD"
}
},
"bundle": null,
"metadata": null
},
"license": {
"key": "ABC-123-XYZ-789",
"masked_key": "ABC-***-***-789"
},
"is_active": true,
"is_expired": false,
"can_activate": true,
"activations": {
"count": 3,
"max": 10,
"remaining": 7
},
"certificate_url": "https://download.chariow.com/licenses/license_abc123?expires=1736937000&signature=4f1c...",
"metadata": null,
"activated_at": "2025-01-15T10:30:00.000000Z",
"expires_at": "2026-01-15T10:30:00.000000Z",
"expired_at": null,
"revoked_at": null,
"created_at": "2025-01-15T09:00:00.000000Z",
"updated_at": "2025-01-15T10:30:00.000000Z"
}
}
{
"message": "License key not found.",
"errors": []
}
Retrieves detailed information about a specific license by its license key or public ID. This endpoint returns comprehensive license information including activation status, usage counts, expiration dates, and the associated customer and product.
Required scope:
licenses.read. A key without it receives a 403 error. See Authentication.Path Parameters
string
required
The licence key (e.g.,
ABC-123-XYZ-789). The licence public ID (e.g., license_abc123) is also accepted.Response
object
Show properties
Show properties
string
Licence public ID (e.g.,
license_abc123)string
Licence status:
pending_activation, active, expired, or revokedobject
Customer who owns the licence:
id, name, first_name, last_name, email, phone (number and country) and avatar_urlobject
Product that issued the licence:
id, name, type, pictures, category, pricing (type, price, effective), bundle and metadataobject
boolean
Whether the licence is currently active and usable
boolean
Whether the licence has expired
boolean
Whether the licence can be activated on another device (not revoked, not expired, slots left)
object
string
Signed URL to download the licence certificate. It expires 30 minutes after the response: fetch the licence again for a fresh link.
object | null
Custom metadata attached to the licence
string | null
ISO 8601 timestamp of the first activation (
null if not yet activated)string | null
ISO 8601 expiration timestamp (
null for a lifetime licence)string | null
ISO 8601 timestamp when the licence expired
string | null
ISO 8601 timestamp when the licence was revoked
string
ISO 8601 creation timestamp
string
ISO 8601 last update timestamp
curl -X GET "https://api.chariow.com/v1/licenses/ABC-123-XYZ-789" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch('https://api.chariow.com/v1/licenses/ABC-123-XYZ-789', {
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
});
const { data } = await response.json();
$ch = curl_init('https://api.chariow.com/v1/licenses/ABC-123-XYZ-789');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer YOUR_API_KEY'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
{
"data": {
"id": "license_abc123",
"status": "active",
"customer": {
"id": "cus_xyz789",
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com",
"phone": {
"number": "+1 202-555-0123",
"country": {
"name": "United States",
"code": "US",
"alpha_3_code": "USA",
"dial_code": "+1",
"currency": "USD",
"flag": "https://cdn.axazara.com/flags/svg/US.svg"
}
},
"avatar_url": null
},
"product": {
"id": "prd_abc456",
"name": "Premium Software License",
"type": "license",
"pictures": {
"thumbnail": null,
"cover": null
},
"category": {
"value": "technology",
"label": "Technology"
},
"pricing": {
"type": "one_time",
"price": {
"value": 49,
"formatted": "$49.00",
"short": "49",
"currency": "USD"
},
"effective": {
"value": 49,
"formatted": "$49.00",
"short": "49",
"currency": "USD"
}
},
"bundle": null,
"metadata": null
},
"license": {
"key": "ABC-123-XYZ-789",
"masked_key": "ABC-***-***-789"
},
"is_active": true,
"is_expired": false,
"can_activate": true,
"activations": {
"count": 3,
"max": 10,
"remaining": 7
},
"certificate_url": "https://download.chariow.com/licenses/license_abc123?expires=1736937000&signature=4f1c...",
"metadata": null,
"activated_at": "2025-01-15T10:30:00.000000Z",
"expires_at": "2026-01-15T10:30:00.000000Z",
"expired_at": null,
"revoked_at": null,
"created_at": "2025-01-15T09:00:00.000000Z",
"updated_at": "2025-01-15T10:30:00.000000Z"
}
}
{
"message": "License key not found.",
"errors": []
}
Was this page helpful?