Skip to main content
GET
https://api.chariow.com/v1
/
licenses
curl -X GET "https://api.chariow.com/v1/licenses?status=active&per_page=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "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

​
per_page
integer
default:"50"
Number of licenses to return per page (max 100)
​
cursor
string
Cursor for pagination. Use the next_cursor from the previous response.
​
status
string
Filter by license status. Valid values: pending_activation, active, expired, revoked
​
customer_id
string
Filter by customer public ID (e.g., cus_abc123)
​
product_id
string
Filter by product public ID (e.g., prd_def456)

​
Response

​
data
object
curl -X GET "https://api.chariow.com/v1/licenses?status=active&per_page=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "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": []
}