Listar planos
RegistosGET /plans
Returns the published plans plus the tenant's own plan, wrapped in a data array, with the offers beside them (the custom offer past the largest plan). Name, tagline, capability labels and offer text are in the caller's language: lang, else Accept-Language, else the plan's default text. Clients show these and build no plan text of their own. Requires the business:subscription:read permission. The list is not paginated.
Parâmetros
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
langThe language to answer plan text in, as a language tag (pt, en, pt-MZ). It wins over Accept-Language. A language without a translation falls back to the plan's default text.
Accept-LanguageThe caller's languages by preference, used when lang is not sent.
Devolve
200 Plans
Mostrar atributos
dataMostrar atributos filhos
idcodenameDisplay name in the caller's language on reads
taglineTagline in the caller's language on reads
name_i18nOne text per language, keyed by language tag (pt, en, pt-MZ).
tagline_i18nOne text per language, keyed by language tag (pt, en, pt-MZ).
default_namePlatform plan list only; the default name behind a localised name
default_taglinePlatform plan list only; the default tagline
price_centscurrencymax_connectionsmax_usersmax_accountsMaximum accounts owned by the subscribed organization's legal entity; 0 means no plan cap
max_sandboxestrial_daysoverage_connection_centsoverage_user_centscapabilitiescapability_labelsThe capabilities labelled in the caller's language (reads)
Mostrar atributos filhos
codelabelThe capability's label in the caller's language
publisheddisplay_orderhighlightedcreated_at
offersOffers listed beside the plans; the custom offer (code custom) when a published plan has a connection limit.
Mostrar atributos filhos
codelabelTitle in the caller's language
textOne line in the caller's language
ctaThe link's wording in the caller's language
label_i18nOne text per language, keyed by language tag (pt, en, pt-MZ).
text_i18nOne text per language, keyed by language tag (pt, en, pt-MZ).
cta_i18nOne text per language, keyed by language tag (pt, en, pt-MZ).
contact_pathPath on the public site to contact sales
above_connectionsThe active connection count the offer starts above
Erros 403
Permissões business:subscription:read · Funções: admin, analyst, finance, owner, viewer
curl -X GET "$BUSINESS_API/plans" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/plans", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/plans",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/plans", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "pla_2lVU4nTwUfHw6nxUwjbOeRn8u5D",
"code": "COD-2026-000142",
"name": "Ana Matsinhe",
"tagline": "tagline",
"name_i18n": {
"en": "Up to 100 customers",
"pt": "Até 100 clientes"
},
"tagline_i18n": {
"en": "Up to 100 customers",
"pt": "Até 100 clientes"
},
"default_name": "Ana Matsinhe",
"default_tagline": "default tagline",
"price_cents": 125000,
"currency": "MZN",
"max_connections": 1,
"max_users": 1,
"max_accounts": 1,
"max_sandboxes": 1,
"trial_days": 1,
"overage_connection_cents": 1,
"overage_user_cents": 1,
"capabilities": [
"configure"
],
"capability_labels": [
{
"code": "COD-2026-000142",
"label": "label"
}
],
"published": true,
"display_order": 1,
"highlighted": true,
"created_at": "2026-11-19T09:30:00Z"
}
],
"offers": [
{
"code": "custom",
"label": "label",
"text": "text",
"cta": "cta",
"label_i18n": {
"en": "Up to 100 customers",
"pt": "Até 100 clientes"
},
"text_i18n": {
"en": "Up to 100 customers",
"pt": "Até 100 clientes"
},
"cta_i18n": {
"en": "Up to 100 customers",
"pt": "Até 100 clientes"
},
"contact_path": "/contact?topic=sales",
"above_connections": 1
}
]
}