> ## 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 an invoice > One invoice with its lines, the trader-months it bills (`usage`), and plain-language notes on how minimums and first-month proration applied (`explain`). You see issued invoices only: `open`, `paid` and `uncollectible`. Drafts Hyperprop is still reviewing, and voided invoices, are never returned (fetching one by ID returns 404 `INVOICE_NOT_FOUND`). Amounts are integers in cents of the invoice `currency`. **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/invoices/{invoiceId} 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/invoices/{invoiceId}: get: tags: - Billing and invoices summary: Get an invoice description: >- One invoice with its lines, the trader-months it bills (`usage`), and plain-language notes on how minimums and first-month proration applied (`explain`). You see issued invoices only: `open`, `paid` and `uncollectible`. Drafts Hyperprop is still reviewing, and voided invoices, are never returned (fetching one by ID returns 404 `INVOICE_NOT_FOUND`). Amounts are integers in cents of the invoice `currency`. **Access:** read-only and full-access API keys. Dashboard members need view access to Billing & purchases revenue. operationId: getV1OrganizationBillingInvoicesInvoiceid parameters: - description: Invoice ID, from `GET /billing/invoices` x-format: guid: true name: invoiceId in: path required: true example: 5b0c7a2e-3f41-4d1a-9c6e-2a8f0d9b7e13 schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Model723' '400': description: Validation failed content: application/json: schema: $ref: '#/components/schemas/Model25' '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' '404': description: No issued invoice with this ID in your organization content: application/json: schema: $ref: '#/components/schemas/Model724' '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/Model725' security: - X-API-Key: [] components: schemas: Model723: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model722' Model25: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 400 error: type: string example: Bad Request message: type: string example: Validation failed code: type: string description: Machine-readable error code — switch on this, not on message text example: VALIDATION_ERROR 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' Model724: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 404 error: type: string example: Not Found message: type: string example: No issued invoice with this ID in your organization code: type: string description: Machine-readable error code — switch on this, not on message text example: INVOICE_NOT_FOUND 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 Model725: 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 Model722: type: object properties: invoice: $ref: '#/components/schemas/InvoiceDetail' 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 InvoiceDetail: type: object properties: id: type: string example: 5b0c7a2e-3f41-4d1a-9c6e-2a8f0d9b7e13 x-format: guid: true organizationId: type: string example: 0e9b6a14-7c2d-4b8f-93a1-6d5e2f8c0b47 x-format: guid: true kind: $ref: '#/components/schemas/Model718' billingMonth: type: string description: The month a `month_final` invoice closes example: '2026-11-01' pattern: ^\d{4}-(0[1-9]|1[0-2])-01$ periodFrom: type: string description: Start of the billed period example: '2026-10-01T05:00:00.000Z' x-format: isoDate: true periodTo: type: string description: End of the billed period (exclusive) example: '2026-11-01T05:00:00.000Z' x-format: isoDate: true revision: type: integer description: 1 for a first issue; higher when the invoice re-issues a voided one example: 1 replacesInvoiceId: type: string description: >- The voided invoice this one re-issues. Voided invoices are not listed, so this ID is for reference only x-format: guid: true replacedByInvoiceId: type: string description: The invoice that re-issues this one x-format: guid: true replacesNumber: type: string description: Number of the invoice this one re-issues example: null replacedByNumber: type: string description: Number of the invoice that re-issues this one example: null status: $ref: '#/components/schemas/Model719' displayStatus: $ref: '#/components/schemas/displayStatus' paymentState: $ref: '#/components/schemas/paymentState' number: type: string description: Invoice number; quote it as the payment reference example: HP-0042 currency: $ref: '#/components/schemas/currency' subtotalCents: type: integer description: Sum of the lines, in cents of `currency` example: 2860000 creditAppliedCents: type: integer description: >- Credit from your credit balance applied to this invoice, in cents of `currency` example: 0 creditNotesCents: type: integer description: Credit notes issued against this invoice, in cents of `currency` example: 0 taxCents: type: integer description: Tax, in cents of `currency` example: 0 totalCents: type: integer description: Total after credit notes and tax, in cents of `currency` example: 2860000 amountDueCents: type: integer description: Amount to pay after applied credit, in cents of `currency` example: 2860000 amountPaidCents: type: integer description: Amount received so far, in cents of `currency` example: 0 amountRemainingCents: type: integer description: Amount still to pay, in cents of `currency` example: 2860000 dueDate: type: string example: '2026-11-15T00:00:00.000Z' x-format: isoDate: true finalizedAt: type: string description: When the invoice was issued example: '2026-11-01T09:00:00.000Z' x-format: isoDate: true sentAt: type: string description: When it was last emailed to your billing email example: '2026-11-01T09:00:05.000Z' x-format: isoDate: true paidAt: type: string example: null x-format: isoDate: true voidedAt: type: string example: null x-format: isoDate: true hostedInvoiceUrl: type: string description: Online page to view and pay the invoice example: https://invoice.example.com/i/acct_1/test_YWNjdF8x memo: type: string description: Note printed on the invoice example: null createdAt: type: string example: '2026-11-01T08:59:58.000Z' x-format: isoDate: true lines: $ref: '#/components/schemas/lines' usage: $ref: '#/components/schemas/usage' explain: $ref: '#/components/schemas/explain' agreementId: type: string description: The pricing agreement the invoice was computed under x-format: guid: true agreementVersion: type: integer example: 3 engineVersion: type: string description: Version of the billing calculation used example: '2026-10-30' Model718: type: string description: >- `interim` = usage up to a cut-off during the month, without minimums; `month_final` = the rest of a finished month, with its minimums example: month_final enum: - interim - month_final Model719: type: string description: >- `open` = issued and awaiting payment; `paid`; `uncollectible` = written off by Hyperprop example: open enum: - open - paid - uncollectible displayStatus: type: string description: >- The status to show: `overdue` = open past its due date; `pending` = open and partly funded by a bank transfer example: open enum: - open - pending - overdue - paid - uncollectible paymentState: type: string description: Bank transfer progress on an open invoice; null otherwise example: awaiting_transfer enum: - awaiting_transfer - partially_funded - failed currency: type: string description: Invoice currency (lowercase ISO 4217) example: usd enum: - usd - eur lines: type: array description: The invoice lines, in display order items: $ref: '#/components/schemas/InvoiceLine' usage: type: array description: The trader-months the invoice bills, per month and family items: $ref: '#/components/schemas/InvoiceUsageRow' explain: type: array description: Plain-language notes on how minimums and proration were applied example: - >- CME minimum 2,000 traders for November 2026: 1,300 billed (900 on earlier invoices), 700 added. items: type: string InvoiceLine: type: object properties: id: type: string example: 8d6f3c1a-2b7e-4f90-a1c3-5e7d9b0f2a64 x-format: guid: true billingMonth: type: string description: The month this line bills (first day of the month) example: '2026-11-01' pattern: ^\d{4}-(0[1-9]|1[0-2])-01$ priceLineCode: type: string description: The priced product this line bills; null for manual lines example: platform_futures family: $ref: '#/components/schemas/Model720' lineType: $ref: '#/components/schemas/lineType' source: $ref: '#/components/schemas/Model721' description: type: string description: The line as printed on the invoice example: CME, 1,300 traders, November 2026 quantity: type: string description: Decimal string, up to 4 decimals example: '1300.0000' unitAmount: type: string description: Price per unit, decimal string in the invoice currency example: '22.0000' amountCents: type: integer description: Line total, in cents of `currency` example: 2860000 sort: type: integer description: Display order on the invoice example: 1 InvoiceUsageRow: type: object properties: billingMonth: type: string example: '2026-11-01' pattern: ^\d{4}-(0[1-9]|1[0-2])-01$ family: $ref: '#/components/schemas/family' units: type: integer description: Trader-months this invoice bills example: 400 previouslyBilled: type: integer description: Trader-months of the same month already billed on earlier invoices example: 900 Model720: type: string description: >- `cme` = CME futures traders, `crypto` = crypto perpetuals traders, `platform` = fixed monthly fees example: cme enum: - cme - crypto - platform lineType: type: string description: >- `usage` = traders billed at the agreed price; `minimum_topup` = traders added to reach a product's minimum traders; `first_month_proration` = first-month adjustment; `flat_fee` = a fixed monthly fee; `minimum_commitment` = the top-up to the monthly minimum amount; `manual_charge` / `manual_credit` = lines Hyperprop added by hand example: usage enum: - usage - minimum_topup - first_month_proration - flat_fee - minimum_commitment - manual_charge - manual_credit Model721: type: string description: '`engine` = computed from your usage; `manual` = added by Hyperprop' example: engine enum: - engine - manual family: type: string example: cme enum: - cme - crypto - platform 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 - [Billing and invoices](https://docs.hyperprop.com/guides/billing-and-invoices.md) - [List invoices](https://docs.hyperprop.com/platform-api/billing-and-invoices/list-invoices.md) - [Download an invoice PDF](https://docs.hyperprop.com/platform-api/billing-and-invoices/download-an-invoice-pdf.md) - [Get credits](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-credits.md) - [Get bank transfer instructions](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-bank-transfer-instructions.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.