PT EN

Planos

URL base: $BUSINESS_API

O objecto

idstring · opcional
codestring · opcional
namestring · opcional

Display name in the caller's language on reads

taglinestring · opcional

Tagline in the caller's language on reads

name_i18nobject · opcional

One text per language, keyed by language tag (pt, en, pt-MZ).

tagline_i18nobject · opcional

One text per language, keyed by language tag (pt, en, pt-MZ).

default_namestring · opcional

Platform plan list only; the default name behind a localised name

default_taglinestring · opcional

Platform plan list only; the default tagline

price_centsinteger · opcional
currencystring · opcional
max_connectionsinteger · opcional
max_usersinteger · opcional
max_accountsinteger · opcional

Maximum accounts owned by the subscribed organization's legal entity; 0 means no plan cap

max_sandboxesinteger · opcional
trial_daysinteger · opcional
overage_connection_centsinteger · opcional
overage_user_centsinteger · opcional
capabilitiesarray of string · opcional
capability_labelsarray of CapabilityLabel · opcional

The capabilities labelled in the caller's language (reads)

Mostrar atributos filhos
codestring · obrigatório
labelstring · obrigatório

The capability's label in the caller's language

publishedboolean · opcional
display_orderinteger · opcional
highlightedboolean · opcional
created_atstring (date-time) · opcional
Operações
O objecto
{
  "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"
}

Listar planos

Registos

GET /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

limitinteger · consulta · opcional

Maximum resources to return (default 20, maximum 100).

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

langstring · consulta · opcional

The 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-Languagestring · cabeçalho · opcional

The caller's languages by preference, used when lang is not sent.

Devolve

200 Plans

Mostrar atributos
dataarray of Plan · opcional
Mostrar atributos filhos
idstring · opcional
codestring · opcional
namestring · opcional

Display name in the caller's language on reads

taglinestring · opcional

Tagline in the caller's language on reads

name_i18nobject · opcional

One text per language, keyed by language tag (pt, en, pt-MZ).

tagline_i18nobject · opcional

One text per language, keyed by language tag (pt, en, pt-MZ).

default_namestring · opcional

Platform plan list only; the default name behind a localised name

default_taglinestring · opcional

Platform plan list only; the default tagline

price_centsinteger · opcional
currencystring · opcional
max_connectionsinteger · opcional
max_usersinteger · opcional
max_accountsinteger · opcional

Maximum accounts owned by the subscribed organization's legal entity; 0 means no plan cap

max_sandboxesinteger · opcional
trial_daysinteger · opcional
overage_connection_centsinteger · opcional
overage_user_centsinteger · opcional
capabilitiesarray of string · opcional
capability_labelsarray of CapabilityLabel · opcional

The capabilities labelled in the caller's language (reads)

Mostrar atributos filhos
codestring · obrigatório
labelstring · obrigatório

The capability's label in the caller's language

publishedboolean · opcional
display_orderinteger · opcional
highlightedboolean · opcional
created_atstring (date-time) · opcional
offersarray of PlanOffer · opcional

Offers listed beside the plans; the custom offer (code custom) when a published plan has a connection limit.

Mostrar atributos filhos
codestring · obrigatório
labelstring · obrigatório

Title in the caller's language

textstring · obrigatório

One line in the caller's language

ctastring · obrigatório

The link's wording in the caller's language

label_i18nobject · opcional

One text per language, keyed by language tag (pt, en, pt-MZ).

text_i18nobject · opcional

One text per language, keyed by language tag (pt, en, pt-MZ).

cta_i18nobject · opcional

One text per language, keyed by language tag (pt, en, pt-MZ).

contact_pathstring · obrigatório

Path on the public site to contact sales

above_connectionsinteger · obrigatório

The 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_..."
Resposta 200
{
  "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
    }
  ]
}