Registra o uso medido de um item da assinatura

POST/v1/subscriptions/{subscriptionId}/items/{itemId}/usage

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros do caminho

actionstring
increment (padrão) soma ao uso do ciclo; set substitui.
Valores:incrementset
metadataobject
Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.
quantityintegerobrigatório
O uso, na unidade do medidor.
occurredAtstring (date-time)
Quando o uso aconteceu (padrão agora) — decide em que ciclo ele cai.
idempotencyKeystring
A sua chave para este registro: reenviá-la não conta o uso duas vezes.

200Sucesso

idstringobrigatório
Identificador público (usg_…)
actionstringobrigatório
increment ou set.
itemIdstringobrigatório
O item em que o uso foi registrado.
quantityintegerobrigatório
O uso registrado.
idempotentbooleanobrigatório
true quando este pedido repetiu um anterior (mesma idempotencyKey) e nada foi registrado de novo.
meterEventNamestringobrigatóriopode ser nulo
Nome do medidor do item.
subscriptionIdstringobrigatório
A assinatura.

201Criado

idstringobrigatório
Identificador público (usg_…)
actionstringobrigatório
increment ou set.
itemIdstringobrigatório
O item em que o uso foi registrado.
quantityintegerobrigatório
O uso registrado.
idempotentbooleanobrigatório
true quando este pedido repetiu um anterior (mesma idempotencyKey) e nada foi registrado de novo.
meterEventNamestringobrigatóriopode ser nulo
Nome do medidor do item.
subscriptionIdstringobrigatório
A assinatura.

400Requisição inválida (validação)

401Não autenticado (credencial ausente ou inválida)

403Sem permissão

404Não encontrado

422Regra de negócio impede o processamento

500Erro interno do servidor