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

# List plans



## OpenAPI

````yaml GET /plans/
openapi: 3.0.3
info:
  title: Piriod API
  version: 1.0.0
  description: >
    Piriod API for billing, payments, procurement and collections.


    All requests require:

    - `Authorization: Token <api_token>` header.

    - `x-simple-workspace: <workspace_id>` header (the account/workspace
    identifier).

    - Optionally `x-piriod-test-mode: true` to operate against test-mode data.


    See the Documentation tab for getting started, integration flows,
    authentication,

    error handling and pagination/filtering guides.
servers:
  - url: https://api.piriod.com
    description: Production
security:
  - TokenAuth: []
paths:
  /plans/:
    get:
      tags:
        - Billing
      summary: List plans
      parameters:
        - $ref: '#/components/parameters/WorkspaceHeader'
        - $ref: '#/components/parameters/TestModeHeader'
        - $ref: '#/components/parameters/PageQuery'
        - $ref: '#/components/parameters/PageSizeQuery'
        - $ref: '#/components/parameters/OrderingQuery'
        - name: product
          in: query
          schema:
            type: string
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - archived
      responses:
        '200':
          description: Paginated plan list.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Paginated'
                  - type: object
                    properties:
                      results:
                        type: array
                        items:
                          $ref: '#/components/schemas/Plan'
components:
  parameters:
    WorkspaceHeader:
      name: x-simple-workspace
      in: header
      required: true
      schema:
        type: string
      description: Workspace (account) identifier. Required for every request.
      example: acc_01H8XYZ123ABC
    TestModeHeader:
      name: x-piriod-test-mode
      in: header
      required: false
      schema:
        type: boolean
        default: false
      description: Whether to operate against test-mode data. Defaults to `false`.
    PageQuery:
      name: page
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        default: 1
      description: Page number to retrieve (1-indexed).
    PageSizeQuery:
      name: page_size
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      description: Number of items per page.
    OrderingQuery:
      name: ordering
      in: query
      required: false
      schema:
        type: string
      description: |
        Field to sort results by. Prefix with `-` for descending order
        (e.g. `-created`).
  schemas:
    Paginated:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          description: Total number of items matching the filter.
          example: 142
        next:
          type: string
          format: uri
          nullable: true
          description: URL of the next page, or `null` if last page.
        previous:
          type: string
          format: uri
          nullable: true
          description: URL of the previous page, or `null` if first page.
        results:
          type: array
          items: {}
          description: The items in the current page.
    Plan:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        product:
          type: string
          description: Product ID.
        sku:
          type: string
          maxLength: 32
          nullable: true
        name:
          type: string
          maxLength: 56
        description:
          type: string
          maxLength: 200
        frequency:
          type: string
          description: Frequency ID (e.g. `monthly`).
        currency:
          type: string
          description: ISO currency code.
        amount:
          type: number
        exempt:
          type: boolean
          default: false
        usage_scheme:
          type: string
          enum:
            - licensed
            - metered
          default: licensed
        usage_aggregation:
          type: string
          enum:
            - last_record
            - max
            - sum
          nullable: true
        tiers_mode:
          type: string
          enum:
            - package
            - volume
            - graduated
            - package_overage
            - unit
            - range
          nullable: true
          description: |
            Pricing mode for tiered plans. `unit` and `range` are deprecated
            aliases of `volume` and `package` respectively.
        tiers:
          type: array
          items:
            $ref: '#/components/schemas/PlanTier'
        unit_label:
          type: string
          maxLength: 4
          nullable: true
        status:
          type: string
          enum:
            - active
            - archived
          default: active
        archived:
          type: string
          format: date-time
          nullable: true
          readOnly: true
        created:
          type: string
          format: date-time
          readOnly: true
        updated:
          type: string
          format: date-time
          readOnly: true
      required:
        - product
        - name
        - description
        - frequency
        - currency
        - amount
    PlanTier:
      type: object
      properties:
        amount:
          type: number
        amount_scheme:
          type: string
          enum:
            - flat
            - per_unit
          default: flat
        quantity_from:
          type: integer
        quantity_to:
          type: integer
          nullable: true
        unit_scheme:
          type: string
          enum:
            - all_units
            - tier_units
            - overage
          nullable: true
      required:
        - amount
        - quantity_from
  securitySchemes:
    TokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: |
        Use header `Authorization: Token <api_token>`.
        API tokens are obtained from the Piriod dashboard.

````