> ## 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 transactions for the organization

> Returns transactions for the organization associated with the API token, filtered by transaction creation time to a window of at most 24 hours and ordered by `createdAt` descending. When `startDate` and `endDate` are omitted, the window defaults to the last 24 hours (`endDate = now`, `startDate = now - 24h`). When only one of the two is provided, the other is derived from the 24-hour window. Transactions with `amount = 0` are excluded. Requires the `transactions:read` scope.




## OpenAPI

````yaml /openapi-platform.json get /v1/platform/transactions
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.


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

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

    | `403` | API key is missing the required scope |

    | `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:
  - name: Classes
    description: Browse class schedules, pricing, and availability.
  - name: Content
    description: Read published content (FAQs, posts, documents, blocks).
  - name: Clubs
    description: Look up club details by slug.
  - name: Transactions
    description: List and inspect billing transactions.
  - name: Bookings
  - name: Areas
paths:
  /v1/platform/transactions:
    get:
      tags:
        - Transactions
      summary: List transactions for the organization
      description: >
        Returns transactions for the organization associated with the API token,
        filtered by transaction creation time to a window of at most 24 hours
        and ordered by `createdAt` descending. When `startDate` and `endDate`
        are omitted, the window defaults to the last 24 hours (`endDate = now`,
        `startDate = now - 24h`). When only one of the two is provided, the
        other is derived from the 24-hour window. Transactions with `amount = 0`
        are excluded. Requires the `transactions:read` scope.
      parameters:
        - in: query
          name: startDate
          schema:
            type: string
            format: date-time
          description: >-
            Inclusive lower bound on transaction `createdAt`. Defaults to
            `endDate - 24h`.
        - in: query
          name: endDate
          schema:
            type: string
            format: date-time
          description: Inclusive upper bound on transaction `createdAt`. Defaults to `now`.
        - in: query
          name: paymentStatus
          schema:
            type: string
            enum:
              - pending
              - paid
              - void
              - failed
              - settled
              - overdue
              - partially_paid
              - refunded
              - cancelled
          description: Filter by payment status. When omitted, all statuses are returned.
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 100
          description: Maximum number of transactions to return.
        - in: query
          name: offset
          schema:
            type: integer
            minimum: 0
            default: 0
          description: Number of transactions to skip.
      responses:
        '200':
          description: List of transactions
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlatformTransaction'
        '400':
          description: Invalid query parameters (e.g. malformed date, window > 24h)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '403':
          description: API key is missing the required `transactions:read` scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
      security:
        - customerApiAuth: []
components:
  schemas:
    PlatformTransaction:
      type: object
      description: >-
        A billing transaction with amounts, payment status, and links to the
        originating booking or membership.
      properties:
        id:
          type: integer
        description:
          type: string
          nullable: true
        transactionType:
          type: string
          nullable: true
          description: >-
            TransactionType enum value (e.g. booking_creation,
            membership_creation, product_sale, membership_recurrence, etc.).
        bookingId:
          type: integer
          nullable: true
        membershipId:
          type: integer
          nullable: true
        createdAt:
          type: string
          format: date-time
        date:
          type: string
          format: date-time
        paymentStatus:
          type: string
          enum:
            - pending
            - paid
            - void
            - failed
            - settled
            - overdue
            - partially_paid
            - refunded
            - cancelled
        amount:
          type: number
          format: decimal
          description: >-
            Pre-tax amount. Serialized as a decimal string on the wire (e.g.
            "25.00") to preserve precision - parse rather than relying on JSON
            number behavior.
        taxAmount:
          type: number
          format: decimal
          description: >-
            Tax portion. Serialized as a decimal string on the wire to preserve
            precision.
        totalAmount:
          type: number
          format: decimal
          description: >-
            Total billed amount (amount + taxAmount). Serialized as a decimal
            string on the wire to preserve precision.
    PlatformError:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    customerApiAuth:
      type: http
      scheme: bearer
      description: Customer API key obtained from the admin portal (e.g. 1club_sk_live_...)

````