Skip to main content
Este evento é publicado quando uma nova taxa baseada em uso é definida no sistema de faturamento. Taxas representam as regras de precificação para consumo variável — elas vinculam um produto/preço externo de billing a um nome de evento interno, definindo quanto cobrar por unidade de uso. A criação de taxas normalmente acontece durante a configuração de um plano ou quando uma nova métrica cobrável é introduzida. Uma vez que a taxa esteja ACTIVE, o sistema começa a rastrear custos associados sempre que o eventName correspondente é registrado.
Uma taxa começa no status PENDING e precisa ser ativada antes que custos possam ser registrados contra ela. Os campos externalProductRef, externalPriceRef e externalBillingMeterRef vinculam a taxa ao catálogo de produtos e billing meter do provedor de pagamento.
Ao tratar este evento, você pode usá-lo para sincronizar seu catálogo local de taxas ou pré-aquecer caches. O campo eventName é a chave que conecta o rastreamento de uso a esta taxa — armazene-o para lookups rápidos durante o registro de custos.

Detalhes do Evento

PropriedadeValor
Typefee.created

Schema do Payload

feeId
string (UUID v7)
required
Identificador UUID v7.
externalProductRef
string
required
Referência externa do produto.
externalPriceRef
string
required
Referência externa do preço.
externalBillingMeterRef
string
required
Referência externa do billing meter.
name
string
required
Nome da taxa.
description
string
Descrição da taxa.
eventName
string
required
Nome do evento único associado à taxa.
currency
string
required
Moeda da taxa (USD, BRL, EUR).
status
string
required
Status da taxa: PENDING, ACTIVE ou INACTIVE.
createdBy
string (UUID)
required
Usuário que criou a taxa.
createdAt
string (ISO 8601)
required
Timestamp de criação.
updatedBy
string (UUID)
required
Usuário que atualizou a taxa por último.
updatedAt
string (ISO 8601)
required
Timestamp da última atualização.
{
  "specversion": "1.0",
  "type": "fee.created",
  "id": "evt_0195f3a2-7b8c-7d9e-a0b1-c2d3e4f56789",
  "time": "2026-03-25T14:00:00Z",
  "datacontenttype": "application/json",
  "data": {
    "feeId": "0195f3a2-7b8c-7d9e-a0b1-c2d3e4f56789",
    "externalProductRef": "prod_abc123",
    "externalPriceRef": "price_def456",
    "externalBillingMeterRef": "mbm_ghi789",
    "name": "API Request Fee",
    "description": "Fee charged per API request",
    "eventName": "api_request",
    "currency": "BRL",
    "status": "ACTIVE",
    "createdBy": "0195f3a2-8c00-7d4e-b806-6f7a8b9c0d1e",
    "createdAt": "2026-03-25T14:00:00Z",
    "updatedBy": "0195f3a2-8c00-7d4e-b806-6f7a8b9c0d1e",
    "updatedAt": "2026-03-25T14:00:00Z"
  }
}