---
title: "Get API consumer allowance"
method: POST
path: "/get_api_consumer_allowance"
---

# Get API consumer allowance

`POST /get_api_consumer_allowance`

## Request

- Base URL: `https://api-integration-v2-qd6wo466iq-uc.a.run.app`
- URL: `https://api-integration-v2-qd6wo466iq-uc.a.run.app/get_api_consumer_allowance`
- Auth: HTTP bearer

Returns the live read model for the current UTC usage period and lazily rolls an expired period forward.

## Request body

- GetApiConsumerAllowanceRequest
  - `apiIntegrationId` string, required
  - `consumerId` string, required

## Response `200`

Current allowance returned.

- ApiConsumerAllowance
  - `consumerId` string, required
  - `active` boolean, required
  - `canStartRun` boolean, required: False when access is disabled or the current period is exhausted.
  - `period` ApiConsumerPeriod, required
    - `id` string, required: UTC period start date and document ID, based on the member's registration date.
    - `startsAt` string, date-time, required
    - `endsAt` string, date-time, required
    - `limitMicros` integer, required: USD allowance in millionths of a dollar.
    - `spentMicros` integer, required
    - `remainingMicros` integer, required
    - `inputTokens` integer, required
    - `outputTokens` integer, required
    - `usageItemCount` integer, required
    - `lastUsageRequestId` string, nullable
    - `updatedAt` string, date-time, required

## Other responses

- `400`: Invalid request.
- `401`: Missing or invalid platform API key.
- `403`: The API key does not own this integration.
- `404`: Integration or consumer not found.

## Changes

- **2026-11-03** `d9ab31b0307f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/agency-swarm/apis/agencii-platform-api/changes/get_api_consumer_allowance/post.md)

---

[API](https://skmtc.dev/agency-swarm/apis/agencii-platform-api.md) - [All operations](https://skmtc.dev/agency-swarm/apis/agencii-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/agency-swarm/apis/agencii-platform-api/revisions/d9ab31b0307f?raw)