Consumo de Prosas

Consulte o consumo de Prosas da empresa em grão de linha — uma linha por movimento do ledger, com categoria, custo em reais, origem e contato atribuído — para reconciliar a fatura no seu BI. Exige plano Enterprise.

escopo: billing:readEnterprise

Lista os movimentos de consumo de Prosas. Filtros: ?start_date=&end_date=&category=&source=&contact_id=&page=1&limit=50. Sem datas, a janela é dos últimos 30 dias.

  • `prosas` e `cost_brl` são ASSINADOS: uma linha negativa é o estorno de uma cobrança anterior. Some os valores como vêm — filtrar o negativo superestima o custo.
  • `coverage` diz quais cobranças estão desligadas na empresa. Com `campaign_billing_enabled: false` não existe linha de campanha; com `messages_billing_enabled: false` não existe linha nenhuma. Leia esse bloco antes de concluir que um período não teve consumo.
  • Sem `start_date`, a janela recua 30 dias a partir de `end_date` (ou de agora). A tabela inteira nunca é varrida numa só chamada.
  • `limit` vai até 100 e a ordenação é por data decrescente. O rate limit é de 60 requisições por minuto por chave: use `pagination.next_page` para retomar a paginação de onde parou depois de um 429.
  • `contact` vem `null` quando o débito não tem lead — prospecção, enriquecimento, contato excluído, ou linha anterior à atribuição por lead.

Resposta (200)

Corpo da resposta
{
  "success": true,
  "data": [
    {
      "id": "<uuid>",
      "date": "2026-09-02T14:33:10.221Z",
      "category": "marketing",
      "prosas": 40,
      "cost_brl": 0.4,
      "source": "campaign",
      "contact_id": "<uuid>",
      "contact": {
        "id": "<uuid>",
        "name": "João Silva",
        "identifier": "5548999990000"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 240,
    "total_pages": 5,
    "next_page": 2
  },
  "coverage": {
    "messages_billing_enabled": true,
    "campaign_billing_enabled": false,
    "note": "Envios de campanha não consomem Prosas nesta empresa: nenhuma linha com origem de campanha aparece neste relatório. As demais origens estão cobertas."
  }
}

Erros

StatusCódigoQuando ocorre
400INVALID_PARAMETERData fora do ISO 8601, end_date anterior a start_date, category fora do catálogo ou contact_id que não é UUID
403INSUFFICIENT_SCOPEA chave não tem o escopo billing:read
403PLAN_REQUIREDA conta não está no plano Enterprise

Exemplo

curl
curl -s -H "Authorization: Bearer <sua-key>" https://www.prosalab.com/api/v1/prosas/consumption
Consumo de Prosas — Prosalab Developers