Current billing period usage

GET

/v1/usage/current

const url = 'https://api.pomeloanalytics.com/v1/usage/current';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.pomeloanalytics.com/v1/usage/current \
  --header 'Authorization: Bearer <token>'

Requires usage:read scope. Tokens with metrics:read also have implicit access to this endpoint.

Authorizations

bearerAuth

Parameters

Header Parameters

X-Request-Id

string

Optional idempotency/request correlation identifier.

Responses

200

application/json

object

period

required

string

units_used

required

integer

units_included

required

integer

units_overage

required

integer

hard_cap_units

required

integer

reset_at

required

string format: date-time

Example

{
  "period": "2026-02"
}

Headers

X-Request-Id

string

Request identifier for troubleshooting.

401

Invalid or revoked API token.

application/json

object

error

required

object

code

required

string

Allowed values: UNAUTHORIZED FORBIDDEN INVALID_METHOD INVALID_PARAMS RETENTION_EXCEEDED RATE_LIMITED HARD_CAP_REACHED REPORT_LOCKED_BY_PROFILE REPORT_NOT_AVAILABLE_FOR_REQUESTED_PERIOD REPORT_RESPONSE_TOO_LARGE INTERNAL_ERROR NOT_FOUND

message

required

string

request_id

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "UNAUTHORIZED"
  }
}

Headers

X-Request-Id

string

Request identifier for troubleshooting.

403

Token scope/site/plan does not allow this request.

application/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "UNAUTHORIZED"
  }
}

Headers

X-Request-Id

string

Request identifier for troubleshooting.

429

Request was throttled.

application/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "UNAUTHORIZED"
  }
}

Headers

X-Request-Id

string

Request identifier for troubleshooting.

X-RateLimit-Limit

integer

Maximum requests allowed during current short window.

X-RateLimit-Remaining

integer

Remaining requests in current short window.

X-RateLimit-Reset

integer

Unix timestamp when short window resets.