> ## 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.

# Open your billing page

> Returns the URL of the trader's billing page, where they can update their payment method and billing details and download invoices. 404 if the trader has never paid for an add-on.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/user/addons/billing-portal
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: Authentication
    description: >-
      User authentication - signup, signin, signout, password reset, email
      verification, OAuth, and MFA
  - name: User
    description: >-
      User account management - profile, notifications, agreements, dismissals,
      and audit logs. Requires Bearer token.
  - name: Organization
    description: >-
      Organization management - profile, team, trading accounts, plans, and
      rules. Supports **dual authentication**: Bearer JWT token (dashboard
      users) OR X-API-Key (programmatic access).
  - name: Market Data
    description: CME futures contracts and market data. Requires Bearer token.
  - name: Indicator Builder
    description: >-
      AI-assisted authoring of custom Hyperprop Script indicators for the web
      terminal. Requires Bearer token.
  - name: System
    description: System endpoints - health checks and connectivity
paths:
  /v1/user/addons/billing-portal:
    post:
      tags:
        - User
      summary: Open your billing page
      description: >-
        Returns the URL of the trader's billing page, where they can update
        their payment method and billing details and download invoices. 404 if
        the trader has never paid for an add-on.
      operationId: postV1UserAddonsBillingportal
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model681'
      responses:
        '200':
          description: Billing page created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model683'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model9'
        '404':
          description: Resource not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model24'
        '500':
          description: An unexpected error occurred
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model5'
components:
  schemas:
    Model681:
      type: object
      properties:
        returnPath:
          type: string
          description: >-
            Path in the web app to come back to afterwards (default
            `/settings/add-ons`)
          example: /settings/add-ons
          maxLength: 200
          pattern: ^\/(?!\/)
    Model683:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model682'
    Model9:
      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
    Model24:
      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: Resource not found
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: NOT_FOUND
    Model5:
      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
    Model682:
      type: object
      properties:
        url:
          type: string
          example: https://billing.example.com/p/session/a1b2c3
          x-format:
            uri: true

````

## Related topics

- [List billing cycles](/platform-api/organization/list-billing-cycles.md)
- [List all billing events](/platform-api/organization/list-all-billing-events.md)
- [Get monthly billing summary](/platform-api/organization/get-monthly-billing-summary.md)
- [Get events for a billing cycle](/platform-api/organization/get-events-for-a-billing-cycle.md)
- [Get your Market Depth add-on status](/platform-api/user/get-your-market-depth-add-on-status.md)