Ver .md

admin.accounts.set_plan

Define o plano de uma conta. Troca o plano da conta. Na primeira vez que o plano deixa de ser gratuito, a conta é ativada (activated_at) e deixa de ser apagada. Voltar ao plano gratuito bloqueia a conta, sem apagá-la.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/admin.accounts.set_plan (corpo JSON)
  • Quem pode chamar: super-admin da plataforma
  • Escopo da chave: admin:write
  • Grava dados: sim
  • Pela chave de API: sim
  • Ferramenta MCP: admin_accounts_set_plan
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId admin.accounts.set_plan)

Entrada

CampoTipoObrigatórioNota
accountIdstring (uuid)sim
planKeystringsim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "planKey": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "accountId",
    "planKey"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/admin.accounts.set_plan \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"accountId":"00000000-0000-0000-0000-000000000000","planKey":"teste"}'

CLI:

node cli/atomiks.mjs admin.accounts.set_plan --json '{"accountId":"00000000-0000-0000-0000-000000000000","planKey":"teste"}'

MCP: ferramenta admin_accounts_set_plan com a mesma entrada.

Saída

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

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