AtomiksAPI
Ver .md

account.plan_get

Ver o plano e o uso da conta. Plano da conta atual (nome, módulos, limites de usuários, canais, contatos e dias de retenção de mídia) e o uso de cada limite: usage.users (membros), usage.channels (números conectados) e usage.contacts.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/account.plan_get (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: account:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: account_plan_get
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId account.plan_get)

Entrada

Sem campos: envie {}.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/account.plan_get \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

node cli/atomiks.mjs account.plan_get --json '{}'

MCP: ferramenta account_plan_get com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "plan": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "isFree": {
          "type": "boolean"
        },
        "modules": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "limits": {
          "type": "object",
          "properties": {
            "users": {
              "type": "number"
            },
            "channels": {
              "type": "number"
            },
            "contacts": {
              "type": "number"
            },
            "mediaRetentionDays": {
              "type": "number"
            }
          },
          "required": [
            "users",
            "channels",
            "contacts",
            "mediaRetentionDays"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "key",
        "name",
        "isFree",
        "modules",
        "limits"
      ],
      "additionalProperties": false
    },
    "usage": {
      "type": "object",
      "properties": {
        "users": {
          "type": "number"
        },
        "channels": {
          "type": "number"
        },
        "contacts": {
          "type": "number"
        }
      },
      "required": [
        "users",
        "channels",
        "contacts"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "plan",
    "usage"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).