> ## Documentation Index
> Fetch the complete documentation index at: https://altostrat.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List billing accounts

> Returns a list of billing accounts associated with a workspace.



## OpenAPI

````yaml /api/en/workspaces.yaml get /workspaces/{workspaceId}/billing-accounts
openapi: 3.0.3
info:
  title: Altostrat Workspaces API
  version: 1.0.0
  description: >-
    The Altostrat Workspaces API is the microservice responsible for tenancy,
    billing, user identity, and organizational hierarchy.

    It serves as the foundational layer for all multi-tenancy and subscription
    logic within the Altostrat SDX platform, enabling the secure separation of
    customer data and resources for SD-WAN, network automation, and agentic AI
    features.

    This API allows you to programmatically manage:

    - **Workspaces:** The top-level containers for all tenant resources, users,
    and billing configurations.

    - **Organizations:** Hierarchical entities used to model customer tenants or
    business units, track resource usage, and apply limits.

    - **Billing & Subscriptions:** The financial accounts and Stripe-powered
    subscriptions that govern access to Altostrat SDX features and resources.

    - **Members & Access:** The users and their specific roles (Owner, Admin,
    Viewer) within a workspace.

    Developers use this API to build the structural foundation and manage the
    billing lifecycle upon which all other Altostrat SDX automation and AI
    features operate.
servers:
  - url: https://v1.api.altostrat.io
    description: Production API Server
security:
  - bearerAuth: []
tags:
  - name: Workspaces
    description: Manage workspaces, the top-level containers for all resources.
  - name: Workspace Members
    description: Manage user access and roles within a workspace.
  - name: Organizations
    description: Manage hierarchical organizations for tenancy and resource segmentation.
  - name: Billing Accounts
    description: Manage financial accounts linked to Stripe for billing and subscriptions.
  - name: Subscriptions
    description: Manage product subscriptions powered by Stripe.
  - name: Invoices
    description: Retrieve invoice history and preview upcoming billing changes.
  - name: Payment Methods
    description: Manage customer payment methods for subscriptions.
  - name: Public
    description: Unauthenticated endpoints for retrieving public organization information.
paths:
  /workspaces/{workspaceId}/billing-accounts:
    get:
      tags:
        - Billing Accounts
      summary: List billing accounts
      description: Returns a list of billing accounts associated with a workspace.
      parameters:
        - $ref: '#/components/parameters/WorkspaceId'
      responses:
        '200':
          description: A list of billing account objects.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BillingAccount'
                  has_more:
                    type: boolean
                    example: false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    WorkspaceId:
      name: workspaceId
      in: path
      required: true
      description: The ID of the workspace.
      schema:
        type: string
        example: ws_a1b2c3d4e5f6g7h8
  schemas:
    BillingAccount:
      type: object
      properties:
        id:
          type: string
          description: >-
            Unique identifier for the billing account (Stripe Customer ID),
            prefixed with `cus_`.
          example: cus_a1b2c3d4e5f6g7h8
        workspace_id:
          type: string
          description: The ID of the workspace this billing account belongs to.
          example: ws_a1b2c3d4e5f6g7h8
        name:
          type: string
          description: The name of the billing account.
          example: ACME Corp Billing
        email:
          type: string
          format: email
          description: The primary billing email address.
          example: billing@acme.com
        phone:
          type: string
          nullable: true
          description: The billing contact phone number.
          example: '+15551234567'
        description:
          type: string
          nullable: true
          description: An optional description for the billing account.
          example: For US-based operations
        currency:
          type: string
          description: The three-letter ISO currency code for the billing account.
          enum:
            - usd
            - zar
            - eur
            - gbp
            - aud
          example: usd
        address:
          $ref: '#/components/schemas/Address'
        created_at:
          type: string
          format: date-time
          description: The timestamp when the billing account was created.
          example: '2025-10-29T00:40:06.000000Z'
        updated_at:
          type: string
          format: date-time
          description: The timestamp when the billing account was last updated.
          example: '2025-10-29T00:40:06.000000Z'
    Address:
      type: object
      properties:
        country:
          type: string
          description: Two-letter country code (ISO 3166-1 alpha-2).
          example: US
        line1:
          type: string
          nullable: true
          description: Address line 1 (e.g., street, PO Box, or company name).
          example: 123 Main Street
        line2:
          type: string
          nullable: true
          description: Address line 2 (e.g., apartment, suite, unit, or building).
          example: Suite 456
        city:
          type: string
          nullable: true
          description: City, district, suburb, town, or village.
          example: San Francisco
        state:
          type: string
          nullable: true
          description: State, county, province, or region.
          example: CA
        postal_code:
          type: string
          nullable: true
          description: ZIP or postal code.
          example: '94105'
  responses:
    Unauthorized:
      description: >-
        Unauthorized - The request was not authenticated. Ensure you have
        provided a valid Bearer token in the Authorization header.
    Forbidden:
      description: >-
        Forbidden - The authenticated user does not have permission to perform
        this action.
    NotFound:
      description: Not Found - The requested resource could not be found.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Enter your JWT in the format: Bearer {token}'

````