Measured quantities over time, per meter

GET

https://billing.ezghcloud.com/v1/organizations/{orgId}/usage

View as Markdown

Authorization

apiKeyoptionalHTTP
oauthoptionalHTTP
sessionCookieoptionalAPI key in cookie

Path parameters

orgIdstringrequired
format: uuid

Query parameters

fromstringrequired
A date (2026-09-01) or an hour-aligned UTC time (2026-09-01T10:00:00Z).
tostringrequired
Exclusive, like from. Hourly windows are at most 14 days, others 13 months.
granularityoptionalhourordayormonth
Default: "day"
groupByoptionalstring
Up to two of project, meter, region, comma-separated.
filteroptionalstring
key:value, comma-separated, keys as groupBy.
meteroptionalstring
Only these meters, comma-separated.

Returns

200

OK

JSON

organizationIdstringrequired
fromstringrequired
format: date-time
tostringrequired
format: date-time
granularitystringrequired
ratedThroughstringrequired
format: date-time
periodsarray ofobjectrequired
4 properties
- startstringrequired
  format: date-time
- endstringrequired
  Exclusive.
  
  format: date-time
- estimatedbooleanrequired
  Any of its groups is.
- groupsarray ofobjectrequired
  5 properties
  keysmap ofstringrequired
  Always includes meter.
  
  quantitystringrequired
  In unit.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
  unitstring | nullrequired
  eventCountintegerrequired
  estimatedbooleanrequired
  Some of it is a level carried forward.
valuesmap ofarray<string>required
Every value of each key in the window, whatever the filter.
labelsobjectrequired
Display names for the IDs in the answer. IDs without one are left out.
3 properties
- servicesmap ofstringrequired
- metersmap ofstringrequired
- skusmap ofstringrequired
nextCursornullrequired
One page: always null.

400

invalid_request: the request is malformed (with issues), or invalid_cursor.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

401

unauthenticated: no valid credential.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

403

access_denied: the caller isn't allowed to (the message names the action); forbidden_origin: a cookie-authenticated write from another site.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

404

not_found: the organization (or one the caller doesn't belong to), or the resource, doesn't exist.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

429

too_many_requests: slow down.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

500

internal_error: a bug; the details are in the logs, under the request ID.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

503

unavailable, ledger_unavailable or payments_unavailable: retry later.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

Measured quantities over time, per meter

curl --request GET \
  --url 'https://billing.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/usage?from=string&to=string' \
  --header 'Authorization: Bearer <token>'

const url = 'https://billing.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/usage?from=string&to=string';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://billing.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/usage?from=string&to=string"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "organizationId": "string",
  "from": "2019-08-24T14:15:22Z",
  "to": "2019-08-24T14:15:22Z",
  "granularity": "string",
  "ratedThrough": "2019-08-24T14:15:22Z",
  "periods": [
    {
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z",
      "estimated": true,
      "groups": [
        {
          "keys": {
            "property1": "string",
            "property2": "string"
          },
          "quantity": "string",
          "unit": "string",
          "eventCount": 0,
          "estimated": true
        }
      ]
    }
  ],
  "values": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "labels": {
    "services": {
      "property1": "string",
      "property2": "string"
    },
    "meters": {
      "property1": "string",
      "property2": "string"
    },
    "skus": {
      "property1": "string",
      "property2": "string"
    }
  },
  "nextCursor": null
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}