Lista os registros de uso medido

GET/v1/subscriptions/{subscriptionId}/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

subscriptionIdstringobrigatório
Identificador público (subs_/sub_…)

Parâmetros de consulta

limitinteger
Tamanho da página (itens por página).
offsetinteger
Posição do primeiro item (a partir de 0).
sortstring
Expressão de ordenação, ex.: "-createdAt"
daterangestring
Uso registrado neste dia.
daterangegtstring (date-time)
Uso registrado depois deste instante (exclusivo).
daterangegtestring (date-time)
Uso registrado a partir deste instante (inclusivo).
daterangeltstring (date-time)
Uso registrado antes deste instante (exclusivo).
daterangeltestring (date-time)
Uso registrado até este instante (inclusivo).

Respostas

200Sucesso

dataobject[]obrigatório
Os itens desta página.
+7 campos de data
- idstringobrigatório
  Identificador público (usg_…)
- actionstringobrigatório
  increment ou set.
- itemIdstringobrigatóriopode ser nulo
  O item em que o uso foi registrado.
- quantityintegerobrigatório
  O uso registrado.
- createdAtstringobrigatório
  Quando o recurso foi criado (ISO 8601, UTC).
- occurredAtstringobrigatório
  Quando o uso aconteceu.
- meterEventNamestringobrigatóriopode ser nulo
  Nome do medidor do item.
pageobjectobrigatório
Cursores de paginação da lista.
+3 campos de page
- totalintegerobrigatório
  Número total de páginas.
- offsetobjectobrigatório
  O offset para pedir a primeira, a anterior, a próxima e a última página.
  +4 campos de offset
  - lastintegerobrigatório
    Posição da última página.
  - nextintegerobrigatório
    Posição da próxima página (fica nesta quando ela é a última).
  - previntegerobrigatório
    Posição da página anterior (0 na primeira).
  - firstintegerobrigatório
    Posição da primeira página.
- currentintegerobrigatório
  Número da página atual (a primeira é 1).
limitintegerobrigatório
Tamanho da página, como pedido.
totalintegerobrigatório
Número total de itens que atendem aos filtros.
_linksobject
Links para operações relacionadas, por ação (self, create, update, delete, list…).
offsetintegerobrigatório
Posição do primeiro item desta página, como pedido.
hasMorebooleanobrigatório
true quando há mais itens depois desta página.
merchantobject
A conta dona do recurso (o vendedor de registro).
+3 campos de merchant
- namestringobrigatóriopode ser nulo
  Nome fantasia da conta dona do recurso.
- merchantIdstringobrigatóriopode ser nulo
  Id público da conta dona do recurso (bus_…).
- isSubAccountbooleanobrigatório
  true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.

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

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

404Não encontrado

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorPausa uma assinatura PróximaCancela uma assinatura

{ "data": [ { "id": "usg_0a1b2c3d4e5f60718293", "action": "string", "itemId": "sit_0a1b2c3d4e5f60718293", "quantity": 0, "createdAt": "string", "occurredAt": "string", "meterEventName": "string" } ], "page": { "total": 5000, "offset": { "last": 0, "next": 0, "prev": 0, "first": 0 }, "current": 0 }, "limit": 0, "total": 5000, "_links": {}, "offset": 0, "hasMore": true, "merchant": { "name": "Acme Ltda", "merchantId": "string", "isSubAccount": true } }