Package catalog package-catalog
The catalog of packages, groups and add-ons a customer can buy.
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/package-catalogPurchasable package catalog
Authentication: User
Package catalog object
| Field | Type | Description |
|---|---|---|
feature_states | PackageFeatureStates | Whether the platform currently has each package paid feature enabled (license state is neither none nor degraded); a false item does not take effect for now even if the package includes it. |
groups | PackageGroup[] | Package groups. |
packages | Package[] | Base packages on sale. |
storefront | PackageStorefront | Storefront settings (system config plan.storefront, read and written via GET/PUT /configs/plan.storefront; PUT takes expected_updated_at to avoid lost updates). |
upgrades | PackageUpgrade[] | Add-ons on sale. |
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"
}