Pular para o conteúdo principal

Créditos

Saldo a favor do cliente, aplicável a faturas futuras. Aplicar e remover créditos são comandos da própria fatura.

ComandoHTTPDescrição
credits listGET /v1/creditsListar créditos
credits createPOST /v1/creditsAdicionar crédito
credits getGET /v1/credits/{id}Obter crédito
credits updatePATCH /v1/credits/{id}Atualizar crédito
credits deleteDELETE /v1/credits/{id}Excluir crédito

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 créditos
kobana billing credits list \
--fields "id,public_id,external_id,billing_account_id,organization_id"

# Obter crédito
kobana billing credits get --params '{"id": "CREDIT_ID"}'

# Adicionar crédito
kobana billing credits create \
--json '{"billing_account_id": "BILLING_ACCOUNT_ID", "type": "promotional", "amount_cents": 10000}'

# Atualizar crédito
kobana billing credits update \
--params '{"id": "CREDIT_ID"}' \
--json '{"external_id": "EXTERNAL_ID", "type": "promotional", "amount_cents": 100}'

# Excluir crédito
kobana billing credits delete --params '{"id": "CREDIT_ID"}' --dry-run

Próximos passos​