AtomiksAPI
Ver .md

account.plans_list

Listar os planos do Atomiks. Planos disponíveis (nome, módulos e limites) e currentKey, o plano da conta atual. Sem preço: a contratação não passa pelo app.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/account.plans_list (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_plans_list
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId account.plans_list)

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.plans_list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

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

MCP: ferramenta account_plans_list com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "currentKey": {
      "type": [
        "string",
        "null"
      ]
    },
    "plans": {
      "type": "array",
      "items": {
        "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
      }
    }
  },
  "required": [
    "currentKey",
    "plans"
  ],
  "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).