List plans
curl --request GET \
--url https://commet.co/api/v1/plans \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://commet.co/api/v1/plans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://commet.co/api/v1/plans"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://commet.co/api/v1/plans"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://commet.co/api/v1/plans")
.header("x-api-key", "<api-key>")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://commet.co/api/v1/plans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"object": "list",
"data": [
{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"description": "<string>",
"consumptionModel": "metered",
"isPublic": true,
"isDefault": true,
"isFree": true,
"blockOnExhaustion": true,
"unusedPlanCredits": {
"type": "expire"
},
"planCreditLimit": {
"credits": 123,
"interval": "day"
},
"unusedPlanBalance": {
"type": "expire"
},
"planBalanceLimit": {
"amount": 123,
"interval": "day"
},
"sortOrder": 0,
"planGroupId": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"features": [
{
"code": "<string>",
"name": "<string>",
"type": "boolean",
"unitName": "<string>",
"enabled": true,
"includedAmount": 0,
"unlimited": true,
"overage": {
"enabled": true,
"model": "per_unit",
"unitPrice": 0
},
"regionalPrices": [
{
"currency": "<string>",
"overageUnitPrice": 0,
"autoSynced": true
}
]
}
],
"prices": [
{
"id": "<string>",
"billingInterval": "weekly",
"price": 0,
"isDefault": true,
"trialDays": 0,
"trialRequiresPaymentMethod": true,
"includedBalance": 0,
"includedCredits": 0,
"offerId": "<string>",
"inheritsFromPriceId": "<string>",
"metadata": {},
"marketPrices": [
{
"marketGroupId": "<string>",
"currency": "<string>",
"price": 0
}
],
"regionalPrices": [
{
"currency": "<string>",
"price": 0,
"includedBalance": 0,
"autoSynced": true
}
]
}
],
"exchangeRates": [
{
"currency": "<string>",
"exchangeRate": 123
}
],
"countries": [
{
"country": "<string>",
"currency": "<string>",
"prices": [
{
"billingInterval": "weekly",
"price": 0,
"manual": true
}
],
"addons": [
{
"addonId": "<string>",
"price": 0,
"manual": true
}
],
"creditPacks": [
{
"creditPackId": "<string>",
"price": 0,
"manual": true
}
]
}
],
"object": "plan",
"livemode": true
}
],
"hasMore": true,
"nextCursor": "<string>"
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"param": "<string>",
"details": "<unknown>"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"param": "<string>",
"details": "<unknown>"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"param": "<string>",
"details": "<unknown>"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"param": "<string>",
"details": "<unknown>"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"param": "<string>",
"details": "<unknown>"
}
}Plans
List plans
List plans with public price IDs and their automatic introductory offer IDs.
GET
/
plans
List plans
curl --request GET \
--url https://commet.co/api/v1/plans \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://commet.co/api/v1/plans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://commet.co/api/v1/plans"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://commet.co/api/v1/plans"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://commet.co/api/v1/plans")
.header("x-api-key", "<api-key>")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://commet.co/api/v1/plans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"object": "list",
"data": [
{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"description": "<string>",
"consumptionModel": "metered",
"isPublic": true,
"isDefault": true,
"isFree": true,
"blockOnExhaustion": true,
"unusedPlanCredits": {
"type": "expire"
},
"planCreditLimit": {
"credits": 123,
"interval": "day"
},
"unusedPlanBalance": {
"type": "expire"
},
"planBalanceLimit": {
"amount": 123,
"interval": "day"
},
"sortOrder": 0,
"planGroupId": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"features": [
{
"code": "<string>",
"name": "<string>",
"type": "boolean",
"unitName": "<string>",
"enabled": true,
"includedAmount": 0,
"unlimited": true,
"overage": {
"enabled": true,
"model": "per_unit",
"unitPrice": 0
},
"regionalPrices": [
{
"currency": "<string>",
"overageUnitPrice": 0,
"autoSynced": true
}
]
}
],
"prices": [
{
"id": "<string>",
"billingInterval": "weekly",
"price": 0,
"isDefault": true,
"trialDays": 0,
"trialRequiresPaymentMethod": true,
"includedBalance": 0,
"includedCredits": 0,
"offerId": "<string>",
"inheritsFromPriceId": "<string>",
"metadata": {},
"marketPrices": [
{
"marketGroupId": "<string>",
"currency": "<string>",
"price": 0
}
],
"regionalPrices": [
{
"currency": "<string>",
"price": 0,
"includedBalance": 0,
"autoSynced": true
}
]
}
],
"exchangeRates": [
{
"currency": "<string>",
"exchangeRate": 123
}
],
"countries": [
{
"country": "<string>",
"currency": "<string>",
"prices": [
{
"billingInterval": "weekly",
"price": 0,
"manual": true
}
],
"addons": [
{
"addonId": "<string>",
"price": 0,
"manual": true
}
],
"creditPacks": [
{
"creditPackId": "<string>",
"price": 0,
"manual": true
}
]
}
],
"object": "plan",
"livemode": true
}
],
"hasMore": true,
"nextCursor": "<string>"
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"param": "<string>",
"details": "<unknown>"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"param": "<string>",
"details": "<unknown>"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"param": "<string>",
"details": "<unknown>"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"param": "<string>",
"details": "<unknown>"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"param": "<string>",
"details": "<unknown>"
}
}This reference describes API version
2026-07-31. Send Commet-Version: 2026-07-31 with your request.Headers
Was this page helpful?