> ## 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 Subscriptions

***

## icon: calendar-days

# List Subscriptions

Use the List Subscriptions API to retrieve all subscriptions created under your KwikPaisa Neo Bank merchant account.

This API returns subscription details, including the associated customer and plan IDs, payment method, billing information, subscription status, authorization URL, metadata, and timestamps.

***

## Endpoint

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

***

#### 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/subscriptions \
--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}
{
  "status": true,
  "message": "Subscriptions fetched successfully.",
  "data": [
    {
      "mandate_id": "mand_8dceeb5f-986b-4cb9-ade2-475f25df1ee5",
      "customer_id": "cust_d71f980e-4b3f-4e9b-9d14-7cfa92fd9134",
      "plan_id": "plan_7ec2fc01-2361-45ea-945b-936d88251844",
      "type": "upi",
      "reference_id": "1794458812",
      "amount_type": "fixed",
      "amount": "699.00",
      "currency": "INR",
      "frequency": "monthly",
      "interval_count": 1,
      "quantity": 1,
      "total_cycles": 12,
      "start_date": null,
      "end_date": null,
      "start_at": null,
      "paid_count": 0,
      "remaining_count": 12,
      "authorization_url": null,
      "status": "pending",
      "metadata": {
        "purpose": "subscription",
        "package": "gold",
        "addons": [
          {
            "item": {
              "name": "Delivery charges",
              "amount": 3000,
              "currency": "INR"
            }
          }
        ]
      },
      "created_at": "2026-11-12T04:46:53.000000Z",
      "updated_at": "2026-11-12T04:46:53.000000Z"
    },
    {
      "mandate_id": "mand_0112f7c3-cda2-4405-b4f6-c0c5f2a97b17",
      "customer_id": "cust_d71f980e-4b3f-4e9b-9d14-7cfa92fd9134",
      "plan_id": "plan_7ec2fc01-2361-45ea-945b-936d88251844",
      "type": "upi",
      "reference_id": "1794406777",
      "amount_type": "fixed",
      "amount": "699.00",
      "currency": "INR",
      "frequency": "monthly",
      "interval_count": 1,
      "quantity": 1,
      "total_cycles": 12,
      "start_date": null,
      "end_date": null,
      "start_at": null,
      "paid_count": 0,
      "remaining_count": 12,
      "authorization_url": null,
      "status": "revoked",
      "metadata": {
        "purpose": "subscription",
        "package": "gold",
        "addons": [
          {
            "item": {
              "name": "Delivery charges",
              "amount": 3000,
              "currency": "INR"
            }
          }
        ]
      },
      "created_at": "2026-11-11T14:19:38.000000Z",
      "updated_at": "2026-11-11T14:37:12.000000Z"
    },
    {
      "mandate_id": "mand_a231a81e-da6a-4f9f-a2b9-c1ee3b6f8128",
      "customer_id": "cust_d71f980e-4b3f-4e9b-9d14-7cfa92fd9134",
      "plan_id": "plan_7ec2fc01-2361-45ea-945b-936d88251844",
      "type": "upi",
      "reference_id": "1794405633",
      "amount_type": "fixed",
      "amount": "699.00",
      "currency": "INR",
      "frequency": "monthly",
      "interval_count": 1,
      "quantity": 1,
      "total_cycles": 12,
      "start_date": null,
      "end_date": null,
      "start_at": null,
      "paid_count": 0,
      "remaining_count": 12,
      "authorization_url": null,
      "status": "revoked",
      "metadata": {
        "purpose": "subscription",
        "package": "gold",
        "addons": [
          {
            "item": {
              "name": "Delivery charges",
              "amount": 3000,
              "currency": "INR"
            }
          }
        ]
      },
      "created_at": "2026-11-11T14:00:34.000000Z",
      "updated_at": "2026-11-11T14:38:22.000000Z"
    },
    {
      "mandate_id": "mand_5ca18b9b-848a-4ec4-82fc-28ad44f72585",
      "customer_id": "cust_d71f980e-4b3f-4e9b-9d14-7cfa92fd9134",
      "plan_id": "plan_7ec2fc01-2361-45ea-945b-936d88251844",
      "type": "upi",
      "reference_id": "1794405559",
      "amount_type": "fixed",
      "amount": "699.00",
      "currency": "INR",
      "frequency": "monthly",
      "interval_count": 1,
      "quantity": 1,
      "total_cycles": 12,
      "start_date": null,
      "end_date": null,
      "start_at": null,
      "paid_count": 0,
      "remaining_count": 12,
      "authorization_url": null,
      "status": "pending",
      "metadata": null,
      "created_at": "2026-11-11T13:59:20.000000Z",
      "updated_at": "2026-11-11T13:59:20.000000Z"
    }
  ]
}
```

***

## Response Parameters

| Parameter | Description |
| :- | :- |
| `status` | Indicates whether subscriptions were fetched successfully |
| `message` | API response message |
| `data` | Array containing subscription records |
| `data[].mandate_id` | Unique KwikPaisa Neo Bank generated subscription/mandate ID |
| `data[].customer_id` | Associated customer ID |
| `data[].plan_id` | Associated subscription plan ID |
| `data[].type` | Subscription payment method |
| `data[].reference_id` | Merchant-provided subscription reference ID |
| `data[].amount_type` | Subscription amount type |
| `data[].amount` | Subscription amount |
| `data[].currency` | Subscription currency |
| `data[].frequency` | Billing frequency |
| `data[].interval_count` | Number of frequency intervals between billing cycles |
| `data[].quantity` | Subscription plan quantity |
| `data[].total_cycles` | Total billing cycles |
| `data[].start_date` | Requested subscription start date |
| `data[].end_date` | Requested subscription end date |
| `data[].start_at` | Actual subscription start timestamp |
| `data[].paid_count` | Number of successfully paid billing cycles |
| `data[].remaining_count` | Number of remaining billing cycles |
| `data[].authorization_url` | Customer authorization URL, when available |
| `data[].status` | Current subscription status |
| `data[].metadata` | Merchant-defined subscription information |
| `data[].created_at` | Subscription creation timestamp |
| `data[].updated_at` | Subscription last update timestamp |

***

## Subscription Status

The response may contain subscriptions in different statuses.

| Status | Description |
| :- | :- |
| `pending` | Subscription is awaiting customer authorization |
| `revoked` | Subscription has been cancelled or revoked |

***

## Important Notes

* The API retrieves subscriptions associated with the authenticated merchant account.
* Each subscription has a unique `mandate_id`.
* Use `mandate_id` for fetching, cancelling, and retrieving subscription invoices.
* `customer_id` and `plan_id` refer to the associated customer and plan.
* `paid_count` represents successfully paid billing cycles.
* `remaining_count` represents the remaining billing cycles.
* `authorization_url` may be null until the authorization flow generates a URL.
* `metadata` contains merchant-defined subscription information and may be null.
* 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.