Pular para o conteúdo principal
GET
Consultar créditos
Este endpoint exige uma chave de API de gerenciamento. Chaves padrão da API do Gateway não são aceitas.

Adicionar créditos pela CLI ou pela API

Agentes e scripts podem iniciar uma recarga com POST /v1/credits/topups ou pela CLI. Uma pessoa sempre aprova a cobrança.
  • O token precisa do escopo billing:write. Ele nunca é concedido por padrão: adicione-o com phaseo login --scopes billing:write ou inclua-o em uma chave de gerenciamento.
  • Recargas pela API ou pela CLI vão de $5 a $500; recargas maiores são feitas no painel. Um espaço de trabalho pode ter 5 aguardando ao mesmo tempo (uma sexta retorna 429 too_many_pending_topups), e cada uma expira após 30 minutos.
  • Ainda sem cartão salvo: a resposta traz um checkout_url. Um proprietário ou administrador do espaço de trabalho o abre e paga com um cartão novo, que fica salvo para recargas futuras.
  • Com cartão salvo: cada proprietário e administrador recebe um e-mail com um link de uso único. Um deles o abre, entra na conta e escolhe Confirmar ou Recusar. Ao confirmar, o cartão é cobrado, com verificação do banco se ele pedir.
  • Consulte GET /v1/credits/topups/{id} (ou phaseo credits topups get <id>) até que final seja true. Os créditos são adicionados quando o status é paid. declined, expired e failed vêm com um código reason: não os repita automaticamente; pergunte a uma pessoa.

Autorizações

Authorization
string
header
obrigatório

Autenticação com token Bearer

Parâmetros de consulta

workspace_id
string<uuid>

Substituição opcional do espaço de trabalho. Deve corresponder ao espaço autenticado, exceto quando usada por um chamador de controle interno.

Resposta

Informações de créditos

ok
enum<boolean>
obrigatório
Opções disponíveis:
true
credits
object
obrigatório
Última modificação em 16 de novembro de 2026