Products

Manage product offerings, including creation and retrieval

Get Products

Retrieve a list of products

Query Parameters

x-kc-token
string
Content-Type
string

Response

Successful request, returns product list

data
array
GET /products
Response Example
{
  "data": [
    {
      "id": "22c220b6-9926-4a9c-baa1-95558d7a338d",
      "date_created": "2025-02-28T07:11:01.232Z",
      "name": "Awesome Saas1",
      "description": "This is first product for Awesome SaaS",
      "status": "draft",
      "user_updated": null,
      "date_updated": null,
      "user_created": "a01c4d98-34e6-48b4-b31d-d543f0cc1da7",
      "prices": null,
      "image": null,
      "subscription_blueprint": "52832de5-18a5-43dd-bc75-7f47599cc2cc",
      "selected_currencies": [
        "1"
      ],
      "features": []
    }
  ]
}

Create Product

Add a new product to the catalog

Query Parameters

Content-Type
string
x-kc-token
string
x-idempotency-id
string

Request Body

status
string
name
string
description
string
selected_currencies
array
subscription_blueprint
object

Response

Product created successfully

data
object
POST /products
Response Example
{
  "data": {
    "id": "22c220b6-9926-4a9c-baa1-95558d7a338d",
    "date_created": "2025-02-28T07:11:01.232Z",
    "name": "Awesome Saas1",
    "description": "This is first product for Awesome SaaS",
    "status": "draft",
    "user_updated": null,
    "date_updated": null,
    "user_created": "a01c4d98-34e6-48b4-b31d-d543f0cc1da7",
    "prices": null,
    "image": null,
    "subscription_blueprint": "52832de5-18a5-43dd-bc75-7f47599cc2cc",
    "selected_currencies": [
      "1"
    ],
    "features": []
  }
}

Get Product by ID

Retrieve a specific product by its ID

Query Parameters

id
string
x-kc-token
string
Content-Type
string

Response

Product retrieved successfully

data
object
GET /products/{id}
Response Example
{
  "data": {
    "id": "22c220b6-9926-4a9c-baa1-95558d7a338d",
    "date_created": "2025-02-28T07:11:01.232Z",
    "name": "Awesome Saas1",
    "description": "This is first product for Awesome SaaS",
    "status": "draft",
    "user_updated": null,
    "date_updated": null,
    "user_created": "a01c4d98-34e6-48b4-b31d-d543f0cc1da7",
    "prices": null,
    "image": null,
    "subscription_blueprint": "52832de5-18a5-43dd-bc75-7f47599cc2cc",
    "selected_currencies": [
      "1"
    ],
    "features": []
  }
}

Update Product

Update an existing product by its ID

Query Parameters

id
string
Content-Type
string
x-kc-token
string
x-idempotency-id
string

Request Body

status
string
name
string
description
string
selected_currencies
array
subscription_blueprint
object

Response

Product updated successfully

data
object
PATCH /products/{id}
Response Example
{
  "data": {
    "id": "22c220b6-9926-4a9c-baa1-95558d7a338d",
    "date_updated": "2025-02-28T07:30:01.232Z",
    "name": "Awesome Saas1 Updated",
    "description": "Updated description for Awesome SaaS",
    "status": "published",
    "date_created": "2025-02-28T07:11:01.232Z",
    "user_updated": "a01c4d98-34e6-48b4-b31d-d543f0cc1da7",
    "user_created": "a01c4d98-34e6-48b4-b31d-d543f0cc1da7",
    "prices": null,
    "image": null,
    "subscription_blueprint": "52832de5-18a5-43dd-bc75-7f47599cc2cc",
    "selected_currencies": [
      "1"
    ],
    "features": []
  }
}