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

# List subscription plans

> Which of the store's options are sold as subscriptions, each with how often it renews and how many subscriptions to it are running. An option on this list is sold only as a subscription, and bought on its own.

Needs the `subscriptions.read` permission (Read Subscriptions).



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/subscription-plans
openapi: 3.1.0
info:
  title: Shoply API
  version: '1'
  description: >-
    Everything a store's own server can do with a secret API key: its catalogue,
    orders, customers, marketing, finance and the rest of what the dashboard
    does. And the Customer API, which a buyer's own device asks with a token of
    theirs.
servers:
  - url: https://api.shoply.gg/v1
security:
  - apiKey: []
tags:
  - name: API key
  - name: Store
  - name: Domain
  - name: Payment methods
  - name: Analytics
  - name: Storefronts
  - name: Storefront code
  - name: Payment Routing
  - name: Custom payment methods
  - name: Products
  - name: Product pictures
  - name: Stock
  - name: Categories
  - name: Upsells
  - name: Subscriptions
  - name: Orders
  - name: Invoices
  - name: Reviews
  - name: Coupons
  - name: Coupon categories
  - name: Coupon pop-up
  - name: Sales
  - name: Blog
  - name: Search settings
  - name: Redirects
  - name: Sitemap
  - name: Cart Recovery
  - name: Email Marketing
  - name: Email Templates
  - name: Customers
  - name: Affiliates
  - name: Support Tickets
  - name: Blacklist
  - name: Fraud protection
  - name: Disputes
  - name: Finance
  - name: Tax
  - name: Expenses
  - name: Expense setup
  - name: API requests
  - name: Webhook endpoints
  - name: Webhook deliveries
  - name: Customer API
paths:
  /stores/{storeId}/subscription-plans:
    get:
      tags:
        - Subscriptions
      summary: List subscription plans
      description: >-
        Which of the store's options are sold as subscriptions, each with how
        often it renews and how many subscriptions to it are running. An option
        on this list is sold only as a subscription, and bought on its own.


        Needs the `subscriptions.read` permission (Read Subscriptions).
      operationId: subscriptions.plans
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID. A key reaches the store it was made in: `GET /key`
            answers which.
          schema:
            type: string
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        variantId:
                          type: string
                        productId:
                          type: string
                        productName:
                          type: string
                        variantName:
                          type: string
                        price:
                          type: number
                        every:
                          type: integer
                        unit:
                          type: string
                        running:
                          type: integer
                        automatic:
                          type: integer
                  meta:
                    type: object
                    properties:
                      settings:
                        type: object
                        properties:
                          cancelOn:
                            type: boolean
                          cancelMode:
                            type: string
                          undoOn:
                            type: boolean
                          pauseOn:
                            type: boolean
                          pauseDays:
                            type: integer
                          pausesAYear:
                            type: integer
                          remindersOn:
                            type: boolean
                          reminderDays:
                            type: array
                            items:
                              type: integer
                          graceDays:
                            type: integer
                          revokeOn:
                            type: boolean
                          autoOn:
                            type: boolean
                          cardChangeOn:
                            type: boolean
                          chargeTries:
                            type: integer
                      limits:
                        type: object
                        properties:
                          maxPlans:
                            type: integer
                          minDays:
                            type: integer
                          maxDays:
                            type: integer
                          maxReminders:
                            type: integer
                          maxReminderDay:
                            type: integer
                          maxGraceDays:
                            type: integer
                          maxPauseDays:
                            type: integer
                          maxPausesAYear:
                            type: integer
                          maxChargeTries:
                            type: integer
              example:
                success: true
                message: null
                code: null
                data:
                  - variantId: 00e1d395-9ba2-4db3-900a-cb5e2811a2a9
                    productId: f463e265-097a-4235-bc2f-5239b19a9874
                    productName: Northwind Pro
                    variantName: 1 month
                    price: 9.99
                    every: 1
                    unit: month
                    running: 0
                    automatic: 0
                meta:
                  settings:
                    cancelOn: true
                    cancelMode: end
                    undoOn: true
                    pauseOn: true
                    pauseDays: 30
                    pausesAYear: 2
                    remindersOn: true
                    reminderDays:
                      - 7
                      - 3
                    graceDays: 3
                    revokeOn: true
                    autoOn: true
                    cardChangeOn: true
                    chargeTries: 3
                  limits:
                    maxPlans: 200
                    minDays: 7
                    maxDays: 365
                    maxReminders: 5
                    maxReminderDay: 30
                    maxGraceDays: 30
                    maxPauseDays: 365
                    maxPausesAYear: 12
                    maxChargeTries: 5
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooMany'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import Shoply from "@shoplygg/node";

            const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

            const result = await shoply.subscriptions.plans();
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $result = $shoply->subscriptions->plans();
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.subscriptions.plans()
components:
  responses:
    NoKey:
      description: >-
        No API key was sent, or the one sent is not a live key:
        `api_key_required`, `invalid_api_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotAllowed:
      description: >-
        The key is real and may not do this: `missing_scope` (with
        `requiredScope`), `ip_not_allowed`, `account_unavailable`, or
        `dashboard_only` for something only a person in the dashboard may do.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotFound:
      description: >-
        There is no such thing in this store: `not_found`. A store that is not
        the key's own is answered the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    TooMany:
      description: >-
        The key has used up its budget for now: `rate_limited`. `Retry-After`
        says how many seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
  schemas:
    Refusal:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: What is wrong, in words for a person.
        code:
          type: string
          description: What is wrong, as a word that does not change.
        data:
          nullable: true
        errors:
          type: object
          description: >-
            For `validation_failed`: what is wrong with each field, by the
            field's name.
          additionalProperties:
            type: string
      required:
        - success
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A secret API key, made under Developers in the dashboard:
        `Authorization: Bearer shoply_sk_...`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.