> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kwikpaisa.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Fetch All Plans

***

## icon: calendar-days

# List Plans

Use the List Plans API to retrieve all subscription plans created under your KwikPaisa Neo Bank merchant account.

This API returns the available plan details, including the plan ID, name, description, amount, currency, billing frequency, total billing cycles, status, and merchant-defined metadata.

***

## Endpoint

```text theme={null}
GET /api/v3/pg/plans
```

***

#### To view all available base URLs and environments, refer to:

➡️ [API Resources](https://docs.kwikpaisa.com/guide/quick-start/api-resources.md)

#### This endpoint requires standard KwikPaisa Neo Bank authentication headers.

Refer to:

➡️ [Headers](https://docs.kwikpaisa.com/guide/authentication/headers.md)\
➡️ [Signature Generation](https://docs.kwikpaisa.com/guide/authentication/signature.md)\
➡️ [Timestamp Validation](https://docs.kwikpaisa.com/guide/authentication/timestamp.md)

***

## Request Parameters

This endpoint does not require any request body parameters.

***

## Example cURL Request

```text theme={null}
curl --request GET \
--url https://sandbox.kwikpaisa.com/api/v3/pg/plans \
--header "Accept: application/json" \
--header "X-API-KEY: pk_test_xxxxxxxxx" \
--header "X-TIMESTAMP: GENERATED_TIMESTAMP" \
--header "X-SIGNATURE: GENERATED_SIGNATURE"
```

***

## Signature Generation

For this GET request, generate the signature using an empty payload.

```text theme={null}
$timestamp = time();
$payload = [];

$sortPayload = function ($data) use (&$sortPayload) {
    if (!is_array($data)) {
        return $data;
    }

    ksort($data);

    foreach ($data as $key => $value) {
        $data[$key] = $sortPayload($value);
    }

    return $data;
};

$sortedPayload = $sortPayload($payload);
$jsonPayload = json_encode($sortedPayload, JSON_UNESCAPED_SLASHES);

$signature = hash_hmac(
    'sha256',
    $jsonPayload . $timestamp,
    $secretKey
);
```

***

## Example Success Response

```text theme={null}
{
  "success": true,
  "message": "Plans fetched successfully",
  "plans": [
    {
      "plan_id": "plan_28731541-b987-43e3-9ae7-9a66bd097fd2",
      "name": "Monthly Gold Plan",
      "description": "Monthly subscription plan",
      "amount_type": "fixed",
      "amount": "699.00",
      "currency": "INR",
      "frequency": "monthly",
      "interval_count": 1,
      "total_cycles": 12,
      "status": "active",
      "metadata": {
        "package": "gold",
        "purpose": "subscription"
      },
      "created_at": "2026-11-12T04:41:51.000000Z",
      "updated_at": "2026-11-12T04:41:51.000000Z"
    },
    {
      "plan_id": "plan_7ec2fc01-2361-45ea-945b-936d88251844",
      "name": "Monthly Gold Plan",
      "description": "Monthly subscription plan",
      "amount_type": "fixed",
      "amount": "699.00",
      "currency": "INR",
      "frequency": "monthly",
      "interval_count": 1,
      "total_cycles": 12,
      "status": "active",
      "metadata": {
        "package": "gold",
        "purpose": "subscription"
      },
      "created_at": "2026-11-11T10:26:22.000000Z",
      "updated_at": "2026-11-11T10:26:22.000000Z"
    },
    {
      "plan_id": "plan_225b4f4f-f129-4454-80c7-f6baeef7e7e4",
      "name": "Monthly Gold Plan",
      "description": "Monthly subscription plan",
      "amount_type": "fixed",
      "amount": "699.00",
      "currency": "INR",
      "frequency": "monthly",
      "interval_count": 1,
      "total_cycles": 12,
      "status": "active",
      "metadata": {
        "package": "gold",
        "purpose": "subscription"
      },
      "created_at": "2026-11-11T10:25:08.000000Z",
      "updated_at": "2026-11-11T10:25:08.000000Z"
    }
  ]
}
```

***

## Response Parameters

| Parameter | Description |
| :- | :- |
| `success` | Indicates whether the plans were fetched successfully |
| `message` | API response message |
| `plans` | Array containing subscription plan records |
| `plans[].plan_id` | Unique KwikPaisa Neo Bank generated plan ID |
| `plans[].name` | Name of the subscription plan |
| `plans[].description` | Plan description |
| `plans[].amount_type` | Plan amount type (`fixed` or `variable`) |
| `plans[].amount` | Subscription amount |
| `plans[].currency` | Plan currency |
| `plans[].frequency` | Billing frequency |
| `plans[].interval_count` | Number of frequency intervals between billing cycles |
| `plans[].total_cycles` | Total number of billing cycles |
| `plans[].status` | Current plan status |
| `plans[].metadata` | Merchant-defined additional plan information |
| `plans[].created_at` | Plan creation timestamp |
| `plans[].updated_at` | Plan last update timestamp |

***

## Important Notes

* The API retrieves plans associated with the authenticated merchant account.
* Each plan has a unique `plan_id` generated by KwikPaisa Neo Bank.
* Store the returned `plan_id` for future subscription operations.
* The `amount` is returned as a decimal string.
* `metadata` contains additional merchant-defined information associated with the plan.
* Some plan records may contain `metadata` as a JSON object or a JSON-encoded string, depending on the stored record.
* Generate API signatures on your server only.
* Use HTTPS for all API requests.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.