Skip to main content

Fetch Subscription

Use the Fetch Subscription API to retrieve the details of a specific subscription using its unique KwikPaisa Neo Bank generated mandate_id. This API returns subscription information, including the associated customer and plan IDs, payment method, billing details, payment cycle counts, authorization URL, current status, and merchant-defined metadata.

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


Example cURL Request


Signature Generation

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

Example Success Response


Response Parameters


Subscription Status

The supplied response demonstrates the following status: Other possible statuses should be interpreted according to the subscription lifecycle.

Important Notes

  • Provide a valid subscription_id in the endpoint URL.
  • The subscription ID must be generated by KwikPaisa Neo Bank during subscription creation.
  • The API retrieves the subscription associated with the authenticated merchant account.
  • Use mandate_id for subsequent subscription operations, including cancellation and invoice retrieval.
  • paid_count represents successfully paid billing cycles.
  • remaining_count represents the remaining billing cycles.
  • authorization_url may be null when an authorization URL has not been generated.
  • metadata contains merchant-defined subscription information and may be null.
  • Generate API signatures on your server only.
  • Never expose your secret key in frontend applications.
  • Use HTTPS for all API requests.