Search
IntroductionRequest Headers
Copied !
| Header Name | Header Value |
|---|---|
Content-Type | application/json |
X-VERIFY | SHA256(“/v3/recurring/subscription/status/{merchantId}/{merchantSubscriptionId}” + saltKey) + “###” + saltIndex |
Path Parameters
Copied !
| 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 |
Sample Response - CREATED{
"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
Copied !
Sample Response - 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
Copied !
| 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 |
{“method”:”get”,”url”:”/v3/recurring/subscription/status/{merchantId}/{merchantSubscriptionId}”,”auth”:”required”,”results”:{“codes”:[{“name”:”CREATED State”,”code”:”{\n \”success\”: true,\n \”code\”: \”SUCCESS\”,\n \”message\”: \”Your request has been successfully completed. [message = Your subscription request has been successfully created.]\”,\n \”data\”: {\n \”subscriptionId\”: \”OMS2105131257131014108471\”,\n \”state\”: \”CREATED\”,\n \”validUpto\”: 1620891733101,\n \”isSupportedApp\”: true,\n \”isSupportedUser\”: true\n }\n}”,”language”:”json”,”status”:200},{“name”:””,”code”:”{\n \”success\”: false,\n \”code\”: \”SUBSCRIPTION_NOT_FOUND\”,\n \”message\”: \”No Subscription found with the given details.\”,\n \”data\”: {}\n}”,”language”:”json”,”status”:400},{“code”:”{\n \”success\”: true,\n \”code\”: \”SUCCESS\”,\n \”message\”: \”Your request has been successfully completed.\”,\n \”data\”: {\n\t\t\”subscriptionId\”: \”OMS2006110139450123456789\”,\n\t\t\”merchantSubscriptionId\”: \”MSUB123456789012345\”,\n\t\t\”state\”: \”PAUSED\”,\n\t\t\”stateStartDate\”: 1653371461055\n\t\t\”stateEndDate\”: 1653371571095\n\t}\n}\n”,”language”:”json”,”status”:200,”name”:”PAUSED State”}]},”params”:[{“name”:”merchantId”,”type”:”string”,”enumValues”:””,”default”:””,”desc”:”Unique Merchant ID assigned to the merchant by PhonePe”,”required”:false,”in”:”path”,”ref”:””,”_id”:”60ade31579d7c1005b56d00b”},{“name”:”merchantSubscriptionId”,”type”:”string”,”enumValues”:””,”default”:””,”desc”:”Merchant Subscription Id for which status is to be fetched”,”required”:false,”in”:”path”,”ref”:””,”_id”:”60ade31579d7c1005b56d00a”},{“name”:”Content-Type”,”type”:”string”,”enumValues”:””,”default”:”application/json”,”desc”:””,”required”:true,”in”:”header”,”ref”:””,”_id”:”60ade31579d7c1005b56d009″},{“name”:”X-VERIFY”,”type”:”string”,”enumValues”:””,”default”:””,”desc”:”SHA256(\”/v3/recurring/subscription/status/{merchantId}/{merchantSubscriptionId}\” + saltKey) + \”###\” + saltIndex”,”required”:true,”in”:”header”,”ref”:””,”_id”:”60ade31579d7c1005b56d008″}],”examples”:{“codes”:[]},”apiSetting”:”63bb01b11abcf7046d98754c”}
https://api-preprod.phonepe.com/apis/pg-sandbox
