get https://mercury-uat.phonepe.com/v3/recurring/subscription/status//
Request Headers
Header Name | Header Value |
---|---|
Content-Type | application/json |
X-VERIFY | SHA256("/v3/recurring/subscription/status/{merchantId}/{merchantSubscriptionId}" + saltKey) + "###" + saltIndex |
Path Parameters
Parameter Name | Type | Description | Mandatory |
---|---|---|---|
merchantId | STRING | Unique Merchant ID assigned to the merchant by PhonePe | Yes |
merchantSubscriptionId | STRING | merchantSubscriptionId for which status is to be fetched | Yes |
{
"success": true,
"code": "SUCCESS",
"message": "Your request has been successfully completed. [message = Your subscription request has been successfully created.]",
"data": {
"subscriptionId": "OMS2105131257131014108471",
"state": "CREATED",
"validUpto": 1620891733101,
"isSupportedApp": true,
"isSupportedUser": true
}
}
Sample Response Payload When Subscription is PAUSED
{
"success": true,
"code": "SUCCESS",
"message": "Your request has been successfully completed.",
"data": {
"subscriptionId": "OMS2006110139450123456789",
"merchantSubscriptionId": "MSUB123456789012345",
"state": "PAUSED",
"stateStartDate": 1653371461055,
"stateEndDate": 1653371571095
}
}
Response Parameters
Parameter Name | Type | Description |
---|---|---|
subscriptionId | STRING | PhonePe subscription identifier |
state | STRING | ● CREATED ● ACTIVE ● SUSPENDED ● REVOKED ● CANCELLED ● PAUSED ● EXPIRED ● FAILED ● CANCEL_IN_PROGRESS |
stateStartDate | DATETIME | Epoch time from which given state is valid |
stateEndDate | DATETIME | Epoch time until which given state is valid |
validUpto | DATETIME | Epoch time until which auth must be completed |