> ## 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 subscriptions ## OpenAPI ````yaml https://app.dimepayments.com/openapi.yaml get /api/subscription/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/list: get: tags: - Subscriptions management summary: List subscriptions operationId: listSubscriptions parameters: [] requestBody: required: false content: application/json: schema: type: object properties: data: type: object description: '' example: [] properties: sid: type: integer description: The merchant SID. example: 12345 required: - sid filters: type: object description: '' example: [] properties: status: type: string description: >- Filter by status (Active, Failed, Paused, Cancelled, Ended). example: Active customer_uuid: type: string description: Filter to a single customer's subscriptions. example: 9c1e6a7e-1f2b-4c3d-8e9f-0a1b2c3d4e5f responses: '200': description: '' content: application/json: schema: type: object example: data: - id: null subscription_plan_id: 97 plan_name: Premium Plan 24492 amount: '0.00' recurrence_schedule: Monthly start_date: '2026-07-20T04:00:00.000000Z' end_date: null last_run_date: null last_run_status: null last_run_failed_count: 0 next_run_date: '2026-09-20T04:00:00.000000Z' status: Active paused_until_date: null cancelled_at: null cancelled_by: null customer_uuid: f41b4913-eb14-47d8-8c65-6e3e39126ecf error: null payment_method: id: 5992 type: cc last_four: '3642' expiration: 08/2030 - id: null subscription_plan_id: 98 plan_name: Monthly Membership 88481 amount: '0.00' recurrence_schedule: Monthly start_date: '2026-07-20T04:00:00.000000Z' end_date: null last_run_date: null last_run_status: null last_run_failed_count: 0 next_run_date: '2026-09-20T04:00:00.000000Z' status: Active paused_until_date: null cancelled_at: null cancelled_by: null customer_uuid: d85cf521-1556-4bf4-af4e-c1eb78b9648d error: null payment_method: id: 5993 type: cc last_four: '5053' expiration: 08/2030 links: prev: null next: null meta: path: / per_page: 500 next_cursor: null prev_cursor: null properties: data: type: array example: - id: null subscription_plan_id: 97 plan_name: Premium Plan 24492 amount: '0.00' recurrence_schedule: Monthly start_date: '2026-07-20T04:00:00.000000Z' end_date: null last_run_date: null last_run_status: null last_run_failed_count: 0 next_run_date: '2026-09-20T04:00:00.000000Z' status: Active paused_until_date: null cancelled_at: null cancelled_by: null customer_uuid: f41b4913-eb14-47d8-8c65-6e3e39126ecf error: null payment_method: id: 5992 type: cc last_four: '3642' expiration: 08/2030 - id: null subscription_plan_id: 98 plan_name: Monthly Membership 88481 amount: '0.00' recurrence_schedule: Monthly start_date: '2026-07-20T04:00:00.000000Z' end_date: null last_run_date: null last_run_status: null last_run_failed_count: 0 next_run_date: '2026-09-20T04:00:00.000000Z' status: Active paused_until_date: null cancelled_at: null cancelled_by: null customer_uuid: d85cf521-1556-4bf4-af4e-c1eb78b9648d error: null payment_method: id: 5993 type: cc last_four: '5053' expiration: 08/2030 items: type: object properties: id: type: string example: null nullable: true subscription_plan_id: type: integer example: 97 plan_name: type: string example: Premium Plan 24492 amount: type: string example: '0.00' recurrence_schedule: type: string example: Monthly start_date: type: string example: '2026-07-20T04:00:00.000000Z' end_date: type: string example: null nullable: true last_run_date: type: string example: null nullable: true last_run_status: type: string example: null nullable: true last_run_failed_count: type: integer example: 0 next_run_date: type: string example: '2026-09-20T04:00:00.000000Z' status: type: string example: Active paused_until_date: type: string example: null nullable: true cancelled_at: type: string example: null nullable: true cancelled_by: type: string example: null nullable: true customer_uuid: type: string example: f41b4913-eb14-47d8-8c65-6e3e39126ecf error: type: string example: null nullable: true payment_method: type: object properties: id: type: integer example: 5992 type: type: string example: cc last_four: type: string example: '3642' expiration: type: string example: 08/2030 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 Generate API token under your profile in top right. ````