Skip to main content

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


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

➡️ API Resources

This endpoint requires standard KwikPaisa Neo Bank authentication headers.

Refer to: ➡️ Headers
➡️ Signature Generation
➡️ Timestamp Validation

Request Parameters

This endpoint does not require any request body parameters.

Example cURL Request


Signature Generation

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

Example Success Response


Response Parameters


Subscription Status

The response may contain subscriptions in different statuses.

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.