Skip to Content
FluxStore is currently invite-only. Some sections of this documentation are still being written and expanded.
APIManagement APIPackagesGet a package
GET/api/v1/packages/{id}

Retrieve a single package by its ID.

Requires the Packages:View permission.

Path parameters

idstring· uuidrequired

The package ID.

Headers

X-Api-Keystringrequired

Your API key.

Response fields

Package object

idstring· uuidrequired
The package ID.
namestringrequired
The package name.
descriptionstring
Long-form description of the package.
pricenumberrequired
Base price in the store’s default currency.
salePricenumber
Sale price if a sale is active, otherwise null.
imageUrlstring
URL of the package image.
isActivebooleanrequired
Whether the package is enabled in the store.
sortOrderinteger
Position of the package within its category.
categoryIdstring· uuid
ID of the category this package belongs to.
categoryNamestring
Name of the category.
allowCustomPriceboolean
Whether customers can set their own price.
globalLimitinteger
Global purchase limit, or null for unlimited.
perUserLimitinteger
Per-user purchase limit, or null for unlimited.
isCumulativeboolean
Whether per-user limit accumulates across resets.
isTieredboolean
Whether the package has tier pricing.
isSubscriptionboolean
Whether the package is a subscription.
serverIdsstring[]· uuid
Servers this package is available on.
createdAtstring· date-timerequired
Creation timestamp.
updatedAtstring· date-timerequired
Last update timestamp.
List packagesCreate a package