cURL
curl --request PUT \
--url https://commet.co/api/v1/plans/{id}/visibility \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"isPublic": true
}
'import { Commet } from "@commet/node";
const commet = new Commet({ apiKey: "ck_xxx" });
const plan = await commet.plans.setVisibility({
id: "pln_xxx",
isPublic: true,
});from commet import Commet
commet = Commet("ck_xxx")
plan = commet.plans.set_visibility(
"pln_xxx",
is_public=True,
)client, err := commet.New("ck_xxx")
if err != nil {
log.Fatal(err)
}
ctx := context.Background()
plan, err := client.Plans.SetVisibility(ctx, "pln_xxx", &commet.SetPlanVisibilityParams{
IsPublic: true,
})
if err != nil {
log.Fatal(err)
}import co.commet.Commet;
import co.commet.params.SetPlanVisibilityParams;
var commet = Commet.builder().apiKey("ck_xxx").build();
var plan = commet.plans().setVisibility(
"pln_xxx",
SetPlanVisibilityParams.builder(true).build()
);use Commet\Commet;
$commet = new Commet('ck_xxx');
$plan = $commet->plans->setVisibility(
id: 'pln_xxx',
isPublic: true,
);{
"id": "plan_1a2b3c4d",
"name": "Pro",
"code": "pro",
"description": "For growing API products",
"consumptionModel": "metered",
"isPublic": false,
"isDefault": false,
"isFree": false,
"blockOnExhaustion": true,
"sortOrder": 0,
"planGroupId": "group_1a2b3c4d",
"metadata": {},
"createdAt": "2026-09-07T12:00:00.000Z",
"updatedAt": "2026-09-07T12:00:00.000Z",
"features": [
{
"code": "api_calls",
"name": "API Calls",
"type": "usage",
"unitName": "calls",
"enabled": true,
"includedAmount": 1000,
"unlimited": false,
"overage": {
"enabled": false,
"model": null,
"unitPrice": null
},
"regionalPrices": []
}
],
"prices": [
{
"id": "price_1a2b3c4d",
"billingInterval": "monthly",
"price": 2000,
"isDefault": true,
"trialDays": 0,
"includedBalance": null,
"includedCredits": null,
"offerId": null,
"inheritsFromPriceId": null,
"metadata": {},
"marketPrices": [],
"regionalPrices": []
}
],
"exchangeRates": [],
"object": "plan",
"livemode": false
}{
"error": {
"type": "validation_error",
"code": "validation_error",
"message": "The request contains an invalid parameter.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md"
}
}{
"error": {
"type": "authentication_error",
"code": "unauthorized",
"message": "A valid API key is required.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md"
}
}{
"error": {
"type": "authentication_error",
"code": "forbidden",
"message": "You do not have permission to perform this operation.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md"
}
}{
"error": {
"type": "not_found_error",
"code": "not_found",
"message": "The requested resource was not found.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/not_found.md"
}
}{
"error": {
"type": "conflict_error",
"code": "idempotency_in_progress",
"message": "A request with this idempotency key is still being processed.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_in_progress.md"
}
}{
"error": {
"type": "rate_limit_error",
"code": "rate_limited",
"message": "Too many requests. Retry after the interval specified in the Retry-After header.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md"
}
}{
"error": {
"type": "internal_error",
"code": "internal_error",
"message": "An unexpected error occurred while processing the request.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md"
}
}{
"error": {
"type": "internal_error",
"code": "idempotency_unavailable",
"message": "Idempotency storage is temporarily unavailable. Retry with the same idempotency key.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_unavailable.md"
}
}Plans
Set plan visibility
Set a plan’s public visibility and return the updated plan.
PUT
/
plans
/
{id}
/
visibility
cURL
curl --request PUT \
--url https://commet.co/api/v1/plans/{id}/visibility \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"isPublic": true
}
'import { Commet } from "@commet/node";
const commet = new Commet({ apiKey: "ck_xxx" });
const plan = await commet.plans.setVisibility({
id: "pln_xxx",
isPublic: true,
});from commet import Commet
commet = Commet("ck_xxx")
plan = commet.plans.set_visibility(
"pln_xxx",
is_public=True,
)client, err := commet.New("ck_xxx")
if err != nil {
log.Fatal(err)
}
ctx := context.Background()
plan, err := client.Plans.SetVisibility(ctx, "pln_xxx", &commet.SetPlanVisibilityParams{
IsPublic: true,
})
if err != nil {
log.Fatal(err)
}import co.commet.Commet;
import co.commet.params.SetPlanVisibilityParams;
var commet = Commet.builder().apiKey("ck_xxx").build();
var plan = commet.plans().setVisibility(
"pln_xxx",
SetPlanVisibilityParams.builder(true).build()
);use Commet\Commet;
$commet = new Commet('ck_xxx');
$plan = $commet->plans->setVisibility(
id: 'pln_xxx',
isPublic: true,
);{
"id": "plan_1a2b3c4d",
"name": "Pro",
"code": "pro",
"description": "For growing API products",
"consumptionModel": "metered",
"isPublic": false,
"isDefault": false,
"isFree": false,
"blockOnExhaustion": true,
"sortOrder": 0,
"planGroupId": "group_1a2b3c4d",
"metadata": {},
"createdAt": "2026-09-07T12:00:00.000Z",
"updatedAt": "2026-09-07T12:00:00.000Z",
"features": [
{
"code": "api_calls",
"name": "API Calls",
"type": "usage",
"unitName": "calls",
"enabled": true,
"includedAmount": 1000,
"unlimited": false,
"overage": {
"enabled": false,
"model": null,
"unitPrice": null
},
"regionalPrices": []
}
],
"prices": [
{
"id": "price_1a2b3c4d",
"billingInterval": "monthly",
"price": 2000,
"isDefault": true,
"trialDays": 0,
"includedBalance": null,
"includedCredits": null,
"offerId": null,
"inheritsFromPriceId": null,
"metadata": {},
"marketPrices": [],
"regionalPrices": []
}
],
"exchangeRates": [],
"object": "plan",
"livemode": false
}{
"error": {
"type": "validation_error",
"code": "validation_error",
"message": "The request contains an invalid parameter.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md"
}
}{
"error": {
"type": "authentication_error",
"code": "unauthorized",
"message": "A valid API key is required.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md"
}
}{
"error": {
"type": "authentication_error",
"code": "forbidden",
"message": "You do not have permission to perform this operation.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md"
}
}{
"error": {
"type": "not_found_error",
"code": "not_found",
"message": "The requested resource was not found.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/not_found.md"
}
}{
"error": {
"type": "conflict_error",
"code": "idempotency_in_progress",
"message": "A request with this idempotency key is still being processed.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_in_progress.md"
}
}{
"error": {
"type": "rate_limit_error",
"code": "rate_limited",
"message": "Too many requests. Retry after the interval specified in the Retry-After header.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md"
}
}{
"error": {
"type": "internal_error",
"code": "internal_error",
"message": "An unexpected error occurred while processing the request.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md"
}
}{
"error": {
"type": "internal_error",
"code": "idempotency_unavailable",
"message": "Idempotency storage is temporarily unavailable. Retry with the same idempotency key.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_unavailable.md"
}
}Set a plan’s public visibility and return the updated plan.
Autorizaciones
Encabezados
Unique key used to safely retry this write for 24 hours without applying it twice.
Required string length:
1 - 200API version used by this reference. Send this header to select this contract explicitly.
Parámetros de ruta
Cuerpo
application/json
Respuesta
Success
Opciones disponibles:
metered, credits, balance Rango requerido:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Allowed value:
"plan"¿Esta página le ayudó?