Fetch All Subscriptions

To fetch all the subscription for a user

Request Headers

Header Name

Header Value

Content-Type

application/json

X-VERIFY

SHA256("/v3/recurring/subscription/user/{merchantId}/{merchantUserId}/all" + saltKey) + "###" + saltIndex

Path Parameters

Parameter Name

Type

Description

Mandatory

merchantId

STRING

Unique Merchant ID assigned to the merchant by PhonePe

Yes

merchantUserId

STRING

Unique User Id linked with PhonePe

Yes

{
  "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 Name

Data Type

Description

merchantSubscriptionId

STRING

Merchant's SubscriptionId

subscriptionId

STRING

PhonePe’s SubscriptionId

state

STRING

● EXPIRED
● CREATED
● FAILED
● SUSPENDED
● CANCELLED
● ACTIVE
● REVOKED

validUpto

DATETIME

Epoch time until which auth must be
completed

Language
Click Try It! to start a request and see the response here!