Skip to main content
POST
Registrar evento de uso

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.

Corpo

application/json
meter
string
obrigatório

Chave do meter (por exemplo tokens).

productId
string<uuid>

O produto do meter.

customerId
string

Id da inscrição ou externalId do cliente. A inscrição precisa ser do produto informado.

value
string | null

Quantidade, em texto decimal. Sem valor, conta como 1.

eventId
string

Seu id para este evento. Com o mesmo timestamp, um reenvio com o mesmo eventId não é contado de novo.

timestamp
string<date-time> | null

Quando o uso aconteceu. Sem ele, vale o horário de chegada, e um reenvio vira um evento novo.

metadata
object

Dados livres seus, em JSON.

Resposta

Evento aceito. duplicate: true indica que ele já tinha sido registrado e não foi contado de novo.

Resultado do registro de uso. accepted indica que o evento foi registrado agora; duplicate, que já tinha sido registrado antes.