v4

latestOpenAPI 3.0.22026-08-02109239415.7 KB

manage

Lifetime credit totals for the API user's account.

Returns the lifetime credit KPIs (consumed, expired, issued) used to render the API credit dashboard strip. All values default to $0 when Metronome is unavailable so the FE can always render.

get/manage/api/credit_summary

Query parameters

organization_idstring required

Workspace to summarize credits for. The caller must be OWNER, ADMIN, or MEMBER of the org.

Response

API credit summary content

Example response

{
  "total_issued": {
    "amount": 1050,
    "currency_code": "USD"
  },
  "total_expired": {
    "amount": 1050,
    "currency_code": "USD"
  },
  "total_consumed": {
    "amount": 1050,
    "currency_code": "USD"
  },
  "credit_grants": [
    {
      "effective_at": "effective_at",
      "amount_consumed": {
        "amount": 1050,
        "currency_code": "USD"
      },
      "expires_at": "expires_at",
      "amount_available": {
        "amount": 1050,
        "currency_code": "USD"
      },
      "grant_id": "grant_id",
      "name": "name",
      "amount_issued": {
        "amount": 1050,
        "currency_code": "USD"
      }
    },
    {
      "effective_at": "effective_at",
      "amount_consumed": {
        "amount": 1050,
        "currency_code": "USD"
      },
      "expires_at": "expires_at",
      "amount_available": {
        "amount": 1050,
        "currency_code": "USD"
      },
      "grant_id": "grant_id",
      "name": "name",
      "amount_issued": {
        "amount": 1050,
        "currency_code": "USD"
      }
    }
  ]
}