> ## Documentation Index > Fetch the complete documentation index at: https://docs.payaza.africa/llms.txt > Use this file to discover all available pages before exploring further. # List Plans > This endpoint retrieves a paginated list of subscription plans that have been created by the merchant. ## OpenAPI ````yaml /openapi.json get /subscription/api/v1/subscription-plans?page={page}&size={size}&status={status} openapi: 3.0.1 info: title: Payaza Documentation version: 2.0.0 description: >- API reference for processing payments using Card, Bank Transfer, USSD, and QR Code methods. servers: - url: https://api.payaza.africa/live security: - ApiKeyAuth: [] - TenantID: [] - ProductID: [] tags: - name: Transfers description: >- Transfers are transactions made from your Payaza account to beneficiaries. Merchants can instantly transfer funds from their available balance. For every transfer, you need to specify the amount and the beneficiary’s details. You become eligible to make transfers after you have been verified. (you sign up, finish account activation and KYC verification). - name: Payaza Account description: >- This is our internal account that can be used to make payouts to other bank accounts, in single or in bulk. The Payaza account can also be used to receive settlements. It can also be used to track the transfer status of your transactions and check your balance instantly - name: Sub Accounts description: >- This enables you to establish Sub Payaza accounts for your customers. Each sub-account comes with an assigned static virtual account, facilitating direct funding for individual accounts. Furthermore, the Main Payaza account can directly initiate funding for each sub-account. These sub-accounts serve the purpose of managing unique account positions or balances and facilitating disbursements from these positions to specified beneficiaries. - name: EUR Accounts description: >- This endpoints enable you to create EUR subaccounts which can be used to make transfers as required . - name: Apple Pay and Google Pay description: >- Apple Pay and Google Pay give your customers a fast, familiar, and secure way to complete payments. Our APIs provide a gateway to provide these services to your users for a smooth payment experience. - name: Virtual Accounts description: >- Virtual Accounts are bank accounts that are created for a specific purpose and last for specified durations. Virtual accounts are issued by Payaza’s partner banks. Our virtual account APIs can be used to create virtual accounts and perform other tasks relevant to virtual accounts. Virtual accounts are created to foster easy payment collections for your business and platform. Static/Reserved Account: This virtual account is created by the merchant and remains valid indefinitely. It can be used multiple times and does not expire. Dynamic Account: This virtual account is generated for a specific transaction or purpose. Please note that dynamic virtual account remains valid for a temporary period of time or until a payment of the specified amount is received. Upon expiry, a merchant can generate another one for a different purpose. - name: Card Collection description: >- The Card Collection APIs can be used to make card transactions, refund transactions that have been performed, check the status of a transaction and so much more. - name: Card Tokenisation description: >- The Card Tokenisation APIs are used to create card tokens, charge cards using tokens, retrieve all tokens created by a merchant account and deleting any card token as desired. - name: Refunds And Chargebacks description: >- The Refunds and Chargeback APIs are used to initiate refunds, view your refund and chargeback history and so much more. - name: Branches description: >- The Refunds and Chargeback APIs are used to initiate refunds, view your refund and chargeback history and so much more. - name: Auth-Capture-Void description: >- The Auth-Capture-Void APIs provide a two-phase payment process where transactions are first authorized, then captured or voided. This allows merchants to hold funds and complete the transaction in the future. - name: Momo and ZAR Collections description: APIs for MoMo, ZAR and XOF collections. - name: Check Transaction Status(Merchant Reference) description: >- This endpoint is used to check the transaction status of a transaction using the Merchant Reference.. paths: /subscription/api/v1/subscription-plans?page={page}&size={size}&status={status}: get: tags: - Subscription Plans summary: List Plans description: >- This endpoint retrieves a paginated list of subscription plans that have been created by the merchant. parameters: - name: page in: path required: true schema: type: integer description: The page number to be retrieved. - name: size in: path required: true schema: type: integer description: The number of records per page. - name: status in: path required: false schema: type: string description: Filter plans by status (**ACTIVE** or **ARCHIVED**). responses: '200': description: Payment successful content: application/json: schema: $ref: '#/components/schemas/listSubscriptionPlansResponse' examples: List Subscription Plans: summary: List Subscription Plans value: success: true message: Success data: content: - id: 69 name: Basic Monthly (B) description: Basic tier billed monthly amount: 100 currency: NGN interval: MONTHLY intervalCount: 1 trialPeriodDays: 2 billingLimit: 1 status: ACTIVE planCode: PLN_821DCFD billingDaysOfWeek: null metadata: null createdAt: '2026-07-08T17:17:14.173361' updatedAt: '2026-07-08T17:17:14.173362' pageable: sort: unsorted: false sorted: true empty: false pageNumber: 0 pageSize: 1 offset: 0 paged: true unpaged: false totalPages: 4 totalElements: 4 last: false numberOfElements: 1 size: 1 number: 0 sort: unsorted: false sorted: true empty: false first: true empty: false security: - ApiKeyAuth: - Payaza {{Public API Key In Base64}} components: schemas: listSubscriptionPlansResponse: title: List Subscription Plans type: object properties: success: type: boolean description: Indicates if the request was successful. example: true message: type: string description: Descriptive message regarding the operation. example: Success data: type: object description: The payload containing the paginated list of plans. properties: content: type: array description: The list of plan records. items: type: object properties: id: type: integer description: Unique internal identifier for the plan. example: 69 name: type: string description: The name of the subscription plan. example: Basic Monthly (B) description: type: string description: >- A brief overview or summary explaining what the plan offer entails. example: Basic tier billed monthly amount: type: number description: The price of the plan. example: 100 currency: type: string description: The 3-letter ISO currency code for the billing. example: NGN interval: type: string description: The frequency of the billing cycle (e.g., MONTHLY). example: MONTHLY intervalCount: type: integer description: The number of intervals between subscription billings. example: 1 trialPeriodDays: type: integer description: The number of free trial days given to subscribers. example: 2 billingLimit: type: integer description: >- The maximum number of times a subscriber can be charged on this plan. example: 1 status: type: string description: The operational status of the plan. example: ACTIVE planCode: type: string description: >- The unique, system-generated code used to identify this plan. example: PLN_821DCFD billingDaysOfWeek: type: array nullable: true description: >- Specific days of the week scheduled for billing, if applicable. items: type: string example: null metadata: type: object nullable: true description: Key-value pairs for storing additional custom information. example: null createdAt: type: string format: date-time description: Timestamp indicating exactly when the plan was created. example: '2026-07-08T17:17:14.173361' updatedAt: type: string format: date-time description: >- Timestamp indicating when the plan record was last updated. example: '2026-07-08T17:17:14.173362' pageable: type: object description: Pagination configuration and structural metadata. properties: sort: type: object properties: unsorted: type: boolean example: false sorted: type: boolean example: true empty: type: boolean example: false pageNumber: type: integer description: The current page index. example: 0 pageSize: type: integer description: The number of records per page. example: 1 offset: type: integer description: The record offset for pagination. example: 0 paged: type: boolean example: true unpaged: type: boolean example: false totalPages: type: integer description: The total number of pages available. example: 4 totalElements: type: integer description: The total number of matching records available across all pages. example: 4 last: type: boolean description: Indicates if the current page is the last page. example: false numberOfElements: type: integer description: The number of elements on the current page. example: 1 size: type: integer description: The configured size limit for the page payload. example: 1 number: type: integer description: The current page number identifier. example: 0 sort: type: object description: Sorting status metadata of the list results. properties: unsorted: type: boolean example: false sorted: type: boolean example: true empty: type: boolean example: false first: type: boolean description: Indicates if the current page is the first page. example: true empty: type: boolean description: Indicates if the content list payload returned completely empty. example: false securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: Payaza {{Public API Key in Base 64}} TenantID: type: apiKey in: header name: X-TenantID description: live or test ProductID: type: apiKey in: header name: X-ProductID description: 'default value is ‟app” ' ````