Pular para o conteúdo principal
PATCH
Atualizar medidor

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

productID
string
obrigatório

ID do produto.

Pattern: ^prod_[0-9A-Za-z]{22}$
Exemplo:

"prod_1d4YogBuw00jAySh5mbUpk"

meterID
string<uuid>
obrigatório

ID do medidor.

Corpo

application/json

Campos omitidos ficam como estão. O name não pode ser alterado.

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

Resposta

O medidor atualizado.

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

id
string<uuid>
obrigatório
productId
string
obrigatório
Pattern: ^prod_[0-9A-Za-z]{22}$
Exemplo:

"prod_1d4YogBuw00jAySh5mbUpk"

name
string
obrigatório

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

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>
obrigatório

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

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

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