> ## Documentation Index > Fetch the complete documentation index at: https://docs.myrouter.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get credits > Get purchased, used, and remaining prepaid credits. ## OpenAPI ````yaml /openapi/v0-api/public.openapi.yaml get /api/v1/credits openapi: 3.1.0 info: title: MyRouter V0 Public API version: 0.1.0 description: >- Customer-facing MyRouter V0 API. Core paths follow OpenRouter where possible; billing is a MyRouter extension using Stripe-style resource naming. license: name: Proprietary identifier: LicenseRef-Proprietary x-platform-contract-commit: 56b047ef2c076be151e090aa4e2f5e974180ea14 x-phase-sources: - phase1/2026-05-28-source-inventory.md - phase8/2026-05-28-public-v0-api-review-matrix.md servers: - url: https://api.myrouter.example description: Placeholder until public environment is finalized. security: - bearerApiKey: [] paths: /api/v1/credits: get: tags: - Credits summary: Get credits description: Get purchased, used, and remaining prepaid credits. operationId: getCredits parameters: - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Get credits response. headers: x-request-id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/CreditsResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' components: parameters: RequestIdHeader: name: x-request-id in: header required: false schema: type: string description: Optional caller request id. x-source: Platform error contracts and product API convention x-owner: shared x-status: product-to-build x-platform-dependency: Platform runtime errors and product API errors x-rationale: Every API needs a stable supportable error envelope with request id. headers: RequestId: schema: type: string description: Effective request id. x-source: Platform error contracts and product API convention x-owner: shared x-status: product-to-build x-platform-dependency: Platform runtime errors and product API errors x-rationale: Every API needs a stable supportable error envelope with request id. schemas: CreditsResponse: type: object additionalProperties: false required: - data properties: data: type: object additionalProperties: false required: - total_credits - total_usage - remaining_credits - currency - updated_at properties: total_credits: type: string description: Total purchased or credited amount. x-source: OpenRouter /credits plus product prepaid credits ledger x-owner: product x-status: product-to-build x-platform-dependency: None direct; consumes platform usage for deductions x-rationale: >- Credits are the prepaid customer balance snapshot and must not include service state. total_usage: type: string description: Total customer charges consumed. x-source: OpenRouter /credits plus product prepaid credits ledger x-owner: product x-status: product-to-build x-platform-dependency: None direct; consumes platform usage for deductions x-rationale: >- Credits are the prepaid customer balance snapshot and must not include service state. remaining_credits: type: string description: Remaining prepaid credits. x-source: OpenRouter /credits plus product prepaid credits ledger x-owner: product x-status: product-to-build x-platform-dependency: None direct; consumes platform usage for deductions x-rationale: >- Credits are the prepaid customer balance snapshot and must not include service state. currency: type: string description: Credits currency. x-source: OpenRouter /credits plus product prepaid credits ledger x-owner: product x-status: product-to-build x-platform-dependency: None direct; consumes platform usage for deductions x-rationale: >- Credits are the prepaid customer balance snapshot and must not include service state. updated_at: type: string description: Last ledger update. x-source: OpenRouter /credits plus product prepaid credits ledger x-owner: product x-status: product-to-build x-platform-dependency: None direct; consumes platform usage for deductions x-rationale: >- Credits are the prepaid customer balance snapshot and must not include service state. format: date-time x-source: OpenRouter /credits plus product prepaid credits ledger x-owner: product x-status: product-to-build x-platform-dependency: None direct; consumes platform usage for deductions x-rationale: >- Credits are the prepaid customer balance snapshot and must not include service state. request_id: type: string description: Request id. x-source: OpenRouter /credits plus product prepaid credits ledger x-owner: product x-status: product-to-build x-platform-dependency: None direct; consumes platform usage for deductions x-rationale: >- Credits are the prepaid customer balance snapshot and must not include service state. x-source: OpenRouter /credits plus product prepaid credits ledger x-owner: product x-status: product-to-build x-platform-dependency: None direct; consumes platform usage for deductions x-rationale: >- Credits are the prepaid customer balance snapshot and must not include service state. ErrorEnvelope: type: object additionalProperties: false required: - error - request_id properties: error: type: object additionalProperties: false required: - code - message properties: code: type: string description: Stable machine-readable error code. x-source: Platform error contracts and product API convention x-owner: shared x-status: product-to-build x-platform-dependency: Platform runtime errors and product API errors x-rationale: >- Every API needs a stable supportable error envelope with request id. message: type: string description: Human-readable error message. x-source: Platform error contracts and product API convention x-owner: shared x-status: product-to-build x-platform-dependency: Platform runtime errors and product API errors x-rationale: >- Every API needs a stable supportable error envelope with request id. type: type: string description: Error category. x-source: Platform error contracts and product API convention x-owner: shared x-status: product-to-build x-platform-dependency: Platform runtime errors and product API errors x-rationale: >- Every API needs a stable supportable error envelope with request id. x-source: Platform error contracts and product API convention x-owner: shared x-status: product-to-build x-platform-dependency: Platform runtime errors and product API errors x-rationale: Every API needs a stable supportable error envelope with request id. request_id: type: string description: Effective request id for support. x-source: Platform error contracts and product API convention x-owner: shared x-status: product-to-build x-platform-dependency: Platform runtime errors and product API errors x-rationale: Every API needs a stable supportable error envelope with request id. x-source: Platform error contracts and product API convention x-owner: shared x-status: product-to-build x-platform-dependency: Platform runtime errors and product API errors x-rationale: Every API needs a stable supportable error envelope with request id. responses: BadRequest: description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Unauthorized: description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: Authenticated principal is not allowed. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' NotFound: description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' RateLimited: description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' InternalError: description: Internal error. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: bearerApiKey: type: http scheme: bearer bearerFormat: MyRouter API key ````