Skip to main content
GET
/
catalog
/
plans
List plans
curl --request GET \
  --url https://api.kelviq.com/api/v1/catalog/plans/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "identifier": "pro-monthly",
      "name": "Pro Monthly",
      "description": "Pro tier billed monthly.",
      "product": "0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de",
      "metadata": {},
      "version": 3,
      "isLatest": true,
      "modifiedOn": "2025-04-12T08:21:14.910Z",
      "createdOn": "2025-03-01T08:21:14.910Z",
      "details": {
        "stripeProductId": "prod_ABC123"
      },
      "isVisible": true,
      "isImported": false,
      "countries": [
        "US",
        "IN"
      ],
      "license": {
        "enabled": true,
        "activationLimit": 3,
        "activationLimitEnabled": true,
        "durationUnit": "YEAR",
        "durationValue": 1,
        "hasExpiry": true
      },
      "links": [
        {
          "name": "Product page",
          "url": "https://example.com/product"
        }
      ],
      "files": [
        {
          "id": "7a3e3411-cef0-4f4e-bdb6-1f74a4f4d2c0",
          "name": "Plan Terms.pdf",
          "file": "media/.../plans/<id>/<uuid>/terms.pdf",
          "ordering": 0,
          "enabled": true,
          "downloadUrl": "https://api.kelviq.com/api/v1/catalog/plans/pro-monthly/file/7a3e3411-cef0-4f4e-bdb6-1f74a4f4d2c0/download/"
        }
      ],
      "ordering": 1
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.kelviq.com/llms.txt

Use this file to discover all available pages before exploring further.

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'

Response

Paginated list of plans.

count
integer
Example:

1

next
string | null
Example:

null

previous
string | null
Example:

null

results
object[]