Skip to main content
O objeto taxa define uma cobranca baseada em uso que e medida e cobrada de organizacoes. Cada taxa e vinculada a um nome de evento que aciona a medicao e e sincronizada com o provedor de pagamento externo para billing.
​
feeId
string
O identificador unico da taxa (UUIDv7).
​
externalProductRef
string
A referencia externa do produto no provedor de pagamento.
​
externalPriceRef
string
A referencia externa do preco no provedor de pagamento.
​
externalBillingMeterRef
string
A referencia externa do medidor de billing no provedor de pagamento.
​
name
string
O nome da taxa.
​
description
string
A descricao da taxa.
​
eventName
string
O nome do evento que aciona esta taxa.
​
currency
string
O codigo da moeda (ex: BRL, USD).
​
status
string
O status da taxa. Um de: ACTIVE, INACTIVE.
​
createdBy
string
O ID do usuario que criou a taxa.
​
createdAt
string
Timestamp de criacao (ISO 8601).
​
updatedBy
string
O ID do usuario que atualizou a taxa por ultimo.
​
updatedAt
string
Timestamp da ultima atualizacao (ISO 8601).
{
  "feeId": "019525fd-8f54-7d6b-c3e9-5f7a9b1d3e5b",
  "externalProductRef": "prod_R3xK9mN7pQ",
  "externalPriceRef": "price_1PqR2sT4uV",
  "externalBillingMeterRef": "meter_1AbC2dE3fG",
  "name": "API Call Fee",
  "description": "Per-call fee for API usage.",
  "eventName": "api_call",
  "currency": "BRL",
  "status": "ACTIVE",
  "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "createdAt": "2026-01-15T10:00:00.000Z",
  "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "updatedAt": "2026-01-15T10:00:00.000Z"
}