Skip to main content

icon: calendar-plus

Create Subscription

Use the Create Subscription API to create a subscription for an existing customer using a previously created subscription plan. The API creates a subscription mandate in KwikPaisa Neo Bank and returns a unique mandate_id. The subscription is initially created with a pending status. Once created, the subscription can be used to initiate the customer authorization process through the subscription checkout flow. This API supports:
  • UPI
  • Card
  • Net Banking

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

Metadata Parameters

The metadata object supports merchant-defined information associated with the subscription.

Example Request Body


Example cURL Request


Signature Generation

Generate the request signature using the recursively sorted request payload.

Example Success Response


Response Parameters


Subscription Status

A newly created subscription is assigned the following initial status:

Important Notes

  • Create a customer before creating a subscription.
  • Create a plan before creating a subscription.
  • The supplied customer_id and plan_id must belong to the authenticated merchant account.
  • The reference_id should be unique for each subscription under the merchant account.
  • The subscription amount, currency, and billing frequency are derived from the associated plan.
  • metadata is intended for additional merchant-defined information.
  • start_at and authorization_expires_at are provider-generated values and are updated during the authorization process.
  • A successful API response means the subscription record has been created; it does not mean that the customer has authorized the mandate.
  • Store the returned mandate_id for subsequent subscription operations.
  • Generate API signatures on your server only.
  • Never expose your secret key in frontend applications.
  • Use HTTPS for all API requests.

  1. Create a customer using the Create Customer API.
  2. Create a subscription plan using the Create Plan API.
  3. Create a subscription using the customer ID and plan ID.
  4. Store the generated mandate_id.
  5. Provide the subscription authorization/checkout URL to the customer when available.
  6. Customer completes the mandate authorization process.
  7. Receive the webhook notification and update the subscription status.
  8. Use the Fetch Subscription API to retrieve the latest subscription details.