Fetch All Subscriptions

To fetch all the subscription for a user

Request Headers

Header NameHeader Value
Content-Typeapplication/json
X-VERIFYSHA256("/v3/recurring/subscription/user/{merchantId}/{merchantUserId}/all" + saltKey) + "###" + saltIndex

Path Parameters

Parameter NameTypeDescriptionMandatory
merchantIdSTRINGUnique Merchant ID assigned to the merchant by PhonePeYes
merchantUserIdSTRINGUnique User Id linked with PhonePeYes
{
  "success": true,
  "code": "SUCCESS",
  "message": "Your request has been successfully processed.",
  "data": {
    "subscriptions": [
      {
        "merchantSubscriptionId": "MSUB123456789012345",
        "subscriptionId": "OMS20061101394501234567890",
        "state": "EXPIRED",
        "expiredAt": "Thursday, 11 June 2020 01:54:42 IST"
      },
      {
        "merchantSubscriptionId": "MSUB1234567890123456",
        "subscriptionId": "OMS20061101554201234567891",
        "state": "FAILED"
      },
      {
        "merchantSubscriptionId": "MSUB12345678901234567",
        "subscriptionId": "OMS20061101404501234567892",
        "state": "CREATED",
        "validUpto": "Thursday, 11 June 2020 02:54:42 IST"
      }
    ]
  }
}

Response Parameters

Field NameData TypeDescription
merchantSubscriptionIdSTRINGMerchant's SubscriptionId
subscriptionIdSTRINGPhonePe’s SubscriptionId
stateSTRING● EXPIRED
● CREATED
● FAILED
● SUSPENDED
● CANCELLED
● ACTIVE
● REVOKED
validUptoDATETIMEEpoch time until which auth must be
completed
Language
Click Try It! to start a request and see the response here!