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

# Create a membership plan

> Creates a membership plan for the organization. Supports the `Idempotency-Key` header.



## OpenAPI

````yaml /openapi-platform.json post /v1/platform/plans
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:
    post:
      tags:
        - Plans
      summary: Create a membership plan
      description: >-
        Creates a membership plan for the organization. Supports the
        `Idempotency-Key` header.
      parameters:
        - in: header
          name: Idempotency-Key
          schema:
            type: string
            maxLength: 255
          description: >-
            Retry-safe key; a repeat of the same request replays the first
            response
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformPlanCreate'
      responses:
        '201':
          description: Plan created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformPlan'
        '403':
          description: Missing `plans:write` scope
      security:
        - customerApiAuth: []
components:
  schemas:
    PlatformPlanCreate:
      type: object
      required:
        - name
        - price
      properties:
        name:
          type: string
          maxLength: 120
        description:
          type: string
          nullable: true
          maxLength: 5000
        clubId:
          type: integer
          nullable: true
        price:
          type: number
          minimum: 0
        signupFee:
          type: number
          minimum: 0
        billingFrequency:
          type: string
          enum:
            - one_time
            - weekly
            - monthly
            - quarterly
            - annually
            - custom
        customPeriod:
          type: integer
          nullable: true
          minimum: 1
        customPeriodUnit:
          type: string
          nullable: true
          enum:
            - days
            - weeks
            - months
        isActive:
          type: boolean
        maxUses:
          type: number
          nullable: true
          minimum: 0
        sessionUnit:
          type: string
          nullable: true
          enum:
            - booking
            - hour
        validityPeriod:
          type: integer
          nullable: true
          minimum: 1
        autoRenews:
          type: boolean
        renewalDaysInAdvance:
          type: integer
          minimum: 0
          maximum: 60
        requirePaymentUpfront:
          type: boolean
        sports:
          type: array
          items:
            type: string
          maxItems: 50
        features:
          type: array
          items:
            type: string
          maxItems: 100
        visibility:
          type: string
          enum:
            - Private
            - Member_only
            - Public
        validFor:
          type: object
          properties:
            scopes:
              type: array
              items:
                type: string
                enum:
                  - classes
                  - areas
                  - instructors
            classTypes:
              type: array
              items:
                type: integer
            areaTypes:
              type: array
              items:
                type: integer
            instructorTypes:
              type: array
              items:
                type: integer
    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
  securitySchemes:
    customerApiAuth:
      type: http
      scheme: bearer
      description: >-
        Organization-scoped bearer credential: a customer API key
        (1club_sk_live_...) or an MCP OAuth access token.

````