> ## Documentation Index > Fetch the complete documentation index at: https://docs-pos.solya.app/llms.txt > Use this file to discover all available pages before exploring further. # Read the credit wallet, ledger and usage > Returns everything the Centrale credits-and-notifications page renders in one call: the current `wallet` (materialized balance, subscribed plan tier and renewal date), every `ledger` movement (top-ups, plan grants, debits, refunds, adjustments), the `usage` events each send produced, the per-store `byStore` ventilation of sends and credits spent, and a `lowBalance` flag tripped at `lowBalanceThreshold`. Reach for this to answer how many credits are left, where they went, or why the low-balance banner is showing; it takes no parameters and returns the whole (unpaginated) history. ## OpenAPI ````yaml /openapi.json get /v1/credits/overview openapi: 3.0.3 info: title: Solya POS API version: 1.0.0 description: >- The Solya POS backend HTTP surface. Every documented operation is agent-ready: it carries an `operationId`, an agent-facing `description`, the `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`. Success responses return the payload as raw JSON; failures return the `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`). servers: - url: / description: The backend, relative to its deployed origin. security: [] paths: /v1/credits/overview: get: tags: - Billing summary: Read the credit wallet, ledger and usage description: >- Returns everything the Centrale credits-and-notifications page renders in one call: the current `wallet` (materialized balance, subscribed plan tier and renewal date), every `ledger` movement (top-ups, plan grants, debits, refunds, adjustments), the `usage` events each send produced, the per-store `byStore` ventilation of sends and credits spent, and a `lowBalance` flag tripped at `lowBalanceThreshold`. Reach for this to answer how many credits are left, where they went, or why the low-balance banner is showing; it takes no parameters and returns the whole (unpaginated) history. operationId: getCreditsOverview responses: '200': description: >- The wallet, its ledger, the usage events, the per-store split and the flag. content: application/json: schema: type: object properties: wallet: type: object properties: accountId: type: string minLength: 1 smsCreditBalance: type: integer minimum: -9007199254740991 maximum: 9007199254740991 planTier: type: string minLength: 1 planRenewsAt: 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))$ updatedAt: 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))$ required: - accountId - smsCreditBalance - updatedAt additionalProperties: false ledger: type: array items: type: object properties: id: type: string minLength: 1 accountId: type: string minLength: 1 type: type: string enum: - topup - plan_grant - debit - refund - adjustment amount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 balanceAfter: type: integer minimum: -9007199254740991 maximum: 9007199254740991 source: type: string minLength: 1 createdAt: 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))$ required: - id - accountId - type - amount - balanceAfter - createdAt additionalProperties: false usage: type: array items: type: object properties: id: type: string minLength: 1 accountId: type: string minLength: 1 storeId: type: string minLength: 1 channel: type: string enum: - email - sms kind: type: string minLength: 1 recipientHash: type: string minLength: 1 status: type: string enum: - sent - failed - dry_run creditsCharged: type: integer minimum: 0 maximum: 9007199254740991 template: type: string minLength: 1 providerMessageId: type: string minLength: 1 createdAt: 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))$ required: - id - accountId - storeId - channel - kind - recipientHash - status - creditsCharged - createdAt additionalProperties: false byStore: type: array items: type: object properties: storeId: type: string minLength: 1 sends: type: integer minimum: 0 maximum: 9007199254740991 creditsSpent: type: integer minimum: 0 maximum: 9007199254740991 required: - storeId - sends - creditsSpent additionalProperties: false lowBalance: type: boolean lowBalanceThreshold: type: integer minimum: 0 maximum: 9007199254740991 required: - wallet - ledger - usage - byStore - lowBalance - lowBalanceThreshold additionalProperties: false description: >- The wallet, its ledger, the usage events, the per-store split and the flag. example: wallet: accountId: network smsCreditBalance: 500 planTier: starter planRenewsAt: '2026-08-28T00:00:00.000Z' updatedAt: '2026-07-28T09:12:00.000Z' ledger: - id: 3f1c8a6e-1d2b-4f7a-9c33-5b0e2a8d41f6 accountId: network type: adjustment amount: 500 balanceAfter: 500 source: pilot seed createdAt: '2026-07-28T09:12:00.000Z' usage: - id: 9a4d1e77-6b02-4c15-8f39-2ad7c0e5b183 accountId: network storeId: store-lyon-1 channel: sms kind: receipt recipientHash: b94d27b9934d3e08a52e52d7da7dabfa status: sent creditsCharged: 1 createdAt: '2026-07-28T09:30:00.000Z' byStore: - storeId: store-lyon-1 sends: 1 creditsSpent: 1 lowBalance: false lowBalanceThreshold: 100 '400': description: >- The request failed schema validation; `error.fieldErrors` lists the fields. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' '401': description: No valid credential was presented — send a bearer token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: The actor is authenticated but lacks the required `pos.*` scope. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: An unexpected server error — safe to retry idempotent requests. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: ValidationErrorResponse: type: object required: - error additionalProperties: false description: >- A `VALIDATION_FAILED` envelope carrying the offending fields in `fieldErrors`. properties: error: type: object required: - code - message - statusCode additionalProperties: false properties: code: type: string enum: - VALIDATION_FAILED message: type: string statusCode: type: integer fieldErrors: type: array description: >- One entry per rejected field: the field path and why it was rejected. items: type: object required: - field - message additionalProperties: false properties: field: type: string description: Dot-path of the offending field. message: type: string description: Why the field was rejected. ErrorResponse: type: object required: - error additionalProperties: false description: The uniform failure envelope every non-2xx response returns. properties: error: type: object required: - code - message - statusCode additionalProperties: false properties: code: type: string enum: - VALIDATION_FAILED - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - CONFLICT - BUSINESS_RULE_VIOLATION - INTERNAL_ERROR description: >- Machine-readable kernel `ResultCode` — branch on this, not on `message`. message: type: string description: >- Human-readable explanation. Safe to surface; never leaks server internals. statusCode: type: integer description: >- The HTTP status, mirrored into the body so a client need not read headers. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- `Authorization: Bearer `. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same `pos.*` scope vocabulary the route guards enforce. ````