Subscriptions/Recurring Payments

Following are the APIs that are required to create, debit, and cancel a subscription.

1. Create subscription - You can refer to the link given below to know the parameters required for creating a subscription: https://docs.rocketfuel.inc/developer-guides/api-reference/generate-invoice-link

2. Request a debit of funds for the subscription

Reminder emails are sent to the shoppers to make the pre-payment for the subscriptions with the invoice link or maintain the exchange balance equal to the bill amount.

POST /subscription/debit

Request Body

Name	Type	Description
merchantAuth*	String
merchantId*	String
orderId	String
items	Array
subscriptionId*	String
amount*	Number
currency*	String

200: OK

{

status: 200,

result: {

data: [{

      transactionId: response.id,

      amount: response.localAmount,

      currency: response.localCurrency,

      rateDivisor: response.rateDivisor,

      orderId: response.meta.offerId,

      status: response.status,

      userId,

      merchantId,

subscriptionId

}],

errors: [],

}

3. To cancel a subscription

POST /subscription/cancel

Request Body

Name	Type	Description
merchantId	String
merchantAuth	String
subscriptionId	String

200: OK

{

status: 200,

result: { success: true }

}

400: Bad Request

{

  "ok": false,

  "statusCode": 400,

  "data": {

}

"message": "Subscription not found"

}

500: Internal Server Error

{
  "ok": false,

  "statusCode": 500,
  "data": {

}

"message": "Internal server error"

  }