Add plan entitlements
curl --request POST \
--url https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/features/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"planEntitlements": [
{
"feature": "3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01",
"details": {
"value": 10000,
"hasUnlimitedUsage": false,
"reset": "EVERY_MONTH",
"resetTime": "BEGINNING_OF_PERIOD",
"rollover": {},
"usageAlerts": {
"enabled": true,
"thresholds": [
75,
90
],
"thresholdType": "PERCENTAGE"
},
"hardLimit": false,
"isInherited": false,
"isValueOverridden": false
}
}
]
}
'import requests
url = "https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/features/"
payload = { "planEntitlements": [
{
"feature": "3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01",
"details": {
"value": 10000,
"hasUnlimitedUsage": False,
"reset": "EVERY_MONTH",
"resetTime": "BEGINNING_OF_PERIOD",
"rollover": {},
"usageAlerts": {
"enabled": True,
"thresholds": [75, 90],
"thresholdType": "PERCENTAGE"
},
"hardLimit": False,
"isInherited": False,
"isValueOverridden": False
}
}
] }
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({
planEntitlements: [
{
feature: '3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01',
details: {
value: 10000,
hasUnlimitedUsage: false,
reset: 'EVERY_MONTH',
resetTime: 'BEGINNING_OF_PERIOD',
rollover: {},
usageAlerts: {enabled: true, thresholds: [75, 90], thresholdType: 'PERCENTAGE'},
hardLimit: false,
isInherited: false,
isValueOverridden: false
}
}
]
})
};
fetch('https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/features/', 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/{identifier}/features/",
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([
'planEntitlements' => [
[
'feature' => '3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01',
'details' => [
'value' => 10000,
'hasUnlimitedUsage' => false,
'reset' => 'EVERY_MONTH',
'resetTime' => 'BEGINNING_OF_PERIOD',
'rollover' => [
],
'usageAlerts' => [
'enabled' => true,
'thresholds' => [
75,
90
],
'thresholdType' => 'PERCENTAGE'
],
'hardLimit' => false,
'isInherited' => false,
'isValueOverridden' => false
]
]
]
]),
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/{identifier}/features/"
payload := strings.NewReader("{\n \"planEntitlements\": [\n {\n \"feature\": \"3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01\",\n \"details\": {\n \"value\": 10000,\n \"hasUnlimitedUsage\": false,\n \"reset\": \"EVERY_MONTH\",\n \"resetTime\": \"BEGINNING_OF_PERIOD\",\n \"rollover\": {},\n \"usageAlerts\": {\n \"enabled\": true,\n \"thresholds\": [\n 75,\n 90\n ],\n \"thresholdType\": \"PERCENTAGE\"\n },\n \"hardLimit\": false,\n \"isInherited\": false,\n \"isValueOverridden\": false\n }\n }\n ]\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/{identifier}/features/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"planEntitlements\": [\n {\n \"feature\": \"3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01\",\n \"details\": {\n \"value\": 10000,\n \"hasUnlimitedUsage\": false,\n \"reset\": \"EVERY_MONTH\",\n \"resetTime\": \"BEGINNING_OF_PERIOD\",\n \"rollover\": {},\n \"usageAlerts\": {\n \"enabled\": true,\n \"thresholds\": [\n 75,\n 90\n ],\n \"thresholdType\": \"PERCENTAGE\"\n },\n \"hardLimit\": false,\n \"isInherited\": false,\n \"isValueOverridden\": false\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/features/")
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 \"planEntitlements\": [\n {\n \"feature\": \"3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01\",\n \"details\": {\n \"value\": 10000,\n \"hasUnlimitedUsage\": false,\n \"reset\": \"EVERY_MONTH\",\n \"resetTime\": \"BEGINNING_OF_PERIOD\",\n \"rollover\": {},\n \"usageAlerts\": {\n \"enabled\": true,\n \"thresholds\": [\n 75,\n 90\n ],\n \"thresholdType\": \"PERCENTAGE\"\n },\n \"hardLimit\": false,\n \"isInherited\": false,\n \"isValueOverridden\": false\n }\n }\n ]\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",
"ordering": 0,
"enabled": true,
"downloadUrl": "https://api.kelviq.com/api/v1/catalog/plans/10-july/file/bf9f0fe0-c9c0-436d-8811-e412d0365470/download/?token=Yjk5ZjBmZTAtYzljMC00MzZkLTg4MTEtZTQxMmQwMzY1NDcw%3A1v2Abc%3Ahash"
}
],
"ordering": 1
}Plan Entitlements
Add plan entitlements
Appends one or more feature entitlements to the plan. If the plan’s latest version is published, a new draft version is created automatically.
POST
/
catalog
/
plans
/
{identifier}
/
features
/
Add plan entitlements
curl --request POST \
--url https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/features/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"planEntitlements": [
{
"feature": "3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01",
"details": {
"value": 10000,
"hasUnlimitedUsage": false,
"reset": "EVERY_MONTH",
"resetTime": "BEGINNING_OF_PERIOD",
"rollover": {},
"usageAlerts": {
"enabled": true,
"thresholds": [
75,
90
],
"thresholdType": "PERCENTAGE"
},
"hardLimit": false,
"isInherited": false,
"isValueOverridden": false
}
}
]
}
'import requests
url = "https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/features/"
payload = { "planEntitlements": [
{
"feature": "3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01",
"details": {
"value": 10000,
"hasUnlimitedUsage": False,
"reset": "EVERY_MONTH",
"resetTime": "BEGINNING_OF_PERIOD",
"rollover": {},
"usageAlerts": {
"enabled": True,
"thresholds": [75, 90],
"thresholdType": "PERCENTAGE"
},
"hardLimit": False,
"isInherited": False,
"isValueOverridden": False
}
}
] }
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({
planEntitlements: [
{
feature: '3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01',
details: {
value: 10000,
hasUnlimitedUsage: false,
reset: 'EVERY_MONTH',
resetTime: 'BEGINNING_OF_PERIOD',
rollover: {},
usageAlerts: {enabled: true, thresholds: [75, 90], thresholdType: 'PERCENTAGE'},
hardLimit: false,
isInherited: false,
isValueOverridden: false
}
}
]
})
};
fetch('https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/features/', 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/{identifier}/features/",
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([
'planEntitlements' => [
[
'feature' => '3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01',
'details' => [
'value' => 10000,
'hasUnlimitedUsage' => false,
'reset' => 'EVERY_MONTH',
'resetTime' => 'BEGINNING_OF_PERIOD',
'rollover' => [
],
'usageAlerts' => [
'enabled' => true,
'thresholds' => [
75,
90
],
'thresholdType' => 'PERCENTAGE'
],
'hardLimit' => false,
'isInherited' => false,
'isValueOverridden' => false
]
]
]
]),
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/{identifier}/features/"
payload := strings.NewReader("{\n \"planEntitlements\": [\n {\n \"feature\": \"3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01\",\n \"details\": {\n \"value\": 10000,\n \"hasUnlimitedUsage\": false,\n \"reset\": \"EVERY_MONTH\",\n \"resetTime\": \"BEGINNING_OF_PERIOD\",\n \"rollover\": {},\n \"usageAlerts\": {\n \"enabled\": true,\n \"thresholds\": [\n 75,\n 90\n ],\n \"thresholdType\": \"PERCENTAGE\"\n },\n \"hardLimit\": false,\n \"isInherited\": false,\n \"isValueOverridden\": false\n }\n }\n ]\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/{identifier}/features/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"planEntitlements\": [\n {\n \"feature\": \"3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01\",\n \"details\": {\n \"value\": 10000,\n \"hasUnlimitedUsage\": false,\n \"reset\": \"EVERY_MONTH\",\n \"resetTime\": \"BEGINNING_OF_PERIOD\",\n \"rollover\": {},\n \"usageAlerts\": {\n \"enabled\": true,\n \"thresholds\": [\n 75,\n 90\n ],\n \"thresholdType\": \"PERCENTAGE\"\n },\n \"hardLimit\": false,\n \"isInherited\": false,\n \"isValueOverridden\": false\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandboxapi.kelviq.com/api/v1/catalog/plans/{identifier}/features/")
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 \"planEntitlements\": [\n {\n \"feature\": \"3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01\",\n \"details\": {\n \"value\": 10000,\n \"hasUnlimitedUsage\": false,\n \"reset\": \"EVERY_MONTH\",\n \"resetTime\": \"BEGINNING_OF_PERIOD\",\n \"rollover\": {},\n \"usageAlerts\": {\n \"enabled\": true,\n \"thresholds\": [\n 75,\n 90\n ],\n \"thresholdType\": \"PERCENTAGE\"\n },\n \"hardLimit\": false,\n \"isInherited\": false,\n \"isValueOverridden\": false\n }\n }\n ]\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",
"ordering": 0,
"enabled": true,
"downloadUrl": "https://api.kelviq.com/api/v1/catalog/plans/10-july/file/bf9f0fe0-c9c0-436d-8811-e412d0365470/download/?token=Yjk5ZjBmZTAtYzljMC00MzZkLTg4MTEtZTQxMmQwMzY1NDcw%3A1v2Abc%3Ahash"
}
],
"ordering": 1
}Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.
Authorizations
The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'
Path Parameters
Plan identifier.
Query Parameters
Plan version to scope the listing to (GET only).
Body
application/json
Show child attributes
Show child attributes
Response
Entitlements added.
A versioned plan attached to a product. Updates create new versions; only the published version is is_latest=true.
URL-safe slug. Stable across versions.
Example:
"pro-monthly"
Example:
"Pro Monthly"
Example:
"Pro tier billed monthly."
UUID of the parent product.
Example:
"0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de"
Example:
{}
Example:
3
True only for the currently published version.
Example:
true
Example:
"2025-04-12T08:21:14.910Z"
Example:
"2025-03-01T08:21:14.910Z"
Provider-side identifiers (e.g. stripeProductId).
Example:
{ "stripeProductId": "prod_ABC123" }
Example:
true
Example:
false
Example:
["US", "IN"]
License configuration for a plan (used when issuing license keys).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
1