Skip to main content
GET
Retrieve a product

Authorizations

Authorization
string
header
required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Path Parameters

pk
string<uuid>
required

Product UUID.

Response

Product details.

A product returned via the detail endpoint, including its published plans.

id
string<uuid>
read-only
Example:

"0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de"

identifier
string

Human-readable, URL-safe slug. Auto-generated from name if omitted on create.

Example:

"pro-suite"

name
string
Example:

"Pro Suite"

description
string
Example:

"Premium tools for growing teams."

taxCode
enum<string>

Tax code for the product. Must be one of the supported values.

Available options:
saas,
saas_business,
software,
videocontent,
informationservice,
ebook,
digitalgraphic,
videogame,
eservice,
training
Example:

"saas"

createdBy
string
read-only

Display name of the user who created the product.

Example:

"Jane Smith"

modifiedOn
string<date-time>
read-only
Example:

"2025-04-12T08:21:14.910Z"

images
object[]
read-only
plans
string[]

Identifiers of all published (latest, non-archived) plans on this product.

Example: