> ## Documentation Index > Fetch the complete documentation index at: https://docs.hyperprop.com/llms.txt > Use this file to discover all available pages before exploring further. # Get credits > Your available credit balance and every credit grant and reversal. Credit is applied automatically to your next invoices when they are issued (`creditAppliedCents` on the invoice). Not paginated. **Access:** read-only and full-access API keys. Dashboard members need view access to Billing & purchases revenue. ## OpenAPI ````yaml https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/credits openapi: 3.0.0 info: title: Hyperprop Platform API version: 1.0.0 description: >- REST API for the Hyperprop Trading Platform — provision evaluation and funded trading accounts, manage traders and plans, react to account lifecycle events via signed webhooks, and reconcile billing. Built for prop firms integrating from their own backend. Authentication, quick start, error handling, idempotency, pagination, custom metadata, webhooks, and the MCP connector are documented at https://docs.hyperprop.com. x-logo: url: https://app.hyperprop.com/logo-icon.svg altText: Hyperprop href: https://hyperprop.com servers: - url: https://api.hyperprop.com/platform description: Production security: [] tags: - name: Trading accounts description: Create, update, and inspect trading accounts. - name: Traders description: Look up and update the traders in your organization. - name: Trading plans description: Define the plans you sell. - name: Trading rules description: Define how accounts are evaluated. - name: Instruments description: >- The contracts your organization's accounts can trade, with their specifications. - name: Lockouts description: Pause and resume trading on an account. - name: Payouts description: Check payout eligibility and record payouts. - name: Purchases description: Purchases recorded for your organization. - name: Time Machine description: Restore accounts to an earlier trading day or instant. - name: Mass credit description: >- Credit back losses across many accounts after an incident, as background jobs you can follow, pause, export and reverse. - name: Webhooks description: Register webhook endpoints and inspect deliveries. - name: Events description: Your organization's event history, to replay or audit what happened. - name: Real-time streams description: >- Live events and trading data over a WebSocket, for dashboards and CRMs that update as things happen. - name: Reconciliation description: Balances, end-of-day snapshots, and fills for reconciliation. - name: Analytics description: Organization performance, revenue and top traders. - name: Risk description: Firm profit and loss and plan economics. - name: Billing and invoices description: >- Your Hyperprop invoices, credits and billing details, with usage so far this month, billing cycles, forecasts and CSV exports. - name: Team and roles description: Manage dashboard access for your staff. - name: API keys description: >- Manage your organization's API keys: rotation, read-only keys and IP allowlists. - name: Logs and health description: >- API request logs, the audit log, integration health, and idempotency key recovery. - name: Organization profile description: Your organization's profile and logo. - name: Support description: Open and follow up on support tickets. - name: Partner access description: >- Read a trader's journal as an approved partner app, with the trader's own key. paths: /v1/organization/billing/credits: get: tags: - Billing and invoices summary: Get credits description: >- Your available credit balance and every credit grant and reversal. Credit is applied automatically to your next invoices when they are issued (`creditAppliedCents` on the invoice). Not paginated. **Access:** read-only and full-access API keys. Dashboard members need view access to Billing & purchases revenue. operationId: getV1OrganizationBillingCredits responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Model408' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/Model11' '403': description: The credentials may not make this request content: application/json: schema: $ref: '#/components/schemas/OrganizationAccessError' '500': description: An unexpected error occurred content: application/json: schema: $ref: '#/components/schemas/Model6' '504': description: >- Gateway Timeout - The request did not complete within 25 seconds (`REQUEST_TIMEOUT`). Nothing was changed; retry, or narrow the request (for example a shorter date range). content: application/json: schema: $ref: '#/components/schemas/Model410' security: - X-API-Key: [] components: schemas: Model408: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/BillingCredits' Model11: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Authentication required code: type: string description: Machine-readable error code — switch on this, not on message text example: UNAUTHORIZED OrganizationAccessError: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: Your role does not have view access to "Billing & purchases revenue" code: $ref: '#/components/schemas/Model409' Model6: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An unexpected error occurred code: type: string description: Machine-readable error code — switch on this, not on message text example: INTERNAL_ERROR Model410: type: object properties: statusCode: type: number example: 504 error: type: string example: Gateway Timeout message: type: string example: >- The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range). code: type: string description: Machine-readable error code — switch on this, not on message text example: REQUEST_TIMEOUT BillingCredits: type: object properties: balanceCents: type: integer description: Credit available for your next invoices, in cents of `currency` example: 250000 currency: $ref: '#/components/schemas/currency' credits: $ref: '#/components/schemas/credits' Model409: type: string description: >- `INSUFFICIENT_PERMISSIONS` = the role or key lacks the permission this endpoint needs; `READ_ONLY_KEY` = a read-only API key sent a request that changes data; `IP_NOT_ALLOWED` = the request came from an address outside the key's IP allowlist; `ORG_INACTIVE` = the organization is not active example: INSUFFICIENT_PERMISSIONS enum: - INSUFFICIENT_PERMISSIONS - READ_ONLY_KEY - IP_NOT_ALLOWED - ORG_INACTIVE currency: type: string description: Invoice currency (lowercase ISO 4217) example: usd enum: - usd - eur credits: type: array description: Every grant and reversal, newest first items: $ref: '#/components/schemas/BillingCredit' BillingCredit: type: object properties: id: type: string example: 2c4e6a8b-1d3f-4b5a-9c7e-0f2a4c6e8b1d x-format: guid: true amountCents: type: integer description: Amount in cents of `currency` example: 500000 currency: $ref: '#/components/schemas/currency' reason: type: string example: Outage credit, October 2026 kind: $ref: '#/components/schemas/Model407' reversesCreditId: type: string description: 'For a reversal: the grant it reverses' example: null x-format: guid: true reversedCents: type: integer description: 'For a grant: how much of it has been reversed' example: 0 createdAt: type: string example: '2026-10-22T14:03:00.000Z' x-format: isoDate: true Model407: type: string description: >- `grant` adds to your balance; `reversal` takes back part of an earlier grant example: grant enum: - grant - reversal securitySchemes: X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key (`hp_live_...`), sent in the `X-API-Key` header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A **full-access** key can call every endpoint in this reference. A **read-only** key can call `GET` endpoints (and create a trading stream token); any other request returns `403 READ_ONLY_KEY`. A key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other address. Each endpoint lists which keys can call it under **Access**. ```` ## Related topics - [Confirm a mass credit](https://docs.hyperprop.com/platform-api/mass-credit/confirm-a-mass-credit.md) - [Preview a mass credit](https://docs.hyperprop.com/platform-api/mass-credit/preview-a-mass-credit.md) - [Preview a balance credit](https://docs.hyperprop.com/platform-api/mass-credit/preview-a-balance-credit.md) - [Reverse a balance credit](https://docs.hyperprop.com/platform-api/mass-credit/reverse-a-balance-credit.md) - [Reverse a mass credit](https://docs.hyperprop.com/platform-api/mass-credit/reverse-a-mass-credit.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.