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

# Get a membership plan

> Returns a single plan, including what a membership on it costs and what it grants. Retired plans resolve here too - hiding them is the list's job, and a caller that just retired a plan still needs to read it back or undo it.




## OpenAPI

````yaml /openapi-platform.json get /v1/platform/plans/{id}
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/plans/{id}:
    get:
      tags:
        - Plans
      summary: Get a membership plan
      description: >
        Returns a single plan, including what a membership on it costs and what
        it grants. Retired plans resolve here too - hiding them is the list's
        job, and a caller that just retired a plan still needs to read it back
        or undo it.
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: The plan
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformPlan'
        '400':
          $ref: '#/components/responses/PlatformBadRequest'
        '401':
          $ref: '#/components/responses/PlatformUnauthorized'
        '403':
          description: API key is missing the required `plans:read` scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '404':
          $ref: '#/components/responses/PlatformNotFound'
        '429':
          $ref: '#/components/responses/PlatformRateLimited'
      security:
        - customerApiAuth: []
components:
  schemas:
    PlatformPlan:
      type: object
      description: >-
        A membership plan. It carries its own price, joining fee, billing
        frequency and session allowance, so creating a membership only has to
        name the plan and the customer.
      properties:
        planId:
          type: integer
        name:
          type: string
        description:
          type: string
          nullable: true
        clubId:
          type: integer
          nullable: true
          description: Club the plan is limited to; null when organization-wide.
        price:
          type: number
          description: Charged each billing period.
        signupFee:
          type: number
          description: Charged once when the membership starts, on top of the price.
        billingFrequency:
          type: string
        isActive:
          type: boolean
          description: False for a retired plan that is no longer sold.
        maxUses:
          type: number
          nullable: true
          description: Session allowance a membership gets; null when unlimited.
        sessionUnit:
          type: string
          nullable: true
          description: What a use is counted in - a booking or an hour.
        validityPeriod:
          type: integer
          nullable: true
          description: Days the membership stays valid, when time-limited.
        autoRenews:
          type: boolean
          description: Whether a membership on this plan renews by default.
        renewalDaysInAdvance:
          type: integer
        requirePaymentUpfront:
          type: boolean
        customPeriod:
          type: integer
          nullable: true
        customPeriodUnit:
          type: string
          nullable: true
        features:
          type: array
          items:
            type: string
        visibility:
          type: string
          enum:
            - Private
            - Member_only
            - Public
        validFor:
          type: object
          additionalProperties: true
          description: >-
            Booking resource scopes and optional type filters covered by the
            plan.
        sports:
          type: array
          items:
            type: string
    PlatformError:
      type: object
      properties:
        error:
          type: string
  responses:
    PlatformBadRequest:
      description: Invalid request (bad parameters, or a body that fails validation)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
    PlatformUnauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
    PlatformNotFound:
      description: The requested resource does not exist in this organization
      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.

````