icon: calendar-search
Fetch Subscription
Use the Fetch Subscription API to retrieve the details of a specific subscription using its unique KwikPaisa Neo Bank generatedmandate_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 ResourcesThis 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_idin 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_idfor subsequent subscription operations, including cancellation and invoice retrieval. paid_countrepresents successfully paid billing cycles.remaining_countrepresents the remaining billing cycles.authorization_urlmay be null when an authorization URL has not been generated.metadatacontains 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.
