Skip to main content

Product entity

id
string
required

Unique product identifier

Example:

"product_0197a8d9-8426-7e71-9edf-26301686ed26"

name
string
required

Product name

Example:

"Premium API Access"

organization_id
string
required

Organization identifier

Example:

"org_0197a8d9-8426-7e71-9edf-26301686ed26"

version_group_id
string

Version group identifier

Example:

"vg_0197a8d9-8426-7e71-9edf-26301686ed26"

is_active
integer | null

Whether the product is active

description
string | null

Product description

Example:

"Premium API access with advanced features"

image_id
string | null

Product image identifier

Example:

"img_0197a8d9-8426-7e71-9edf-26301686ed26"

metadata
object

Additional product metadata

schemas
object[]

Product billing schemas

created_at
string<mysql-date-time>

Timestamp when the product was created

Example:

"2024-01-15 10:30:00"

updated_at
string<mysql-date-time> | null

Timestamp when the product was last updated

Example:

"2024-01-15 10:30:00"

image
object

Associated product's image

Example:
{
"id": "file_0196b6e6-54e3-796d-9c6a-2862a5fef597",
"url": "https://assets.bitgpt.xyz//app/public/src/storage/uploads/image/2025/05/09/0196b6e6-54e3-7290-9d73-0074c623e368.jpg"
}