Skip to main content

API de Custo e Uso

A Consumption API da Magalu Cloud disponibiliza dados de custo e uso em granularidade diária, permitindo acompanhar a evolução dos gastos ao longo do mês e, ao mesmo tempo, consultar períodos completos para obter uma visão consolidada do faturamento.

Durante o mês, você pode consultar os dados diariamente para acompanhar a evolução do consumo, identificar variações de custo e entender quais serviços, SKUs ou recursos estão gerando os gastos.

Ao final do período, é possível consultar o mês completo para obter uma visão consolidada dos custos e analisar a composição do faturamento, incluindo créditos e descontos aplicáveis.

Por exemplo, uma consulta referente ao período de abril pode ser utilizada para analisar todos os registros de consumo daquele mês, permitindo construir uma visão consolidada do faturamento: 01/04/2026 → 31/05/2026

Como funciona​

Os dados são disponibilizados conforme o consumo é registrado. Por isso, é importante considerar que:

  • A API retorna dados agregados por dia;
  • O dia anterior (D-1) representa o consumo completo daquele dia;
  • O dia atual também pode aparecer na consulta, porém os dados estarão parciais, pois o dia ainda não foi encerrado;
  • Não existe um horário específico de atualização para o D-1. Os dados são atualizados à medida que os consumos são registrados;
  • Para análises de faturamento do mês, recomendamos utilizar o período completo, por exemplo 01/04/2026 a 31/05/2026 ou acompanhar pelo accrual_period.

Como acessar a Consumption API​

A Consumption API está disponível no endpoint público da Magalu Cloud:

GET https://api.magalu.cloud/consumption/usage

Para realizar uma consulta, você precisa de uma API Key com acesso à aplicação tally-consumption-api.

  1. Siga o procedimento descrito em Como criar uma API Key e, durante a criação, selecione: Magalu Cloud > tally-consumption-api
  2. Consulte os dados de consumo de um período utilizando start_date e end_date por exemplo:
curl --request GET \
 --url 'https://api.magalu.cloud/consumption/usage?start_date=2026-04-01&end_date=2026-04-15' \
 --header 'x-api-key: {API_KEY}'

Exemplo de retorno da API de custo e uso diária:

{
      "SkuId": "BRSE10500102MD",
      "SkuPriceId": null,
      "ConsumedQuantity": "1.000000000000000",
      "ConsumedUnit": "InstanceSeconds",
      "ListUnitPrice": "0.000068489346",
      "PricingQuantity": "1.000000000000000",
      "ListCost": "0.000068489346000",
      "BillingAccountId": "81591409-07b2-4185-bf91-4d36b97c23c9",
      "BillingCurrency": "BRL",
      "BillingPeriodStart": "2026-07-31T00:00:00-03:00",
      "BillingPeriodEnd": "2026-08-31T00:00:00-03:00",
      "BilledCost": "0.000068489346000",
      "EffectiveCost": "0.000068489346000",
      "ResourceId": "a9ba72f4-4114-4d19-8e1c-74aca4f6442e",
      "ResourceName": null,
      "ChargePeriodEnd": "2026-08-21T00:00:00-03:00",
      "ChargePeriodStart": "2026-08-21T00:00:00-03:00",
      "ChargeCategory": "Usage",
      "ChargeClass": "Standard",
      "ChargeFrequency": "Usage-Based",
      "ChargeDescription": "",
      "ContractedCost": "0.000068489346000",
      "ServiceCategory": "Compute",
      "ServiceName": "Containers",
      "ProviderName": "Magalu Cloud",
      "PublisherName": "Magalu Cloud LTDA",
      "InvoiceIssuerName": "Magalu Cloud LTDA",
      "RegionName": "br-se1",
      "AvailabilityZone": "br-se1",
      "PricingUnit": "InstanceSeconds",
      "RegionId": null,
      "HostProviderName": "Magalu Cloud",
      "ServiceProviderName": "Magalu Cloud",
      "BillingAccountName": null,
      "CommitmentDiscountCategory": null,
      "CommitmentDiscountId": null,
      "CommitmentDiscountName": null,
      "CommitmentDiscountStatus": null,
      "CommitmentDiscountType": null,
      "ContractedUnitPrice": null,
      "PricingCategory": "On-Demand",
      "ResourceType": null,
      "SubAccountId": null,
      "SubAccountName": null,
      "Tags": null
    },

Alguns campos previstos na especificação FOCUS podem não estar disponíveis ou retornar null, pois dependem de características que ainda não fazem parte do modelo de cobrança da Magalu Cloud.