> ## 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 subscriptions > The store's subscriptions, newest first, 25 a page. A subscription's `status` is `active`, `renewal_due` (its renewal is made and waits to be paid), `past_due` (the period ran out unpaid: it ends after the store's grace days), `paused`, `cancelling` (it ends when what was paid for runs out), `cancelled` or `expired`. `renewsWith` is the card kept for one paid through Stripe, NMI, Authorize.net, Tagada, Mollie, MONEI, Adyen or Square (`provider`, `name`, `label` once named, and `canChange`, whether its buyer may give another on Stripe's own page), and null for one renewed by email; `autoRenews` says whether its next renewal is charged to it by itself. `meta.figures` is what the dashboard shows over the list, `meta.attention` the past due ones, and `meta.plans` which options are sold as subscriptions. Needs the `subscriptions.read` permission (Read Subscriptions). ## OpenAPI ````yaml /api-reference/openapi.json get /stores/{storeId}/subscriptions 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}/subscriptions: get: tags: - Subscriptions summary: List subscriptions description: >- The store's subscriptions, newest first, 25 a page. A subscription's `status` is `active`, `renewal_due` (its renewal is made and waits to be paid), `past_due` (the period ran out unpaid: it ends after the store's grace days), `paused`, `cancelling` (it ends when what was paid for runs out), `cancelled` or `expired`. `renewsWith` is the card kept for one paid through Stripe, NMI, Authorize.net, Tagada, Mollie, MONEI, Adyen or Square (`provider`, `name`, `label` once named, and `canChange`, whether its buyer may give another on Stripe's own page), and null for one renewed by email; `autoRenews` says whether its next renewal is charged to it by itself. `meta.figures` is what the dashboard shows over the list, `meta.attention` the past due ones, and `meta.plans` which options are sold as subscriptions. Needs the `subscriptions.read` permission (Read Subscriptions). operationId: subscriptions.list 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 - name: page in: query required: false description: Which page of the list. The first is 1. schema: type: integer default: 1 - name: show in: query required: false description: >- Only these: running and not cancelling, past due, paused, cancelling, or ended (cancelled and expired). schema: type: string enum: - all - active - attention - paused - cancelling - ended default: all - name: variant in: query required: false description: Only subscriptions to this option, by its ID. schema: type: string - name: search in: query required: false description: Part of a buyer's email. 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: id: type: string email: type: string customerId: nullable: true productId: type: string variantId: type: string productName: type: string variantName: type: string quantity: type: integer price: type: number currency: type: string every: type: integer unit: type: string status: type: string periodEnd: type: string graceEnd: nullable: true renewalOrderId: nullable: true renewalUrl: nullable: true firstOrderId: type: string cycles: type: integer remindedAt: nullable: true endedAt: nullable: true revoked: type: boolean pausedAt: nullable: true resumeAt: nullable: true pausedBy: nullable: true renewsWith: nullable: true autoRenews: type: boolean chargeTried: type: integer chargeNextAt: nullable: true createdAt: type: string pages: type: integer total: type: integer meta: type: object properties: page: type: integer figures: type: object properties: active: type: integer new: type: integer monthly: type: number renewing: type: object properties: count: type: integer total: type: integer attention: type: integer paused: type: integer attention: type: - array - object plans: 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 example: success: true message: null code: null data: - id: d5b2ae58-5363-4806-bcaf-7fc939e2c948 email: grace@example.com customerId: null productId: f463e265-097a-4235-bc2f-5239b19a9874 variantId: 00e1d395-9ba2-4db3-900a-cb5e2811a2a9 productName: Northwind Pro variantName: 1 month quantity: 1 price: 9.99 currency: USD every: 1 unit: month status: active periodEnd: '2026-11-22T16:20:19Z' graceEnd: null renewalOrderId: null renewalUrl: null firstOrderId: bc44febe-0f25-4076-92eb-03a5045a57e7 cycles: 1 remindedAt: null endedAt: null revoked: false pausedAt: null resumeAt: null pausedBy: null renewsWith: null autoRenews: false chargeTried: 0 chargeNextAt: null createdAt: '2026-10-22T16:20:19Z' pages: 1 total: 1 meta: page: 1 figures: active: 1 new: 1 monthly: 9.99 renewing: count: 0 total: 0 attention: 0 paused: 0 attention: [] plans: - 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: 1 automatic: 0 '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 page = await shoply.subscriptions.list(); // Or every row of every page: for await (const row of shoply.subscriptions.list()) { console.log(row); } - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $page = $shoply->subscriptions->list(); // Or every row of every page: foreach ($shoply->subscriptions->list() as $row) { print_r($row); } - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY page = client.subscriptions.list() # Or every row of every page: for row in client.subscriptions.list(): print(row) 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.