Retrieve a plan
curl --request GET \
--url https://api.nozle.app/core/api/v1/plans/{code} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nozle.app/core/api/v1/plans/{code}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.nozle.app/core/api/v1/plans/{code}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.nozle.app/core/api/v1/plans/{code}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.nozle.app/core/api/v1/plans/{code}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nozle.app/core/api/v1/plans/{code}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.nozle.app/core/api/v1/plans/{code}")
.header("Authorization", "Bearer <token>")
.asString();{
"plan": {
"nozle_id": "00000000-0000-4000-8000-000000000001",
"name": "Pro",
"invoice_display_name": "Acme Pro",
"created_at": "2026-01-15T10:00:00Z",
"code": "pro",
"interval": "monthly",
"description": "For teams replacing their sales, communication, and automation stack.",
"amount_cents": 1499,
"amount_currency": "USD",
"trial_period": null,
"pay_in_advance": true,
"bill_charges_monthly": null,
"bill_fixed_charges_monthly": null,
"parent_id": null,
"pending_deletion": false,
"charges": [
{
"nozle_id": "00000000-0000-4000-8000-000000000002",
"feature_id": "00000000-0000-4000-8000-000000000003",
"code": "active_seats",
"invoice_display_name": "Active Acme members",
"feature_code": "active_seats",
"created_at": "2026-01-15T10:00:00Z",
"charge_model": "graduated",
"invoiceable": true,
"regroup_paid_fees": null,
"pay_in_advance": false,
"prorated": false,
"min_amount_cents": 0,
"accepts_target_wallet": false,
"properties": {
"graduated_ranges": [
{
"to_value": 1,
"from_value": 0,
"flat_amount": "0",
"per_unit_amount": "0"
},
{
"to_value": null,
"from_value": 2,
"flat_amount": "0",
"per_unit_amount": "14.99"
}
]
},
"applied_pricing_unit": null,
"parent_id": null,
"filters": [],
"taxes": []
}
],
"fixed_charges": [],
"entitlements": [
{
"feature_id": "00000000-0000-4000-8000-000000000004",
"feature_type": "config",
"code": "included_ai_credits",
"name": "Included AI Credits",
"description": "AI credits included per person with the plan",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": [
{
"code": "included",
"name": "Included Credits",
"value_type": "integer",
"value": 500,
"config": {}
}
]
},
{
"feature_id": "00000000-0000-4000-8000-000000000005",
"feature_type": "boolean",
"code": "unlimited_team_members",
"name": "Unlimited Team Members",
"description": "No Acme team-member cap",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000006",
"feature_type": "boolean",
"code": "all_channels",
"name": "All Channels",
"description": "Access to all supported communication channels",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000007",
"feature_type": "boolean",
"code": "full_crm",
"name": "Full CRM",
"description": "Access to the complete CRM workspace",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000008",
"feature_type": "boolean",
"code": "meeting_notetaker",
"name": "Meeting Notetaker",
"description": "AI meeting notes and follow-ups",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000009",
"feature_type": "boolean",
"code": "workflow_automation",
"name": "Workflow Automation",
"description": "Automated Acme workflows",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000010",
"feature_type": "boolean",
"code": "lead_discovery",
"name": "Lead Discovery",
"description": "AI-assisted lead discovery",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000011",
"feature_type": "boolean",
"code": "voice_ai",
"name": "Voice AI",
"description": "AI voice calling and campaigns",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000012",
"feature_type": "boolean",
"code": "integrations_200",
"name": "200 Integrations",
"description": "Access to Acme's workflow integration catalog",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000013",
"feature_type": "config",
"code": "support",
"name": "Support Tier",
"description": "Customer support level",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": [
{
"code": "tier",
"name": "Tier",
"value_type": "select",
"value": "standard",
"config": {
"select_options": [
"community",
"standard",
"priority"
]
}
}
]
}
],
"usage_thresholds": [],
"applicable_usage_thresholds": [],
"taxes": [],
"credit_grant_rules": [
{
"nozle_id": "00000000-0000-4000-8000-000000000014",
"plan_id": "00000000-0000-4000-8000-000000000001",
"plan_code": "pro",
"credit_system_id": "00000000-0000-4000-8000-000000000015",
"credit_system_code": "ai_credits",
"amount": "500.0",
"interval": "month",
"interval_count": 1,
"scope": "entity",
"entity_join_policy": "full_grant",
"entity_leave_policy": "expire_plan_grant",
"upgrade_policy": "grant_difference",
"downgrade_policy": "next_period",
"status": "active",
"created_at": "2026-01-15T10:00:00Z",
"updated_at": "2026-01-15T10:00:00Z"
}
],
"credit_pool_policies": [
{
"nozle_id": "00000000-0000-4000-8000-000000000016",
"plan_id": "00000000-0000-4000-8000-000000000001",
"plan_code": "pro",
"credit_system_id": "00000000-0000-4000-8000-000000000015",
"credit_system_code": "ai_credits",
"policy": "entity_only",
"status": "active",
"created_at": "2026-01-15T10:00:00Z",
"updated_at": "2026-01-15T10:00:00Z"
}
],
"metadata": {
"product": "acme",
"billing_model": "one_seat_base",
"credit_cadence": "monthly",
"price_per_person_cents": "1499",
"included_credits_per_person": "500"
}
}
}{
"status": 401,
"error": "Unauthorized"
}{
"status": 404,
"error": "Not Found",
"code": "object_not_found"
}Plans
Retrieve a plan
This endpoint retrieves a specific plan by code.
Publishable keys. A publishable pk_ key may call this endpoint and GET /plans, and nothing else. It returns the same body as a secret key: the whole plan, including charges, fixed_charges, taxes, minimum_commitment, usage_thresholds, entitlements, credit_grant_rules, credit_pool_policies and metadata. Anyone who has the key can read all of it.
This endpoint also returns a plan with a trial or pay-in-arrears billing, and, to a secret key, a plan that is pending deletion (pending_deletion: true). An unknown code, the code of a per-customer override plan, or a plan pending deletion read with a publishable key returns 404 with the code plan_not_found.
A publishable key receives a plan of a family hidden from the pricing table, or whose family was deleted, so the SDK can describe a subscriber’s own plan. The plan carries all its entitlements and charges, including those of features hidden from the pricing table.
The Engine host also serves this path at https://api.nozle.app/engine/api/v1/plans/{code} and returns Core’s body unchanged.
See Public plan catalog.
GET
/
plans
/
{code}
Retrieve a plan
curl --request GET \
--url https://api.nozle.app/core/api/v1/plans/{code} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nozle.app/core/api/v1/plans/{code}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.nozle.app/core/api/v1/plans/{code}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.nozle.app/core/api/v1/plans/{code}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.nozle.app/core/api/v1/plans/{code}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nozle.app/core/api/v1/plans/{code}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.nozle.app/core/api/v1/plans/{code}")
.header("Authorization", "Bearer <token>")
.asString();{
"plan": {
"nozle_id": "00000000-0000-4000-8000-000000000001",
"name": "Pro",
"invoice_display_name": "Acme Pro",
"created_at": "2026-01-15T10:00:00Z",
"code": "pro",
"interval": "monthly",
"description": "For teams replacing their sales, communication, and automation stack.",
"amount_cents": 1499,
"amount_currency": "USD",
"trial_period": null,
"pay_in_advance": true,
"bill_charges_monthly": null,
"bill_fixed_charges_monthly": null,
"parent_id": null,
"pending_deletion": false,
"charges": [
{
"nozle_id": "00000000-0000-4000-8000-000000000002",
"feature_id": "00000000-0000-4000-8000-000000000003",
"code": "active_seats",
"invoice_display_name": "Active Acme members",
"feature_code": "active_seats",
"created_at": "2026-01-15T10:00:00Z",
"charge_model": "graduated",
"invoiceable": true,
"regroup_paid_fees": null,
"pay_in_advance": false,
"prorated": false,
"min_amount_cents": 0,
"accepts_target_wallet": false,
"properties": {
"graduated_ranges": [
{
"to_value": 1,
"from_value": 0,
"flat_amount": "0",
"per_unit_amount": "0"
},
{
"to_value": null,
"from_value": 2,
"flat_amount": "0",
"per_unit_amount": "14.99"
}
]
},
"applied_pricing_unit": null,
"parent_id": null,
"filters": [],
"taxes": []
}
],
"fixed_charges": [],
"entitlements": [
{
"feature_id": "00000000-0000-4000-8000-000000000004",
"feature_type": "config",
"code": "included_ai_credits",
"name": "Included AI Credits",
"description": "AI credits included per person with the plan",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": [
{
"code": "included",
"name": "Included Credits",
"value_type": "integer",
"value": 500,
"config": {}
}
]
},
{
"feature_id": "00000000-0000-4000-8000-000000000005",
"feature_type": "boolean",
"code": "unlimited_team_members",
"name": "Unlimited Team Members",
"description": "No Acme team-member cap",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000006",
"feature_type": "boolean",
"code": "all_channels",
"name": "All Channels",
"description": "Access to all supported communication channels",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000007",
"feature_type": "boolean",
"code": "full_crm",
"name": "Full CRM",
"description": "Access to the complete CRM workspace",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000008",
"feature_type": "boolean",
"code": "meeting_notetaker",
"name": "Meeting Notetaker",
"description": "AI meeting notes and follow-ups",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000009",
"feature_type": "boolean",
"code": "workflow_automation",
"name": "Workflow Automation",
"description": "Automated Acme workflows",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000010",
"feature_type": "boolean",
"code": "lead_discovery",
"name": "Lead Discovery",
"description": "AI-assisted lead discovery",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000011",
"feature_type": "boolean",
"code": "voice_ai",
"name": "Voice AI",
"description": "AI voice calling and campaigns",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000012",
"feature_type": "boolean",
"code": "integrations_200",
"name": "200 Integrations",
"description": "Access to Acme's workflow integration catalog",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": []
},
{
"feature_id": "00000000-0000-4000-8000-000000000013",
"feature_type": "config",
"code": "support",
"name": "Support Tier",
"description": "Customer support level",
"usage_limit": null,
"hard_limit": null,
"min_margin_percent": null,
"margin_enforcement_mode": null,
"enforce_plan_margin": null,
"privileges": [
{
"code": "tier",
"name": "Tier",
"value_type": "select",
"value": "standard",
"config": {
"select_options": [
"community",
"standard",
"priority"
]
}
}
]
}
],
"usage_thresholds": [],
"applicable_usage_thresholds": [],
"taxes": [],
"credit_grant_rules": [
{
"nozle_id": "00000000-0000-4000-8000-000000000014",
"plan_id": "00000000-0000-4000-8000-000000000001",
"plan_code": "pro",
"credit_system_id": "00000000-0000-4000-8000-000000000015",
"credit_system_code": "ai_credits",
"amount": "500.0",
"interval": "month",
"interval_count": 1,
"scope": "entity",
"entity_join_policy": "full_grant",
"entity_leave_policy": "expire_plan_grant",
"upgrade_policy": "grant_difference",
"downgrade_policy": "next_period",
"status": "active",
"created_at": "2026-01-15T10:00:00Z",
"updated_at": "2026-01-15T10:00:00Z"
}
],
"credit_pool_policies": [
{
"nozle_id": "00000000-0000-4000-8000-000000000016",
"plan_id": "00000000-0000-4000-8000-000000000001",
"plan_code": "pro",
"credit_system_id": "00000000-0000-4000-8000-000000000015",
"credit_system_code": "ai_credits",
"policy": "entity_only",
"status": "active",
"created_at": "2026-01-15T10:00:00Z",
"updated_at": "2026-01-15T10:00:00Z"
}
],
"metadata": {
"product": "acme",
"billing_model": "one_seat_base",
"credit_cadence": "monthly",
"price_per_person_cents": "1499",
"included_credits_per_person": "500"
}
}
}{
"status": 401,
"error": "Unauthorized"
}{
"status": 404,
"error": "Not Found",
"code": "object_not_found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.
Example:
"startup"
Response
Plan
A plan. This is the object returned by GET /plans, GET /plans/{code} and the plan write endpoints.
With a publishable pk_ key, GET /plans and GET /plans/{code} return this whole object, including prices, charges, taxes, minimums, credit grants and metadata. Nothing is filtered or redacted. See "Publishable keys" on those operations.
charges, entitlements, usage_thresholds, applicable_usage_thresholds, taxes, credit_grant_rules and credit_pool_policies are always present in a plan returned by the plan endpoints. They are empty arrays when the plan has none.
Show child attributes
Show child attributes