List Licenses

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, pagination } = 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);

{
  "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"
    }
  ],
  "pagination": {
    "count": 1,
    "path": "https://api.chariow.com/v1/licenses",
    "per_page": 20,
    "next_cursor": null,
    "next_page_url": null,
    "prev_cursor": null,
    "prev_page_url": null,
    "has_more_pages": false,
    "has_pages": false
  }
}

{
  "message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
  "errors": []
}

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, pagination } = 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);

{
  "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"
    }
  ],
  "pagination": {
    "count": 1,
    "path": "https://api.chariow.com/v1/licenses",
    "per_page": 20,
    "next_cursor": null,
    "next_page_url": null,
    "prev_cursor": null,
    "prev_page_url": null,
    "has_more_pages": false,
    "has_pages": false
  }
}

{
  "message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
  "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 and product, and searching by licence key.

Required scope: licenses.read. A key without it receives a 403 error. See Authentication.

Query Parameters

integer

default:"10"

Number of licences to return per page (max 100)

string

Cursor for pagination. Use the next_cursor from the previous response.

string

Filter by licence status. Valid values: pending_activation, active, expired, revoked

string

Filter by product public ID (e.g., prd_def456)

string

Search by licence key

There is no customer filter: use Get Customer to find a customer, then filter the licences on customer.id on your side.

Response

The list is returned at the top level of the body, without the message and errors fields used by error responses.

array

Array of licence objects, newest first

Show license object

string

Licence public ID (e.g., license_abc123)

string

Licence status: pending_activation, active, expired, or revoked

object

Customer who owns the licence: id, name, first_name, last_name, email, phone (number and country) and avatar_url

object

Product that issued the licence: id, name, type, pictures, category, pricing (type, price, effective), bundle and metadata

object

Show properties

string

Full licence key (e.g., ABC-123-XYZ-789)

string

Masked licence key for display

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

Show properties

integer

Current number of activations

integer

Maximum number of activations allowed

integer

Number of activations remaining

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

object

Cursor pagination metadata

Show pagination object

integer

Number of items on this page

string

Base URL of the endpoint

integer

Page size used for this request

string | null

Cursor for the next page, or null if there are no more pages

string | null

Full URL of the next page, or null

string | null

Cursor for the previous page, or null on the first page

string | null

Full URL of the previous page, or null

boolean

Whether there are more items to fetch

boolean

Whether the results span more than one page

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, pagination } = 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);

{
  "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"
    }
  ],
  "pagination": {
    "count": 1,
    "path": "https://api.chariow.com/v1/licenses",
    "per_page": 20,
    "next_cursor": null,
    "next_page_url": null,
    "prev_cursor": null,
    "prev_page_url": null,
    "has_more_pages": false,
    "has_pages": false
  }
}

{
  "message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
  "errors": []
}

Overview

Store

Products

Checkout

Sales

Customers

Licenses

Discounts

Pulses

Affiliates

Query Parameters

Response

​Query Parameters

​Response

Query Parameters

Response