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

# List subscription plans



## OpenAPI

````yaml https://app.dimepayments.com/openapi.yaml get /api/subscription-plan/list
openapi: 3.0.3
info:
  title: Dime Payments API Documentation
  description: >-
    A simple, basic API for managing Merchants through Dime Payments. JSON based
    REST API
  version: 1.0.0
servers:
  - url: https://app.dimepayments.com
security:
  - default: []
tags:
  - name: Merchant management
    description: ''
  - name: Transaction management
    description: >-

      APIs for managing transactions.  Depending on API KEY permissions, one
      should be able to

      charge credit cards, ACH, Google/Apple Pay wallets along with other
      functions.
  - name: Addresses
    description: |-

      APIs for managing customer addresses
  - name: Customer management
    description: >-

      APIs for managing customers.  Depending on API KEY permissions, one should
      be able to

      list, create, update, and delete customers along with several other
      customer specific requests.
  - name: Deposit management
    description: ''
  - name: Invoice management
    description: >-

      APIs for managing invoices. Depending on API KEY permissions, one should
      be

      able to list, create, update, delete, and send invoices, manage their line

      items, and manage recurring-invoice schedules. Every request is scoped to
      a

      single Merchant via the required `data.sid`.
  - name: Payment Method management
    description: >-

      APIs for managing payment methods associated with customers.  Depending on
      API KEY permissions, one should be able to

      list, show, create, update, and delete payment methods.
  - name: Recurring Payments management
    description: >-

      APIs for managing recurring payments.  Depending on API KEY permissions,
      one should be able to

      create, edit, pause, cancel along with other functions.
  - name: Subscription Plans management
    description: >-

      Merchant-facing API for subscription plans (recurring offerings customers

      subscribe to). The merchant is identified by `data.sid`; the token must
      carry

      the matching `subscription-plan:*` ability. Mirrors the recurring-payment
      and

      invoice API controllers.
  - name: Subscriptions management
    description: >-

      Merchant-facing API for individual customer subscriptions (enrollments in
      a

      plan). The merchant is identified by `data.sid`; the token must carry the

      matching `subscription:*` ability. Lifecycle transitions delegate to the

      {@see \App\Actions\Subscription} action classes so the matching
      `SUBSCRIPTION_*`

      webhook always fires. Mirrors the recurring-payment and subscription-plan
      API

      controllers.
  - name: Zapier
    description: >-

      APIs for use through Zapier.  Depending on API KEY permissions, one should
      be able to

      see customers and transactions data.
paths:
  /api/subscription-plan/list:
    get:
      tags:
        - Subscription Plans management
      summary: List subscription plans
      operationId: listSubscriptionPlans
      parameters: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  description: ''
                  example:
                    sid: 12345
                  properties:
                    sid:
                      type: integer
                      description: The merchant SID.
                      example: 12345
                    status:
                      type: string
                      description: Filter by status (draft, active, archived).
                      example: active
                  required:
                    - sid
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: null
                      name: Monthly Membership 54634
                      description: Qui commodi incidunt iure odit.
                      recurrence_schedule: Monthly
                      status: active
                      subtotal: 0
                      total: 0
                      token: LNsESrQKtBcnZP7NVQAs1b1Jc1Jbyooe8IRxvSby
                      public_url: >-
                        http://app.dimepayments.com/subscribe/LNsESrQKtBcnZP7NVQAs1b1Jc1Jbyooe8IRxvSby
                      allow_public: true
                      created_at: null
                      items: []
                    - id: null
                      name: Monthly Membership 35354
                      description: Ex voluptatem laboriosam praesentium quis adipisci.
                      recurrence_schedule: Monthly
                      status: active
                      subtotal: 0
                      total: 0
                      token: jtnGshtSR2wxA6OHFX6WH1Eu8uYjhNHVyN8f3hg3
                      public_url: >-
                        http://app.dimepayments.com/subscribe/jtnGshtSR2wxA6OHFX6WH1Eu8uYjhNHVyN8f3hg3
                      allow_public: true
                      created_at: null
                      items: []
                  links:
                    prev: null
                    next: null
                  meta:
                    path: /
                    per_page: 500
                    next_cursor: null
                    prev_cursor: null
                properties:
                  data:
                    type: array
                    example:
                      - id: null
                        name: Monthly Membership 54634
                        description: Qui commodi incidunt iure odit.
                        recurrence_schedule: Monthly
                        status: active
                        subtotal: 0
                        total: 0
                        token: LNsESrQKtBcnZP7NVQAs1b1Jc1Jbyooe8IRxvSby
                        public_url: >-
                          http://app.dimepayments.com/subscribe/LNsESrQKtBcnZP7NVQAs1b1Jc1Jbyooe8IRxvSby
                        allow_public: true
                        created_at: null
                        items: []
                      - id: null
                        name: Monthly Membership 35354
                        description: Ex voluptatem laboriosam praesentium quis adipisci.
                        recurrence_schedule: Monthly
                        status: active
                        subtotal: 0
                        total: 0
                        token: jtnGshtSR2wxA6OHFX6WH1Eu8uYjhNHVyN8f3hg3
                        public_url: >-
                          http://app.dimepayments.com/subscribe/jtnGshtSR2wxA6OHFX6WH1Eu8uYjhNHVyN8f3hg3
                        allow_public: true
                        created_at: null
                        items: []
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: null
                          nullable: true
                        name:
                          type: string
                          example: Monthly Membership 54634
                        description:
                          type: string
                          example: Qui commodi incidunt iure odit.
                        recurrence_schedule:
                          type: string
                          example: Monthly
                        status:
                          type: string
                          example: active
                        subtotal:
                          type: integer
                          example: 0
                        total:
                          type: integer
                          example: 0
                        token:
                          type: string
                          example: LNsESrQKtBcnZP7NVQAs1b1Jc1Jbyooe8IRxvSby
                        public_url:
                          type: string
                          example: >-
                            http://app.dimepayments.com/subscribe/LNsESrQKtBcnZP7NVQAs1b1Jc1Jbyooe8IRxvSby
                        allow_public:
                          type: boolean
                          example: true
                        created_at:
                          type: string
                          example: null
                          nullable: true
                        items:
                          type: array
                          example: []
                  links:
                    type: object
                    properties:
                      prev:
                        type: string
                        example: null
                        nullable: true
                      next:
                        type: string
                        example: null
                        nullable: true
                  meta:
                    type: object
                    properties:
                      path:
                        type: string
                        example: /
                      per_page:
                        type: integer
                        example: 500
                      next_cursor:
                        type: string
                        example: null
                        nullable: true
                      prev_cursor:
                        type: string
                        example: null
                        nullable: true
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: >-
        You can retrieve your token by visiting your dashboard and clicking
        <b>Generate API token under your profile in top right</b>.

````