curl -X GET "https://api.chariow.com/v1/licenses?status=active&per_page=20" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch('https://api.chariow.com/v1/licenses?status=active&per_page=20', {
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
});
const data = await response.json();
$ch = curl_init('https://api.chariow.com/v1/licenses?status=active&per_page=20');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer YOUR_API_KEY'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
{
"message": "success",
"data": {
"data": [
{
"id": "lic_ghi789",
"sale_id": 156,
"customer_id": 89,
"license_key": "ABC-123-XYZ-789",
"status": "active",
"activated_at": "2025-01-15T10:30:00.000000Z",
"expires_at": "2026-01-15T10:30:00.000000Z",
"expired_at": null,
"revoked_at": null,
"activation_count": 3,
"max_activations": 10,
"activations_remaining": 7,
"is_active": true,
"is_expired": false,
"can_activate": true,
"metadata": null,
"created_at": "2025-01-15T09:00:00.000000Z",
"updated_at": "2025-01-15T10:30:00.000000Z",
"product": {
"id": 42,
"name": "Premium Software License"
}
}
],
"pagination": {
"next_cursor": "eyJpZCI6NTB9",
"prev_cursor": null,
"has_more": true,
"per_page": 20
}
},
"errors": []
}
Licenses
List Licenses
Retrieve all licenses from your store
curl -X GET "https://api.chariow.com/v1/licenses?status=active&per_page=20" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch('https://api.chariow.com/v1/licenses?status=active&per_page=20', {
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
});
const data = await response.json();
$ch = curl_init('https://api.chariow.com/v1/licenses?status=active&per_page=20');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer YOUR_API_KEY'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
{
"message": "success",
"data": {
"data": [
{
"id": "lic_ghi789",
"sale_id": 156,
"customer_id": 89,
"license_key": "ABC-123-XYZ-789",
"status": "active",
"activated_at": "2025-01-15T10:30:00.000000Z",
"expires_at": "2026-01-15T10:30:00.000000Z",
"expired_at": null,
"revoked_at": null,
"activation_count": 3,
"max_activations": 10,
"activations_remaining": 7,
"is_active": true,
"is_expired": false,
"can_activate": true,
"metadata": null,
"created_at": "2025-01-15T09:00:00.000000Z",
"updated_at": "2025-01-15T10:30:00.000000Z",
"product": {
"id": 42,
"name": "Premium Software License"
}
}
],
"pagination": {
"next_cursor": "eyJpZCI6NTB9",
"prev_cursor": null,
"has_more": true,
"per_page": 20
}
},
"errors": []
}
Retrieves a cursor-paginated list of all licenses in your store. Licenses are automatically generated when customers purchase license-based products. This endpoint supports filtering by status, customer, and product.
Query Parameters
integer
default:"50"
Number of licenses to return per page (max 100)
string
Cursor for pagination. Use the
next_cursor from the previous response.string
Filter by license status. Valid values:
pending_activation, active, expired, revokedstring
Filter by customer public ID (e.g.,
cus_abc123)string
Filter by product public ID (e.g.,
prd_def456)Response
object
Show properties
Show properties
array
Array of license objects
Show license object
Show license object
string
Unique license identifier (e.g.,
lic_abc123)integer
Associated sale ID
integer
Associated customer ID
string
The license key string
string
License status:
pending_activation, active, expired, or revokedstring
ISO 8601 timestamp when first activated (null if not yet activated)
string
ISO 8601 expiration timestamp (null if no expiration)
string
ISO 8601 timestamp when expired (null if not expired)
string
ISO 8601 timestamp when revoked (null if not revoked)
integer
Current number of activations
integer
Maximum number of activations allowed
integer
Number of activations remaining
boolean
Whether the license is currently active
boolean
Whether the license has expired
boolean
Whether the license can be activated (has remaining activations)
object
Custom metadata attached to the license
string
ISO 8601 creation timestamp
string
ISO 8601 last update timestamp
curl -X GET "https://api.chariow.com/v1/licenses?status=active&per_page=20" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch('https://api.chariow.com/v1/licenses?status=active&per_page=20', {
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
});
const data = await response.json();
$ch = curl_init('https://api.chariow.com/v1/licenses?status=active&per_page=20');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer YOUR_API_KEY'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
{
"message": "success",
"data": {
"data": [
{
"id": "lic_ghi789",
"sale_id": 156,
"customer_id": 89,
"license_key": "ABC-123-XYZ-789",
"status": "active",
"activated_at": "2025-01-15T10:30:00.000000Z",
"expires_at": "2026-01-15T10:30:00.000000Z",
"expired_at": null,
"revoked_at": null,
"activation_count": 3,
"max_activations": 10,
"activations_remaining": 7,
"is_active": true,
"is_expired": false,
"can_activate": true,
"metadata": null,
"created_at": "2025-01-15T09:00:00.000000Z",
"updated_at": "2025-01-15T10:30:00.000000Z",
"product": {
"id": 42,
"name": "Premium Software License"
}
}
],
"pagination": {
"next_cursor": "eyJpZCI6NTB9",
"prev_cursor": null,
"has_more": true,
"per_page": 20
}
},
"errors": []
}
Was this page helpful?
⌘I