Create a plan

Create a plan

curl --request POST \
  --url https://sandboxapi.kelviq.com/api/v1/catalog/plans/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Pro Monthly",
  "identifier": "pro-monthly",
  "description": "Pro tier billed monthly.",
  "product": "0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de",
  "isVisible": true,
  "fileKeys": [
    "tmp/9b1c8af2-3d4e-4f9a-8b2c-1f3e5a7b9d12/plan-terms.pdf"
  ],
  "ordering": 1
}
'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/catalog/plans/"

payload = {
    "name": "Pro Monthly",
    "identifier": "pro-monthly",
    "description": "Pro tier billed monthly.",
    "product": "0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de",
    "isVisible": True,
    "fileKeys": ["tmp/9b1c8af2-3d4e-4f9a-8b2c-1f3e5a7b9d12/plan-terms.pdf"],
    "ordering": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Pro Monthly',
    identifier: 'pro-monthly',
    description: 'Pro tier billed monthly.',
    product: '0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de',
    isVisible: true,
    fileKeys: ['tmp/9b1c8af2-3d4e-4f9a-8b2c-1f3e5a7b9d12/plan-terms.pdf'],
    ordering: 1
  })
};

fetch('https://sandboxapi.kelviq.com/api/v1/catalog/plans/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandboxapi.kelviq.com/api/v1/catalog/plans/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Pro Monthly',
    'identifier' => 'pro-monthly',
    'description' => 'Pro tier billed monthly.',
    'product' => '0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de',
    'isVisible' => true,
    'fileKeys' => [
        'tmp/9b1c8af2-3d4e-4f9a-8b2c-1f3e5a7b9d12/plan-terms.pdf'
    ],
    'ordering' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandboxapi.kelviq.com/api/v1/catalog/plans/"

	payload := strings.NewReader("{\n  \"name\": \"Pro Monthly\",\n  \"identifier\": \"pro-monthly\",\n  \"description\": \"Pro tier billed monthly.\",\n  \"product\": \"0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de\",\n  \"isVisible\": true,\n  \"fileKeys\": [\n    \"tmp/9b1c8af2-3d4e-4f9a-8b2c-1f3e5a7b9d12/plan-terms.pdf\"\n  ],\n  \"ordering\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandboxapi.kelviq.com/api/v1/catalog/plans/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Pro Monthly\",\n  \"identifier\": \"pro-monthly\",\n  \"description\": \"Pro tier billed monthly.\",\n  \"product\": \"0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de\",\n  \"isVisible\": true,\n  \"fileKeys\": [\n    \"tmp/9b1c8af2-3d4e-4f9a-8b2c-1f3e5a7b9d12/plan-terms.pdf\"\n  ],\n  \"ordering\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/catalog/plans/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Pro Monthly\",\n  \"identifier\": \"pro-monthly\",\n  \"description\": \"Pro tier billed monthly.\",\n  \"product\": \"0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de\",\n  \"isVisible\": true,\n  \"fileKeys\": [\n    \"tmp/9b1c8af2-3d4e-4f9a-8b2c-1f3e5a7b9d12/plan-terms.pdf\"\n  ],\n  \"ordering\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "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": "bf9f0fe0-c9c0-436d-8811-e412d0365470",
      "name": "custom-pricinig.png",
      "file": "https://cdn.kelviq.com/media/organizations/8/plan/1ad723d2-40eb-4bf0-b924-557e6697e788/53c28d460fed421a81f6c6e90114ff4f/custom-pricinig.png",
      "ordering": 0,
      "enabled": true,
      "downloadUrl": "https://api.kelviq.com/api/v1/catalog/plans/10-july/file/bf9f0fe0-c9c0-436d-8811-e412d0365470/download/"
    }
  ],
  "ordering": 1
}

POST

catalog

plans

Create a plan

curl --request POST \
  --url https://sandboxapi.kelviq.com/api/v1/catalog/plans/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Pro Monthly",
  "identifier": "pro-monthly",
  "description": "Pro tier billed monthly.",
  "product": "0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de",
  "isVisible": true,
  "fileKeys": [
    "tmp/9b1c8af2-3d4e-4f9a-8b2c-1f3e5a7b9d12/plan-terms.pdf"
  ],
  "ordering": 1
}
'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/catalog/plans/"

payload = {
    "name": "Pro Monthly",
    "identifier": "pro-monthly",
    "description": "Pro tier billed monthly.",
    "product": "0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de",
    "isVisible": True,
    "fileKeys": ["tmp/9b1c8af2-3d4e-4f9a-8b2c-1f3e5a7b9d12/plan-terms.pdf"],
    "ordering": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Pro Monthly',
    identifier: 'pro-monthly',
    description: 'Pro tier billed monthly.',
    product: '0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de',
    isVisible: true,
    fileKeys: ['tmp/9b1c8af2-3d4e-4f9a-8b2c-1f3e5a7b9d12/plan-terms.pdf'],
    ordering: 1
  })
};

