GET

Consumo por Pedido

/activations/consumption/order/{orderId}

Consulta o consumo dos chips de um pedido. Todos os volumes vêm em MB. Em planos ilimitados, unlimited=true e franquia/saldo/percentual vêm null.

Importante

Recurso restrito: a agência precisa ter a consulta de consumo habilitada (allow_consumption_query). Sem a permissão, a resposta é 403.

O {orderId} aceita o id interno ou o external_id do pedido.

Headers

Accept

text

application/json

Authorization

text

Bearer {{TOKEN}}

Parâmetros

orderId

Stringpathobrigatório

Valor usado para substituir {orderId} na rota.

ex: 434

Respostas

Consumo por Pedido

{
  "status": "success",
  "message": "Consumo consultado com sucesso.",
  "data": {
    "order_id": 25360,
    "external_id": "434",
    "activation_type": "chip",
    "chips": [
      {
        "sequence": 25869,
        "identifier": "8955010012345678909",
        "available": true,
        "unlimited": false,
        "total_used_mb": 3584,
        "allowance_mb": 5120,
        "remaining_mb": 1536,
        "usage_percentage": 70,
        "last_usage_at": "2026-09-21",
        "fetched_at": "2026-09-22T13:40:05-03:00",
        "history": [
          {
            "date": "2026-09-21",
            "used_mb": 820
          },
          {
            "date": "2026-09-20",
            "used_mb": 640
          }
        ]
      },
      {
        "sequence": 25870,
        "identifier": "355000000000000",
        "available": true,
        "unlimited": true,
        "total_used_mb": 12480,
        "allowance_mb": null,
        "remaining_mb": null,
        "usage_percentage": null,
        "last_usage_at": "2026-09-22",
        "fetched_at": "2026-09-22T13:40:05-03:00",
        "history": [
          {
            "date": "2026-09-22",
            "used_mb": 1500
          }
        ]
      }
    ]
  }
}

{ "status": "success", "message": "Consumo consultado com sucesso.", "data": { "order_id": 25360, "external_id": "434", "activation_type": "chip", "chips": [ { "sequence": 25869, "identifier": "8955010012345678909", "available": true, "unlimited": false, "total_used_mb": 3584, "allowance_mb": 5120, "remaining_mb": 1536, "usage_percentage": 70, "last_usage_at": "2026-09-21", "fetched_at": "2026-09-22T13:40:05-03:00", "history": [ { "date": "2026-09-21", "used_mb": 820 }, { "date": "2026-09-20", "used_mb": 640 } ] }, { "sequence": 25870, "identifier": "355000000000000", "available": true, "unlimited": true, "total_used_mb": 12480, "allowance_mb": null, "remaining_mb": null, "usage_percentage": null, "last_usage_at": "2026-09-22", "fetched_at": "2026-09-22T13:40:05-03:00", "history": [ { "date": "2026-09-22", "used_mb": 1500 } ] } ] }}