> ## Documentation Index
> Fetch the complete documentation index at: https://docs.so-me.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Planos, uso e créditos pela CLI

> Veja planos e complementos e consulte o status da assinatura, o uso e o código de indicação pela CLI do Social media studio.

Os comandos de cobrança permitem navegar pelo catálogo público de planos e consultar, pelo terminal, a sua própria assinatura, o uso e os créditos de indicação.

Esta página tem dois grupos de comandos:

* **`billing:*`**: o catálogo público de planos: planos de assinatura, matrizes de recursos por plano e SKUs de complementos. Esses endpoints são públicos e funcionam sem autenticação.
* **`settings:*`** (relacionados à cobrança): o status da sua própria assinatura, o detalhamento de uso e o código de indicação. Exigem uma chave de API válida (veja [Chaves de API](/pt-BR/cli/api-keys.md)).

> [!NOTE]
>
> Todos os comandos aceitam as flags globais `--json` (padrão), `--table`, `--verbose`, `--api-key <key>` e `--api-url <url>`. Você também pode definir `SOME_API_KEY` / `SOME_API_URL` no ambiente. Nenhum dos comandos de cobrança define flags próprias.

## settings:billing

Obtém o status da assinatura e as informações do plano: seu plano atual, o status da assinatura e os detalhes de renovação.

```bash theme={null}
so-me settings:billing
```

```bash Exemplos theme={null}
# Informações completas da assinatura
so-me settings:billing

# Somente o nome do plano + status
so-me settings:billing | jq '{plan: .plan.name, status: .plan.subscriptionStatus}'

# Tabela compacta
so-me settings:billing --table
```

## settings:usage

Obtém o detalhamento de uso do período de cobrança atual (posts, links na bio, contas sociais, armazenamento de mídia, membros da equipe e créditos de IA para texto/imagem/vídeo).

```bash theme={null}
so-me settings:usage
```

```bash Exemplos theme={null}
# JSON
so-me settings:usage

# Posts usados em relação ao limite
so-me settings:usage | jq '.tenant.posts'

# Uso de créditos de IA para texto/imagem/vídeo
so-me settings:usage | jq '{text: .tenant.aiText, image: .tenant.aiImage, video: .tenant.aiVideo}'

# Tabela
so-me settings:usage --table
```

## settings:referral-code

Obtém o seu código de indicação e os totais (total de indicações, créditos ganhos).

```bash theme={null}
so-me settings:referral-code
```

```bash Exemplos theme={null}
# Objeto completo
so-me settings:referral-code

# Somente o código
so-me settings:referral-code | jq -r '.code'

# Link de compartilhamento (combine com o seu site público)
echo "https://so-me.studio/signup?ref=$(so-me settings:referral-code | jq -r '.code')"
```

## billing:plans

Lista todos os planos de assinatura disponíveis. Somente os planos visíveis e que não sejam complementos são retornados, ordenados pela ordem de exibição. Cada plano traz os preços mensal e anual (`monthlyPrice`, `yearlyPrice`), os IDs de variante correspondentes no Lemon Squeezy (`monthlyVariantId`, `yearlyVariantId`), o nome de exibição e a descrição.

```bash theme={null}
so-me billing:plans
```

```bash Exemplos theme={null}
# Todos os planos em JSON
so-me billing:plans

# Tabela compacta
so-me billing:plans --table

# Lista de nome + preço mensal/anual
so-me billing:plans | jq -r '.[] | "\(.name)\t$\(.monthlyPrice)/mo\t$\(.yearlyPrice)/yr"'

# Somente os IDs de variante mensal do Lemon Squeezy
so-me billing:plans | jq -r '.[] | "\(.name): \(.monthlyVariantId)"'
```

## billing:plan-features

Obtém a lista de recursos (limites de posts, número de vagas, armazenamento, créditos de IA etc.) de um plano específico. Os recursos ativos vêm primeiro, seguidos dos recursos `coming_soon`; os recursos inativos são omitidos.

```bash theme={null}
so-me billing:plan-features <name>
```

**name** `string` *required*

Identificador interno do plano: `solo` (Lite), `team` (Standard), `scale` (Advanced) ou `lifetime` (Lifetime). O identificador `hobby` pertence a um plano legado descontinuado, que não está mais disponível.

```bash Exemplos theme={null}
# Recursos do Lite
so-me billing:plan-features solo

# Recursos do Advanced
so-me billing:plan-features scale

# Comparar posts por mês entre os planos
for p in solo team scale lifetime; do
  echo -n "$p: "
  so-me billing:plan-features $p | jq -r '.[] | select(.name == "Posts/month") | .numericValue'
done

# Como tabela
so-me billing:plan-features team --table
```

> [!NOTE]
>
> Os identificadores de plano são comparados exatamente (diferenciam maiúsculas de minúsculas). Um identificador desconhecido retorna uma lista vazia em vez de um erro. Use `solo` para o Lite, `team` para o Standard, `scale` para o Advanced ou `lifetime` para o Lifetime. `hobby` é um plano legado descontinuado e não está disponível para compra.

## billing:addons

Lista os planos de complemento disponíveis. Complementos são os planos que têm um `addonType`: `MEMBER` (vagas extras de equipe), `TENANT` (espaços de trabalho extras) ou `AI_CREDIT` (pacotes de créditos de IA).

```bash theme={null}
so-me billing:addons
```

```bash Exemplos theme={null}
# Todos os complementos
so-me billing:addons

# Tabela de complementos
so-me billing:addons --table

# Somente os complementos de espaço de trabalho extra
so-me billing:addons | jq '.[] | select(.addonType == "TENANT")'

# Somente os pacotes de créditos de IA
so-me billing:addons | jq '.[] | select(.addonType == "AI_CREDIT")'
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.