Clientes
Quem é cobrado, seus usuários de portal e o extrato consolidado. recalculate-mrr recalcula a receita recorrente do cliente.
| Comando | HTTP | Descrição |
|---|---|---|
customers list | GET /v1/customers | Listar clientes |
customers create | POST /v1/customers | Criar cliente |
customers get | GET /v1/customers/{id} | Obter cliente |
customers update | PATCH /v1/customers/{id} | Atualizar cliente |
customers delete | DELETE /v1/customers/{id} | Remover cliente (soft delete) |
customers recalculate-mrr | POST /v1/customers/{id}/recalculate-mrr | Recalcular o MRR do cliente |
customers statement get | GET /v1/customers/{id}/statement | Listar extrato financeiro do cliente |
customers statement sync create | POST /v1/customers/{id}/statement/sync | Reconstruir o extrato a partir do histórico |
customers users get | GET /v1/customers/{id}/users | Listar usuários do portal do cliente |
customers users create | POST /v1/customers/{id}/users | Convidar usuário do portal |
customers users update | PATCH /v1/customers/{id}/users/{user_id} | Atualizar usuário do portal |
customers users delete | DELETE /v1/customers/{id}/users/{user_id} | Remover usuário do portal |
customers users email-preview | GET /v1/customers/{id}/users/{user_id}/email-preview | Pré-visualizar e-mail do usuário do portal |
customers users resend | POST /v1/customers/{id}/users/{user_id}/resend | Reenviar e-mail de convite ou verificação |
customers users invite create | POST /v1/customers/{id}/users/invite | Convidar usuário do portal (verbo) |
Exemplos
--params carrega parâmetros de query e de caminho (id, página, filtros); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.
# Listar clientes
kobana billing customers list \
--fields "id,public_id,external_id,name,nickname"
# Obter cliente
kobana billing customers get --params '{"id": "CUSTOMER_ID"}'
# Criar cliente
kobana billing customers create --json '{"name": "NAME"}'
# Atualizar cliente
kobana billing customers update \
--params '{"id": "CUSTOMER_ID"}' \
--json '{"name": "NAME", "external_id": "EXTERNAL_ID", "nickname": "NICKNAME"}'
# Recalcular o MRR do cliente
kobana billing customers recalculate-mrr --params '{"id": "CUSTOMER_ID"}'
# Remover cliente (soft delete)
kobana billing customers delete --params '{"id": "CUSTOMER_ID"}' --dry-run
Próximos passos
- Empresas
- Introspecção de schema — todos os parâmetros que este recurso aceita.