Pular para o conteúdo principal

Clientes

Quem é cobrado, seus usuários de portal e o extrato consolidado. recalculate-mrr recalcula a receita recorrente do cliente.

ComandoHTTPDescrição
customers listGET /v1/customersListar clientes
customers createPOST /v1/customersCriar cliente
customers getGET /v1/customers/{id}Obter cliente
customers updatePATCH /v1/customers/{id}Atualizar cliente
customers deleteDELETE /v1/customers/{id}Remover cliente (soft delete)
customers recalculate-mrrPOST /v1/customers/{id}/recalculate-mrrRecalcular o MRR do cliente
customers statement getGET /v1/customers/{id}/statementListar extrato financeiro do cliente
customers statement sync createPOST /v1/customers/{id}/statement/syncReconstruir o extrato a partir do histórico
customers users getGET /v1/customers/{id}/usersListar usuários do portal do cliente
customers users createPOST /v1/customers/{id}/usersConvidar usuário do portal
customers users updatePATCH /v1/customers/{id}/users/{user_id}Atualizar usuário do portal
customers users deleteDELETE /v1/customers/{id}/users/{user_id}Remover usuário do portal
customers users email-previewGET /v1/customers/{id}/users/{user_id}/email-previewPré-visualizar e-mail do usuário do portal
customers users resendPOST /v1/customers/{id}/users/{user_id}/resendReenviar e-mail de convite ou verificação
customers users invite createPOST /v1/customers/{id}/users/inviteConvidar 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​