> ## 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 your billing details

> The legal name, billing email, CC emails, address and tax ID Hyperprop invoices your organization with. No invoice can be issued until `complete` is true; `missing` lists what is still needed. Once complete details are saved they are `locked`.

**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/details
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/details:
    get:
      tags:
        - Billing and invoices
      summary: Get your billing details
      description: >-
        The legal name, billing email, CC emails, address and tax ID Hyperprop
        invoices your organization with. No invoice can be issued until
        `complete` is true; `missing` lists what is still needed. Once complete
        details are saved they are `locked`.


        **Access:** read-only and full-access API keys. Dashboard members need
        view access to Billing & purchases revenue.
      operationId: getV1OrganizationBillingDetails
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model417'
        '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/Model418'
      security:
        - X-API-Key: []
components:
  schemas:
    Model417:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model416'
    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
    Model418:
      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
    Model416:
      type: object
      properties:
        details:
          $ref: '#/components/schemas/BillingDetails'
    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
    BillingDetails:
      type: object
      properties:
        organizationId:
          type: string
          example: 0e9b6a14-7c2d-4b8f-93a1-6d5e2f8c0b47
          x-format:
            guid: true
        organizationName:
          type: string
          example: Acme Trading Co
        legalName:
          type: string
          example: Example Trading Ltd.
        billingEmail:
          type: string
          description: Invoices are emailed here
          example: ap@example.com
        ccEmails:
          $ref: '#/components/schemas/ccEmails'
        address:
          $ref: '#/components/schemas/OrgBillingDetailsAddress'
        taxId:
          $ref: '#/components/schemas/OrgBillingTaxId'
        complete:
          type: boolean
          description: Everything needed to issue an invoice is present
          example: true
        missing:
          $ref: '#/components/schemas/missing'
        locked:
          type: boolean
          description: >-
            Saved complete: your organization can no longer change the details.
            Contact Hyperprop at finance@hyperprop.com to change them
          example: true
        updatedAt:
          type: string
          example: '2026-10-28T10:12:00.000Z'
          x-format:
            isoDate: true
    ccEmails:
      type: array
      description: Extra invoice contacts (stored; invoice emails go to the billing email)
      example:
        - finance@example.com
      items:
        type: string
    OrgBillingDetailsAddress:
      type: object
      properties:
        line1:
          type: string
          example: Herengracht 100
          maxLength: 200
          x-convert:
            trim: true
        line2:
          type: string
          maxLength: 200
          x-convert:
            trim: true
        city:
          type: string
          example: Amsterdam
          maxLength: 100
          x-convert:
            trim: true
        state:
          type: string
          description: State, province or region
          maxLength: 100
          x-convert:
            trim: true
        postalCode:
          type: string
          example: 1015 BS
          maxLength: 20
          x-convert:
            trim: true
        country:
          type: string
          example: NL
          x-constraint:
            length: 2
          x-convert:
            trim: true
    OrgBillingTaxId:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Model415'
        value:
          type: string
          example: NL123456789B01
          minLength: 3
          maxLength: 40
          x-convert:
            trim: true
      required:
        - type
        - value
    missing:
      type: array
      description: >-
        Required fields still missing: `legalName`, `billingEmail`,
        `address.line1`, `address.city`, `address.postalCode` (except where a
        country has none), `address.country`
      example: []
      items:
        type: string
    Model415:
      type: string
      example: eu_vat
      enum:
        - eu_vat
        - gb_vat
        - ch_vat
        - no_vat
        - us_ein
        - ca_bn
        - au_abn
        - nz_gst
        - ae_trn
        - sg_uen
        - sg_gst
        - hk_br
        - in_gst
        - il_vat
        - jp_cn
        - kr_brn
        - za_vat
        - br_cnpj
        - mx_rfc
        - sa_vat
  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

- [Update your billing details](https://docs.hyperprop.com/platform-api/billing-and-invoices/update-your-billing-details.md)
- [Billing and invoices](https://docs.hyperprop.com/guides/billing-and-invoices.md)
- [Get bank transfer instructions](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-bank-transfer-instructions.md)
- [Get this month so far](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-this-month-so-far.md)
- [Get webhook details](https://docs.hyperprop.com/platform-api/webhooks/get-webhook-details.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.