Skip to main content
POST
Criar medidor

Autorizações

Authorization
string
header
obrigatório

Chave secreta da conta: Authorization: Bearer sk_test_… ou sk_live_…. Use só no servidor.

Cabeçalhos

Idempotency-Key
string

Chave única por operação (um UUID serve). Repetir com a mesma chave devolve a resposta original.

Parâmetros de caminho

productID
string<uuid>
obrigatório

ID do produto.

Corpo

application/json
name
string
obrigatório

Chave que você enviará em track() (por exemplo, tokens). Não pode ser alterada depois.

displayName
string
obrigatório

Nome exibido em faturas e no painel.

unit
enum<string>
obrigatório

token, request ou unit.

Opções disponíveis:
token,
request,
unit
aggregation
enum<string>

sum (padrão), count, unique_count, max ou last.

Opções disponíveis:
sum,
count,
unique_count,
max,
last
valueProperty
string | null

Campo do evento que carrega o valor numérico. Obrigatório, exceto com aggregation: "count".

Resposta

Medidor criado.

Um medidor: define como eventos de uso viram uma quantidade cobrável.

id
string<uuid>
productId
string<uuid>
name
string

Chave que você envia em track(). Não muda depois de criado.

displayName
string

Nome exibido em faturas e no painel.

unit
enum<string>

token, request ou unit.

Opções disponíveis:
token,
request,
unit
aggregation
enum<string>

Como os eventos se somam: sum, count, unique_count, max ou last.

Opções disponíveis:
sum,
count,
unique_count,
max,
last
valueProperty
string | null

Campo do evento que carrega o valor numérico. Não é usado com count.

status
string