fetch('https://sandboxapi.kelviq.com/api/v1/catalog/plans/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandboxapi.kelviq.com/api/v1/catalog/plans/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Pro Monthly',
    'identifier' => 'pro-monthly',
    'description' => 'Pro tier billed monthly.',
    'product' => '0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de',
    'isVisible' => true,
    'fileKeys' => [
        'tmp/9b1c8af2-3d4e-4f9a-8b2c-1f3e5a7b9d12/plan-terms.pdf'
    ],
    'ordering' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandboxapi.kelviq.com/api/v1/catalog/plans/"

	payload := strings.NewReader("{\n  \"name\": \"Pro Monthly\",\n  \"identifier\": \"pro-monthly\",\n  \"description\": \"Pro tier billed monthly.\",\n  \"product\": \"0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de\",\n  \"isVisible\": true,\n  \"fileKeys\": [\n    \"tmp/9b1c8af2-3d4e-4f9a-8b2c-1f3e5a7b9d12/plan-terms.pdf\"\n  ],\n  \"ordering\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandboxapi.kelviq.com/api/v1/catalog/plans/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Pro Monthly\",\n  \"identifier\": \"pro-monthly\",\n  \"description\": \"Pro tier billed monthly.\",\n  \"product\": \"0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de\",\n  \"isVisible\": true,\n  \"fileKeys\": [\n    \"tmp/9b1c8af2-3d4e-4f9a-8b2c-1f3e5a7b9d12/plan-terms.pdf\"\n  ],\n  \"ordering\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/catalog/plans/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Pro Monthly\",\n  \"identifier\": \"pro-monthly\",\n  \"description\": \"Pro tier billed monthly.\",\n  \"product\": \"0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de\",\n  \"isVisible\": true,\n  \"fileKeys\": [\n    \"tmp/9b1c8af2-3d4e-4f9a-8b2c-1f3e5a7b9d12/plan-terms.pdf\"\n  ],\n  \"ordering\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "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": "bf9f0fe0-c9c0-436d-8811-e412d0365470",
      "name": "custom-pricinig.png",
      "file": "https://cdn.kelviq.com/media/organizations/8/plan/1ad723d2-40eb-4bf0-b924-557e6697e788/53c28d460fed421a81f6c6e90114ff4f/custom-pricinig.png",
      "ordering": 0,
      "enabled": true,
      "downloadUrl": "https://api.kelviq.com/api/v1/catalog/plans/10-july/file/bf9f0fe0-c9c0-436d-8811-e412d0365470/download/"
    }
  ],
  "ordering": 1
}

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'

Body

application/json

name

string

required

Example:

"Pro Monthly"

product

string<uuid>

required

UUID of the parent product.

Example:

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

identifier

string

Example:

"pro-monthly"

description

string

Example:

"Pro tier billed monthly."

metadata

object

Example:

{}

isVisible

boolean

Example:

true

license

object

License configuration for a plan (used when issuing license keys).

Show child attributes

links

object[]

Show child attributes

fileKeys

string[]

Temporary S3 keys (e.g. tmp/<uuid>/<filename>) returned by POST /media/ for files to attach to the plan. Uploaded files are moved into permanent storage and exposed via the plan's files[].

Example:

[
  "tmp/9b1c8af2-3d4e-4f9a-8b2c-1f3e5a7b9d12/plan-terms.pdf"
]

ordering

integer

Example:

1

Response

Plan created.

A versioned plan attached to a product. Updates create new versions; only the published version is is_latest=true.

identifier

string

URL-safe slug. Stable across versions.

Example:

"pro-monthly"

name

string

Example:

"Pro Monthly"

description

string

Example:

"Pro tier billed monthly."

product

string<uuid>

UUID of the parent product.

Example:

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

metadata

object

Example:

{}

version

integer

read-only

Example:

3

isLatest

boolean

read-only

True only for the currently published version.

Example:

true

modifiedOn

string<date-time>

read-only

Example:

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

createdOn

string<date-time>

read-only

Example:

"2025-03-01T08:21:14.910Z"

details

object

read-only

Provider-side identifiers (e.g. stripeProductId).

Example:

{ "stripeProductId": "prod_ABC123" }

isVisible

boolean

Example:

true

isImported

boolean

read-only

Example:

false

countries

string[]

read-only

Example:

["US", "IN"]

license

object

License configuration for a plan (used when issuing license keys).

Show child attributes

links

object[]

Show child attributes

files

object[]

read-only

Show child attributes

ordering

integer | null

Example:

1

Get Started

API Documentation

Authorizations

Body

Response