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

# List revenue accounts

> Returns the organization's chart of accounts, ordered by code. This is how a `revenueAccountId` is resolved before creating or updating a membership plan or a product - a sale of that item then posts to the account named here.

Adding or renaming an account changes how every future sale is reported and what the club's accountant reconciles against, so the writes are gated on `revenue-accounts:write`, which nothing else grants. There is no delete: every historical row pointing at an account would be stranded, so an account is taken out of use with `isActive: false`.

Retired accounts are included, flagged with `isActive: false`: an existing plan or product may still point at one, so the id has to stay explicable. Do not attach one to something new.

Readable with any scope that carries a revenue account id: the `plans`, `products`, `classes`, `areas` and `instructors` scopes (read *and* write - they are granted independently), plus `transactions:read` and `revenue-accounts:write`. Every one of those resources either reports `revenueAccountId` or accepts it, so requiring one scope in particular would leave a key able to set an account it cannot look up. There is no `revenue-accounts:read`.

Leaving `revenueAccountId` unset is a valid choice: the sale then posts to whichever account the organization has marked `isDefault`, resolved at the time of the sale rather than frozen onto the item.




## OpenAPI

````yaml /openapi-platform.json get /v1/platform/revenue-accounts
openapi: 3.0.0
info:
  title: 1club Platform API
  version: 1.0.0
  description: >-
    The 1club Platform API lets you programmatically access and manage your
    organization's data.


    ## Official API Contract


    This documentation is the official source of truth for the 1club Platform
    API.

    If an integration relies on undocumented endpoints, fields, response shapes,
    or internal behavior outside this spec, we can't guarantee backward
    compatibility.

    Build against what's documented here to stay stable as the platform evolves.


    ## Authentication


    All requests require a customer API key passed as a Bearer token:


    ```

    Authorization: Bearer 1club_sk_live_...

    ```


    Generate API keys from the admin portal under **Settings > API Tokens**.

    The key is tied to your organization - all responses are scoped to your
    org's data.


    ## Rate Limiting


    - **100 requests per minute** per API key

    - When exceeded, the API returns `429 Too Many Requests` with a
    `Retry-After` header

    - Rate limit headers are included in every response:
      - `X-RateLimit-Limit` - max requests per window
      - `X-RateLimit-Remaining` - requests remaining
      - `X-RateLimit-Reset` - seconds until the window resets

    ## Errors


    | Status | Meaning |

    |--------|---------|

    | `400` | Invalid request parameters |

    | `401` | Missing or invalid API key |

    | `404` | Resource not found (or doesn't belong to your organization) |

    | `429` | Rate limit exceeded |

    | `500` | Internal server error |
  contact:
    name: 1club API Support
    email: support@1club.ai
servers:
  - url: https://api.1club.ai
    description: Production API
security:
  - customerApiAuth: []
tags: []
paths:
  /v1/platform/revenue-accounts:
    get:
      tags:
        - Revenue Accounts
      summary: List revenue accounts
      description: >
        Returns the organization's chart of accounts, ordered by code. This is
        how a `revenueAccountId` is resolved before creating or updating a
        membership plan or a product - a sale of that item then posts to the
        account named here.


        Adding or renaming an account changes how every future sale is reported
        and what the club's accountant reconciles against, so the writes are
        gated on `revenue-accounts:write`, which nothing else grants. There is
        no delete: every historical row pointing at an account would be
        stranded, so an account is taken out of use with `isActive: false`.


        Retired accounts are included, flagged with `isActive: false`: an
        existing plan or product may still point at one, so the id has to stay
        explicable. Do not attach one to something new.


        Readable with any scope that carries a revenue account id: the `plans`,
        `products`, `classes`, `areas` and `instructors` scopes (read *and*
        write - they are granted independently), plus `transactions:read` and
        `revenue-accounts:write`. Every one of those resources either reports
        `revenueAccountId` or accepts it, so requiring one scope in particular
        would leave a key able to set an account it cannot look up. There is no
        `revenue-accounts:read`.


        Leaving `revenueAccountId` unset is a valid choice: the sale then posts
        to whichever account the organization has marked `isDefault`, resolved
        at the time of the sale rather than frozen onto the item.
      responses:
        '200':
          description: Every revenue account, ordered by code
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PlatformRevenueAccount'
        '401':
          $ref: '#/components/responses/PlatformUnauthorized'
        '403':
          description: API key holds no scope that carries a revenue account id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '429':
          $ref: '#/components/responses/PlatformRateLimited'
      security:
        - customerApiAuth: []
components:
  schemas:
    PlatformRevenueAccount:
      type: object
      description: >-
        One account in the organization's chart of accounts. Reference the `id`
        as `revenueAccountId` on a membership plan, a product, a class type, an
        area type or an instructor type to decide where its sales post.
      properties:
        id:
          type: integer
        name:
          type: string
        code:
          type: string
          description: >-
            The chart-of-accounts code, which is how the club's bookkeeper names
            the account. Unique within the organization.
        description:
          type: string
          nullable: true
        isActive:
          type: boolean
          description: >-
            False for an account retired from the chart. Still valid on existing
            rows; do not attach it to something new. Never false on the default.
        isDefault:
          type: boolean
          description: >-
            Where a sale posts when nothing on the item names an account.
            Exactly one account holds it, and it is always active.
    PlatformError:
      type: object
      properties:
        error:
          type: string
  responses:
    PlatformUnauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
    PlatformRateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
  securitySchemes:
    customerApiAuth:
      type: http
      scheme: bearer
      description: >-
        Organization-scoped bearer credential: a customer API key
        (1club_sk_live_...) or an MCP OAuth access token.

````