Products API
Manage the product catalog. Products can be of type licensed, saas, or api.
List Products
GET /api/productsReturns all products.
Response 200 OK
[
{
"id": "01JQX...",
"name": "Pro Plan",
"productType": "saas",
"description": "Professional tier SaaS offering",
"price": "49.99",
"status": "active",
"monthlyRevenue": "12500.00",
"activeUsers": 250,
"dailyActiveUsers": 180,
"churnRate": "2.50",
"createdAt": "2026-01-15T10:30:00Z",
"updatedAt": "2026-01-15T10:30:00Z"
}
]Get Product
GET /api/products/:idResponse 200 OK — Single product object.
Create Product
POST /api/products
Content-Type: application/jsonBody
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Product name |
productType | string | Yes | licensed, saas, or api |
description | string | No | Product description |
price | string | Yes | Decimal price (e.g. "49.99") |
status | string | No | Default: active |
Response 201 Created
Update Product
PUT /api/products/:id
Content-Type: application/jsonAccepts the same fields as create. Only provided fields are updated.
Response 200 OK
Delete Product
DELETE /api/products/:idResponse 204 No Content
Public API
Products are also available via the public v1 API:
GET /api/v1/products
Authorization: Bearer <api-key>Returns products scoped to the API key’s customer.
Last updated on