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

# List plans

> Get the plans



## OpenAPI

````yaml get /plans
openapi: 3.0.1
info:
  title: BeyondWords REST API
  description: |-
    This is the documentation for the BeyondWords REST API.
              You can use this API to use BeyondWords programmatically.
              You can get your API Key and Project ID for each project in the Project settings tab in the BeyondWords
              <a href="https://dash.beyondwords.io/dashboard">dashboard</a>.
  version: 1.0.0
servers:
  - url: https://api.beyondwords.io/v1
security: []
paths:
  /plans:
    get:
      tags:
        - Plans
      summary: List
      description: Get the plans
      operationId: plans#index
      responses:
        '200':
          description: OK
          content:
            application/json:
              examples:
                example:
                  $ref: '#/components/examples/plansExample'
              schema:
                $ref: '#/components/schemas/plansModel'
components:
  examples:
    plansExample:
      summary: Plans
      value:
        - id: 1
          name: Pilot
          interval: month
          currency: usd
          amount: 100
          permissions: pilot
          custom: true
  schemas:
    plansModel:
      type: array
      items:
        $ref: '#/components/schemas/planModel'
    planModel:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        interval:
          type: string
        currency:
          type: string
        amount:
          type: integer
        permission:
          type: string
        custom:
          type: boolean
        overage_enabled:
          type: boolean
        overage_billing_threshold:
          type: integer
          nullable: true
        overage_price:
          type: integer
          nullable: true
        promotion_codes:
          type: array
          nullable: true
          items:
            type: object
            properties:
              type:
                type: string
              value:
                type: integer

````