Get It Done Logo
Get It Done

Get plan usage

GET/v1/usage

Reports the current billing period, per-meter consumption against the plan, and the per-credential burst allowance. Reading usage never consumes the API-call quota (the meter cost is zero), so this endpoint stays reachable even when the period allowance is exhausted.

Required scopes
usage:read
Availability
All plans
Quota cost
0 API calls
Idempotency
Not applicable

Request

This operation takes no parameters or body — just your credential.

Response 200

The organization's current usage snapshot.

Fields

FieldTypeDescription
planrequired"FREE" | "PRO" | "TEAM"The organization's current plan tier.e.g. FREE
period_startrequiredstring (date-time)Start of the current billing period, ISO-8601 UTC. Paid plans anchor at their subscription renewal; free plans at the first of the calendar month.e.g. 2026-07-01T00:00:00.000Z
period_endrequiredstring (date-time)End of the current billing period, ISO-8601 UTC — when period meters reset.e.g. 2026-08-01T00:00:00.000Z
metersrequiredobject[]Per-meter consumption for the current period.
burstrequiredobjectThe per-credential burst policy (separate from period quotas; every key/token gets its own window).
▸ Raw response schema
{
  "type": "object",
  "properties": {
    "plan": {
      "type": "string",
      "enum": [
        "FREE",
        "PRO",
        "TEAM"
      ],
      "description": "The organization's current plan tier.",
      "example": "FREE"
    },
    "period_start": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "Start of the current billing period, ISO-8601 UTC. Paid plans anchor at their subscription renewal; free plans at the first of the calendar month.",
      "example": "2026-07-01T00:00:00.000Z"
    },
    "period_end": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "End of the current billing period, ISO-8601 UTC — when period meters reset.",
      "example": "2026-08-01T00:00:00.000Z"
    },
    "meters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UsageMeter"
      },
      "description": "Per-meter consumption for the current period."
    },
    "burst": {
      "type": "object",
      "properties": {
        "per_minute_limit": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991,
          "description": "Requests each individual credential may make per minute before 429 rate_limited.",
          "example": 10
        }
      },
      "required": [
        "per_minute_limit"
      ],
      "additionalProperties": false,
      "description": "The per-credential burst policy (separate from period quotas; every key/token gets its own window)."
    }
  },
  "required": [
    "plan",
    "period_start",
    "period_end",
    "meters",
    "burst"
  ],
  "additionalProperties": false,
  "description": "The organization's consumption against its plan for the current billing period, plus the burst policy."
}

Example request

curl
curl -X GET https://app.nowgetitdone.com/v1/usage \
  -H "Authorization: Bearer gid_YOUR_API_KEY"

Possible errors