List Licenses - Chariow Developers

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

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

Show properties

data

array

Array of license objects

Show license object

string

Unique license identifier (e.g., lic_abc123)

sale_id

integer

Associated sale ID

customer_id

integer

Associated customer ID

license_key

string

The license key string

status

string

License status: pending_activation, active, expired, or revoked

activated_at

string

ISO 8601 timestamp when first activated (null if not yet activated)

expires_at

string

ISO 8601 expiration timestamp (null if no expiration)

expired_at

string

ISO 8601 timestamp when expired (null if not expired)

revoked_at

string

ISO 8601 timestamp when revoked (null if not revoked)

activation_count

integer

Current number of activations

max_activations

integer

Maximum number of activations allowed

activations_remaining

integer

Number of activations remaining

is_active

boolean

Whether the license is currently active

is_expired

boolean

Whether the license has expired

can_activate

boolean

Whether the license can be activated (has remaining activations)

metadata

object

Custom metadata attached to the license

created_at

string

ISO 8601 creation timestamp

updated_at

string

ISO 8601 last update timestamp

product

object

Product information

Show product object

integer

Product ID

name

string

Product name

pagination

object

Cursor pagination metadata

Show pagination object

next_cursor

string

Cursor for the next page (null if no more pages)

prev_cursor

string

Cursor for the previous page (null if on first page)

has_more

boolean

Whether there are more results

per_page

integer

Number of items per page

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

Get Customer Get License

​Query Parameters

​Response

Query Parameters

Response