> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Get the account plan usage of an account > Returns the free-quota consumption of the account in a period, for each fee of the version in effect now of its active account plan: the quota trigger, the period, the free quota, the units used, the free units remaining (never negative) and the units charged. A transaction fee counts its free quota per scheme, so it lists one item per scheme. The numbers come from the same counters the fee decision reads. period (YYYY-MM, in the plan timezone) reads a past month and defaults to the current one; a malformed or future period is refused with 0082. The account must exist in the ledger (404) and have an active assignment (404, 0554). ledgerId in the query is refused with 0235. ## OpenAPI ````yaml /es/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/account-plan/usage openapi: 3.1.0 info: title: Midaz Ledger API version: 4.0.0 servers: - url: https://ledger.sandbox.lerian.net security: [] tags: - name: Account Block Exceptions (v2) - name: Account Plan Assignments (v2) - name: Account Plans (v2) - name: Account Types (v1) - name: Account Types (v2) - name: Accounts (v1) - name: Accounts (v2) - name: Asset Rates (v1) - name: Assets (v1) - name: Assets (v2) - name: Balances (v1) - name: Balances (v2) - name: Billing Calculate (v2) - name: Billing Packages (v2) - name: Composition (v2) - name: Dashboard (v1) - name: Dashboard (v2) - name: Encryption (v2) - name: Fee Charges (v2) - name: Fee Debts (v2) - name: Fees (v2) - name: Holders (v2) - name: Instruments (v2) - name: Ledgers (v1) - name: Ledgers (v2) - name: Metadata Indexes (v1) - name: Metadata Indexes (v2) - name: Operation Routes (v1) - name: Operation Routes (v2) - name: Operations (v1) - name: Operations (v2) - name: Organizations (v1) - name: Organizations (v2) - name: Packages (v2) - name: Portfolios (v1) - name: Portfolios (v2) - name: Protection (v2) - name: Segments (v1) - name: Segments (v2) - name: Transaction Routes (v1) - name: Transaction Routes (v2) - name: Transactions (v1) - name: Transactions (v2) paths: /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/account-plan/usage: get: tags: - Account Plan Assignments (v2) summary: Get the account plan usage of an account description: >- Returns the free-quota consumption of the account in a period, for each fee of the version in effect now of its active account plan: the quota trigger, the period, the free quota, the units used, the free units remaining (never negative) and the units charged. A transaction fee counts its free quota per scheme, so it lists one item per scheme. The numbers come from the same counters the fee decision reads. period (YYYY-MM, in the plan timezone) reads a past month and defaults to the current one; a malformed or future period is refused with 0082. The account must exist in the ledger (404) and have an active assignment (404, 0554). ledgerId in the query is refused with 0235. operationId: getAccountPlanUsageV2 parameters: - description: Organization ID (UUID) in: path name: organization_id required: true schema: description: Organization ID (UUID) type: string - description: Ledger ID (UUID) in: path name: ledger_id required: true schema: description: Ledger ID (UUID) type: string - description: Account ID (UUID) in: path name: account_id required: true schema: description: Account ID (UUID) type: string - description: >- Period to read, in the YYYY-MM format and the plan timezone. Defaults to the current period; a future period is refused. explode: false in: query name: period schema: description: >- Period to read, in the YYYY-MM format and the plan timezone. Defaults to the current period; a future period is refused. type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/FeeAccountPlanUsage' description: OK '422': content: application/problem+json: schema: $ref: '#/components/schemas/Error' description: Unprocessable Entity '500': content: application/problem+json: schema: $ref: '#/components/schemas/Error' description: Internal Server Error default: content: application/problem+json: schema: $ref: '#/components/schemas/Error' description: Error security: - BearerAuth: [] components: schemas: FeeAccountPlanUsage: additionalProperties: false properties: accountId: examples: - 00000000-0000-0000-0000-000000000000 type: string accountPlanId: examples: - 00000000-0000-0000-0000-000000000000 type: string accountPlanVersion: description: >- Version of the plan in effect now, whose fees and free quotas are listed. examples: - 1 format: int64 type: integer items: description: >- One item per fee and quota trigger. A transaction fee counts its free quota per scheme, so it lists one item per scheme. items: $ref: '#/components/schemas/FeeAccountPlanFeeUsage' type: - array - 'null' period: $ref: '#/components/schemas/FeeQuotaUsagePeriod' description: Period the consumption is counted in. required: - accountId - accountPlanId - accountPlanVersion - period - items type: object Error: additionalProperties: true properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object FeeAccountPlanFeeUsage: additionalProperties: false properties: charged: description: Units consumed in the period that were charged. examples: - 0 format: int64 type: integer feeKey: examples: - tedEnviada type: string freeQuota: examples: - 10 format: int64 type: integer period: $ref: '#/components/schemas/FeeQuotaUsagePeriod' remaining: description: Free units left in the period; never negative. examples: - 3 format: int64 type: integer trigger: description: >- Opaque key of the free-quota counter the units are counted under: fee:: for a transaction fee (fee::* for a routed fee without schemes, counting every scheme on its route), fee: for a service fee. Editing the fee keeps the key; do not parse it, read feeKey instead. examples: - fee:tedEnviada:TED type: string used: description: Units consumed in the period, free or charged. examples: - 7 format: int64 type: integer required: - feeKey - trigger - period - freeQuota - used - remaining - charged type: object FeeQuotaUsagePeriod: additionalProperties: false properties: end: description: End of the period, excluded. examples: - '2026-11-01T03:00:00Z' format: date-time type: string label: description: Period in the YYYY-MM format. examples: - 2026-10 type: string start: description: Start of the period, included. examples: - '2026-10-01T03:00:00Z' format: date-time type: string required: - label - start - end type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.