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

# List Plans

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

This endpoint retrieves a paginated list of subscription plans that have been created by the merchant.

## Path parameters

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

## Response `200`

Payment successful

- ListSubscriptionPlansResponse
  - `success` boolean — Indicates if the request was successful.
  - `message` string — Descriptive message regarding the operation.
  - `data` object — The payload containing the paginated list of plans.
    - `content` object[] — The list of plan records.
      - `id` integer — Unique internal identifier for the plan.
      - `name` string — The name of the subscription plan.
      - `description` string — A brief overview or summary explaining what the plan offer entails.
      - `amount` number — The price of the plan.
      - `currency` string — The 3-letter ISO currency code for the billing.
      - `interval` string — The frequency of the billing cycle (e.g., MONTHLY).
      - `intervalCount` integer — The number of intervals between subscription billings.
      - `trialPeriodDays` integer — The number of free trial days given to subscribers.
      - `billingLimit` integer — The maximum number of times a subscriber can be charged on this plan.
      - `status` string — The operational status of the plan.
      - `planCode` string — The unique, system-generated code used to identify this plan.
      - `billingDaysOfWeek` string[], nullable — Specific days of the week scheduled for billing, if applicable.
      - `metadata` object, nullable — Key-value pairs for storing additional custom information.
      - `createdAt` string, date-time — Timestamp indicating exactly when the plan was created.
      - `updatedAt` string, date-time — Timestamp indicating when the plan record was last updated.
    - `pageable` object — Pagination configuration and structural metadata.
      - `sort` object
        - `unsorted` boolean
        - `sorted` boolean
        - `empty` boolean
      - `pageNumber` integer — The current page index.
      - `pageSize` integer — The number of records per page.
      - `offset` integer — The record offset for pagination.
      - `paged` boolean
      - `unpaged` boolean
    - `totalPages` integer — The total number of pages available.
    - `totalElements` integer — The total number of matching records available across all pages.
    - `last` boolean — Indicates if the current page is the last page.
    - `numberOfElements` integer — The number of elements on the current page.
    - `size` integer — The configured size limit for the page payload.
    - `number` integer — The current page number identifier.
    - `sort` object — Sorting status metadata of the list results.
      - `unsorted` boolean
      - `sorted` boolean
      - `empty` boolean
    - `first` boolean — Indicates if the current page is the first page.
    - `empty` boolean — Indicates if the content list payload returned completely empty.

---

[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)