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

# Get All Plans

> This retrieves and lists all subscription plans available on your integration.



## OpenAPI

````yaml openapi.json GET /plans
openapi: 3.1.0
info:
  title: Spotflow
  description: ''
  license:
    name: MIT
  version: 1.0.0
servers:
  - description: Production server
    url: https://api.spotflow.co/api/v1
security:
  - bearerAuth: []
paths:
  /plans:
    get:
      description: >-
        Retrieve details of all subscription plans available on your
        integration.
      operationId: SubsciptionsPlan
      parameters:
        - name: title
          in: query
          required: false
          description: >-
            The unique identifier of the plan whose subscriptions are to be
            retrieved.
          schema:
            type: string
        - name: internal-reference
          in: query
          required: false
          description: >-
            The unique identifier of the plan whose subscriptions are to be
            retrieved.
          schema:
            type: string
        - name: query
          in: query
          required: false
          description: ''
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: ''
          schema:
            type: string
        - name: from
          in: query
          required: false
          description: ''
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: ''
          schema:
            type: string
            format: date-time
        - name: page
          in: query
          required: false
          description: Page number for pagination (default is 0).
          schema:
            type: integer
            format: int32
            default: 0
        - name: size
          in: query
          required: false
          description: Number of items per page for pagination (default is 10).
          schema:
            type: integer
            format: int32
            default: 10
      responses:
        '200':
          description: A JSON array of subscription objects.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlansResponse'
        '400':
          description: Not Found - No subscriptions found for the given plan ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: Unauthorized - Invalid or missing authentication token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionError401'
components:
  schemas:
    PlansResponse:
      type: object
      description: Paginated list of plan details
      properties:
        content:
          type: array
          description: List of plan items
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                description: Unique identifier for the plan
              title:
                type: string
                description: Name or title of the plan
              frequency:
                type: string
                enum:
                  - DAILY
                  - WEEKLY
                  - MONTHLY
                  - '  QUARTERLY'
                  - BIANNUAL
                  - ANNUAL
                description: Billing frequency for the plan
              internalReference:
                type: string
                description: Internal reference code for the plan
              amount:
                type: number
                description: Amount to be charged per billing cycle
              currency:
                type: string
                description: Currency code for the plan (e.g. USD, NGN)
              status:
                type: string
                description: Current status of the plan (e.g. active, inactive)
              regions:
                type: array
                description: List of region codes or names where this plan is available
                items:
                  type: string
              subscribers:
                type: integer
                description: Number of users currently subscribed to this plan
              subscriptions:
                type: integer
                description: Total number of subscriptions created for this plan
              createdAt:
                type: string
                format: date-time
                description: Timestamp indicating when the plan was created
              trial:
                type: object
                description: Trial configuration for this plan
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Unique identifier for the trial
                  planId:
                    type: string
                    format: uuid
                    description: Associated plan ID for this trial
                  periodInDays:
                    type: integer
                    description: Duration of the trial period in days
                  pricingList:
                    type: array
                    description: Pricing details during the trial period
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - FLAT
                            - TIERED
                          description: Type of pricing applied
                        amount:
                          type: number
                          description: Amount charged during the trial
                        currency:
                          type: string
                          description: Currency code (e.g. NGN, USD)
                      required:
                        - type
                        - amount
                        - currency
                required:
                  - id
                  - planId
                  - periodInDays
              pricingOptions:
                type: array
                description: List of available pricing options for the plan
                items:
                  type: object
                  properties:
                    amount:
                      type: number
                      description: Amount for this pricing option
                    currency:
                      type: string
                      description: Currency code (e.g. NGN, USD)
                  required:
                    - amount
                    - currency
            required:
              - id
              - title
              - frequency
              - amount
              - currency
              - status
              - createdAt
        pageNumber:
          type: integer
          description: Current page number
        pageSize:
          type: integer
          description: Number of records per page
        totalElements:
          type: integer
          description: Total number of plan records
        totalPages:
          type: integer
          description: Total number of available pages
      required:
        - content
        - pageNumber
        - pageSize
        - totalElements
        - totalPages
    Error400:
      type: object
      properties:
        error:
          type: string
          example: Missing Parameter
        message:
          type: string
          example: missing_parameter
        status:
          type: integer
          format: float
          example: 400
    SubscriptionError401:
      type: object
      properties:
        code:
          type: string
          example: AUTH_ERROR
        message:
          type: string
          example: Authorization token is required.
        statusCode:
          type: integer
          format: float
          example: 401
        requestMarker:
          type: string
          format: uuid
      required:
        - status
        - statusCode
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````