Skip to main content
GET
/
usage
Get usage
curl --request GET \
  --url https://cloud.laravel.com/api/usage \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "summary": {
      "current_spend_cents": 123,
      "bandwidth": {
        "cost_cents": 123,
        "usage_percentage": 123,
        "allowance_bytes": 123
      },
      "credits": {
        "used_cents": 123,
        "total_cents": 123
      },
      "alert": {
        "threshold_cents": 123,
        "remaining_percentage": 123
      }
    },
    "resources": {
      "total_cost_cents": 123,
      "databases": [
        {}
      ],
      "caches": [
        {}
      ],
      "buckets": [
        {}
      ],
      "websockets": [
        {}
      ]
    },
    "addons": {
      "total_cost_cents": 123,
      "items": [
        {
          "name": "<string>",
          "total_cents": 123
        }
      ]
    },
    "application_totals": {
      "total_cost_cents": 123,
      "application_count": 123,
      "applications": [
        {}
      ]
    },
    "environment_usage": {
      "total_cost_cents": 123,
      "items": [
        {}
      ]
    }
  },
  "meta": {
    "currency": "<string>",
    "period": 123,
    "available_periods": [
      {
        "from": "<string>",
        "to": "<string>"
      }
    ],
    "last_updated_at": "<string>"
  }
}

Authorizations

Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Query Parameters

period
integer | null

The billing period offset. 0 returns the current billing period, 1 returns the previous period, and so on. Periods are not necessarily month-long — they match your billing cycle. Must be between 0 and 3.

Required range: 0 <= x <= 3
environment
string | null

Response

data
object
required
meta
object
required