O que é medido
A unidade de medida é o dia de instância ativa. Para cada instância em cobrança, a API conta os dias comprometidos no ciclo, e o total do ciclo é a soma desses dias de todas as suas instâncias.- Uma instância ativa o ciclo inteiro conta o ciclo cheio.
- Uma instância que entra em cobrança no meio do ciclo compromete os dias dali até a renovação.
- Deletar uma instância não reduz os dias já comprometidos. Veja Como a cobrança funciona.
- Uma instância ainda em teste não entra na conta enquanto estiver nesse estado.
Resumo de cobrança da conta
GET /api/account/billing/summary
Devolve o resumo do ciclo vigente da conta. Autentique com o TokenAccount da conta, ou com o token global passando ?account=<nome-da-conta>.
200 OK
boolean
true quando a conta é Enterprise. Se vier false, os demais campos não aparecem.integer
O crédito mensal (base) do seu contrato, em centavos. É o piso da fatura.
integer
O valor de uso já comprometido no ciclo, em centavos, proporcional aos dias de instância.
integer
A projeção da cobrança do ciclo, em centavos: o maior entre
baseCents e committedCents.integer
A soma de dias de instância em cobrança no ciclo.
integer
O pico de instâncias simultâneas em cobrança no ciclo.
string
Início do ciclo vigente.
string
Fim do ciclo vigente.
string
Quando a próxima cobrança acontece (o fim do ciclo).
Antes da primeira renovação, a janela do ciclo pode ainda não estar preenchida, e o resumo mostra a
base como piso projetado.Cobrança por instância na listagem
GET /api/instance/list já traz, para cada instância, um bloco billing com o estado de cobrança. Ele aparece apenas em chamadas com token de conta ou global, nunca com token de instância.
string
trial ou billable.string | null
Quando o teste termina.
null quando a instância já está em cobrança.string | null
Desde quando a instância é cobrada.
null enquanto em teste.integer
Dias que faltam do teste, arredondado para cima.
0 fora do teste.boolean
true quando a instância já está em cobrança.Acompanhando em tempo real
Para reagir a cada virada de estado, use os webhooks Enterprise. Eles avisam quando um teste começa, quando está prestes a acabar e quando uma instância vira cobrança, o que permite você espelhar esse estado no seu próprio painel.Próximo
Extrato de uso
A fatura com descritivos do período, instância a instância.
Histórico de conexões
A linha do tempo de quando cada número esteve conectado.
Como a cobrança funciona
Crédito, teste e o modelo comprometido em detalhe.
Webhooks Enterprise
Acompanhe as viradas de estado em tempo real.