Uso agregado + valores calculados por item de um ciclo

GET/v1/subscriptions/{subscriptionId}/cycles/{cycleId}/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_…)
cycleIdstringobrigatório
Identificador público (scy_/cycle_…)

Respostas

200Sucesso

cycleIdstringobrigatório
O ciclo.
currencystringobrigatóriopode ser nulo
Moeda (ISO 4217).
windowEndstringobrigatóriopode ser nulo
Fim da janela de uso.
windowStartstringobrigatóriopode ser nulo
Início da janela de uso.
billedAmountnumberobrigatóriopode ser nulo
O que o ciclo cobrou, em centavos; null até ser cobrado.
aggregatedByItemobject[]obrigatório
Uso e valor por item.
+5 campos de aggregatedByItem
- namestringobrigatóriopode ser nulo
  Nome do item.
- usagenumberobrigatório
  Uso agregado do ciclo, na unidade do medidor.
- itemIdstringobrigatório
  O item.
- lineAmountnumberobrigatório
  Quanto esse uso custa, em centavos.
- meterEventNamestringobrigatóriopode ser nulo
  Nome do medidor do item.
totalUsageAmountnumberobrigatório
Soma dos valores de uso do ciclo, em centavos.

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

AnteriorRegistra o uso medido de um item da assinatura PróximaRemove um limiar de cobrança

Requisição

curl -X GET "https://api.selectwin.io/v1/subscriptions/{subscriptionId}/cycles/{cycleId}/usage" \
  -H "SelectKey: $SELECTWIN_API_KEY"

Resposta

{
  "cycleId": "scy_0a1b2c3d4e5f60718293",
  "currency": "BRL",
  "windowEnd": "string",
  "windowStart": "string",
  "billedAmount": 5000,
  "aggregatedByItem": [
    {
      "name": "Acme Ltda",
      "usage": 0,
      "itemId": "sit_0a1b2c3d4e5f60718293",
      "lineAmount": 5000,
      "meterEventName": "string"
    }
  ],
  "totalUsageAmount": 5000
}