---
title: "List Subscription"
method: GET
path: "/subscription/api/v1/subscriptions?page={page}&size={size}&status={status}"
tags: ["Subscription Reads"]
---

# List Subscription

`GET /subscription/api/v1/subscriptions?page={page}&size={size}&status={status}`

It retrieves a paginated list of subscriptions belonging to the authenticated merchant.

## Query parameters

- `page` integer, required
- `size` integer, required
- `status` string, required

## Response `200`

Request Successful

- ListSubscriptionResponse
  - `success` boolean — Indicates if the request was successful.
  - `message` string — Descriptive message regarding the operation.
  - `data` object — The payload containing the paginated list of subscription records paired with their respective plans.
    - `content` object[] — The array of coupled subscription and plan details.
      - `subscription` object — Lifecycle and routing information for the specific subscription record.
        - `id` integer — Unique internal identifier for the subscription.
        - `customerId` string — Unique reference identifier assigned to the customer layer.
        - `customerEmail` string, email — The email address of the customer.
        - `firstName` string, nullable
        - `lastName` string, nullable
        - `customerAuthorizedAt` string, date-time, nullable
        - `status` string — The operational subscription lifecycle state (e.g., ACTIVE, CANCELLED, PAST_DUE).
        - `currentPeriodStart` string, date-time — Timestamp tracking when the current billing window opened.
        - `currentPeriodEnd` string, date-time — Timestamp tracking when the current billing window closes.
        - `nextChargeDate` string, date-time, nullable — The next scheduled auto-billing timestamp execution block. Null if cancelled.
        - `trialEndDate` string, date-time, nullable
        - `pauseResumesAt` string, date-time, nullable
        - `cancelAt` string, date-time, nullable
        - `pausedAt` string, date-time, nullable — Timestamp recording when the schedule was paused.
        - `cancelledAt` string, date-time, nullable — Timestamp recording absolute terminal termination updates.
        - `cancellationReason` string, nullable — Contextual reason string note explaining termination logging context.
        - `cardExpiryAlertSent` boolean
        - `connectionMode` string
        - `enrollmentReference` string — The core global billing token reference signature.
        - `enrollmentTxnReference` string
        - `chargeMode` string
        - `metadata` object, nullable
        - `createdAt` string, date-time
        - `updatedAt` string, date-time
        - `customerBearsFee` boolean
        - `enrollConfirmed` boolean
      - `plan` object — The base subscription product structure specifications mapping rule requirements.
        - `id` integer — Unique internal identifier for the plan.
        - `name` string — The name of the subscription plan.
        - `description` string, nullable — A brief overview explaining what the plan offer entails.
        - `amount` number — The pricing metric total value applied.
        - `currency` string — The 3-letter ISO code denoting currency context.
        - `interval` string — The frequency frequency setup configuration parameter context metrics.
        - `intervalCount` integer
        - `trialPeriodDays` integer
        - `billingLimit` integer, nullable
        - `status` string
        - `planCode` string — The unique system tracking key configuration mapping.
        - `billingDaysOfWeek` string[], nullable
        - `metadata` object, nullable
        - `createdAt` string, date-time
        - `updatedAt` string, date-time
    - `pageable` object — Pagination configuration block snapshot context properties.
      - `sort` object
        - `unsorted` boolean
        - `sorted` boolean
        - `empty` boolean
      - `pageNumber` integer
      - `pageSize` integer
      - `offset` integer
      - `paged` boolean
      - `unpaged` boolean
    - `totalElements` integer — The complete index count matching the search criteria globally.
    - `totalPages` integer — The total volume allocation calculation matching sizes requirements.
    - `last` boolean — Indicates if page iteration structure bounds finish terminal index loop conditions.
    - `numberOfElements` integer — Item total populated within the immediate array index block.
    - `first` boolean — Indicates if page frame calculation structural reference sits at space zero index.
    - `size` integer
    - `number` integer
    - `sort` object
      - `unsorted` boolean
      - `sorted` boolean
      - `empty` boolean
    - `empty` boolean

## Other responses

- `400` — Invalid request

---

[API](https://skmtc.net/payaza/apis/payaza-documentation.md) · [All operations](https://skmtc.net/payaza/apis/payaza-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payaza/payaza-documentation/revisions/1ecd4b94ff07/schema)