Package owners user-package-owners
Admin only: purchased packages grouped by user (package counts, expiry stats, tab counts).
Pick an endpoint to see its example call on the right.
Authentication
Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.
X-API-Key
Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).
Conventions
Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.
Times are RFC 3339 (UTC); amounts are in cents.
Writes return 200/201/204 on success; duplicates of a unique key return 409.
/api/v2/user-package-ownersList purchased packages grouped by user
Authentication: Admin only
Query parameters
| Field | Type | Description |
|---|---|---|
page | integer | Page number, starting from 1 |
page_size | integer | Items per page |
tab | string | Tab: all, week (expiring within 7 days, not yet expired), month (expiring within 30 days, not yet expired), expired, customized (individually edited quotas or not following the base package); defaults to all. |
q | string | Keyword: username, package name or base package name contains it (% and _ match literally), or it equals a user ID or package ID. |
Package owners object
| Field | Type | Description |
|---|---|---|
avatar_ver | integer | Avatar version, increases on every upload and serves as the avatar cache key; omitted when there is no avatar. |
expired_count | integer | Of which expired. |
expiring_count | integer | Of which expiring within 7 days (not yet expired). |
next_end_at | string | End time of the soonest not-yet-expired package in the tab; omitted when all are expired. |
nickname | string | Nickname; omitted when not set (the UI shows the username). |
package_count | integer | Packages in the tab. |
user_id | integer | User ID (same as the tenant ID). |
username | string | Username. |
Responses and errors
Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"code": "validation_failed",
"detail": "Invalid request parameters",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name is required"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}