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

# List plans

> Returns the tenant's plans. **Active-only by default** — pass `include_archived=true` to include archived plans too.




## OpenAPI

````yaml GET /v1/plans
openapi: 3.0.3
info:
  title: Plinth API
  version: 0.9.0
  description: >
    Recurring billing for Nigerian SaaS — card charging, bank transfers via
    virtual accounts,

    proration, dunning, and recovery in one API.


    All amounts are in **kobo** (1/100th of a Naira). ₦5,000 = `500000`.
servers:
  - url: https://api.useplinth.com
    description: Production
  - url: http://localhost:7331
    description: Local development
security:
  - BearerAuth: []
tags:
  - name: Sandbox
    description: Create an isolated sandbox environment for testing. No auth required.
  - name: Customers
    description: Who you are billing. One customer can have multiple subscriptions.
  - name: Plans
    description: Plan groups and the plans within them. Customers subscribe to plans.
  - name: Subscriptions
    description: The recurring billing relationship between a customer and a plan.
  - name: Virtual Accounts
    description: Dedicated bank account numbers for customers who pay by transfer.
  - name: Invoices
    description: Created at each billing cycle. Tracks what a customer owes for a period.
  - name: Webhooks
    description: >-
      Register endpoints that receive signed, retried events. See Receiving
      webhooks.
  - name: Admin
    description: Test clock control, billing tick, and suspense resolution. Test-mode only.
paths:
  /v1/plans:
    get:
      tags:
        - Plans
      summary: List plans
      description: >
        Returns the tenant's plans. **Active-only by default** — pass
        `include_archived=true` to include archived plans too.
      operationId: list-plans
      parameters:
        - name: include_archived
          in: query
          required: false
          description: Include archived (inactive) plans in the result.
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: List of plans
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - list
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Plan'
components:
  schemas:
    Plan:
      type: object
      properties:
        object:
          type: string
          enum:
            - plan
        id:
          type: string
          example: pln_01JABC...
        plan_group_id:
          type: string
          example: pg_01JABC...
        name:
          type: string
          example: Pro
        amount_minor:
          type: string
          description: Amount in kobo as a string. ₦5,000 = "500000".
          example: '500000'
        interval:
          type: string
          enum:
            - day
            - week
            - month
            - year
          example: month
        interval_count:
          type: integer
          example: 1
        trial_period_days:
          type: integer
          example: 14
        lookup_key:
          type: string
          nullable: true
          description: >
            Stable, human-meaningful handle for the plan (e.g. "pro_monthly").
            Unique per tenant. Reference this instead of the UUID so your app
            doesn't hardcode environment-specific ids.
          example: pro_monthly
        active:
          type: boolean
          description: >
            `false` when the plan is archived — hidden from the default plan
            list and closed to new subscriptions. Existing subscribers keep
            billing.
          example: true
        created_at:
          type: string
          format: date-time
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >
        Use `sk_test_` keys for sandbox. Use `sk_live_` keys for production.
        Obtain your key from the dashboard.

````